Job Details Dialog
Accessing the Job Details Dialog
The Job Details dialog displays when you double-click a job occurrence record in the Job Activity pane or right-click and select Details from the context menu.The details shown for a job differ from the details for a job group, thus while the Job Details dialog for a job group is very similar, it does not have the same tabs as a job does.
Job Details – Status Tab
This tab contains these elements:
-
Status – The job’s current status.
-
Est. Start Time – Estimated job launch time based on its time dependencies and the launch times and estimated durations of preceding jobs. You can view all the dependent jobs on the Dependencies tab.
-
Act. Start Time – The time the job became active. Until the job is active, this field is empty.
-
Est. Duration – The estimated time it will take for the job to run. If the job has never run before, it contains the value in the Estimated Duration field in the job’s definition. Otherwise, it contains a historical average of the Actual Duration.
-
Act. Duration – The actual time the job took to run.
-
Job Owner – The user that owns the job.
-
Scheduled By – Indicates how the job entered the production schedule. Three possible values may be displayed here:
-
Calendar – Compiled into the schedule based on an assigned calendar.
-
Event – Inserted by a job action based on an event trigger.
-
On Demand – Inserted by an operator via the TA client, command-line, API or Web Service.
-
-
Exit Code – The exit code of the completed job (if the job has not completed, this field is blank). This field is not displayed for a job group.
Exit code values mean:
-
If the value equals 0, the job has completed normally.
-
If the value does not equal 0, the job has completed abnormally,
-
-
External ID – By default, this is the ID number assigned to the job process by the operating system. Certain job types have an External ID assigned by third party software, such as SAP or PeopleSoft.
-
Reruns – The number of times the job has rerun for the day.
-
Disable Carryover – Selecting this option prevents the job from being carried forward to the next day’s schedule if the job does not run on its scheduled day. If the Try again tomorrow option in the If not ready by end of day field on the Schedule tab of a job definition is selected, it will override the Disable Carryover option and the job will run on the next day.
-
Track Critical Path For Job – This indicates whether the job is critical or not.
Job Details – Audit Log Tab
Displays user-initiated job interaction and production schedule audit trail messages for the job including job control actions, job occurrence status changes and errors. Double-click a record to display its details more clearly.
This tab displays this information:
-
Time – The date and time the audit was recorded.
-
Description – The job audit or error message describing the change/error to the job. Audit information is retained according to the audit retention setting in the System Configuration dialog.
-
User – The user that submitted the job.
Note: Only messages that have not been archived will be displayed by default. Click on View Archive Logs to display the archived log messages as well.
By default, the audit log message shows that a job waiting is on a resource. To enable granular audit logging and to audit log the particular resource or resources the job is waiting on, set the sysval:
Sysval
Description
194
Set the sysval_string field to Y to enable granular audit logging and N to disable granular audit logging.
Set the value in the sysval_integer to specify the threshold time limit (in seconds) after which logging of the exact resource name the job is waiting on happens.
Note: For runtime users/interactive users added to the Not Allowed control list of System Configuration > Runtime User Cotrol tab, the “Runtime user is not authorized by Runtime User Control” message is shown and the job completes with the “Error Occurred” status. For more information about the runtime user control list, see System Configuration - Runtime User Control Tab.
Job Details - Output Tab
Displays the standard output of the job. TA can be configured to save or discard job output by default from the Defaults tab of the System Configuration dialog. Regardless of the system default, any individual job instance can be configured from its job definition to override the system default.
-
If the Append option in the Save Output field on the Options tab of the job definition is selected in the job’s definition, the job’s standard output file is transferred to the Master and displayed on this tab. Each time a job is rerun that run’s output is separated by a block of number signs (#).
-
If the Replace option in the Save Output field is selected, then only the output from the last job instance that ran is saved. The output from the previous time that the job ran is overwritten.
-
If the Discard option of the Save Output field is selected than this tab will not have any job output displayed here.
-
If a job is cancelled before it can complete, any partial output that was generated during the processing of the job displays on the Output tab. Note that a job group does not have an Output tab in its Job Details dialog.
Note: TA’s default is to discard job output. To save or append job output or to specify that the output be produced in summary format, change the system default on the Defaults tab of the System Configuration dialog. This can be adjusted for individual jobs from the Options tab of that job’s Job Definition dialog.
You can refresh the output if parameters have been changed after runtime by clicking Refresh output.
Job Details – Dependencies Tab
About the Dependencies Tab
Shows all predecessors (job, file, time and variable dependencies) needed before a job can run. It also displays all successors occurring after the job runs.
From the Dependencies tab, you can override individual job dependencies for a job instance (but not for a job group).
To override all of a job instance’s dependencies, refer to the override section of the Job Control Submenu. Other instances of the job are not affected when you override a dependency.
There are three ways to override a dependency:
-
Select the dependency in the Predecessors field and click Override.
-
Select the dependency in the Predecessors field, right-click to display the context menu and choose the Override option.
-
Select the dependency in the Predecessors field and use the keyboard shortcut, Ctrl+O.
This tab contains these elements:
-
Include dependencies already satisfied – When not checked, only dependencies that have not been met are displayed. Otherwise, met dependencies are displayed with a green box outlining the dependency’s icon. The default is checked to show all predecessors and successors.
-
Predecessors – Displays files, time that must be met, the exit code criteria along with the job status condition based on which the job dependency has been met, and hierarchical trees of earlier jobs that must reach a particular status before this job can run. Jobs on higher levels of the hierarchies depend upon jobs in lower levels.
These context menu options are displayed when you right-click on a dependency:
Refresh – Refreshes the list of dependencies.
Override – Overrides the selected dependency. If the Activities main menu > System Configuration option > Other tab > Confirm Dependency Override option is selected, a confirmation alert is displayed. Click Yes to override the selected dependency.
Cancel Override – Cancels any previous override(s) for the selected dependency. This option is only enabled if the selected dependency has been overridden.
-
Override – Click it to override the selected dependency. A confirmation alert is displayed if the Activities main menu > System Configuration > Other > Confirm Dependency Override option is selected. Click Yes to override the selected dependency.
-
Successors – Displays a hierarchical tree of jobs that are dependent on the job in question. Jobs on lower levels of the hierarchies depend on the jobs above.
File Dependencies
File dependencies are defined in the job’s definition dialog, and are displayed with a file icon, the file’s path name and the dependency expression (Exist, Not Exist, and so on).
These permissions are required for the file dependencies:
Note: The user running the Agent must have access to the directory, folder, or file (not an RTU).
-
If the file is a Windows UNC path, the user running the Agent must be a network user (not LocalSystem).
-
For a UNIX system, the user running the Agent must have appropriate access through the entire directory structure down to the file.
Job Dependencies
Job dependencies are defined in the job’s definition dialog and are displayed with a job icon, the job’s name, the selected logical operator (=, <>, etc…), its target status, and the present status. If the job is not currently in the production schedule, the icon changes to the not-in-schedule icon.
Note: To have a job ignore a job dependency when the dependency is not in the schedule, select the Ignore dependency if job not in schedule option in the Job Dependency Definition dialog.
Time Dependencies
Time dependencies are displayed with a time icon, and indicate the time when the time dependency will be met.
Note: If the time window of a job begins earlier than the time window of the parent group, the job will only run when the time dependency of the parent group is met. For jobs using Master time zone or agent time zone.
Scenario |
Sysval ‘198’ Configuration |
Behavior |
---|---|---|
The time window of a job begins earlier than the time window of the parent group, but they fall on the same date |
Not Applicable |
The job will only run when the time dependency of the parent group is met |
The time window of a job begins on an earlier date than the time window of the parent group |
Sysval not defined
|
The job will run as per its time window even if the time dependency of the parent group is not met |
Sysval ‘198’ is set to Y SysvaSysval ‘198’ is set to Yl ‘198’ is set to N |
The job will run ahead of its parent group. The job will only run when the time dependency of the parent group is met |
Variable Dependencies
Variable dependencies are defined in the job’s definition dialog and are displayed with a variable icon, the variable’s name, its dependency expression and its present value in parentheses.
Job Details – Resources Tab
The Resources tab of the Job Details dialog displays information about any resources assigned to a job or a job group. The current and required system resource values, with a column showing the status of the resource, displays on this tab. In the case of a job or a job group that uses an agent list and has not yet been assigned an agent from the list, the current and status columns are grayed out.
The possible statuses for the resource are:
-
Available – The resource is available. The job or the job group cannot use the resource until all of its needed resources are available at the same time.
-
Unavailable – The resource is unavailable.
-
Waiting – The resource is not available because another job or job group is using the resource.
-
Locked – The job is running. All of the listed resources will display the Locked status. A job cannot run until all of its assigned resources are simultaneously available. When the resources become available to the job or the job group, the job or the job group locks up its share of each resource until the job completes and the resource is released for use by other jobs or job groups.
A resource in a Locked status cannot be overridden to release it but a user could modify the resource's definition to temporarily increase its limit and make more of the resource available to other jobs or job groups.
The Resources tab contains these elements:
-
Resource Consumption
Type – The kind of resource that is being used, Virtual or Agent.
Resource Name – Displays the name of the resource associated with the job or the job group.
Amount Used – The amount of the resource's specified limit that the job or the job group uses. This number cannot exceed the number shown in the Amount Available column.
Amount Available – The amount of the resource that is available to be used. This number is derived by subtracting the amount of the resource currently in use from the limit specified in the resource’s definition.
Status – Denotes the status of a resource assigned to the job or the job group. There are three possible statuses:
Available – The resource is available for the job or the job group.
Waiting – The resource is not currently available. The job is unable to run until the specified amount (shown in the Amount Needed column) of the resource is available.
Locked – The resource is being used by the job or the job group. The amount of the resource being used by the job or the job group (shown in the Amount Used column) is unavailable to any other job or job group until this job completes. If multiple resources are required for the job or the job group, then an all or nothing approach is used. No resource is locked up until all of the required resources are available and can be locked simultaneously.
A resource in a locked status cannot be overridden to release it but a user could modify the resource's definition to temporarily increase its limit and make more of the resource available to other jobs or job groups.
-
Resource conditions
Type – The kind of resource that is being used, Published or Custom.
Resource Name – Displays the name of the resource associated with the job or the job group.
Current – Displays the current value.
Condition – Contains the conditional operators depending on the data type of the resource.
Required – Displays the amount of the resource needed by the job or the job group. This amount is defined in the Resource Requirement Definition dialog
Status – Denotes the status of a resource assigned to the job or job group. There are three possible statuses:
Available – The resource is available for the job or job group.
Waiting – The resource is not currently available. The job or the job group is unable to run until the specified amount (shown in the Amount Needed column) of the resource is available.
Locked – The resource is being used by the job or the job group. The amount of the resource being used by the job or the job group (shown in the Amount Used column) is unavailable to any other job or job group until this job completes. If multiple resources are required for the job or the job group, then an all or nothing approach is used. No resource is locked up until all of the required resources are available and can be locked simultaneously.
Job Details – Variables Tab
Local Job Variables
Open a job from the Job Activity pane and select the Variables tab in the displayed Job Details dialog to view the variables that are defined in a job. These variables, called Local Job Variables, are isolated from any changes to their values that occur outside of current job and its parent job group. You can add, edit, and view local job variables using the Variables tab. For more information about defining and modifying local job variables, see Local Job Variables.
Note: For agent jobs, the TA Master passes the variable-related information to the agents.
Local Group Variables
Open a job group from the Job Activity pane and select the Variables tab in the displayed Job Group Details dialog to view the variables that are defined in a job group. These variables, called Local Group Variables, are isolated from any changes to their values that occur outside of current job group, its parent or child job groups. You can add, edit, and view local group variables using the Variables tab. You can right-click a local group variable in the Variables tab and select the Where Used option to display the child jobruns where the selected local group variable is used. For more information about defining and modifying local group variables, see Local Group Variables.
Job Details – Override Tab
Displays job properties that can be changed for this occurrence at any time while the job is waiting to run. After a job runs, it is only useful to change these values if you rerun the job. Changes made only affect the instance and not the rule as defined in the Job Definition dialog. The Job Details dialog for a job group does not have an Override tab.
Note: After changing any of these values and clicking OK, you are prompted to confirm the changes, and you are given the choice to apply the changes to all occurrences of the job in today’s schedule if this is a repeating job. This applies to all repeating jobs that have not run yet, and all additions of this job that were inserted manually.
This tab contains these elements:
-
Directory – (Required) Enter the full path of the directory to monitor. This field is displayed only for File Watcher jobs.
Note: Any argument that either explicitly has a space in it or could have a space in the argument should be enclosed in quotation marks; otherwise, the argument is returned as separate arguments wherever the spaces occur. For example, a directory name, say, “Tidal Automation” would be returned as separate arguments, “Tidal” and “Automation”. Similarly, if a variable like <jobname> could return an argument containing a space, it also should be enclosed in quotation marks. If there is a single quote or double quote in the actual directory or file, then agent will not support.
-
Search All Subdirectories – Select to include all hierarchical subdirectories in the search. This field is displayed only for File Watcher jobs.
-
File Mask – (Required) Enter the name of the file you want to monitor. You can also enter a file name pattern. This field is displayed only for File Watcher jobs.
Example: Single file name (Example: myfile.txt). File name pattern containing wildcard (Example: *.log to match any file with a .log extension, app-?.txt to match any .txt file that begins with app- followed by any single character).
Note: Any argument that either explicitly has a space in it or could have a space in the argument should be enclosed in quotation marks; otherwise, the argument is returned as separate arguments wherever the spaces occur. For example, a job with name “File Watcher Job” would be returned as separate arguments, “File” “Watcher” and “Job”. Similarly, if a variable like <jobname> could return an argument containing a space, it also should be enclosed in quotation marks. If there is a single quote or double quote in the actual directory or file, then agent will not support.
-
Match First File Only – Choose this option to continue searching the directory so that the job completes when the first file that matches the specified file mask and criteria is found. The job outputs the matching file name when the job completes.
-
Match All Files – Choose this option to continue searching the directory so that when the job completes after the specified Poll Duration, the job outputs all filenames matching the specified file mask and criteria.
-
Poll Continuously – Choose this option so that the directory is polled at specified interval until the specified criteria are met. This field is displayed only for File Watcher jobs.
-
Poll Duration – Specify the maximum duration the directory should be polled. If the Poll Duration expires when the job run is still active, the job completes abnormally with an error. This field is enabled only when the Poll Continuously checkbox is not selected. This field is displayed only for File Watcher jobs.
-
Poll Interval – Specify the time interval between two consecutive polls for checking file availability and file updates. The default value is 2000 milliseconds. This field is displayed only for File Watcher jobs.
-
File Exists – Choose this criterion so that the job completes normally only if the specified file is found within the Poll Duration. This field is displayed only for File Watcher jobs.
-
File Does Not Exist – Choose this criterion so that the job completes normally only if the specified file is not found within the Poll Duration. This field is displayed only for File Watcher jobs.
-
File Size – This field is enabled only if the File Exists criterion is selected. Specify this additional file size criterion so that the job completes normally only if this criterion is met within the Poll Duration. This field is displayed only for File Watcher jobs. Choose one of the criteria:
Equals – The agent fetches/extracts only those files with the exact size you specify here.
Maximum – The agent fetches/extracts only those files with a size that is equal to or less than the size you specify here.
Minimum – The agent fetches/extracts only those files with a size that is equal to or greater than the size you specify here.
-
File Updated – This field is enabled only if the File Exists criterion is selected. Choose this option to specify the additional criterion that ensures the job completes normally only if the specified file is found to have been updated after the polling begins and within the Poll Duration. This field is displayed only for File Watcher jobs.
-
File Activity – This field is enabled only if the File Exists criterion is selected and File Updated criterion is not selected. Specify this additional criterion so that the job completes normally only if the specified file meets the specified file activity criteria within the Poll Duration. This field is displayed only for File Watcher jobs. When using this criteria, specify only one of these values:
File Stable for – Specifies the amount of time for which the file should be stable. The job completes normally if the file is not modified in the specified last N milliseconds/seconds/minutes.
File Modified in last – Specifies the recent time the file should have been modified. The job completes normally if the file is modified in the specified last N milliseconds/seconds/minutes.
-
Agent – The agent that the job runs on. This is useful if the job failed on one agent and you want to rerun it on another. You can select from a list of active agents only. Be sure to choose an agent platform that will support the command in the command field.
-
Agent List – The list of available agents that can run the job. The Master assigns an agent to the job only when the job's dependencies are met and the job is ready to run. The Master assigns an agent according to demands of the production schedule and the agent's job limit at the time that the job is ready to run.
Note: Since the agent is not assigned to a job until the last minute, if a user looks at a Job Details dialog before the job runs (e.g., the job is in a Waiting on Dependencies state), the Agent field on the Override tab is empty. The Master does not select an agent from the agent list displayed in the Agent List field until the job’s dependencies are met and the job is ready to run. Only then is the agent selected and the name of the agent displayed in the Agent field. If the job reruns, the Master may assign a different agent from the agent list according to the demands of the production schedule.
-
Priority – The priority of the job. This value ranges from low (0) to high (100). This value is used to prioritize job execution by comparing with other jobs within the job’s destination queue.
-
Reset – When clicked, resets the job priority to the value specified in the job definition.
-
Queue – Normally, jobs are automatically assigned to queues. You can use this field to override the automatic assignment. You may want to do this if the present queue is too full to run the job any time soon.
-
Runtime User – The runtime user, if any, assigned to the job. If that user account is currently experiencing problems, you can select another runtime user in this field.
-
Completion Status – This field is displayed only for Terminator jobs. Displays the status selected when defining Terminator jobs.
-
From Time – The start of a job instance’s time dependency pane. By modifying the time within this field, you can override the time dependency.
-
Until Time – The end of a job instance’s time dependency pane. Modifying the time in this field overrides the jobs’s time dependency.
-
SLA At Risk between – The time (in hours) that an SLA will be at risk if the associated job did not complete within the stipulated time. Events are triggered for jobs that did not complete within their SLA risk window. For more information about these events, see Job SLA Events.
-
SLA Breach between – The time (in hours) that an SLA breach will occur if the associated job did not complete within the stipulated time. Events are triggered for jobs that have breached or violated their SLAs. For more information about these events, see JobSLA Events.
-
Remove Time Dependency – This button clears the values entered in the From Time and Until Time fields, removing the time dependency for this job instance.
-
Defaults – This button becomes available whenever you make a change to the job’s parameters from the Override tab. Clicking Defaults after a change returns all the fields on the Override tab to their original values. The Defaults button is then unavailable until the next override change.
Job Details – Runbook Tab
The Runbook tab is intended to supply any instructions for the user relative to the execution of this job. This field can be used effectively with the Require operator release option in the job’s definition.
Job Details – Notes Tab
Use this field to enter other notes concerning the job.
This tab contains these elements:
-
Other Notes – A free text field where you can type any instructions for the operator or enter a web address that provides relevant information about the job. If you selected the Require operator release option on the Options tab, you could use this field for detailed reminders about the circumstances under which to run this job with the Require operator release option selected.
A web address or network directory address can be entered here and if the Load URL option is selected, the specified directory or web page from an internet site or a company intranet site displays. The web page or directory pane that displays here is an active pane that can be refreshed and whose links and folders can be accessed by clicking. You can right-click a web page in this field to display a context menu of the same options available in the web browser.
-
Load URL – If a web URL is entered in the text field and this option is selected then that web page displays in the text field. This web address can be for an internet site or a company intranet site. This can be very useful if information pertaining to a job is stored on a company intranet.
Job Details – History Tab
Details the job run history of every occurrence of this job in the production schedule sorted by Start Time and then by job number in descending order. The history includes jobs that have completed and jobs currently waiting to run either as repeated jobs and in future days of the production schedule. The history is retained according to the retention history setting in the job’s definition.
Note: Columns in the History tab can be resized by clicking the right border bar and dragging left or right.
This tab contains these elements:
-
SLA Status – Indicates the SLA status for each job instance based on one of these SLA levels the job instance reaches during its life cycle.
None – This level is assigned to a job instance without an SLA Time window.
On Time/Met – This level is assigned to a job instance when it completes on time.
At Risk – This level is assigned to an in-progress job instance which is at the risk of violating the SLA Time window.
May Breach – This level is assigned to an in-progress job instance which may breach the SLA Time window.
In Risk – This level is assigned to a job instance that completes within the SLA Risk window.
In Breach – This level is assigned to a job instance when the job instance completes within the SLA Breach window or beyond the SLA Risk window in the absence of SLA Breach window.
Breached – This level is assigned to a job instance that completed beyond the SLA Breach window.
Note: All the job instances assigned with the SLA status At Risk or higher level are marked as Critical.
-
Job No. – The unique number assigned to the job occurrence (day instance).
-
Date – The date on which the occurrence was scheduled to run.
-
Status – The present or final status of the occurrence. For a description of job statuses, see Jobs and Job Groups.
-
Est Start – For past or present jobs, the time the job is estimated to start. For future jobs, this field represents the estimated time when the job occurrence is expected to start. The start time may vary due to system resource utilization and job dependencies.
-
Ready – The time when the job was ready to run.
-
Act Start – For past or present jobs, the actual time the job occurrence started. For future jobs, this field is blank.
-
Launch – The time when the job was launched.
-
Act End – For past jobs, the actual time the job occurrence ended. For currently running jobs or future jobs, this field is blank.
-
Wait Duration – The duration the job waited (between the Ready time and the Launch time) before it ran.
-
Duration – The actual duration of the job.
-
Reruns – The number of times the job has been rerun.
-
Command – The command path, name and parameters that were executed for the occurrence of the job.
-
Priority – The priority of the job when the job ran.
Job Details – SLA History Tab
The SLA History tab displays history for the SLA related to a job instance sorted by Create Time.
This tab contains these elements:
-
Create Time – The date and time when the SLA History record is created.
-
Job No. – The unique job ID.
-
SLA Policy – The SLA Policy the job was associated with.
-
SLA Rule – The SLA Rule defined as part of the SLA Policy that the job was associated with.
-
Date – The date when the related job instance was scheduled to run.
-
Run Date – The date when the related job instance was run.
-
SLA Event – The event that was triggered for a job SLA or system-wide SLA.
-
Ready Time – The date and time when the job was available to run.
-
Active Time – The date and time when the related job instance was active.
-
Wait Duration – The duration the job waited before it ran.
-
Agent – The agent under which the related job instance was scheduled to run.