About bulk import of users

Last Updated : Apr 30, 2018 |

You can use the bulk import functionality to import users in bulk with their attributes from an XML file. The XML file must conform to XML schema definition. For more information, see XML Schema Definition for bulk import of users. See Sample XML for bulk import of users with all attributes for the sample XML file for bulk import of user.

You can perform the following tasks with the bulk import functionality:

  • Abort or continue the import process when the import user operation encounters first error in the user input file.

  • Perform the following import types:

    • A Partial import type helps import of users with specific user attributes.

    • A Complete import type helps import of users with all user attributes.

  • Skip import of the users that already exist in the database. Use this option to import new users from the XML file.

  • Replace the users in the database with the new users from the file you imported. The system performs the following actions:

    • Replaces all items of user collection attributes such as CommprofileSet and Contactlist.

    • Removes the existing items.

    • Adds the new items from the XML.

    • Updates the single-value user attributes.

    For example, the user John Miller has StationA and EndpointB as existing commprofiles in default commprofileset and you import an XML file containing users with StationC and EndpointB with Replace option. After you import, John Miller has commprofiles StationC and EndpointB in the default commprofileset.

    Note:

    For CS1000 Endpoint Profile, you cannot import both communication profile and user at the same time. You must add the user and then merge the profile.

  • Update and merge the user attributes data from the imported file to the existing data. The system performs the following actions:

    • Merges items of user collection attributes such as CommprofileSet and Contactlist.

    • Retains and updates the existing items.

    • Adds the new items from the XML.

    • Updates the single-value user attributes.

    For example, the user John Miller has StationA and EndpointB as existing commprofiles in default commprofileset and you import an XML file containing users with StationC and EndpointB with Replace option. After you import, John Miller has commProfiles StationA, StationC, EndpointB in the default commprofileset.

  • Delete the user records from the database that match the records in the input XML file.

  • Schedule the bulk import job.

  • View the details of an import job:

    • Job scheduled time

    • Job end time

    • Job status

    • Job completion status in percentage

    • Total number of user records in the input file

    • Total number of user records with warnings in the input file

    • Total number of user records that fail to import in the input file

    • The link to the Scheduler user interface

  • Cancel or delete an import job.

  • View logs of records that fail to import and require manual intervention.

  • Download failed records in an XML file. The XML file conforms to XML schema definition. You can modify the failed records and import the records again to the database.

The following two XML schema definitions are available based on the complete and partial import types:

To delete bulk users, a separate XML schema definition is defined. See XML Schema Definition for bulk deletion of users. For a sample XML that conforms to delete bulk users XML schema definition, see Sample XML for bulk deletion of users.