Scheduled user import from an XML file

The format of the XML file to be imported by the Scheduled User Import is as follows (comments are in italics and marked with “--“, these must not be in the actual XML file and are only served as information):

 

  • <?xml version=”1.0”?>
  • <Data>
    • -- Insert a user
    • <User cmd=”Insert”>
      • <UserId></UserId>
      • <Firstname></Firstname>
      • <Lastname></Lastname>
      • <WinLogin></WinLogin>
      • <Password></Password>
      • <SyncCalendar>True</SyncCalendar>   -- Default False
      • <CalendarId></CalendarId>
      • <Calendar></Calendar>  -- Caption of Calendar Connector
      • <Permissions>
        • <Admin>True</Admin>  -- Default False
        • <Switchboard>False</Switchboard>  -- Default False
        • <Receptionist>True</Receptionist>  -- Default False
      • </Permissions>
      • <CustomFields>
        • -- Custom Fields vary for each installation.
        • -- If custom fields have predefined values then each value is separated by a semicolon.
        • -- Here is an example with two Custom Fields:
          • Division – the user belongs to the division “Sales and Services”
          • Capabilities – the user has three capabilities: “Sales”, “Marketing” and  “Customer Support”
        • <CustomField>
          • <Name><![CDATA[Division]]></Name>
          • <Value><![CDATA[Sales and Services]]></Value>
        • </CustomField>
        • <CustomField>
          • <Name><![CDATA[Capabilities]]></Name>
          • <Value><![CDATA[Sales;Marketing;Customer Support]]></Value>
        • </CustomField>
      • </CustomFields>
      • <ContactInfo>
        • -- List of user’s contact information. Each information starts with a new <Info> parameter.
        • <Info>
          • <Type></Type> -- Values: Local, Mobile, Work, Home, Fax, Mail, Web, Mulap. If Value is not one of the above, then this contact info  will not be added.
          • <Value></Value>
          • <Default>False</Default>  -- Default False
          • <Private>False</Private>  -- Default False
        • </Info> -- User’s second contact info. Like above <Info>….</Info>
        • -- User’s third contact info.
        • <Info>…</Info>   -- and so on
      • </ContactInfo>
    • </User>
      • -- Activate a user
      • <User cmd=”Activate”>
      • <UserId></UserId>
    • </User>
      • -- Deactivate a user
      • <User cmd=”Deactivate”>
      • <UserId></UserId>
    • </User>
  • </Data>

 

It’s important to note that the cmd attribute has to be set, otherwise user is ignored. Also UserId is the only node that has to be assigned.
It’s possible to see an example of a XML file for inserting users by exporting the users from the Totalview Administrator. This is done under [User]/[Functions]/[Export] by choosing “Extensible Markup Language File (*.xml)” in the “Save as Type” field.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Last edited on October 30th, 2017