Loading and Extracting Users

You can bulk load user accounts, groups, and security instead of defining them manually. You can load these artifacts in two ways:

  • Use the SecurityTemplate.xlsx file provided by the SampleTemplates MarketPlace solution to generate an xml load file. We recommend this option. See the OneStream Sample Templates User Guide.

  • Extract users in the sample GolfStream application, modify the xml export file to specify user and group properties, and then load the file. See Loading Users.

Administrators must load users and groups into a new application or one without existing users and groups. If user accounts exist, loaded users are validated by comparing their current security settings to those in the xml load file. 

Requirements

By default, only Administrators can load and extract users. To let other users load and extract users, grant them these system security roles:

  • SystemLoadandExtractPage System. This is a User Interface role.

  • ManageSystemSecurityUsers

  • ManageSystemSecurityGroups

  • ManageSystemSecurityRoles

Loading Users

  1. Click System > Tools > Load/Extract.

  2. Select Load and browse to an xml load file.

  3. Click Load.

  4. When processing finishes, review the user list and user settings to ensure the loaded users are correctly defined.

Extracting Users

You can extract users, groups, and security roles to an xml export file.

  1. Click System > Tools > Load/Extract.

  2. Click Extract then select File Type > Security.

  3. In Items to Extract, select Users. Select Export Unique IDs to also extract each user's ID.

  4. Perform a task:
    • Click Extract to specify where to save the extract file.
    • Click Extract and Edit to view and modify the data in an XML Editor.