Hitachi

JP1 Version 12 JP1/Data Highway - Server Administrator Guide


3.5.3 Users & Groups (batch management)

Organization of this subsection

(1) Notes on creating the CSV file used for batch management

In Users & Groups (batch management), you create a CSV file and use it to create, view, or delete multiple users at a time. When you create a CSV file, be careful regarding the following:

(2) Creating multiple users and groups at a time

To create multiples users and groups at a time:

  1. In the sidebar area, click Users & Groups.

    The Users & Groups window appears in the content area.

  2. In the upper right corner of the content area, click To CSV User Import & Export.

    The User Import & Export window appears in the content area.

    [Figure]

  3. Specify the CSV file for import. You can directly enter the full path to the CSV file for import in the Import field, or click the Browse... button to select the file.

    See 3.5.3(2)(a) Format of a CSV file for import and create the CSV file for import beforehand.

    [Figure]

  4. Click the Verify button to check whether your CSV file for import is in the valid format.

    For details about what is checked by clicking the Verify button, see 3.5.3(2)(b) What is verified when the Verify button is clicked.

    [Figure]

  5. After the File Download dialog box opens for downloading the file verify_import.log, click the Save button.

    Important

    If nothing happens except for the window being refreshed, the file might not exist in the specified file path. In this case, specify the correct file path and click the Verify button again.

    [Figure]

  6. Open the saved file verify_import.log in UTF-8 encoding, and check the last line of the file.

    If you see the word OK in the last line, your CSV file for import is in the valid format. Make sure that the characters in each record (discussed later) are not corrupted.

    Important

    If they are corrupted, the CSV file for import might not be encoded in UTF-8.

    If you allow the import processing to proceed, users and groups might be stored in the system, with corrupted characters.

    [Figure]

    If you see the word NG in the last line, your CSV file for import is not in the valid format. A verification result and an error description (for an error) are appended to each record (discussed later).

    In this case, fix the cause of the error and then click the Verify button again.

    [Figure]

  7. After you verify that your CSV file for import is correctly formatted, click the Import button to import it.

    If a great number of users and groups are imported, it can take about five minutes for the import.

    Important

    After clicking the Import button, do not do anything on the window until downloading verify_import.log starts. If you work with the window, the server keeps processing the import of the file, but you might not be able to obtain the file verify_import.log and might receive an unknown result.

    [Figure]

  8. After a dialog box opens for downloading the file verify_import.log in the same way as when you click the Verify button, click the Save button.

    Important

    If nothing happens except for the window being refreshed, the file might not exist in the file path specified in the Import field. In this case, specify the correct file path and click the Import button again.

  9. Open the saved file verify_import.log and check the last line of the file. If you see the word OK there, your batch creation of users and groups was successful.

    If you see the word NG, a verification result and an error description (for an error) are appended to each record (discussed later). In this case, fix the cause of the error and then click the Import button again.

    Important

    In batch creation of users and groups, either all or none of the records are stored. The entire processing is successful only if all the records are successfully processed. If one of the records fails to be processed, the entire processing is unsuccessful.

(a) Format of a CSV file for import

You can download and save the file sample CSV file for import by clicking the CSV Sample File link in the User Import & Export window.

You can easily create users and groups in batches by editing and modifying the record part in the saved file to users and groups you want to create.

[Figure]

The following figure illustrates the file sample CSV file for import.

Figure 3‒2: Sample CSV file for import (four sections)

[Figure]

The CSV file for import consists of four major sections: [users], [groups], [binders], and [managers] definition sections.

The table below describes each major section. One or more empty lines are required between each major section.

Table 3‒19: Major sections in the CSV file for import

Major section

Description

[users] definition section

Defines user information to be created.

Those users must be associated with any group in the [binders] definition section.

[groups] definition section

Defines group information to be created.

[binders] definition section

Associates users with groups.

Users who have already been created or who are defined in the [users] definition section can be associated with or disassociated from groups.

[managers] definition section

Defines group-manager users.

[users] definition section

This definition section specifies user information for creating a user or users. The [users] definition section consists of three elements, as shown in the following sample [users] definition section.

Figure 3‒3: Sample CSV file for import ([users] definition section)

[Figure]

Identifier

This string is fixed, and specifies that the [users] definition section starts from the next line. Even if no user is created (there is no record), it is mandatory.

Header

This string is fixed, and indicates entry names of records. Even if no user is created (there is no record), it is mandatory.

Records

A record defines entries for one user to be created in a single row, separated by commas (,). The maximum number of records is 300. If optional entries are omitted, commas cannot be omitted.

The users defined in this section must be associated with any group in the [binders] definition section. The users associated with user groups in the [binders] definition section can be created as general users.

If the users are associated with guest groups, they can be created as guest users. The number of times a created guest user can send a file is set to zero. If you want to change this number of times, change it separately.

The following table describes and lists each entry in this definition section.

Table 3‒20: CSV entries in the [users] definition section

No.

Entry

Meaning

Description

Omit

1

USER_ID

User ID

Specify the user ID.

  • Format: any-string + @ + domain-name

    If a directory server is used to authenticate users who attempt to log in to JP1/DH - Server, the user ID must be specified in the following format: user-ID-defined-in-the-directory-server + @ + domain-name.

  • The domain name is the same as that of the representative user.

  • The user ID must be unique within a domain.

  • You can enter no more than 100 (for Windows) or 256 (for Linux) alphanumeric characters and symbols, including the ID assigned to the domain.

  • You cannot specify the same user ID as that for an existing user.

  • If the domain (the string after the at mark (@)) does not exist or is different from the domain of the representative user, an error occurs.

  • Some symbols (/\?*:|"<>#@^[]$) and space characters are not available.

  • A user ID consisting of only a period or periods (.) is not available.

  • Reserved words in Windows are not available. For details about reserved words in Windows, see 3.4.2(2) Creating a user.

Example: user1@company

Not allowed

2

EMAIL

Email address

Specify the email address.

You cannot specify the same email address as that for an existing user.

  • You can enter no more than 256 alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>^) and space characters are not available.

Example: user1@mailaddress.com

Not allowed

3

PASSWORD

Password

Specify the password.

JP1/DH - Server manages the password specified here. If a directory server is used to authenticate users, specify the JP1/DH - Server password, instead of using the password managed by the directory server. You cannot change the password managed by the directory server here.

You need to define the password string#1 in clear text or in the digest of the password string#2 in hexadecimal format.

Example in clear text: password

In digest format, a digest string of 40 characters must be followed by the prefix text:HEX:. The digest string is case-insensitive.

You can use the digest found in the password field when user data is exported.

Example in digest format

text:HEX:5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8

A string that starts with the string text:HEX: cannot be used as a clear text password.

Not allowed

4

NAME

Name (Japanese/Chinese)

Specify the name in Japanese or Chinese.

If this entry is specified, the NAME_EN entry is mandatory.

If omitted, an empty value is stored.

  • You can enter no more than 256 characters.

  • Some symbols (/\?*:|"<>#@^[]$) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: ユーザ1

Allowed

5

NAME_EN

Name (English)

Specify the name in English.

If omitted, an empty value is stored.

  • You can enter no more than 100 (for Windows) or 256 (for Linux) alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>#@^[]$) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: User 1

Allowed

6

NAME_KANA

Name (Japanese kana)

Specify the name in Japanese kana characters.

If omitted, an empty value is stored.

  • You can enter no more than 256 characters.

  • Some symbols (/\?*:|"<>#@^[]$) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: ゆーざいち

Allowed

7

LANG

User language

Specify one of the user languages below. This is case-insensitive.

  • ja: Japanese

  • en: English

  • zh: Chinese

If omitted, it is set to Japanese.

Example: ja

Allowed

8

MEMO

Note

Specify a note.

You can enter no more than 4,096 characters.

If omitted, an empty value is stored.

Example: User 1 note

Allowed

9

EXPIRE_DATE

Expire date

Specify the expiration date in YYYY/MM/DD or YYYY-MM-DD format. The possible date ranges from the current date to 2031/12/31 (Dec. 31, 2031).

If omitted, the entry is either of the following case, depending on the type of the first group in the [binders] definition section:

  • For a member of the user group:

    The entry inherits the property value from the group.

  • For a member of the guest group:

    The entry is the date when this user is imported.

If the string UNLIMITED is specified, the account never expires. However, if the account is associated with the guest group in the [binders] definition section, the entry is the date when this user is imported.

The system ignores any space, line feed, and tab characters in the entry string. These characters cannot be between YYYY, MM, and DD arguments.

Example: 2020/12/31

Allowed

10

QUOTA#3

Amount of storage space

Specify the amount of storage space in MB.

The possible value ranges from 0 to 8,796,093,022,207.

Example: 1024

Allowed

11

USE_USER_OPTION#3

Is Options allowed

Specify whether the user is allowed to use the Options function in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

Example: TRUE

Allowed

12

USE_GUEST_USERS#3

Is Guest Users allowed

Specify whether the user is allowed to use the Guest Users function in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

Example: TRUE

Allowed

13

INPUT_ANY_ADDRESS#3

Is any recipient address allowed

Specify whether the user is allowed to enter any recipient address in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

Example: TRUE

Allowed

#1

You can use alphanumeric characters and symbols in a given length and type as defined by authentication rules.

The symbols of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ are available.

#2

A digest is a form of the password in which JP1/DH - Server stores passwords in its database, and from which the actual password string cannot be guessed. The export function outputs the password information in the form of digest into the password entry in the CSV file for export.

#3

If omitted, the entry inherits the property value from the first group associated in the [binders] definition section. For the INPUT_ANY_ADDRESS entry, the entry itself can be omitted.

[groups] definition section

This definition section specifies group information for creating a group or groups. The [groups] definition section consists of three elements, as shown in the following sample [groups] definition section.

Figure 3‒4: Sample CSV file for import ([groups] definition section)

[Figure]

Identifier

This string is fixed, and specifies that the [groups] definition section starts from the next line. Even if no group is created (there is no record), it is mandatory.

Header

This string is fixed, and indicates entry names of records. Even if no group is created (there is no record), it is mandatory.

Records

A record defines entries for one group to be created in a single row, separated by commas (,). If optional entries are omitted, commas cannot be omitted.

The following table describes and lists each entry in this definition section.

Table 3‒21: CSV entries in the [groups] definition section

No.

Entry

Meaning

Description

Omit

1

NAME_EN

Group name (English)

Specify the name of the group in English.

You cannot specify the same English group name as that for an existing group.

  • You can enter no more than 200 alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>@^) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: Group 1

Not allowed

2

NAME_JA

Group name (Japanese/Chinese)

Specify the name of the group in Japanese or Chinese. You cannot specify the same Japanese or Chinese group name as that for an existing group.

  • You can enter no more than 200 characters.

  • Some symbols (/\?*:|"<>@^) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: グループ1

Not allowed

3

PARENT_NAME_EN

Parent group name (English)

Specify the name of the parent group in English. You cannot specify the name of a parent group that does not exist.

The possible characters are the same as those for the NAME_EN entry.

Example: Company

Not allowed

4

FOR_GUEST

Group type

Specify whether the group is for guest users in either of the values below. This is case-insensitive.

  • TRUE: For the guest group

  • FALSE: For the user group

If omitted, it is set to FALSE (which is for the user group).

Example: TRUE

Allowed

5

EXPIRE_DATE

Expire date

Specify the expiration date in YYYY/MM/DD or YYYY-MM-DD format. The possible date ranges from the current date to 2031/12/31 (Dec. 31, 2031).

If the string UNLIMITED is specified, the account never expires.

If omitted, the account also never expires.

The system ignores any space, line feed, and tab characters in the entry string. These characters cannot be between YYYY, MM, and DD arguments.

Example: 2015/12/31

Allowed

6

QUOTA

Amount of storage space

Specify the amount of storage space in MB.

If omitted, it is set to 1 GB.

The possible value ranges from 0 to 8,796,093,022,207.

Example: 1024

Allowed

7

USE_USER_OPTION

Is Options allowed

Specify whether the group is allowed to use the Options function in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

If omitted, it is set to TRUE (which means allowed).

Example: TRUE

Allowed

8

USER_REGISTERABLE

Is Guest Users allowed

Specify whether the group is allowed to use the Guest Users function in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

If omitted, it is set to FALSE (which means not allowed).

If the FOR_GUEST entry is set to TRUE, specify this entry as FALSE.

Example: TRUE

Allowed

9

INPUT_ANY_ADDRESS

Is any recipient address allowed

Specify whether the group is allowed to enter any recipient address in either of the values below. This is case-insensitive.

  • TRUE: Allowed

  • FALSE: Not allowed

This entry itself can be omitted.

If omitted, it is set to FALSE (which means not allowed).

Example: TRUE

Allowed

[binders] definition section

This definition section associates users with groups. A user can be associated with or disassociated from a group. The [binders] definition section consists of three elements, as shown in the following sample [binders] definition section.

Figure 3‒5: Sample CSV file for import ([binders] definition section)

[Figure]

Identifier

This string is fixed, and specifies that the [binders] definition section starts from the next line. Even if no user is associated with a group (there is no record), it is mandatory.

Header

This string is fixed, and indicates entry names of records. Even if no user is associated with a group (there is no record), it is mandatory.

Records

A record defines entries for one user-group association in a single row, separated by commas (,).

Records are processed from top to bottom. Then, if a user is not a member of any group, even temporarily, an error occurs.

If you want to move User A from Group A to Group B, define the record to associate User A with Group B first, and then define the record to disassociate User A from Group A. If optional entries are omitted, commas cannot be omitted.

The following table describes and lists each entry in this definition section.

Table 3‒22: CSV entries in the [binders] definition section

No.

Entry

Meaning

Description

Omit

1

USER_ID

User ID

Specify the user ID of the user whose group is changed.

  • You can enter no more than 100 (for Windows) or 256 (for Linux) alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>#@^[]$) and space characters are not available.

  • A user ID consisting of only a period or periods (.) is not available.

  • Reserved words in Windows are not available. For details about reserved words in Windows, see 3.4.2(2) Creating a user.

Example: user1@company

Not allowed

2

GROUP_NAME_EN

Group name (English)

Specify the English name of the group that the user is associated with or disassociated from.

A user who belongs to the guest group cannot be a member of the user group. A user who belongs to the user group cannot also be a member of the guest group.

  • You can enter no more than 200 alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>@^) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: Group 1

Not allowed

3

FLAG_DELETE

Deletion flag

Specify whether the user is associated with or disassociated from the group.

  • TRUE: The user is disassociated from the group.

  • FALSE: The user is associated with the group.

If omitted, it is set to FALSE.

Allowed

[managers] definition section

This definition section defines group managers. The [managers] definition section consists of three elements, as shown in the following sample [managers] definition section.

Figure 3‒6: Sample CSV file for import ([managers] definition section)

[Figure]

Identifier

This string is fixed, and specifies that the [managers] definition section starts from the next line. Even if no group manager is defined (there is no record), it is mandatory.

Header

This string is fixed, and indicates entry names of records. Even if no group manager is defined (there is no record), it is mandatory.

Records

A record defines entries for one group manager to be defined in a single row, separated by commas (,).

The following table describes and lists each entry in this definition section.

Table 3‒23: CSV entries in the [managers] definition section

No.

Entry

Meaning

Description

Omit

1

USER_ID

User ID

Specify the user ID of the user to be defined as a group manager. One user cannot be the group manager of two or more groups.

  • You can enter no more than 100 (for Windows) or 256 (for Linux) alphanumeric characters and symbols, including the ID assigned to the domain.

  • Some symbols (/\?*:|"<>#@^[]$) and space characters are not available.

  • A user ID consisting of only a period or periods (.) is not available.

  • Reserved words in Windows are not available. For details about reserved words in Windows, see 3.4.2(2) Creating a user.

Example: user1@company

Not allowed

2

GROUP_NAME_EN

Group name (English)

Specify the English name of the managed group.

One user cannot be the group manager of two or more groups.

  • You can enter no more than 200 alphanumeric characters and symbols.

  • Some symbols (/\?*:|"<>@^) are not available.

  • A name consisting of only spaces or periods (.) is not available.

Example: Group 1

Not allowed

(b) What is verified when the Verify button is clicked

The table below describes and lists what the system verifies when the Verify button is clicked. During import, an error might occur because of what is not verified by the system. For details about the list of error messages, see C. List of CSV Error Messages.

Table 3‒24: Items to be verified

No.

Definition section

Item

Description

1

General

Count

The system verifies that the number of records is 300 or less.

2

Entry count

The system verifies that the number of entries for each record is the valid value.

3

Mandatory

The system verifies that the mandatory entries are not omitted.

4

Length of characters

The system verifies that the length of the string entered for each entry is within the valid value.

5

Type of characters

The system verifies that the string for each entry does not contain disallowed characters.

6

Format

The system verifies that each entry matches the format described in 3.5.3(2)(a) Format of a CSV file for import.

Example: For the Expire Date entry, the system verifies that it is in the range from the current date to December 31, 2031.

7

Duplication

The system verifies that any existing user does not have the same user ID or email address as those of the entered user.

8

[users] definition section

Binders

The system verifies that the specified user is also defined in the [binders] definition section.

9

[groups] definition section

Guest group

If a guest group is to be created, the system verifies that the Guest Users function is not allowed for use.

10

[binders] definition section

Existence

The system verifies that the specified user or group exists.

11

[managers] definition section

Existence

The system verifies that the specified user or group exists.

(3) Viewing multiple users and groups at a time

To view multiples users and groups at a time:

  1. In the sidebar area, click Users & Groups.

    The Users & Groups window appears in the content area.

  2. In the upper right corner of the content area, click To CSV User Import & Export.

    The User Import & Export window appears in the content area.

  3. In the Export drop-down list box, select the group you want to view, and then click the Export button.

    [Figure]

  4. After downloading the CSV file for export export_users.csv starts, click the Save button to save the file.

    The CSV file for export contains user and group information.

    [Figure]

(a) Format of a CSV file for export

The CSV file for export has the same format as the CSV file for import, as discussed in 3.5.3(2) Creating multiple users and groups at a time.

The following table describes record rules and record output orders for each major section.

Table 3‒25: Major sections and record rules

Major section

Record rule

[users] definition section

Users in the specified group and its child groups are sorted and output to the file in dictionary order by user ID.

[groups] definition section

The specified group and its child groups are sorted and output to the file from top to bottom in the hierarchy.

Multiple groups in the same level are sorted and output in dictionary order by group name (English).

[binders] definition section

Binder definition records for users in the specified group and its child groups are sorted and output to the file in dictionary order by user ID.

A user in two or more groups is output several times in Groups belongs to order. In this case, any group that is not a child group of the specified group is also output.

[managers] definition section

Group managers are sorted and output to the file in dictionary order by user ID.

(4) Deleting multiple users at a time

To delete multiples users at a time:

  1. In the sidebar area, click Users & Groups.

    The Users & Groups window appears in the content area.

  2. In the upper right corner of the content area, click To CSV User Import & Export.

    For details about the Users & Groups window, see 3.5.3(2) Creating multiple users and groups at a time.

    The User Import & Export window appears in the content area.

  3. Specify the CSV file for deleting users. You can directly enter the full path to the CSV file for deleting users in the Delete Users field, or click the Browse... button to select the file.

    See 3.5.3(4)(a) Format of a CSV file for deleting users and create the CSV file for deleting users beforehand.

    [Figure]

  4. Click the Verify button to check whether your CSV file for deleting users is in the valid format.

    For details about what is checked by clicking the Verify button, see 3.5.3(4)(b) What is verified when the Verify button is clicked.

  5. After downloading the file verify_delete_users.log starts, click the Save button to save the file.

    [Figure]

    Important

    If nothing happens except for the window being refreshed, the file might not exist in the specified file path. In this case, specify the correct file path and click the Verify button again.

  6. Open the saved file verify_delete_users.log and check the last line of the file.

    If you see the word OK in the last line, your CSV file for deleting users is in the valid format.

    [Figure]

    If you see the word NG in the last line, your CSV file for deleting users is not in the valid format.

    A verification result and an error description (for an error) are appended to each record (discussed later). In this case, fix the cause of the error and then click the Verify button again.

    [Figure]

  7. Click the Delete button.

    After clicking the Delete button, do not do anything on the window until the verify_delete_users.log download starts. If you work with the window, the server keeps processing the deletion, but you might not be able to obtain the file verify_delete_users.log and might receive an unknown result.

    [Figure]

  8. Just like verifying the file, after a dialog box opens for downloading the file verify_delete_users.log, click the Save button.

    Important

    If nothing happens except for the window being refreshed, the file might not exist in the file path specified in the Delete Users field. In this case, specify the correct file path and click the Delete button again.

  9. Open the saved file verify_delete_users.log and check the last line of the file. If you see the word OK there, your batch deletion of users is successful.

    If you see the word NG in the last line, your CSV file for deleting users is not in the valid format. A verification result and an error description (for an error) are appended to each record (discussed later). In this case, fix the cause of the error and then click the Delete button again.

    Important

    In batch deletion of users, either all or none of the records are processed. The entire processing is successful only if all the records are successfully processed. If one of the records fails to be processed, the entire processing is unsuccessful.

(a) Format of a CSV file for deleting users

You can download and save the file sample CSV file for deleting users by clicking the CSV Sample File link in the User Import & Export window.

You can easily delete users in batches by editing and modifying the record part in the saved file to users you want to delete.

[Figure]

The following figure illustrates the file sample CSV file for deleting users. The CSV file for deleting users only consists of the major section [users] definition section.

Figure 3‒7: Sample CSV file for deleting users

[Figure]

[users] definition section

This definition section specifies user information for deleting a user or users. The [users] definition section consists of three elements, as shown in the following sample [users] definition section.

Figure 3‒8: Sample CSV file for deleting users ([users] definition section)

[Figure]

Identifier

This string is fixed, and specifies that the [users] definition section starts from the next line. Even if no user is deleted (there is no record), it is mandatory.

Header

This string is fixed, and indicates entry names of records. Even if no user is deleted (there is no record), it is mandatory.

Records

A record defines an entry for one user to be deleted in a single row. The maximum number of records are 300.

The following table describes and lists each entry in this definition section.

Table 3‒26: Record entry (sample [users] definition section)

No.

Entry

Meaning

Description

Omit

1

USER_ID#

User ID

Specify the user ID of the user to be deleted.

Format: any-string + @ + domain-name

The domain name is the same as that of the representative user.

  • You cannot specify the user ID of a user if the user does not exist.

  • You cannot delete an approver user if deleting the user causes an approval route to have no approver.

  • You cannot delete the user representing yourself.

Example: user1@company

Not allowed

#

The possible characters are the same as those when creating a user. For details, see 3.4.2(2) Creating a user.

(b) What is verified when the Verify button is clicked

The table below describes and lists what the system verifies when the Verify button is clicked. During import, an error might occur because of what is not verified by the system. For details about the list of error messages, see C. List of CSV Error Messages.

Table 3‒27: Items to be verified (sample [users] definition section)

No.

Definition section

Item

Description

1

[users] definition section

Count

The system verifies that the number of records are 300 or less.

2

Entry count

The system verifies that the number of entries for each record is the valid value.

3

Mandatory

The system verifies that the mandatory entries are not omitted.

4

Length of characters

The system verifies that the length of the string entered for each entry is within the valid value.

5

Type of characters

The system verifies that the string for each entry does not contain disallowed characters.

6

Existence

The system verifies that the specified user exists.

7

Approval route

The system verifies that the user in an approval route is not only the user specified in that approval route.

8

Operating user

The system verifies that you are not trying to delete the user representing yourself.