Exporting users in bulk from web console

Last Updated : Oct 09, 2020 |

About this task

With bulk export you can export the delta of users for a specified period of time. Delta users are the added, updated, or deleted users for the specified period of time. This feature is useful for performing bulk export of the entire System Manager user database that can be used with the external applications. This feature enables you to export only the users that have changed during the defined interval.

Important:

  • The system runs the export users job that you schedule only once. To export users the next time, you must create a new export job by using this procedure. You cannot reschedule an existing export job.

  • Increasing number of users per file in bulk export configuration beyond verified default limit consumes system resources. It results in degrading system performance and can cause system crash.

Procedure

  1. On the System Manager web console, click Users > User Management.
  2. On the User management page, click one of the following:

    • More Actions > Export All Users to export user records for all users.

    • More Actions > Export Selected Users to export user records for the users that you select.

      Note:

      • If you select specific users from the list and click Export All, the system exports the records of all users instead of the selected records.

      • If you provide the criteria in Advanced Search and click Export All, the system exports only the records that match the criteria.

    • More Actions > Export Delta Users to export the delta of users for a specified period of time.

    The system displays the Export Users page.

  3. In the Export File Type Options section, in Select Export File Types, click Xml, Excel or both.
    Note:

    Select at least one option. If you do not select a file type, and click Export, the export operation does not start. The page displays the message Export File Type/Types Not Selected. Select Export File Types Xml or Excel or Both.

    If you select only Excel, the system automatically clears the Contacts check box in User Attribute Options because excel file does not support importing and exporting user contacts. The page also displays a message Excel file does not support contacts beside the Contacts check box.

  4. Optional In the User Attribute Options section, select one or more check boxes to export contacts and specific communication profiles.

    By default, the system exports basic attributes, communication profiles, and contacts.

    For more information, see Export Users field descriptions.

  5. In the Delta Period Options section, from Select the delta period, select the delta period to generate the file for the delta of users.

    The Delta Period Options section is available only if you select the Export Delta Users option.

    For more information, see Export Users field descriptions.

    For example, if you select the delta period as One Week, schedule the job with the Run immediately option, and export file type as both XML and Excel, then the exported zip file contains the following:

    • An XML file with added or updated users in last one week.

    • An Excel file with added or updated users in last one week.

    • A deleted users .txt file only if there are any permanently deleted users in the specified delta period.

  6. In the Schedule Job field, click Run immediately or Schedule later.

    For more information, see Export Users field descriptions.

    Important:

    The export users job that you schedule runs only once. To export users the next time, you must create a new export job by using this procedure. You cannot reschedule an existing export job.

  7. Click Export to complete the export operation.

    The system exports the user data to the XML and Excel file.

  8. To view the data, in the Export List section, click the link in the Download File column.

    To use the exported excel file for operations such as reimporting, while exporting users from the Export Users page, clear the Contacts check box in User Attribute Options. Excel export or import operations does not support export or import of contacts that are associated with the user.

Related information
Bulk export of users
List of XML Schema Definitions and sample XMLs for bulk import
exportUpmGlobalsettings.sh command
Attribute details defined in Import user XSD
Attribute details defined in Delete User XSD
Attribute details defined in the CM Endpoint profile XSD
Attribute details defined in the Messaging communication profile XSD
Attribute details defined in the Session Manager communication profile XSD
Export Users field descriptions
Downloading the Excel template file
Microsoft Excel data link error
Bulk importing of users