2.5.23 Get list of JP1 users
Function
This service template acquires a list of JP1 users registered in JP1/Base's authentication server.
(1) The JP1 user list is output in text format to the specified file from the JP1/Base authentication server that was set. The output format of the file is the same as the output result of JP1/Base's jbslistuser command.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1) JP1/Base is running.
Job Management Partner 1/Base 09-00 or later, or
JP1/Base 11-00 or later
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) AIX V6
(9) AIX V7
[Usage conditions of prerequisite products in the system executing the service template]
(1) The authentication server has been configured.
(2) The usage conditions for JP1/Base's jbslistuser command have been set.
Cautions
(1)If you are executing this service in a UNIX environment, do not use multibyte characters in properties.
(2)When the files names specified for remote and local already exist, the existing files are overwritten. The file on the remote side is also deleted. For this reason, exercise sufficient caution that file names are specified correctly.
(3)If there is no folder at the path specified as remote, the folder is created. The created folder is left undeleted. If it is not used periodically, delete it.
Version
02.00.00
Tags
Gather JP1 information,Base
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Monitored system environment information |
Specify JP1/Base environment information. |
Y |
|
JP1 user acquisition information |
Specify the information you want to acquire about the JP1 user. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1base.listJP1UserOutputFileNameRemote |
JP1 user list output file name (remote) |
Specify the file name using the full path of the file that is on the JP1/Base host running as an authentication server and to which a JP1 user list is to be output. |
Input |
Disabled |
R |
JP1 user acquisition information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1base.jp1BaseHostName |
JP1/Base host name |
Specifies the host name or IP address of the server where JP1/Base is installed. IPv6 addresses are not supported. In the case of a cluster configuration, specify the logical host of the active server. |
Input |
Disabled |
R |
Monitored system environment information |
|
jp1base.jp1BaseLHostName |
Logical host name of JP1/Base |
Specify the logical host name of JP1/Base on the agent server (if JP1/Base is used in a cluster configuration). |
Input |
Disabled |
O |
Monitored system environment information |
|
jp1base.listJP1UserOutputFileNameLocal |
JP1 user list output file name (local) |
Specify the file name using the full path of the file on the JP1/AO server from which a JP1 user list is to be obtained. |
Input |
Disabled |
R |
JP1 user acquisition information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1base.listJP1UserOutputFileNameRemote |
This is a character string of up to 256 characters. < > | ; & * ? " % ` and trailing \ and / are not allowed. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1base.jp1BaseHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1base.jp1BaseLHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1base.listJP1UserOutputFileNameLocal |
This is a character string of up to 256 characters. < > | ; & * ? " % and trailing \ and / are not allowed. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
listJP1UserJP1BaseM |
Get list of JP1 users |
Acquires a list of JP1 users. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
FileTransferPlugin |
File-forwarding plug-in |
Transfers a list of JP1 users. |
Eliminate the cause of the error, and then re-execute the service. |
|
3 |
osDeleteFile |
Delete file |
Deletes temporary files. |
Files remain in the target server. Delete them manually. |