jssaclexport (exports access-permission information)
- Organization of this page
Description
This command outputs the access-permission information set for each process work board to a CSV file.
Format
jssaclexport -o access-permission-information-file-name
{-ALL | -s -id system-ID | -p -id process-work-board-ID}
[-f]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\bin\
Arguments
-o access-permission-information-file-name
For access-permission-information-file-name, use 255 bytes or less to specify the name of the file to which access permission information is to be output. Count half-width characters as 1-byte each and full-width characters as 2-bytes each. 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 is 255 bytes or less after it is converted to an absolute path. Note that you cannot specify a character string that begins with a hyphen (-) for the file name.
-ALL
Outputs the access-permission information in all systems including the master system.
-s -id system-ID
Outputs the access-permission information in a selected system. For system-ID, use 1 to 64 half-width alphanumeric characters.
-p -id process-work-board-ID
Outputs the access-permission information in a selected process work board. For process-work-board-ID, use 1 to 64 half-width alphanumeric characters.
-f
Overwrites the files in the output destination folder.
If the access-permission information file specified with the -o option does not exist, a file with the specified name is created. If the -f option is omitted when the access-permission information file specified with the -o option exists, the processing finishes without outputting the access-permission information file.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
Abnormal end |
Contents of an access-permission information file
An access-permission information file contains data in the following format.
![[Figure]](GRAPHICS/ZU110550.GIF)
The first line in the body section in an access-permission information file lists the attribute names.
The following details the contents of an access-permission information file.
- Header section
-
Output sequence
Header item
Value
1
Product name
JP1/IM-Service Support
2
Version number of the access-permission information file
The version number of the file is indicated by 6 digits.
3
Character encoding used in the access-permission information file
Character encoding of output files
4
Type of data that is output to the access-permission information
ACLEXPORT
- Body section
-
Output sequence
Body item
Description
1
System ID of target system
ID of the system for which access permissions are set
2
Process work board ID
ID of the process work board that has the process for which access permissions are set
3
User/Role ID type
Type that indicates either the user ID or role ID
-
For user ID: USER
-
For role ID: ROLE
4
User/Role ID
User ID or role ID
5
Access permissions
All access permissions the user or role has#
- #
-
The following table lists and describes access permissions that can be output.
Table 11‒7: Access permissions that can be output Output sequence
Output value
Description
1
CREATE
New item permission for the Item
2
EDIT
Edit item permission for the Item
3
REFER
View item permission for the Item
4
DELETE
Delete item permission for the Item
5
ESCALATE
Escalation permission for the Item
6
APPROVE
Acknowledge item permission for the Item
7
CLOSE
Close item permission for the Item
8
ST_INQUIRY
Edit item permission for the Item that is in Received status
9
ST_RESEARCH
Edit item permission for the Item that is in Investigating status
10
ST_PLANNING
Edit item permission for the Item that is in Planning status
11
ST_DISCUSSING
Edit item permission for the Item that is in Discussing status
12
ST_APPROVED
Edit item permission for the Item that is in Acknowledged status
13
ST_WAITING
Edit item permission for the Item that is in Support Requested status
14
ST_REVIEW
Edit item permission for the Item that is in Reviewing status
15
ST_CLOSE
Edit item permission for the Item that is in Close status
16
ST_USER01 to ST_USER40
Edit item permission for the Item for which the status of Extended status 01 to Extended status 40 is set
-
Sort order of access-permission information (body section)
Access-permission information is output in the following sort order:
-
System ID: Ascending order
-
Process work board ID#1: Ascending order
-
User/Role ID type#2: Descending order
-
User/Role ID: Ascending order
- #1
-
If there are multiple process work boards in a system, they are sorted and output in the following order:
-
Incident management
-
Problem management
-
Change management
-
Release management
-
- #2
-
The access-permission information for roles is output, and then the access-permission information for users is output. However, information about the master system (temporary receipt process work board) is output at the end.
If access permissions are set for the jp1admin user and system roles, the access-permission information is output. However, information about the access permissions for which system roles are set by default is not output. For details about the system roles, see the description about the system roles in 3.17.2 Role management.
Differences in the result of the command depending on the statuses of the system and process work board
The jssaclexport command acts differently depending on the statuses of the system and process work board. The following table describes the differences in the result of the jssaclexport command depending on the statuses of the system and process work board.
|
No. |
Status of the system |
Status of the process work board |
Result |
|---|---|---|---|
|
1 |
Waiting to be deleted |
-- |
The command does not output the access-permission information in the system. |
|
2 |
Operating |
In process |
The command outputs the access-permission information in the process work board. |
|
3 |
Operating |
||
|
4 |
Under suspension |
||
|
5 |
Waiting to be deleted |
The command does not output the access-permission information in the process work board. |
- Legend:
-
--: Not applicable.
Prerequisites for executing the command
-
For details about the status of services when commands are executed, see Status of services when commands are executed in Chapter 11. Commands.
Remarks
-
If you cancel the jssaclexport command by using Ctrl+C while the command is being executed, access permission information might not be output. For this reason, do not use Ctrl+C to cancel the command during execution. If you happen to do so, wait for a while, and then re-execute the command.
-
If the jssaclexport command stops due to an error while it is being executed, the contents of the output file might be incomplete.
-
If you change access permissions set for a process work board while the jssaclexport command is being executed for that process work board, the access-permission information might not be output. For this reason, we recommend that you execute the command after you place the target process work board in Under suspension status.
-
The jssaclexport command can output a maximum of 1,000,000 lines (number of lines in the body section, excluding the first line for attribute names) of access-permission information at one time. If the maximum number of lines is exceeded, review and modify the conditions for outputting access-permission information, and then re-execute the command.
Example
The following example shows how to output the access-permission information for all systems to the access-permission information file (c:\accesspermission\accesspermissioninfo.csv):
jssaclexport -o c:\accesspermission\accesspermissioninfo.csv -ALL