Bulk export of users

Last Updated : Nov 29, 2021 |

In System Manager, you can export users in bulk from the System Manager database. While exporting in bulk, the system exports the data to an XML file.

You can export the following user attributes in bulk:

  • Identity data

  • Communication profile set

  • Handles

  • Communication profiles

    The supported communication profiles are CM Endpoint, CM Agent, Messaging, Session Manager, CS 1000 Endpoint, IP Office, Presence, Avaya Breeze® platform, Work Assignment, Avaya Messaging, and Avaya Meetings Server.

Note:

For security reasons, the system does not export the password fields in the XML file.

You can export the following global settings attributes in bulk:

  • Public Contact Lists

  • Shared Addresses

  • Default access control list (ACLs)

The Export User process creates an archive file containing one or more XML files. While exporting users records, if the number of exported records exceed the limit of records that an XML file can hold, the system creates multiple XML files. The system packages the XML files in a zip file.

The XML file conforms to the XML schema definition that supports import of user. This schema addresses the complete user attributes, for more information, see XML Schema Definition for bulk import of users.

The system generates the XML file on the System Manager server. You can specify the location of the file you want to export while running the Export User job.

You can schedule an export user job. The job parameter provides an option to specify the schedule time in the YYYY:MM:DD:HH:MM:SS format. If you do not specify this parameter, the present job runs immediately.

When you import the same file to a new system, you must provide the password for users with any administrative role. For security reasons, the system does not export the Password fields to the XML file. Therefore, import of users with any administrative role fails, if the password is not provided.

To import users with any administrative role, in the XML file for the users, add the following XML tag after the <username> tag:

<userPassword> provide password for user </userPassword>

For Partial Merge/Replace import type, if you do not specify the password, the existing password remains.

You can export user data in bulk from System Manager web console.

Bulk export users directory

The bulk export users zip files are stored in the /var/avaya/bulkadministration/export/ directory. The total file size of exported zip files is monitored as per the value of the max_bulk_export_files_directory_size_allowed property in the $MGMT_HOME/bulkadministration/exportutility/config/bulkexportconfig.properties directory. The default file size for bulk export user is 1-GB. You can change the file size value for bulk export user to maximum 2-GB.

The system runs the check for the total size of the files in the /var/avaya/bulkadministration/export/ directory on a daily basis. If the file size is greater than max_bulk_export_files_directory_size_allowed, the system automatically deletes the oldest files to make the size less than or equal to max_bulk_export_files_directory_size_allowed.

Note:

If there is only one file in /var/avaya/bulkadministration/export/, the system does not deletes the file.