Bulk User Import

This section provides background information on the bulk user import. For procedures or workflows, see the step-by-step section.

A large group of users can be added to a project by populating a Desigo CC provided CSV file with the required fields for setting up a user, and then importing the file from the management station’s Users tab.

CSV Template for Importing Users

The CSV template file is a comma delimited file that can be populated or edited with MicrosoftTM Excel or a text editor of your choice. The fields in the template file correspond to those in the Users tab and dialog boxes for creating a new user or updating information for existing users.

NOTE: It is important to note that the number of comma’s should correspond to the number of fields. However, the last field comma may be omitted. If there is no value specified for a field, a comma must still be entered. This is particularly important when a spreadsheet application is not used to fill in the template because a missing comma shifts the values. Additionally, entries with invalid number of commas are skipped.

Once you save and import the data, the Users tab is updated with the new users or the updated information for existing users from the CSV file. Any existing Desigo CC users included in the CSV bulk import file are overwritten with the latest information from the import.

The CSV template header text must be kept as is. If the columns are rearranged or if the text is altered, the file will not import correctly.

The DCC_UserData_Import_Template.csv file is located in the following directory: \GMSMainProject\profiles\UserDataTemplate\

BULK CSV Template Fields

Mandatory Field

Field

Description

UserName

The user’s unique identifier.

  • It is recommended that the text is enclosed in double-quotes. For example: "User, Name"
  • The field cannot be blank.
  • If duplicates exist, either in the spreadsheet or the user already exists in Desigo CC, then the last entry in the spreadsheet is imported and any existing user information is overwritten. Roles from any duplicates are merged with the imported user, resulting in multiple roles for that user.

Non-Mandatory Fields

UserType

The assigned user group type.

This field must be one of the following user types, exactly as written below with no spaces:

  • DesigoCC
  • SoftwareAccount
  • OpenID

NOTE: Windows accounts are not allowed. If entered, the user is instead imported with the user type: DesigoCC.

Description

A user description.

FullName

Expanded user name information.

Profile

The project profile the user belongs to.

  • Typing the file extension (.LDL) is not required.
  • If left blank, the Default profile is applied.

The client profile options are found in the following directory: GMSProjects\[Project Name]\profiles.

FlexProfile

The Flex client project profile the user belongs to.

  • Typing the file extension ( .HLDL.JSON) is not required.
  • If left blank, the Default profile is applied.

The client profile options are found in the following directory: GMSProjects\[Websites]\[WebsiteName]\[FlexApplicationName]\profiles.

Role

The role or user group the user belongs to.

  • If this field is blank, the user is not able to see any data in the applications.
  • The role cannot be internal, such as DefaultAdmin, FallbackPolicy, etc.
  • It is recommended that Global users also have Global roles assigned.
  • A user (Username) can have multiple roles. To add multiple roles for a user, create a new row for each applicable role for that user. The information is merged upon import intoDesigo CC.

GlobalUser

(Distributed systems and DesigoCC/OpenID user types only.)

Type one of the following:

  • Yes – If the user will be a Global User.
    • If an existing user is a local user, typing Yes promotes them to a Global user and all their local roles are removed upon import.
    • It is recommended that each Global user has a Global role defined.
  • No - If the user is not a Global User.

Global users can only be imported in the Master system.
NOTE: In distributed systems, promoting or demoting software account might lead to some inconsistencies in the workflow where this account is in use, for example, Advanced Reports, OPC server, Power Manager  or Building X Connector.

Language

The language code applied for the user. The language must be in the correct format, for example: it-IT and installed in the project.

  • If blank or invalid the default language en-US is applied.

Password

(DesigoCC user type only.)

The user password.

  • If left blank, the user’s UserName is set as the password.