Importing/updating groups

The CSV Import feature provides premade templates for the most commonly used import options. This topic provides a sample of a CSV import for a new group, and information on each entity in the corresponding template.

1. In the Bulk import data window, select Download CSV templates.

2. In your downloads, open groups.csv.

3. In the CSV file, populate each selection field with your information according to the entities defined in each column (in the top row of the template table).

For information on how to create a CSV file, see Importing data using a CSV file.

Sample CSV file format for importing groups:

group_name,group_description,group_active,group_organizationId,group_metadata_<KEY>
Group A,Group A description,TRUE,root,metadata_<KEY>
Group B,Group B description,TRUE,root,metadata_<KEY>

The top line or row designates the entities for which you will enter values according to each group.

Entities

Mandatory

• group_name

  • The group name is used to identify the group on TAO Portal.

  • Entering a value for this selection field is mandatory when creating or updating a group, but cannot be changed after creation.

• group_organizationId

  • The organizational unit (inside the hierarchy) where the group is assigned.

  • This field is only valid if Organization (hierarchies) is enabled.

  • If enabled, this field is mandatory.

Available

• group_description

  • A description for the group.

• group_active

  • To create an enabled (active), or disabled (inactive) group. Inactive users cannot login.

  • If left empty, the default value is Active (TRUE). Add FALSE to flag the group as inactive.

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false and will send a warning to the logfile.

• metadata_<KEY>

Updating a group

1. To update a group, you need to enter the mandatory entity values (group name). All other values can be updated.

2. If a value in a column is left blank, the corresponding value is removed (if it is not mandatory, otherwise it will trigger an error).

3. If a value in a column has a new value, it will replace the previous value.

4. If the column is removed, the existing value will be kept.