File Format for Groups or Roles

Article Number:020147

This page describes the file format for adding or changing groups (or roles).

For details on how to import a file, refer to the following page:
Adding or Changing Users and Departments Using a File

File Format

Only groups entered in the file are changed.

Each row contains the information of one group (or role).
Each row requires the following items. These items are mandatory and cannot be omitted.

  • Group Code
  • Name
  • New Group Code
  • Membership Type
  • Description
  • Delete

For details on the items above, refer to the following page:
Group Information Fields

Items to be entered in a file

Fill in a field with an asterisk (*) when you do not want to update the value of the field.

Group Code

To add a new group

Enter a string that that does not duplicate existing group codes.

To change the information of existing groups

Specify the current group code.
Even if you want to change the current group code, specify the current group code in "Group Code". A new group code should be specified in "New Group Code".

Name

"Name" must be a string.
Enter a string that does not duplicate existing group names.

New Group Code

To change "Group Code"

Enter a new group code.

To add a new group, or to change information other than "Group Code"

Enter a string that is identical to "Group Code", or enter "*".

Membership Type

To add a new group

Specify one of the following types.

  • Static group: "static"
  • Dynamic group: "dynamic"

As for the difference in membership types, refer to the following page:
Membership Type

To change the information of existing groups

Enter either a membership type of an existing group or "*".
You cannot change the existing membership type, for example from static to dynamic.

To Be Deleted

Specify one of the following options.

  • To delete a group
    Specify '1'.
  • To add a group, or to change group information
    Specify "*" or leave the item blank.

Example File

Example of actions to perform

  • Add a static group "grp001"
  • Add a dynamic group "grp002"
  • Change the group name of "grp003"
  • Change the group code of "grp004" to "old-grp004"
  • Delete "grp005"

Example of CSV file description

The content has been copied.
Group Code, Name, New Group Code, Membership Type, Description, To Be Deleted
grp001, Managers, *, static, , 
grp002, Part-timers, *, dynamic, , 
grp003, new-grp003, *, *, , 
grp004, *, old-grp004, *, , 
grp005, *, *, *, , 1

The first row contains "Field Name". Omit the first row containing the field names, or select "Skip header row" when importing a file.