Creating and Updating User Groups through a File Import

You can create and update as many user groups as required using a .csv (comma-separated values) or a .ttl (Turtle) file. Both files must be UTF-8 compliant.

Note: This functionality is not available on mobile devices.

Before you begin:
  • You must be an administrator of the platform.
  • if the group is not displayed in the My Groups node, select either of the following:
    • All Groups, to display all the groups of your platform.

      To filter all your groups by access role, on the upper-right of the list of groups, click Filter Groups, and select either of the following:

      • Owner
      • Manager
      • Viewer
      • Member

    • If you have access to several platforms, > Platforms, then select another platform in the list.
  • The members must have validated the invitation to the platform. For more information, see About Members.
  • Prepare a .csv or .ttl file containing the information related to the groups you want to create or update. The file size must not exceed 40KB, and must not contain more than 1,000 members.
See Also
Creating a User Group
Editing a User Group
Adding Members to a User Group
Removing Members From a User Group
Exporting User Groups
  1. In the User Groups dashboard app, click + New Group:
  2. Click Import. select a file.
  3. In the Import Groups/Members dialog box select either of the following:
    • Add as new properties and members, to add new information to the existing groups.

      Members are added to the current list. The name is mandatory when creating a group. If provided, the name, description, owner and visibility fields are updated when modifying a group. If visibility is not provided, visibility is private. Responsibilities with users grant them access to the group. Members are added to the existing list of members when modifying a group.

    • Replace existing properties and members, to update existing information.

      Name is mandatory when creating or modifying a group. Name, description, owner and visibility are updated when modifying a group. If owner is not provided, owner is replaced by the current user. If visibility is not provided, visibility is private. Responsibilities with users replace the existing list of granted users. If not provided, existing granted users are revoked. Members replace the existing list of members when modifying a group. For example, the existing list is discarded.

      Important: Providing responsibilities to users replace the existing list of granted users. If not provided, existing granted users are revoked.

    Note: When creating new groups, selecting any of the options above behaves the same.

  4. Click Browse and select a .csv file.

    You can click See Example to download a .csv file that you can use like an import template.

  5. Click Import File.

The user groups are created or updated.

Important: If one user group is not correctly specified, the whole import is cancelled. No user groups will be imported and the whole file is considered as invalid.

Files Examples:

CSV File Example

The file format is as follows: 

id:e3083fb6-9553-482a-88e0-d31b6712d700;Group 1;Group description 1;Group owner1;Group visibility 1
user0
user1
user2

id:new ;Group 2;Group description 2
user3
user4
user5

id:new;Group 3;Group description 3;;private
viewer;user1
manager;user3
owner;user4
user5
user6

Each group is specified by a set of lines.

The template includes the following fields:

id:[New or UUID];[User Group Name];[User Group Description];[User GroupOwner];[Visibility]

[Responsibility];[User];[User]

[MEMBER]

The fields above are described here below:

  • [New or UUIDV4]: a version 4 UUID (Universal Unique Identifier). Optional. If id:new is specified, a new group is created and a new identifier is generated for that group. If an identifier is specified, the import either modifies the existing group with that identifier, or creates a new group with that identifier.
  • [NAME_VALUE]: group name.
    • Mandatory when creating a new group or if Replace existing properties and members has been selected.
    • Optional when updating an existing group, if Add as new properties and members has been selected.
    Note: The size of the name must range from 3 to 128 characters.
  • [DESCRIPTION_VALUE]: group description. Optional.
    Note: The size of the description must range range from 0 to 512 characters.
  • [OWNER]: owner of the group. Optional
    Important: If no owner has been specified, you become the owner of the group.
  • [VISIBILITY]: Group visibility and privacy.

    Values are as follows:

    • "private"
    • "public"
    • "": Empty string
  • [RESPONSIBILITY]: Group responsibility. This field is followed by the list of users, [USER] (id or email), to grant.

  • Values are as follows

    • owner
    • manager
    • viewer
  • [MEMBER]: Login ID or email of a group member.

The second and following lines list the username or the email of the members of the groups. Optional.

Note: The number of members is limited to 1000 for each group.
Important: The email values are not case sensitive.

You can specify several groups in a single file. Each group must be separated by one to n empty lines that you can add right after the last user of a group.

You can use # to prefix a comment. If you add a comment between two groups, you must also add a blank line between them.

TTL File Example

The file format is as follows: 

<uuid:e3083fb6-9553-482a-88e0-d31b6712d700> a <http://xmlns.com/foaf/0.1/Group>;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsLabel> "UserGroup1"@en;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsComment> "Group description 1"@en;
<http://xmlns.com/foaf/0.1/member> <http://iam.3ds.com/member1>;
.

<uuid:e3083fb6-9553-482a-88e0-d31b6712d701> a <http://xmlns.com/foaf/0.1/Group>;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsLabel> "UserGroup2"@en;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsComment> "Group description 2"@en;
<http://www.3ds.com/RDF/Corpus/Kernel/owner> <http://iam.3ds.com/ase11>; 
<http://xmlns.com/foaf/0.1/member> <http://iam.3ds.com/member2>;
.
<uuid:e3083fb6-9553-482a-88e0-d31b6712d7012 a <http://xmlns.com/foaf/0.1/Group>;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsLabel> "UserGroup3"@en;
<http://www.3ds.com/RDF/Corpus/Kernel/nlsComment> "Group description 3"@en;
<http://www.3ds.com/RDF/Corpus/Kernel/owner> <http://iam.3ds.com/tgt>; 
<http://xmlns.com/foaf/0.1/member> <http://iam.3ds.com/member3>;
<http://www.3ds.com/RDF/Corpus/Access/Responsibility.Group.Owner> <http://iam.3ds.com/user2> ;
<http://www.3ds.com/RDF/Corpus/Access/Responsibility.Group.Author> <http://iam.3ds.com/user1> ;
<http://www.3ds.com/RDF/Corpus/Access/Responsibility.Group.Viewer> <http://iam.3ds.com/user3> ;
.
Notes:
  • The size of the name must range from 3 to 128 characters.
  • The size of the description must range from 0 to 512 characters.
  • The number of members is limited to 1000 for each group.

Important: Whichever the option you select when importing groups, Add as new properties and members or Replace existing properties and members, the UUID is always mandatory.

Important: Emails are not supported. Owners and members must be specified as <http://iam.3ds.com/[USER_ID]> where [USER_ID] is the user's username in lower case.