5.6.1 Format of a file of registered execution-schedule information for jobnets
The following figure shows the format of parameters defined in a file of registered execution-schedule information for jobnets.
|
The following describes the items specified in the file.
- (A) export-time
-
The time that the registered execution-schedule information was exported is output.
- Output format:
-
Japanese: YYYY/MM/DD hh:mm:ss
English: MMM DD YYYY hh:mm:ss
- (B) export-host-name
-
The name of the host on which the registered execution-schedule information was exported is output.
- Output format:
-
FQDN format (In a non-DNS environment, a short name is output.)
- (C) export-scheduler-service-name
-
The name of the scheduler service from which the registered execution-schedule information was exported is output. If the scheduler service name was not specified when the ajsrgexport command was executed, the default scheduler service name is output.
- (D) Start of parameter specifications
-
A left curly bracket ({) is used to indicate the start of a group of registered execution-schedule information parameters. This item cannot be omitted. The end of the group is indicated by a right curly bracket (}). A left curly bracket ({) and a right curly bracket (}) must be specified in pairs. A group of registered execution-schedule information parameters is specified for each jobnet.
- (E) comment
-
A line that begins with a hash mark (#) is treated as a comment line.
A comment cannot be specified on a line on which a parameter has been defined.
A comment line can be added anywhere in the file.
- (F) UNIT=root-jobnet-name
-
Specifies the unit full name of the root jobnet to be registered for execution. You can specify a character string of 1 to 930 bytes.
This parameter cannot be omitted. Multiple UNIT parameters cannot be specified.
The unit full name cannot be followed by a host name, scheduler service name, or execution ID.
- (G) ENTRY={s|f}
-
Specifies the type of execution registration. Either of the following types can be specified:
s: The jobnet is registered for planned execution.
f: The jobnet is registered for fixed execution.
This parameter cannot be omitted. Multiple ENTRY parameters cannot be specified.
- (H) EXCEEDSSCHEDULE={exec|skip}
-
Specifies whether the jobnet is executed if the scheduled time for execution has already passed when the scheduler service is started.
- exec
-
The jobnet is executed even if the scheduled time for execution has already passed when the scheduler service is started.
- skip
-
The jobnet is not executed if the scheduled time for execution has already passed when the scheduler service is started.
If this parameter is omitted, the command assumes that EXCEEDSSCHEDULE=exec is specified.
Multiple EXCEEDSSCHEDULE parameters cannot be specified.
- (I) MACRO=macro-variable-name:value
-
Specifies a macro variable name and the value to be passed via the macro variable during execution of the jobnet. One MACRO= specification can be followed by only one pair of macro variable name and value.
A maximum of 32 MACRO parameters can be specified.
Specification of MACRO parameters is required only when macro variables are used. Each MACRO parameter must be specified on a separate line. If multiple MACRO parameters are specified, the total number of characters that can be specified is 4,085 bytes.
Note that, after the file is imported and the job is executed, the macro variables specified here are inherited each time the next generation is created. Therefore, the specification of MACRO parameters is valid only in the following two cases: (1) when the execution registration type is registration for planned execution (ENTRY=s) and (2) when the number of future generations is specified in registration for fixed execution (when both ENTRY=f and FUTUREGENERATION=x (x: 1 to 99) are specified). If the execution registration type is other than the above, the specification of MACRO parameters is ignored. Specifically, the specification of MACRO parameters is ignored if the execution registration type is period-specified registration for fixed execution (that is, when ENTRY=f and FUTUREGENERATION=0 are specified or when ENTRY=f is specified and FUTUREGENERATION=x is not specified). If the execution registration type is period-specified registration for fixed execution, the parameters must be specified in the (R) section.
- macro-variable-name
-
The character string specified as a macro variable name can consist of upper-case letters, numeric characters, and periods (.).
The maximum length of the character string specified as a macro variable name is 62 bytes, excluding the question mark (?) at the beginning and the question mark (?) at the end of the string.
- value
-
Any character string can be specified.
You can specify a character string of 1 to 255 bytes.
- example 1
-
In the following example, only one macro variable is specified.
MACRO=AJS2ENV:/data/job_report
- example 2
-
In the following example, multiple macro variables are specified.
MACRO=AJS2ENV:/data/job_report MACRO=AJS2COM:c:\temp\test.exe
- (J) TIME=time-that the-jobnet-was-registered-for-execution
-
The time that the jobnet was registered for execution is specified in the YYYY/MM/DDΔhh:mm format (Δ: space). You can specify a character string of 16 bytes. If this parameter is omitted, the time that the ajsrgimport command was executed is assumed. The valid range of a value that can be specified is from 1994/01/01 00:00 to 2099/12/31 23:59. If Registered day is specified in the jobnet schedule rule, the schedule is calculated by using this time as the base point.
- (K) TZ=time-zone
-
Specifies the time zone. You can specify a character string of 99 bytes. If this parameter is omitted, the system behaves in the same way as when the time zone is not specified.
- (L) JP1USER=JP1-user-who-registered-the-jobnet-for-execution
-
Specifies the JP1 user who registered the jobnet for execution. You can specify a character string of 31 bytes. If this parameter is omitted, the JP1 user who executed the ajsrgimport command is assumed.
- (M) FUTUREGENERATION=number-of-future-generations-to-be-registered
-
Specifies the number of generations scheduled to be executed at the next and the following times. You can specify a value from 1 to 99. If the execution registration type is registration for planned execution (ENTRY=s), the specification of this parameter is ignored.
- (N) PRVTIME=time-to-start-dummy-schedule
-
This parameter is used for schedule calculation, and must not be changed.
- (O) PURGETTIME=time-to-cancel-execution-of-dummy-schedule
-
This parameter is used for schedule calculation, and must not be changed.
- (P) SKIPTIME=dummy-schedule-start-time
-
This parameter is used for schedule calculation, and must not be changed.
Note that when the file is imported, the generation management process automatically sets the value for this parameter. Therefore, after importing file of registered execution-schedule information for jobnets, even if you export that same information file without changing any settings, the SKIPTIME parameter values in the import and export files might be different. However, this difference causes no special problem.
- (Q) Schedule information section
-
Schedule information is specified below the [SCHEDULEINFO] line. This section is required if schedule information parameters need to be specified. Note that if the execution registration type is registration for planned execution (ENTRY=s), the specification in this section is ignored.
- (R) schedule-information-parameters
-
Parameters that determine the schedule information to be applied to registration for fixed execution are specified. If the execution registration type is registration for planned execution (ENTRY=s), these parameters are ignored. If the format of any schedule information parameter specified here conflicts with the configuration of the jobnet to be registered for execution, the KAVS4826-E message is output.
Schedule information parameters are specified in the following format.
The following explains the items in the section.
- information-1 to information-9
-
For details about the information-1 to information-9, see (B)schedule-information-parameter-for-jobnet in 5.4.1 Format of the schedule information file.
- information-10
-
Specifies the jobnet execution order control method.
y: The jobnet is executed synchronously.
n: The jobnet is executed asynchronously.
This item can be specified for only a root jobnet. If this item is omitted, the system behaves according to the root jobnet definition.
This item is ignored if it is specified for a nested jobnet.
- information-11
-
Specifies the jobnet monitoring time (equivalent to the time-required-for-execution within which the job is expected to be terminated). You can specify a decimal value between 1 and 2,879 (minutes).
None: The jobnet is monitored according to the definition.
0: The jobnet is not monitored.
1 to 2879: The jobnet is monitored by using the specified value.
- information-12
-
Specifies whether to execute the unit if the time to start the unit has already passed when the service is started.
exec: The unit is executed even if the time to start has already passed.
skip: The unit is not executed if the time to start has already passed.
This item can be specified for only a root jobnet. If you omit this option, the system assumes exec.
This item is ignored if it is specified for a nested jobnet.
- information-13
-
Specifies the time that the jobnet was registered for execution. The time is specified in the YYYYMMDDTTMM format (in both Japanese and English). This item cannot be omitted.
This item can be specified for only a root jobnet.
This item is ignored if it is specified for a nested jobnet.
- information-14
-
Specifies the time zone. The maximum length of the time zone that can be specified is 99 bytes.
This item can be specified for only a root jobnet. If this item is omitted, the system behaves in the same way as when the time zone is not specified.
This item is ignored if it is specified for a nested jobnet.
Note that the time zone must be enclosed in double quotation marks (").
- information-15
-
Specifies the name of the JP1 user who registered the jobnet for execution (the name of the JP1 user who executed the ajsentry command).
This item can be specified for only a root jobnet. If this item is omitted, the user who executed the command is assumed.
This item is ignored if it is specified for a nested jobnet.
Note that the name of the JP1 user who registered the jobnet for execution must be enclosed in double quotation marks (").
- information-16
-
Specifies macro variable information.
0: The macro variables specified in the common section are not used, and the macro variables specified in the schedule information section are used. If "" (null) is specified as a macro variable in the schedule information section, the macro variable is not used.
1: The macro variables specified in the common section are used.
This item can be specified for only a root jobnet. This item is ignored if it is specified for a nested jobnet.
- information-17
-
Specifies a macro variable name and the value to be passed via the macro variable during execution of the jobnet.
This item can be specified for only a root jobnet. This item is ignored if it is specified for a nested jobnet.
Note that the macro variable must be enclosed in double quotation marks (").
For jobs, schedule information parameters are specified in the following format.
For details about the information-1 to information-3, see (D)schedule-information-parameter-group-for-job in 5.4.1 Format of the schedule information file.
- (S) End of parameter specifications
-
A right curly bracket (}) is used to indicate the end of a group of execution registration information parameters. This item cannot be omitted.
If an export file containing the registered execution-schedule information about a root jobnet that has been registered for planned execution is imported, the schedule is created based on items (A) to (P) in the common section.
When registered execution-schedule information about a root jobnet that has been registered for fixed execution is exported, if schedule information that has already been generated exists, the information is output to the schedule information section. Therefore, if the exported file is then imported, schedule information is generated based on the parameters in the schedule information section. Also, be careful if the FUTUREGENERATION value in (M) is at least 1 and the number of schedules generated in the schedule information section when the file is imported is less than the specified number of generations. In this case, the rest of the schedules are generated based on items (A) to (P) in the common section.