Hitachi

JP1 Version 12 JP1/Service Support Configuration and Administration Guide


jssuserlist (outputs a list of users)

Organization of this page

Description

This command outputs a list of users that are registered in the JP1/Service Support database to a CSV file. If you cancel the command while it is being executed, the command outputs a list of users up to that point.

Format

jssuserlist -o user-list-file-name
           [-format {import | edit}]
           [-f]

Required execution permission

Administrator permissions

Storage folder

JP1/SS-path\bin\

Arguments

-o user-list-file-name

Use 255 bytes or less to specify the name of a user list file in CSV format to which you want to output a list of users. 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 an absolute path. For the file name, you cannot specify a character string beginning with a hyphen (-).

-format {import | edit}

Specifies the format of the user list file to which the command will output a list of users. User list files are CSV files.

When you specify import, the format of the user list file is the same as the File for user information entries that you use with the jssuserimport (imports user information) command. You can use the user list file as the base for a File for user information entries.

When you specify edit, the format of the user list file is the same as the User information editing file that you use with the jssuseredit (edits user information) command. You can use the user list file as the base for a User information editing file.

If you do not specify this option, the system assumes import is specified.

-f

Overwrites the user list file.

Return values

Return value

Meaning

0

Normal end

1

Abnormal end

Contents of a user list file

Format of the user list file when you do not specify the -format option or specify import for the -format option

If you do not specify the -format option or specify import for the -format option, the format of the user list file is the same as the File for user information entries that you use with the jssuserimport (imports user information) command. You can modify the contents of the user list file to create a File for user information entries for the jssuserimport command.

A user list file contains data in the following format.

[Figure]

The first line in the body section in a user list file lists the names of the users' attributes.

The details about the contents of a user list file are as follows.

Header section

Output sequence

Header item

Value

1

Product name

JP1/Service Support

2

Version number of the user list file

The version number of the file is indicated by 6 digits.

3

Character encoding used in the user list file

Character encoding of output files.

4

Type of data that is output to the user list file

USERLIST

5

Number of users that are output to the user list file

Total Count of Users : number-of-users

Output example: Total Count of Users : 2

Body section

Output sequence

Body item

1

User ID

2

User name

3

English name

4

Organization

5

Title

6

Title level

7

Email address

8

Phone number

9

Phone number 2

10

Comment

Format of the user list file when you specify edit for the -format option

If you specify edit for the -format option, the format of the user list file is the same as the User information editing file that you use with the jssuseredit (edits user information) command. You can modify the contents of the user list file to create a User information editing file for the jssuseredit command.

A user list file contains data in the following format.

[Figure]

The first line in the body section in a user list file lists the names of the users' attributes.

The details about the contents of a user list file are as follows.

Header section

The header section is the same as the case when you do not specify the -format option or specify import for the -format option.

Body section

Output sequence

Body item

1

Editing target user ID

2

User ID

3

User name

4

English name

5

Organization

6

Title

7

Title level

8

Email address

9

Phone number

10

Phone number 2

11

Comment

Prerequisites for executing the command

Remarks

Example

The following example shows how to output a list of users to a CSV file (c:\user\user01.csv). This type of file has the same format as File for user information entriess used by the command that imports user information into the Item management database.

jssuserlist -o c:\user\user01.csv