4.6.11 Change JP1/AJS job status
Function
This plug-in changes the job status for the instance of JP1/AJS3 - Manager (or JP1/AJS2 - Manager, collectively referred to as JP1/AJS hereafter) on the specified server.
The following servers are required for this plug-in:
- Job server (execution target server)
This is the server on which the JP1/AJS jobnet is executed. JP1/AJS, which is described in prerequisites, must be set up.
This plug-in can only change the job status. With the job status change, the status of the jobnet that includes the changed job is also changed.
The scripts in this plug-in perform the following processes:
- If a value is specified for the logical host name of the job server (JP1.logicalHostName property), sets the JP1_HOSTNAME environment variable to the value of the logical host name.
- If a value is specified for the JP1 user name (JP1AJS.jp1UserName property), sets the JP1_USERNAME environment variable to the value of the JP1 user name.
- Executes the following command:
ajschgstat [-F "the-value-of-the-JP1/AJS-service-name-(JP1AJS.serviceName-property)"]
[-B "the-value-of-the-execution-registration-number-(JP1AJS.execRegistrationNumber-property)"]
-t "the-value-of-the-status-after-the-change-(JP1AJS.newStatus-property)"
[-c "the-value-of-the-return-code-(JP1AJS.returnCode-property)"]
"the-value-of-the-job-name-(JP1AJS.jobName-property)"#
#: Specify the name in the following format: [[scheduler-service-name]:]job-name[:@execution-ID].
For details about the ajschgstat command, see the manual Job Management Partner 1/Automatic Job Management System 3 Command Reference 1.
Use situation
This plug-in is used to change the JP1/AJS job status.
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.
Prerequisite products for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
(1) Job Management Partner 1/Automatic Job Management System 3 - Manager 09-00 or later, or
JP1/Automatic Job Management System 3 - Manager 11-00 or later
Supported OSs for the prerequisite products for the execution-target server:
(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)
Conditions for using the execution-target server:
(1) For the JP1 user name (JP1AJS.jp1UserName property), specify the JP1 user name to change the job status on the execution target server. If you change the job status using the JP1 user account that has the same name as the user of the OS this product connects to, you do not need to specify a value for this property.
(2) If you change the status of the job that is defined on the logical host in a cluster, the following settings must be specified:
- Specify a physical host name of the execution target server or a logical host name as the host name (plugin.destinationHost property) of the execution target server.
- Specify the name of the logical host, where the scheduler service is running, as the logical host name (JP1.logicalHostName property) of the execution target server.
- Specify the name of the scheduler service, which is running on the logical host, as the JP1/AJS service name (JP1AJS.serviceName property).
(3) If the OS running on the job server is UNIX, the character encoding setting of the environment setting parameter in the JP1/AJS instance on the job server must correspond to the default locale setting of the connected user account that connects to the job server.
Cautions
(1) Do not use double quotation marks (") or single quotation marks (') for the property of the plug-in.
(2) Even if the job name (JP1AJS.jobName property) contains symbol characters (&, *, <, >, ?, [, \, ], ^, ', {, |, }, ~) that are escaped by using a backslash (\), you do not need to use double quotation marks (") at the beginning and the end of the strings in the property.
(3) For the job name (JP1AJS.jobName property), explicitly specify the name of the job whose status is to be changed. Do not use the wildcard characters (*, ?, [, ]) in the job name.
(4) For other cautions, see cautions described in Changing the status of jobs in the manual Job Management Partner 1/Automatic Job Management System 3 Operator's Guide and cautions about the ajschgstat command described in the manual Job Management Partner 1/Automatic Job Management System 3 Command Reference 1.
Execution privilege
(1) The JP1 user account that is mapped to the OS user account connecting to the job server must have the permissions to the job to be operated.
(2) If the JP1 user account that is mapped to the OS user account connecting to the job server does not exist, specify a JP1 user account that has permissions to the job to be operated as the JP1 user name (JP1AJS.jp1UserName property).
Version
02.00.00
Plug-in tags
Control JP1,AJS,Windows,Linux
Plug-in name displayed in the task log
jp1ajsChangeStatus
Return code
0: Normal
21: Error (Environmental error) No command was found. (An error was detected in the component script.)
27: Error (Check the error details by using the task log.) Unidentified error
41: Error (An error has been detected in the component.) Property not entered (An error has been detected in the component script.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
JP1.logicalHostName |
Logical host name for the execution target server |
Specify the JP1 logical host name of the execution target server. |
-- |
Input |
O |
|
JP1AJS.jp1UserName |
JP1 user name |
Specify a JP1 user name. You do not need to specify this property if you execute a command with a JP1 user name that is the same as the OS user name used for connecting to the execution target server. |
-- |
Input |
O |
|
JP1AJS.serviceName |
JP1/AJS service name |
Specify the service name of the scheduler. |
-- |
Input |
O |
|
JP1AJS.jobName |
Job name |
Specify the name of the job whose status you want to change. |
-- |
Input |
R |
|
JP1AJS.execRegistrationNumber |
Execution registration number |
Specify the execution registration number of the jobnet that includes the job whose status you want to change in YYYYMMDDNNN format. |
-- |
Input |
O |
|
JP1AJS.newStatus |
Status after a change |
Specify the status to which you change a job. You can specify normal, fail, warning, abnormal, bypass, or exit. |
-- |
Input |
R |
|
JP1AJS.returnCode |
End code |
Specify the end code of a job. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |