jssmemberimport (imports member information)
- Organization of this page
Description
This command adds members to the roles that are registered in the JP1/Service Support database.
Format
jssmemberimport -i role-member-entry-file-name [-f]
Required execution permission
Administrator permissions
Storage folder
JP1/SS-path\bin\
Arguments
-i role-member-entry-file-name
Use 255 bytes or less to specify the name of a role member entry file. Count two bytes for full-width characters in the file name. You can use an absolute path or a relative path to specify the file name. When you use a relative path, make sure that it will be 255 bytes or less after it is converted to a absolute path. For the file name, you cannot specify a character string beginning with a hyphen (-). For details about role member entry files, see File for member information entries (Optional) in Chapter 13. Definition Files.
-f
Continues processing even if some of the data in the role member entry file is incorrect. When you specify the -f option, the command skips a role member in the role member entry file if the information about the member is incorrect and proceeds to add the next member to a role.
If you do not specify the -f option and the command fails to add even a single role member in the role member entry file to a role, the command is canceled and the remaining members will not be added to roles.
Return values
Return value |
Meaning |
---|---|
0 |
Normal end |
1 |
Abnormal end |
Prerequisites for executing the command
-
For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 12. Commands.
-
Only one jssmemberimport command can be executed at a time. Also note that the jssmemberimport command cannot be executed together with the jssmemberdelete command.
Remarks
-
If you cancel the jssmemberimport command while it is being executed, the remaining role members will not be added to roles.
-
If you cancel the jssmemberimport command by using Ctrl+C while the command is being executed, role members might not be added to roles. For this reason, do not cancel the command during execution by using Ctrl+C. If you happen to do so, wait for a while and then re-execute the command.
-
If you specify an empty role member entry file, the command ends normally without adding any role members to roles.
-
A maximum of 2,000 lines can be entered in a role member entry file. Comment lines are not included in the number of lines. If you want to add more than 2,000 role members, create multiple role member entry files and execute the command for those files.
-
If you enter the ID of a user that is already a member of a role in the role member entry file and execute the command, the command continues processing without displaying an error message or a warning message. That user is not included in the number of added members.
-
Make sure that the input file you specify is created with a character encoding that is compatible with the system locale of the machine on which JP1/Service Support is installed. The character encodings that can be used are as follows:
-
In a Japanese environment: MS932
-
In an English environment: ISO-8859-1
-
In a Chinese environment: GB18030
-
Example
The following example shows how to use the role member entry file (c:\member\member01.csv) to add members to roles without stopping even if the file contains incorrect data.
jssmemberimport -i c:\member\member01.csv -f