Runnable: Execute
With this module objects can be executed once or recurring. Via different modes the module may exited immediately after the activation or after submitting promptsets (if available) or it may wait for the activated object to finish and, optionally, to display a selected report of the task.
Designation
- Name
- util.Activate
- Aliases
- Activate, RunnableExecute
Configuration
- Optionen
- Object name (
object) - The name of the object to execute
- Alias (
alias) - The alias of the object to execute
- Report type (
report-type) - Defines the report type to retrieveMögliche Werte: Aktivierungsreport (
ACT), Mandanten-Report (CLNT), Laufzeit-Report (LOG), SYSLST-Report für BS2000-Jobs (LST), Objekt-Report (OBJ), Agent-Report (PLOG), Post-Script-Report (POST), Interner Report (PP), Jobreport (REP), Script-Report (REV0), JCL-Report (REV1), Objektzugriffsreport (REV2)
- Mode (
mode) - Defines the mode of execution, i.e. what to do after starting the job. The module can just end after the activation, wait for the end of the task or wait for the end and print out a selected report.Mögliche Werte: Exit directly (
exit), Wait for promptset (promptset), Wait for Job (wait), Retrieve Report (report)
- Logical Date (
logical-date) - Defines the logical date that will be passed on to the executed object
- Parameter filename (
instance-parameter) - File containing the parameters
- Prompt Buffer File (
prompt-buffer) - A file containing a list of variables to pass on to the object to define PromptSet values
- Take over return code (
use-retcode) - If set the return code of the started job is used for the program
- Use status code for exit code (
use-status-code) - If set the module exit code is controlled by the status code of the execute object. Only of the activity ends with a status matching ANY_OK, the module's exit code will be 0. Otherwise it will be 1.
- Start Type (
start-type) - Defines if the object should be started once or recurringMögliche Werte: Once (
once), Recurring (recurring)
- Start (
period-start) - Defines the start of the period of the execution of the object
- End Mode (
period-end-mode) - Defines if the period has an end or notMögliche Werte: Never (
never), On (on), After (after)
- End Date (
period-end-date) - At the given date the period for the execution of the object ends
- Number of Executions (
period-end-after) - Defines the exact number of executions that should be done
- Description (
period-description) - An optional description for the C_PERIOD task
- Mode (
frequency-mode) - Defines the frequency of executions within a dayMögliche Werte: At (
at), Interval (interval), After the previous run (after)
- Interval (
frequency-interval) - The interval given in hours and minutes
- Time (
frequency-time) - The object will be executed at the given time
- Allow one Overlap (
frequency-overlap) - If set the next execution can start even if the last one is not finished yet
- Start Time (
frequency-start) - The start time of the interval
- End Time (
frequency-end) - The end time of the interval
- Adjust initial Start Time (
frequency-adjust-start-time) - Adjust initial start to a clock-time interval
- Mode (
days-mode) - Defines the way how to select the days for executionMögliche Werte: Daily (
daily), Weekly (weekly), Calendar Condition (calendar)
- Days (
days-days) - Selection of weekdays for the executionMögliche Werte: Monday (
monday), Tuesday (tuesday), Wednesday (wednesday), Thursday (thursday), Friday (friday), Saturday (saturday), Sunday (sunday)
- Execution time (
execute-at) - Execution time of the object
- Calendar Match Rule (
days-calendar-match) - Defines in which way the calendar definitions of to match.Mögliche Werte: All (
all), None (none), One (one)
- Calendar Keywords (
days-calendars) - A list of pairs of calender object and a keyword
Description
The file for the prompt buffer file must be in CSV format with a semicolon as the separator between the variable name and the value, as shown in the following example.
variable1#;42
variable2#;best4Automic
To provide a multi-line value, it must be written in quotation marks.
variable1#;42
variable2#;"best4Automic Solution
the addition for AWA"
To fill multiple values in a checkbox, they must be enclosed in quotation marks and separated by the separator stored in the PromptSet for the parameter.
variable1#;42
variable2#;“b4A;best4Automic;42”
The same applies to the parameter file.
Modes
The module can use the mode (mode) option to influence the behavior of how or whether the activated object should be observed.
- Exit directly (
exit): After activating the object, the module exits immediately - Wait for promptset (
promptset): In this case, the system checks whether the object enters the status "Waiting for user input". If this is the case, the PromptSets are confirmed with the default values. If the object to be activated has no PromptSets, the system automatically switches toexitmode. The module then exits. - Wait for the job (
wait): After activation, the module waits until the task is completed and then exits. - Get report (
report): After activation, the system waits until the task is completed and then another selected report is output.