7.4.9 Importing user information
You can import user information by using a CSV file.
- Organization of this subsection
(1) Format
DWAdminClient.bat IMPORTUSERINFO -property property-file -file import-file -result execution-result-storage-destination
(2) Arguments
No. |
Option |
Description |
---|---|---|
1 |
-file |
Specifies the path to the CSV file to be imported. When a space is contained in a file path, surround that file path with double quotation marks (""). |
2 |
-result |
Specifies the path to the storage destination of execution result file. If the file does not exist, a new file is created. If the file exists, the existing file is overwritten. |
3 |
-property |
For details, see 7.3.2 Common options. |
(3) Description
(a) Available user information for import
The following table describes available user information for import.
No. |
User information |
Create |
View |
Update |
Delete |
---|---|---|---|---|---|
1 |
User |
Y |
Y |
Y |
Y |
2 |
Domain |
Y |
Y |
N |
N |
3 |
Group |
Y |
Y |
Y |
Y# |
4 |
User's group |
Y |
Y |
N |
N |
5 |
Representative user authority |
Y |
Y |
N |
N |
- #
-
The specified group cannot be deleted if a user or group exists directly below it. However, it can be deleted if those users all belong to another group.
- Legend:
-
Y: Can be imported
N: Cannot be imported
(b) Example of creating an import CSV (import_users.csv) file
An example of creating an import CSV file is shown below. For details about notes on creating this file, see 3.5.2(1) Notes on creating the CSV file used for batch management in the Job Management Partner 1/Data Highway - Server Administrator Guide.
[domains] FUNCTION,NAME_EN,NAME_JA,PARENT_NAME_EN,FOR_GUEST,EXPIRE_DATE,QUOTA, USE_USER_OPTION,USER_REGISTERABLE,MAX_DISK_SPACE,TRAFFIC_LIMIT, LIMIT_USER_NUMBER,CUT_OFF_DAY,INPUT_ANY_ADDRESS,USE_UNREGISTERED_ADDRESS CREATE,Hitachi xxxxxx,All Users,FALSE,,,,,51200,51200,100,31,TRUE,TRUE [users] FUNCTION,USER_ID,EMAIL,PASSWORD,NAME,NAME_EN,NAME_KANA,LANG, MEMO,EXPIRE_DATE,QUOTA,USE_USER_OPTION,USE_GUEST_USERS,INPUT_ANY_ADDRESS READ,u1@user,u1@xxx.com,passowrd,,,User1,,,en,,,2012/01/01,1024,,, READ,u2@user,u2@xxx.com,passowrd,,,User2,,,en,,,2012/01/01,1024,,, [groups] FUNCTION,DOMAIN,NAME_EN,NAME_JA,PARENT_NAME_EN,FOR_GUEST,EXPIRE_DATE,QUOTA,USE_USER_OPTION,USER_REGISTERABLE,INPUT_ANY_ADDRESS READ,domain1,Group1,group-1,Hitachi xxxxx [binders] USER_ID,GROUP_NAME_EN,FLAG_DELETE u1@user,g1,FALSE u2@user,g1,FALSE [managers] FUNCTION,USER_ID,GROUP_NAME_EN
- Important note
-
If you want to specify only item names, and not the contents for the [groups] definition section, you can omit the item DOMAIN.
Description of each definition section is given in the following pages. The following table describes the items you can specify for the [domains] definition section.
No. |
Item |
Meaning |
Description |
Omit |
---|---|---|---|---|
1 |
FUNCTION |
Action type |
Specify the type of action to be performed for the [domains] definition contents that is specified.
If you specify READ, the relevant record (line) is ignored. If no type is specified for FUNCTION, CREATE is used. |
Allowed |
2 |
NAME_EN |
Group name (English) |
Specify the group name (English). Note that the value specified here is used as a domain name with the spaces between words taken away. It is the same as the value after @ of the user ID. |
Not allowed |
Rules for specifying a group name (English):
|
||||
3 |
NAME_JA |
Group name (Japanese/Chinese) |
Specify the group name (Japanese/Chinese). |
Not allowed |
Rules for specifying a group name (Japanese/Chinese):
|
||||
4 |
PARENT_NAME_EN |
Parent group name (English) |
Specify the group name of the parent group (English). Specify All Users for this item. |
Not allowed |
5 |
FOR_GUEST |
Group type |
Specify the group type. This item is not case-sensitive.
This item is not case-sensitive. You cannot specify a domain group as a guest group. |
Allowed |
6 |
EXPIRE_DATE |
Account expiration date |
Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date (JST) to 2031/12/31 (Dec. 31, 2031). If you specify the string UNLIMITED, no limit is set for time. If you omit specifying a value, no limit is set for time. A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items. |
Allowed |
7 |
QUOTA |
Storage capacity |
Specify the storage capacity in MB. If you omit specifying a value, the amount of 1 GB is applied. You can specify a value in the range from 0 to 8796093022207. |
Allowed |
8 |
USE_USER_OPTION |
Permission for the use of the Options function |
Specify whether to permit the use of the Options function. This item is not case-sensitive.
This item is not case-sensitive. |
Allowed |
9 |
USER_REGISTERABLE |
Permission for the use of the Guest Users function |
Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.
This item is not case-sensitive. If you specify TRUE for FOR_GUEST, specify FALSE for this item. If you specify TRUE, an error occurs. |
Allowed |
10 |
MAX_DISK_SPACE |
Disk capacity |
Specify the total disk capacity in MB. You can specify a value in the range from 0 to 8796093022207. |
Not allowed |
11 |
TRAFFIC_LIMIT |
Download limit |
Specify the download limit in MB per month. You can specify a value in the range from 0 to 8796093022207. |
Not allowed |
12 |
LIMIT_USER_NUMBER |
Maximum number of users |
Specify the maximum number of users. You can specify a value in the range from 1 to 1,000,000. |
Not allowed |
13 |
CUT_OFF_DAY |
Reset date for download limit measurement |
Specify the reset date for download limit measurement. You can specify a value in the range from 1 to 31. |
Not allowed |
14 |
INPUT_ANY_ADDRESS |
Address input permission |
Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.
|
Allowed |
15 |
USE_UNREGISTERED_ADDRESS |
Address input permission |
Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.
|
Allowed |
The following table describes the items you can specify for the [users] definition section.
No. |
Item |
Meaning |
Description |
Omit |
---|---|---|---|---|
1 |
FUNCTION |
Action type |
Specify the type of action to be performed for the [users] definition contents that is specified.
If you specify READ, the relevant record (line) is ignored. If you specify DELETE, the items after EMAIL are ignored. In addition, an error occurs if a non-existing value is specified for USER_ID, or for users specified for an approval route, if there is only one user specified for that approval route. |
Allowed |
2 |
USER_ID |
User ID |
Specify the user ID. |
Not allowed |
Rules for specifying a user ID:
|
||||
3 |
|
Email address |
Specify the email address. If you specify CREATE for FUNCTION, you cannot omit specifying this item. If you specify UPDATE for FUNCTION, and omit specifying this item, the email address is not changed. |
Not allowed at the time of creation |
Rules for specifying an email address:
|
||||
4 |
PASSWORD |
Password |
Specify the password with a string. If you specify CREATE for FUNCTION, you cannot omit specifying this item. If you specify UPDATE for FUNCTION, and omit specifying this item, the password is not changed. To specify a password by using digest authentication, enter a 40-character digest string after text:HEX. The digest string portion is not case-sensitive. For a digest string, you can use what is output in the password field of the exported file. Note that you cannot specify a string starting with text:HEX for an unencrypted password string. |
Not allowed at the time of creation |
Rules for specifying a password:
|
||||
5 |
NAME |
Name (Japanese/Chinese) |
Specify the name (Japanese/Chinese). If you specify UPDATE for FUNCTION, and omit specifying this item, the name is not changed. |
Allowed |
Rules for specifying a name (Japanese/Chinese):
|
||||
6 |
NAME_EN |
Name (English) |
Specify the name (English). If you specify UPDATE for FUNCTION, and omit specifying this item, the name (English) is not changed. |
Allowed |
Rules for specifying a name (English):
|
||||
7 |
NAME_KANA |
Name (kana) |
Specify the name (kana). If you specify UPDATE for FUNCTION, and omit specifying this item, the name (kana) is not changed. |
Allowed |
Rules for specifying a name (kana):
|
||||
8 |
LANG |
User language |
Specify the user language.
If you specify UPDATE for FUNCTION, and omit specifying this item, the user language is not changed. |
Allowed |
9 |
MEMO |
Memo |
Specify the memo. If you omit specifying a value, registration is made without any information for this item. You can enter maximum of 4,096 characters. If you specify UPDATE for FUNCTION, and omit specifying this item, the contents of the memo are not changed. |
Allowed |
10 |
EXPIRE_DATE |
Account expiration date |
Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date to 2031/12/31 (Dec. 31, 2031). If you omit specifying a value, depending on the type of the first group the user belongs to (specified in [binders] definition section), one of the following applies:
If you specify UPDATE for FUNCTION, and omit specifying this item, the account expiration date is not changed. If you specify the string UNLIMITED, no limit is set for time. However, if the user belongs to the guest group (specified in the [binders] definition section), the same rule applies as when the value is omitted. A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items. |
Allowed |
11 |
QUOTA |
Storage capacity |
Specify the storage capacity in MB. You can specify a value in the range from 0 to 8796093022207. If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed. If you omit specifying a value, the property of the first group the user belongs to (specified in [binders] definition section) is inherited. |
Allowed |
12 |
USE_USER_OPTION |
Permission for the use of the Options function |
Specify whether to permit the use of the Options function. This item is not case-sensitive.
If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed. If you omit specifying a value, the property of the first group the user belongs to (specified in [binders] definition section) is inherited. |
Allowed |
13 |
USE_GUEST_USERS |
Permission for the use of the Guest Users function |
Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.
If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed. If you omit specifying a value, the property of the first group the user belongs to (specified in [binders] definition section) is inherited. |
Allowed |
14 |
INPUT_ANY_ADDRESS |
Address input permission |
Specify whether to permit inputting address. This item is not case-sensitive.
If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed. If you omit specifying a value, the property of the first group the user belongs to (specified in [binders] definition section) is inherited. You can omit the item itself. |
Allowed |
The table below describes the items you can specify for the [groups] definition section. Note that to register a parent group and a child group together, you must register a parent group first.
No. |
Item |
Meaning |
Description |
Omit |
---|---|---|---|---|
1 |
FUNCTION |
Action type |
Specify the type of action to be performed for the [groups] definition contents that is specified.
If you specify READ, the relevant record (line) is ignored. If no type is specified for FUNCTION, CREATE is used. If you specify DELETE, the specified group cannot be deleted if a user or group exists directly below it. However, it can be deleted if those users all belong to another group. In case the group deleted in this section is specified in the [binders] section, an error occurs during the process for [binders] section. |
Allowed |
2 |
DOMAIN |
Domain name |
Specify the domain name. Specify the domain name (the value after @ of the user ID) or the group name of the domain (the value of NAME_EN for registration of the items in [domains] section). This item is not case-sensitive. |
Not allowed |
3 |
NAME_EN |
Group name (English) |
Specify the group name (English). |
Not allowed at the time of creation |
Rules for specifying a group name (English):
|
||||
4 |
NAME_JA |
Group name (Japanese/Chinese) |
Specify the group name (Japanese/Chinese). |
Not allowed at the time of creation |
Rules for specifying a group name (Japanese/Chinese):
|
||||
5 |
PARENT_NAME_EN |
Parent group name (English) |
Specify the group name of the parent group (English). You cannot specify All Users for the value. The rules for specifying this item are the same as the rules for specifying a value for NAME_EN. |
Not allowed at the time of creation |
6 |
FOR_GUEST |
Group type |
Specify the group type. This item is not case-sensitive.
This item is not case-sensitive. You cannot specify a domain group as a guest group. If you specify UPDATE for FUNCTION, and a value different from the registered group type, an error occurs. Also in the above case, if you omit specifying this item, the group type is not changed. |
Allowed |
7 |
EXPIRE_DATE |
Account expiration date |
Specify the account expiration date in YYYY/MM/DD or YYYY-MM-DD format. You can specify a date in the range from the current date (JST) to 2031/12/31 (Dec. 31, 2031). If you specify the string UNLIMITED, no limit is set for time. If you omit specifying a value, no limit is set for time. A single-byte space, line feed, and tab character in a string are ignored. Note that none of the above characters can be inserted between YYYY, MM, and DD items. If you specify UPDATE for FUNCTION, and omit specifying this item, the account expiration date is not changed. |
Allowed |
8 |
QUOTA |
Storage capacity |
Specify the storage capacity in MB. If you omit specifying a value, the amount of 1 GB is applied. You can specify a value in the range from 0 to 8796093022207. If you specify UPDATE for FUNCTION, and omit specifying this item, the storage capacity is not changed. |
Allowed |
9 |
USE_USER_OPTION |
Permission for the use of the Options function |
Specify whether to permit the use of the Options function. This item is not case-sensitive.
This item is not case-sensitive. If you specify UPDATE for FUNCTION, and omit specifying this item, the permission setting for the use of the Options function is not changed. |
Allowed |
10 |
USER_REGISTERABLE |
Permission for the use of the Guest Users function |
Specify whether to permit the use of the Guest Users function. This item is not case-sensitive.
This item is not case-sensitive. If you specify TRUE for FOR_GUEST, specify FALSE for this item. If you specify TRUE at the time of group creation, an error occurs. When the setting for guest group is updated, regardless of the entered value, FALSE is forcibly applied to this item. If you specify UPDATE for FUNCTION, and omit specifying this item, the permission setting for the use of the Guest Users function is not changed. |
Allowed |
11 |
INPUT_ANY_ADDRESS |
Address input permission |
Specify whether to permit inputting address by selecting either of the values below. This item is not case-sensitive.
If you specify UPDATE for FUNCTION, and omit specifying this item, the setting for the address input permission is not changed. |
Allowed |
The following table describes the items you can specify in the [binders] definition section.
No. |
Item |
Meaning |
Description |
Omit |
---|---|---|---|---|
1 |
USER_ID |
User ID |
Specify the user ID of the user whose group you want to change. Example: user1@company
|
Not allowed |
2 |
GROUP_NAME_EN |
Group name (English) |
Specify the name (English) of the group to include the user into or to exclude the user from. You cannot include a user belonging to the guest group to the user group. You cannot include a user belonging to the user group in the guest group.
|
Not allowed |
3 |
FLAG_DELETE |
Delete flag |
Specify whether to include the user in the group or exclude the user from the group.
If you omit specifying a value, the user is included. |
Allowed |
The following table describes the items you can specify in the [managers] definition section.
No. |
Item |
Meaning |
Description |
Omit |
---|---|---|---|---|
1 |
FUNCTION |
Action type |
Specify the type of operation to be performed for the [managers] definition section.
If the batch process is executed by the system administrator, a representative user is created by specifying CREATE. If you specify READ, the relevant record (line) is ignored. |
Allowed |
2 |
USER_ID |
User ID |
Specify the user ID of the user to be set as a representative user or group manager. The user to be specified as a group manager must belong to the affiliated group. Note that you cannot specify one user as group managers for multiple groups. |
Not allowed |
Rules for specifying a user ID:
|
||||
3 |
GROUP_NAME_EN |
Group name (English) |
Specify the name (English) of the target group for managing. |
Not allowed |
Rules for specifying a group name (English):
|
- Important note
-
-
If you specify a domain group for GROUP_NAME_EN, the user specified for USER_ID is created as a representative user.
-
If the batch process is executed by the system administrator, the target group is identified with the domain name (the part after @ in the specified user ID) and the group name looked up as keywords.
-
(c) Format of the execution result file
For details, see 3.5.2(2)(a) Format of a CSV file for import in the Job Management Partner 1/Data Highway - Server Administrator Guide.
(4) Execution example
DWAdminClient.bat GETSERVERSTATUS -property "C:\DWCLient\property.xml" -result C:\temp\result.xml