ajsrelease
- Organization of this page
Format
ajsrelease [-F service-name] {-a release-target-root-jobnet-name -rid release-ID [-rcm release-comment] -rdy release-date [-rti release-time] -ru release-source-root-jobnet-name | -c release-target-root-jobnet-name | -i release-target-root-jobnet-name...}
Format1 (for making release entry)
ajsrelease [-F service-name] -a release-target-root-jobnet-name -rid release-ID [-rcm release-comment] -rdy release-date [-rti release-time] -ru release-source-root-jobnet-name
Format2 (for making release cancellation)
ajsrelease [-F service-name] -c release-target-root-jobnet-name
Format3 (for outputting release information)
ajsrelease [-F service-name] -i release-target-root-jobnet-name...
Description
The ajsrelease command can be used to perform the following operations on a root jobnet:
-
Making release entry
To enter the time that the jobnet definition will be switched, and the definition to be switched
-
Making release cancellation
To cancel the switching of the definition of a jobnet for which release entry has been made
-
Outputting release information
To output release information
If you register a jobnet-definition release specifying a release-target jobnet for which the upper-level unit-attribute inheritance function is set, the owner and JP1 resource group of that jobnet will be set by the function. For details on this function, see 6.4.1(4)(a) Overview of the upper-level unit-attribute inheritance function in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.
Execution privileges
You must have any of the following JP1 privileges:
- For making release entry or release cancellation:
-
-
JP1_AJS_Admin privilege
-
JP1_AJS_Manager privilege
-
JP1_AJS_Editor privilege and JP1_AJS_Operator privilege
-
- For outputting release information:
-
-
JP1_AJS_Admin privilege
-
JP1_AJS_Manager privilege
-
JP1_AJS_Editor privilege
-
JP1_AJS_Operator privilege
-
JP1_AJS_Guest privilege
-
Arguments
-F service-name
Specify the name of the scheduler service in which the target root jobnet (the release-target root jobnet) has been defined.
You can specify a character string of 1 to 30 bytes.
-a release-target-root-jobnet-name
Specify this option when making release entry.
Specify the full name of the release target root jobnet, which has the definitions to be switched to the new definition.
You can specify a character string of 1 to 930 bytes.
You can specify this option only if the release target root jobnet does not have jobnet definitions in Release wait, Delete wait, or Release entry wait status.
If the specified root jobnet does not exist, an error occurs. You cannot specify the following root jobnets:
-
Root jobnet in a planning group
-
Remote jobnet
-
Jobnet for recovery
-
Manager jobnet
-c release-target-root-jobnet-name
Specify this option when canceling the switching of the jobnet definition to a jobnet definition for which release entry is made.
Specify the full name of the root jobnet for which you want to cancel the switching of the definition.
You can specify a character string of 1 to 930 bytes.
If you specify this option, the command deletes the jobnet definitions in the Release wait, Delete wait, and Release entry wait statuses.
-i
Specify this option to output release information for the root jobnet.
If you specify this option, the command outputs information about the jobnet definitions in Being applied, Release wait, Delete wait, and Release entry wait statuses as release information. The command does not output release information about the jobnet definitions in other statuses.
-rid release-ID
Specify the release ID of the root jobnet (release-target root jobnet) definition for which the command is to be executed. You can specify a character string of 1 to 30 bytes.
You must specify this option with the -a option.
You must specify this option if you specify the -a option.
You cannot specify the following release IDs:
-
A release ID associated with the release-target jobnet for which the command is to be executed.
-
A release ID that begins with AJS (upper case)
-
A release ID that includes a space, tab, linefeed, or any of the following characters:
( ) , / : ; = " & ' * < > ? [ \ ] ^ ` { | } ~
You cannot specify this option with the -c and -i option.
-rcm release-comment
Specify a comment on the release entry you are making.
You can specify a character string of 1 to 80 bytes.
You must specify this option with the -a option.
You cannot specify this option with the -C and -i option.
If you omit this option, no release comment is registered.
-rdy release-date
Specify in the YYYY/MM/DD format the date on which the jobnet definition will be switched.
You can specify a value in the range from 1994/01/01 to December 31 in the year set for the SCHEDULELIMIT environment setting parameter. For details about the SCHEDULELIMIT environment setting parameter, see 20.4.2(123) SCHEDULELIMIT in the JP1/Automatic Job Management System 3 Configuration Guide.
You must specify this option if you specify the -a option.
You cannot specify this option with the -c and -i option.
If you specify a date in the past, an error occurs. An error also occurs if you specify the same date as the release date of a jobnet definition for which release entry is already made.
-rti release-time
Specify in the hh:mm format the time at which the jobnet definition will be switched.
You can specify a value in the range from 00:00 to 23:59. If you omit this option, the system assumes 00:00.
You must specify this option with the -a option.
You cannot specify this option with the -c and -i option.
If you specify a time in the past, an error occurs.
-ru release-source-root-jobnet-name
Specify the full name of the release source root jobnet, the definition of which is to be applied to another root jobnet.
You can specify a character string of 1 to 930 bytes.
You cannot specify any of the following root jobnets:
-
Root jobnet for which release entry is made
-
Root jobnet in a planning group
-
Remote jobnet
-
Jobnet for recovery
-
Manager jobnet
You must specify this option if you specify the -a option.
You cannot specify this option with the -c and -i option.
release-target-root-jobnet-name...
Specify the root jobnets for which you want to switch the definition.
You can specify multiple units or wildcard characters of units.
You cannot specify a character string that contains a logical host name, service name, or execution ID.
You can specify a character string of 1 to 930 bytes.
You must specify this option if you specify the -i option.
You cannot specify this option with the -a and -c option.
Notes
-
Either of the following users can register or cancel release:
-
A user granted the operation privilege and the update privilege for the unit to be released
-
A JP1 user mapped to the OS user who has Administrators or superuser privileges
Note, however, that if yes is set after changing the ADMACLIMIT environment setting parameter from its default, even a JP1 user who was mapped to an OS user with Administrators or superuser privileges must have the operation and the update privileges.
-
-
Either of the following users can output release information:
-
A user granted the reference privilege for the unit to be output
-
A JP1 user mapped to the OS user who has Administrators or superuser privileges
Note, however, that if yes is set after changing the ADMACLIMIT environment setting parameter from its default, even a JP1 user who was mapped to an OS user with Administrators or superuser privileges must have the reference privilege.
-
Notes on registering jobnets for release
-
A jobnet whose schedule is later than the release time and which has been registered for fixed execution with either a period or a date specified cannot be specified as a release target. In such cases, cancel the registration or prohibit the execution of schedules after the release time, and then register the jobnet-definition release. Note, however, that if a number of future generations is also specified for the jobnet registered for fixed execution, you can register the jobnet-definition release even when the schedule of the jobnet is later than the release time.
-
You cannot use the jobnet release function for jobnets of different scheduler services.
-
The following jobnets cannot be specified as a release source:
-
A jobnet that has already been specified as a release target
-
A suspended jobnet
-
A jobnet being edited
-
A jobnet being used by another user
-
A jobnet for which at least two of the following are defined: a jobnet connector, a connection-destination jobnet, or a start condition (.CONDITION)
-
-
The following jobnets cannot be specified as release targets:
-
A suspended jobnet
-
A jobnet whose status is Shutdown
-
A jobnet being edited
-
A jobnet being used by another user
If the other user is setting or releasing a hold attribute that applies to a unit under a jobnet whose status is Being applied, the jobnet can be specified as a release target.
-
A jobnet for which at least two of the following are defined: a jobnet connector, a connection-destination jobnet, or a start condition (.CONDITION)
-
-
A jobnet whose definition is in Release wait, Delete wait or Release entry wait status cannot be specified as a release-target jobnet. If you want to register a jobnet definition in the Release wait status, wait for the jobnet status to change to Being applied. For a jobnet definition in Delete wait or Release entry wait status, cancel the jobnet-definition release, and then re-register it.
-
The scheduler service needs to be running to register a release.
-
Registering a jobnet-definition release creates a system load that is equal to or greater than the load created by the definition for the release-source jobnet. Do not register a jobnet-definition release during peak job execution times.
-
If you register a jobnet-definition release specifying a release-target jobnet for which the upper-level unit-attribute inheritance function is set, the owner and JP1 resource group of that jobnet are set by the function.
-
When you register a jobnet-definition release, generations after the release date are re-created based on the registered jobnet definition. Therefore, any changes made by temporarily changing the plan before the registering the jobnet-definition release are not passed to the generations after the release date (The information specified during registration for execution, such as macro variables and JP1 user, is passed). You can reinstate temporary plan changes for generations of a jobnet after its release date by using the temporary change re-execution function to re-execute of temporary changes made prior to its release. For details on this function, see 4.5.16 Displaying and re-executing temporary change operations for a job or jobnet in the manual JP1/Automatic Job Management System 3 Overview.
-
Even if you register, for release, a jobnet definition that (in the schedule definition) will have no next scheduled generation created, no scheduled generation will be created from that definition. Therefore, use JP1/AJS3 - View or the ajsshow command to make sure that a scheduled generation has been created correctly from the jobnet definition that was released. If a scheduled generation has not been created, cancel the jobnet-definition release, review the release-source jobnet definition, and then re-reregister the jobnet-definition release.
-
When fixed execution registration is used, the jobnet definition returns to the unregistered status if:
- Generations exist only after the specified release date, and
- A jobnet-definition release is registered for a jobnet definition for which (in the schedule definition) no next scheduled generation is created.
In such cases, cancel the registration of the jobnet-definition release, review the release-source jobnet definition, again register the jobnet-definition release, and then re-register the jobnet definition for execution.
-
If you want to change the definition of a jobnet whose release status is Release wait, cancel the release, change the definition, and then perform release entry. If you do not have enough time to cancel the release or to re-do release entry, or if you want to change the definition whose status is Being applied, suspend the jobnet and then change the definition.
-
If release entry fails, the jobnet definition remains in the Release entry wait status and release entry is not performed. To prevent this problem, after you perform release entry, check whether the release status of the released jobnet definition changes from Release entry wait to Being applied or Release wait. If release entry fails and a definition remains in the Release entry wait status, cancel the release to delete the definition.
-
Release of the following jobnets cannot be canceled:
-
A suspended jobnet
-
A jobnet whose status is Shutdown
-
A jobnet being edited
-
A jobnet being used by another user
If the other user is setting or releasing a hold attribute that applies to a unit under a jobnet whose status is Being applied, the release of the jobnet can be canceled.
-
-
It is not recommended that you change the JP1 resource group of the release-target unit by means of a release entry. If you use a release entry to change the JP1 resource group, a JP1 user who can access the unit that existed before the release must execute commands or use JP1/AJS3 - View even after the release.
Cautionary notes on canceling a release
-
You cannot cancel release of a root jobnet that is being operated on by another user.
-
You cannot cancel a release for a root jobnet that has been suspended. In such cases, release the suspension of the root jobnet and try again to cancel the release.
-
You cannot cancel a release for a root jobnet in shutdown status. In such cases, cancel the execution registration of the root jobnet and try again to cancel the release.
-
The scheduler service needs to be running to cancel a release.
-
Canceling a release creates a system load that is equal to or greater than the load caused by deleting the jobnet definitions in the release information. Do not cancel a release during peak job execution times.
-
When you cancel a release, generations are re-created based on the jobnet definition whose status becomes Being applied after the release is canceled. Therefore, any changes made by temporarily changing the plan before canceling the release are not passed to the jobnets after the release is canceled. Note, however, that the information specified during registration for execution, such as macro variables and JP1 users, is passed.
-
If no next scheduled generation is created because of cancellation of the release of a jobnet definition whose status became Being applied after the cancellation, no scheduled generation will be created from that definition. Therefore, use JP1/AJS3 - View or the ajsshow command to make sure that the scheduled generation has been created correctly after the release is canceled. If a scheduled generation has not been created, review the jobnet definition that is in the Being applied status.
-
When fixed execution registration is used, the jobnet definition returns to the unregistered status if:
- Generations exist only in the jobnet definition whose release is to be canceled, and
- No next scheduled generation is created because the release was cancelled for a jobnet definition whose status became Being applied after the cancellation.
Review the jobnet definition that is in Being applied status after the release was canceled, and then re-register the jobnet for execution.
Cautionary notes on outputting release information
-
When extracting data from the output information, extract the data based on its delimiting spaces, not by fixed byte count.
Return values
0 |
Normal end |
Multiple of 4 within the range from 4 to 124 |
Abnormal end |
Example 1
In the following example, the command applies the definition of the test-environment/Rel001 jobnet to the /production-environment/unit001/ jobnet as release 001 at 20:00 on August 10, 2010.
ajsrelease -F AJSROOT1 -a / production-environment /unit001 -rid 001 -rcm 2010/08/10 release-definition -rdy 2010/08/10 -rti 20:00 -ru / test-environment /Rel001
Example 2
In the following example, the command removes the release entry for the /production-environment/unit001 root jobnet.
ajsrelease -F AJSROOT1 -c / production-environment /unit001
Example 3
In the following example, the command displays the release information for the /production-environment/unit001 root jobnet.
ajsrelease -F AJSROOT1 -i / production-environment /unit001
Output example
The following shows a sample execution of the command with the -i option specified:
The following shows the meaning of the output.
- upper job group name
-
The name of the upper-level job group is indicated here.
- Unit name
-
Unit names are listed in this column.
- Release ID
-
Release IDs are listed in this column.
- Release time
-
Release times are listed in MM DD YYYY HH:MM format in this column.
- Release status
-
Any of the following release statuses is displayed in this column.
-
release wait :
The unit is waiting for the new definition to be applied.
-
being applied :
The jobnet definition registered by release entry is currently applied.
-
delete wait :
There is a definition for which release cancellation failed.
-
release entry wait :
There is a definition for which release entry failed. Alternatively, release entry was successful but the status has not changed to Release wait yet.
-
- Release comment
-
Comments specified when release entry was made are displayed in this column.
- Release source jobnet
-
The name of the release source jobnet whose definition is used as the new definition is displayed in this column.