File Transfer Task
- Stonebranch (Deactivated)
Overview
The File Transfer task allows you to execute file transfers on remote machines using any of the following protocols:
- FTP
- SFTP
- UDM
- FTPS
- FTPES
To run a File Transfer task, you need Universal Agent for Linux/Unix, z/OS, or Windows to communicate with the File Transfer server. The Agent can, but does not have to be, running on the same machine as the File Transfer server.
The following examples provide sample configurations for executing file transfers using a File Transfer task.
In the first example, the user wants to transfer a file from a remote File Transfer Server on a machine that does not have an Agent running on it. In this case, the File Transfer task definition provides an address and login credentials for the machine where the Agent is running as well as address and login credentials for the machine where the File Transfer server is running.
In the second example, the user wants to transfer a file from a remote File Transfer Server on a z/OS machine that does have an Agent running on it. In this case, the login credentials for the Agent machine and the File Transfer server machine are the same.
Built-In Variables
The following built-in variables can be used in a File Transfer task to pass data where appropriate:
Creating a File Transfer Task
|
Step 1 |
From the Automation Center navigation pane, select Tasks > File Transfer Tasks. The File Transfer Tasks list displays a list of all currently defined File Transfer tasks. |
|---|---|
|
Step 2 |
Enter/select Details for a new File Transfer task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
|
Step 3 |
Click a |
Note
To open an existing record on the list, either:
- Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
- Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
- Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
File Transfer Protocols
When you create a File Transfer task, you select a file transfer protocol: FTP, SFTP, UDM, FTPS or FTPES.
The File Transfer Task Exclude Protocols Universal Controller system property permits the exclusion of one or more, but not all, protocols from being selected (see the Transfer Protocol field, below.)
The order of precedence for selecting a default Transfer Protocol for a File Transfer task is UDM, SFTP, FTPS, FTP, FTPES. The first of these protocols that is not specified in the File Transfer Task Exclude Protocols system property will be the default.
For example:.
- If File Transfer Task Exclude Protocols = UDM, the default Transfer Protocol will be SFTP.
- If File Transfer Task Exclude Protocols = UDM and SFTP, the default Transfer Protocol will be FTPS.
File Transfer Protocols Details
The Details for FTP, SFTP, FTPS, and FTPES transfer protocols are the same; the Details for the UDM transfer protocol differs considerably.
Using SFTP requires that you supply a valid credential that specifies the location of the SSL/TLS Private key on your Agent. In the Credentials Details, you supply the location for the private key in the field "Key Location (File Transfer only)". This location must exist on the Agent where you intend to run the SFTP task.
Make sure you have your private/public keys properly set up and working before you configure the Controller to use it. For example, to validate the keys, log into your destination server from your agent server using ssh.
FTP/SFTP/FTPS/FTPES File Transfer Task Details
The following FTP/SFTP/FTPS/FTPES File Transfer Task Details is for an existing FTP/SFTP/FTPS/FTPES File Transfer task.
Depending on the values that you enter / select for these fields, and whether or not the FTP/SFTP/FTPS/FTPES File Transfer task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the FTP/SFTP/FTPS/FTPES File Transfer Task Details.
FTP/SFTP/FTPS/FTPES File Transfer Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS/FTPES File Transfer Task Details.
|
Field Name |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
General |
This section contains general information about the task. |
||||||||||
|
Name |
User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks. |
||||||||||
|
Version |
System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning. |
||||||||||
|
Description |
Description of this record. Maximum length is 255 characters. |
||||||||||
|
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
||||||||||
|
Resolve Name Immediately |
If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time. |
||||||||||
|
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
||||||||||
|
Hold on Start |
If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. |
||||||||||
|
Hold Reason |
Information about why the task will be put on hold when it starts. |
||||||||||
|
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
||||||||||
|
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
||||||||||
| Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
||||||||||
| Simulate | Specifies if the instance should execute under simulation mode. |
||||||||||
|
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
||||||||||
|
Cluster |
Indication that selecting an Agent Cluster is required and selecting Broadcast, which lets you select a Cluster Broadcast, is optional. If Cluster is selected, selecting an Agent is not required unless Agent Variable is selected. |
||||||||||
|
Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify an Agent, you must specify an Agent Cluster or Cluster Broadcast. |
||||||||||
|
Agent Variable |
Indication of whether the Agent field is a reference field for selecting a specific Agent (unchecked) or a text field for specifying the Agent as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent reference to using an Agent variable, you must change the Agent Variable field to Yes and specify the Agent variable in the Agent Unresolved field. Conversely, to change from using an Agent variable to using an Agent reference, you must change the Agent Variable field to No and specify the Agent reference in the Agent field. |
||||||||||
|
Agent Cluster |
If Cluster is selected and Broadcast is not selected; Group of Agents, one of which the Controller will choose to run this task (compare with Cluster Broadcast). You can specify an agent cluster in addition to or in place of a specific Agent. If you specify an Agent and an agent cluster, the Controller first tries to run the task on the specific agent. If the Agent is not available, the Controller reverts to the agent cluster. See Agent Clusters for more information. |
||||||||||
|
Agent Cluster Variable |
Indication of whether the Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Agent Cluster as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent Cluster reference to using an Agent Cluster variable, you must change the Agent Cluster Variable field to Yes and specify the Agent Cluster variable in the Agent Cluster Unresolved field. Conversely, to change from using an Agent Cluster variable to using an Agent Cluster reference, you must change the Agent Cluster Variable field to No and specify the Agent Cluster reference in the Agent Cluster field. |
||||||||||
|
Broadcast |
Displays only if Cluster is selected; Indication that selecting a Cluster Broadcast is required. Selecting Broadcast hides the Agent and Agent Cluster fields; you cannot select values for them. |
||||||||||
|
Cluster Broadcast |
Group of Agents, all of which will run this task (compare with Agent Cluster). If Broadcast is selected for a task, you must select a Cluster Broadcast instead of a specific Agent and/or agent cluster. Each instance of the task running on its own Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor. |
||||||||||
|
Cluster Broadcast Variable |
Indication of whether the Cluster Broadcast field is a reference field for selecting a specific Cluster Broadcast (unchecked) or a text field for specifying the Cluster Broadcast as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Cluster Broadcast reference to using a Cluster Broadcast variable, you must change the Cluster Broadcast Variable field to Yes and specify the Cluster Broadcast variable in the Cluster Broadcast Unresolved field. Conversely, to change from using a Cluster Broadcast variable to using a Cluster Broadcast reference, you must change the Cluster Broadcast Variable field to No and specify the Cluster Broadcast reference in the Cluster Broadcast field. |
||||||||||
|
Credentials |
Credentials under which an Agent runs this task. These Credentials override any Credentials provided in the Agent Details for any Agent running this task. If the user does not have a login shell, add a - character in front of the runtime credentials name. The Controller will provide a shell for that user and strip the - character from the name. Required if the Agent Credentials Required Universal Controller system property is true. When required, if the Credential is specified as a variable, and the variable resolves to blank, a Start Failure will occur. |
||||||||||
|
Credentials Variable |
Indication of whether the Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Credential as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Credentials reference to using a Credentials variable, you must change the Credentials Variable field to Yes and specify the Credentials variable in the Credentials Unresolved field. Conversely, to change from using a Credentials variable to using a Credentials reference, you must change the Credentials Variable field to No and specify the Credentials reference in the Credentials field. |
||||||||||
|
File Transfer Details |
This section contains assorted detailed information about the task. |
||||||||||
|
Transfer Protocol |
Type of transfer protocol for this file transfer. Options:
|
||||||||||
|
Command |
File Transfer command being executed. Options:
|
||||||||||
|
Job Card (z/OS only) |
For z/OS, the job card information for the JCL statement. Example:
|
||||||||||
|
Subcommands (z/OS only) |
For z/OS, any subcommands used in the JCL statement. |
||||||||||
| Verify Host Name |
If Transfer Protocol = FTPS or FTPES; Indication of whether to verify the DNS name or IP address of the FTP server's certificate against the host system. |
||||||||||
| Authenticate Peer |
If Transfer Protocol = FTPES; Indication of whether to use a CA certificate configured in the agent to authenticate the FTP server's certificate. |
||||||||||
|
Transfer Type |
Data format of the file being transferred. Options:
|
||||||||||
|
Transfer Mode |
|
||||||||||
|
Remote Server |
Required if Transfer Protocol = FTP, SFTP, FTPS, or FTPES; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. |
||||||||||
|
FTP Credentials |
Login credentials that the Agent will use to access the FTP or SFTP server machine. If the File Transfer server and Agent are running on the same machine, enter the same credentials as those you entered in the Credentials field. |
||||||||||
|
FTP Credentials Variable |
Indication of whether the FTP Credentials field is a reference field for selecting a specific /wiki/spaces/UC71x/pages/5178443 (unchecked) or a text field for specifying the FTP Credentials as a variable (checked). Use the format: The variable must be a supported type as described in /wiki/spaces/UC71x/pages/5177616. Note When updating multiple Tasks, to change from using an FTP Credentials reference to using an FTP Credentials variable, you must change the FTP Credentials Variable field to Yes and specify the FTP Credentials variable in the FTP Credentials Unresolved field. Conversely, to change from using an FTP Credentials variable to using an FTP Credentials reference, you must change the FTP Credentials Variable field to No and specify the FTP Credentials reference in the FTP Credentials field. |
||||||||||
|
Local Filename |
Required if Transfer Type = FTP, SFTP, FTPS, or FTPES; Path and file name on the local server. That is, the "transfer from" file name. |
||||||||||
|
Use Regular Expression |
Enables the use of a regular expression in the Local Filename field. |
||||||||||
|
Remote Filename |
Required if Transfer Type = FTP, SFTP, FTPS, or FTPES; Path and file name on the remote server. That is, the "transfer to" file name. |
||||||||||
|
Move |
If Transfer Protocol = FTP, SFTP, FTPS, or FTPES, and Command = GET, MGET, PUT, or MPUT; Modifies the behavior of GET/MGET and PUT/MPUT by deleting the source file(s) after being transferred to the destination. |
||||||||||
|
Retry Options |
This section contains specifications for retrying the task. |
||||||||||
|
Maximum Retries |
User-defined; maximum number of times that the Controller should retry this task after it has started and gone to a failed state. |
||||||||||
|
Retry Indefinitely |
User-defined; indicates whether the Controller should continue trying indefinitely to run this task. If you enable this field, it overrides any value placed in the Maximum Retries field. |
||||||||||
|
Retry Interval (Seconds) |
User-defined; number of seconds between each retry. |
||||||||||
|
Suppress Intermediate Failures |
User-defined; If the task instance is in the Failed status, indicates whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:
|
||||||||||
|
Wait / Delay Options |
This section contains specifications for waiting to start and/or delaying on start the task. |
||||||||||
|
Wait To Start |
Amount of time to wait before starting a task from the time that it was launched.
|
||||||||||
|
Wait Time |
If Wait To Start = Time or Relative Time; Time of day (in 24-hour time) to wait until before starting the task. |
||||||||||
|
Wait Day Constraint |
If Wait To Start = Time or Relative Time; Specification for whether or not to advance the wait time to another day. Valid values:
Default is – None --. |
||||||||||
|
Wait Duration |
If Wait To Start = Duration; Number of days, hours, minutes, and seconds to wait before starting the task. |
||||||||||
|
Wait Duration In Seconds |
If Wait To Start = Seconds; Number of seconds to wait before starting the task. |
||||||||||
|
Delay On Start |
Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.
|
||||||||||
|
Delay Duration |
If Delay On Start = Duration; Number of days, hours, minutes, and seconds to delay after starting the task. |
||||||||||
|
Delay Duration In Seconds |
If Delay On Start = Seconds; Number of seconds to delay after starting the task. |
||||||||||
|
Workflow Only |
Specification for whether or not to apply the Wait To Start and Delay On Start specifications only if the task is in a Workflow.
|
||||||||||
|
Time Options |
This section contains time-related specifications for the task. |
||||||||||
|
Late Start |
If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time. The Started Late field displays in the task instance Details only if the user specified a Late Start in the task Details. |
||||||||||
|
Late Start Type |
Required if Late Start is enabled. Options:
|
||||||||||
|
Late Start Time |
If Late Start Type = Time; Time after which the task start time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Start Day Constraint |
If Late Start Type = Time; Specification for whether or not to advance the late start time to another day.
Default is – None --. |
||||||||||
|
Late Start Nth Amount |
If Late Start Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Start Duration |
If Late Start Type = Duration; Duration (amount of relative time) after which the task is considered to have started late. For a task within a workflow, the duration is the period between the time the workflow starts and the time the task itself starts. For example, a task might have a Late Start Duration of 60 minutes. If the workflow starts at 9:00 a.m. but the task itself does not start until 10:30, the task has started late. For a task that is not within a workflow, Late Start Duration has meaning only if the task has been held upon starting. For example, if a task has a Late Start Duration of 60 minutes and the Hold on Start field is enabled, if the task is not released from hold within the amount of time specified in the Late Start Duration field, the task has started late. |
||||||||||
|
Late Finish |
If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. This field only appears on the task instance if the user specified a Late Finish in the task definition. |
||||||||||
|
Late Finish Type |
Required if Late Finish is enabled. Options:
|
||||||||||
|
Late Finish Offset Type |
|
||||||||||
|
Late Finish Percentage Offset ( + ) |
Required if Late Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset ( + ) |
Required if Late Finish Offset Type = Duration; Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset Unit |
|
||||||||||
|
Late Finish Time |
If Late Finish Type = Time; Time after which the task finish time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Finish Day Constraint |
If Late Finish Type = Time; Specification for whether or not to advance the late finish time to another day.
Default is – None --. |
||||||||||
|
Late Finish Nth Amount |
If Late Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Finish Duration |
If Late Finish Type = Duration; Longest amount of time this task instance should take to run. |
||||||||||
|
Early Finish |
If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. This field only appears on the task instance if the user added Early Finish specifications to the task definition. |
||||||||||
|
Early Finish Type |
Required if Early Finish is enabled. Options:
|
||||||||||
|
Early Finish Offset Type |
|
||||||||||
|
Early Finish Percentage Offset ( - ) |
Required if Early Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset ( - ) |
Required if Early Finish Offset Type = Duration; Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset Unit |
|
||||||||||
|
Early Finish Time |
If Early Finish Type = Time; Time before which the task finish time is considered early. That is, enter a time at which the task should still be running. Use HH:MM, 24-hour time. |
||||||||||
|
Early Finish Day Constraint |
If Early Finish Type = Time; Specification for whether or not to advance the early finish time to another day.
Default is – None --. |
||||||||||
|
Early Finish Nth Amount |
If Early Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Early Finish Duration |
If Early Finish Type = Duration; Shortest amount of time this task instance should take to run. |
||||||||||
|
User Estimated Duration |
Required if Early Finish Type or Late Finish Type = Average Duration; Estimated amount of time it should normally take to run this task. The Controller uses this information to calculate the User Estimated End Time on a task instance record. User Estimated Duration is used when the Average Duration is not available; for example, on the first launch of a task. |
||||||||||
|
Critical Path Options |
This section contains Critical Path-related specifications for the task. |
||||||||||
|
CP Duration |
Optional; Allows you to override the estimated Critical Path Duration of the task when running in a Workflow; used in conjunction with the CP Duration Unit field. In most cases, this field should be left blank, which implies that the Controller will estimate the Critical Path Duration based on historical executions. Valid values are any integer equal to or greater than 0. Variables and Functions are supported. |
||||||||||
|
CP Duration (Resolved) |
Displays the current resolved value of the CP Duration field, which may contain variables or functions that will be displayed as unresolved until the task instance starts. The CP Duration (Resolved) field can continue to change value until the task instance starts, at which time CP Duration will display as resolved and CP Duration (Resolved) will no longer be visible unless there was an issue resolving the variables and/or functions contained within CP Duration. If the Controller is unable to resolve CP Duration or it resolves to an invalid value, CP Duration will be ignored and the Controller will estimate the Critical Path Duration based on historical executions. |
||||||||||
|
CP Duration Unit |
Type of CP Duration; used in conjunction with the CP Duration field. For example, for a CP Duration of two minutes, specify 2 in the CP Duration field and select Minutes in this field. Options:
Default is Minutes. |
||||||||||
|
Workflow Execution Options |
This section contains Execution Restriction specifications for the task if it is within a Workflow. |
||||||||||
|
Execution Restriction |
Specification for whether or not there is a restriction for this task to be run, skipped, or held. Options are:
If Execution Restriction on a task is Run or Skip, then when it is part of a Workflow that is being launched, the Restriction Period is evaluated. The task instance will be skipped if Execution Restriction is Skip and the date is within the Restriction Period or Execution Restriction is Run and the date is not within the Restriction Period. Execution Restriction can be set to Skip with a Restriction Period of - None -, meaning the restriction is always active and the task will be skipped when it is part of a Workflow. |
||||||||||
|
Restriction Period |
If Execution Restriction = Run, Skip, or Hold; Period of time when the task is restricted. Options are:
|
||||||||||
|
Before Date |
If Restriction Period = Before or Span; Date before which the restriction is valid. |
||||||||||
|
Before Time |
If Restriction Period = Before or Span; Time on the selected date before which the restriction is valid. |
||||||||||
|
After Date |
If Restriction Period = After or Span; Date after which the restriction is valid. |
||||||||||
|
After Time |
If Restriction Period = After or Span; Time on the selected date after which the restriction is valid. |
||||||||||
|
Date List |
If Restriction Period = On; Date(s) on which the restriction is valid. |
||||||||||
|
Statistics |
This section contains time-related statistics for task instances of the task. |
||||||||||
| First Execution |
System-supplied; End Time of the first instance of this task to complete. |
||||||||||
|
Last Execution |
System-supplied; End Time of the last instance of this task to complete. |
||||||||||
|
Last Instance Duration |
System-supplied; Amount of time the task took to run the last time it ran. |
||||||||||
|
Lowest Instance Time |
System-supplied; Lowest amount of time this task has taken to run. |
||||||||||
|
Average Instance Time |
System-supplied; Average amount of time this task takes to run. |
||||||||||
|
Highest Instance Time |
System-supplied; Highest amount of time this task has taken to run. |
||||||||||
|
Number of Instances |
System-supplied; Number of instances in the database for this task. |
||||||||||
|
Metadata |
This section contains Metadata information about this record. |
||||||||||
|
UUID |
Universally Unique Identifier of this record. |
||||||||||
|
Updated By |
Name of the user that last updated this record. |
||||||||||
|
Updated |
Date and time that this record was last updated. |
||||||||||
|
Created By |
Name of the user that created this record. |
||||||||||
|
Created |
Date and time that this record was created. |
||||||||||
|
Buttons |
This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |
||||||||||
|
Save |
Saves a new task record in the Controller database. |
||||||||||
|
Save & New |
Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
||||||||||
|
Save & View |
Saves a new record in the Controller database and continues to display that record. |
||||||||||
|
New |
Displays empty (except for default values) Details for creating a new task. |
||||||||||
|
Update |
Saves updates to the record. |
||||||||||
|
Launch Task |
|
||||||||||
|
View Parents |
Displays a list of any parent Workflow tasks for this task. |
||||||||||
|
Copy |
Creates a copy of this task, which you are prompted to rename. |
||||||||||
|
Delete |
Deletes the current record. Note You cannot delete a task if it is either:
|
||||||||||
|
Refresh |
Refreshes any dynamic data displayed in the Details. |
||||||||||
|
Close |
For pop-up view only; closes the pop-up view of this task. |
||||||||||
|
Tabs |
This section identifies the tabs across the top of the Task Details that provide access to additional information about the task. |
||||||||||
|
Variables |
|
||||||||||
|
Actions |
Allows you to specify actions that the Controller will take automatically based on events that occur during the execution of this task. Events are:
Actions are:
|
||||||||||
|
Virtual Resources |
|
||||||||||
|
Mutually Exclusive |
|
||||||||||
|
Instances |
Lists all instances of the task. |
||||||||||
|
Triggers |
List of all triggers that reference this task in the Task(s) field of the trigger Details; that is, a list of all triggers that have been defined to launch this task. Also allows you to add new triggers. If you add a new trigger from this location, the Controller automatically constructs a default trigger name as follows: <current task name>#TRIGGER#. You can change the default name if desired. For instructions on creating triggers, see Triggers. |
||||||||||
|
Notes |
|
||||||||||
|
Versions |
|
UDM File Transfer Task Details
The following UDM File Transfer Task Details is for an existing UDM File Transfer task.
Depending on the values that you enter / select for these fields, and whether or not the UDM File Transfer task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the UDM File Transfer Task Details.
UDM File Transfer Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in UDM File Transfer Task Details.
|
Field Name |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
General |
This section contains general information about the task. |
||||||||||
|
Name |
User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks. |
||||||||||
|
Version |
System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning. |
||||||||||
|
Description |
Description of this record. Maximum length is 255 characters. |
||||||||||
|
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
||||||||||
|
Resolve Name Immediately |
If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time. |
||||||||||
|
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
||||||||||
|
Hold on Start |
If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. |
||||||||||
|
Hold Reason |
Information about why the task will be put on hold when it starts. |
||||||||||
|
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
||||||||||
|
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
||||||||||
| Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
||||||||||
| Simulate | Specifies if the instance should execute under simulation mode. |
||||||||||
|
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
||||||||||
|
Cluster |
Indication that selecting a Utility Agent Cluster is required. If Cluster is selected, selecting a Utility Agent is not required unless Utility Agent Variable is selected. |
||||||||||
|
Utility Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify a Utility Agent, you must specify a Utility Agent Cluster or Utility Cluster Broadcast. |
||||||||||
|
Utility Agent Variable |
If enabled, the Utility Agent field converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format:
The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Utility Agent reference to using a Utility Agent variable, you must change the Utility Agent Variable field to Yes and specify the Utility Agent variable in the Utility Agent Unresolved field. Conversely, to change from using a Utility Agent variable to using a Utility Agent reference, you must change the Utility Agent Variable field to No and specify the Utility Agent reference in the Utility Agent field. |
||||||||||
|
Utility Agent Cluster |
If Cluster is selected; Group of Agents, one of which the Controller will choose to run this task. You can specify a Utility Agent Cluster in addition to or in place of a specific Utility Agent. If you specify a Utility Agent and a Utility Agent Cluster, the Controller first tries to run the task on the specific Utility Agent. If the Utility Agent is not available, the Controller reverts to the Utility Agent Cluster. See Agent Clusters for more information. |
||||||||||
|
Utility Agent Cluster Variable |
Indication of whether the Utility Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Utility Agent Cluster as a variable (checked). Use the format:
The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Utility Agent Cluster reference to using a Utility Agent Cluster variable, you must change the Utility Agent Cluster Variable field to Yes and specify the Utility Agent Cluster variable in the Utility Agent Cluster Unresolved field. Conversely, to change from using a Utility Agent Cluster variable to using a Utility Agent Cluster reference, you must change the Utility Agent Cluster Variable field to No and specify the Utility Agent Cluster reference in the Utility Agent Cluster field. |
||||||||||
|
Broadcast |
Displays only if Cluster is selected; Indication that selecting a Cluster Broadcast is required. Selecting Broadcast hides the Agent and Agent Cluster fields; you cannot select values for them. |
||||||||||
|
Utility Cluster Broadcast |
Group of Agents, all of which will run this task (compare with Utility Agent Cluster). You can specify a Utility Cluster Broadcast in place of a specific Utility Agent and/or Utility Agent Cluster. Each instance of the task running on its own Utility Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor. |
||||||||||
|
Utility Cluster Broadcast Variable |
Indication of whether the Utility Cluster Broadcast field is a reference field for selecting a specific Utility Cluster Broadcast (unchecked) or a text field for specifying the Utility Cluster Broadcast as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Utility Cluster Broadcast reference to using a Utility Cluster Broadcast variable, you must change the Utility Cluster Broadcast Variable field to Yes and specify the Utility Cluster Broadcast variable in the Utility Cluster Broadcast Unresolved field. Conversely, to change from using a Utility Cluster Broadcast variable to using a Utility Cluster Broadcast reference, you must change the Utility Cluster Broadcast Variable field to No and specify the Utility Cluster Broadcast reference in the *Utility Cluster Broadcast * field. |
||||||||||
|
Utility Credentials |
Required if the Agent Credentials Required Universal Controller system property is true. |
||||||||||
|
Utility Credentials Variable |
Indication of whether the Utility Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Utility Credentials as a variable (checked). Use the format: Note When updating multiple Tasks, to change from using a Utility Credentials reference to using a Utility Credentials variable, you must change the Utility Credentials Variable field to Yes and specify the Utility Credentials variable in the Utility Credentials Unresolved field. Conversely, to change from using a Utility Credentials variable to using a Utility Credentials reference, you must change the Utility Credentials Variable field to No and specify the Utility Credentials reference in the Utility Credentials field. |
||||||||||
|
File Transfer Details |
This section contains assorted detailed information about the task. |
||||||||||
|
Transfer Protocol |
Type of transfer protocol for this file transfer. Options:
|
||||||||||
|
Primary UDM Agent Option |
Type of definition to use for the Primary UDM Agent selection. Options:
If Form or Script = Form; Default is Utility Agent. If Form or Script = Script; Default is -- None -- . |
||||||||||
|
Secondary UDM Agent Option |
Type of definition to use for the Secondary UDM Agent selection. Options:
If Form or Script = Form; Default is UDM Agent. If Form or Script = Script; Default is -- None -- . |
||||||||||
|
Primary UDM Agent |
If Primary UDM Agent Option is not Utility Agent or --None--; Agent to use as the Primary UDM Agent. |
||||||||||
|
Secondary UDM Agent |
If Secondary UDM Agent Option is not --None-- ; Agent to use as the Secondary UDM Agent. |
||||||||||
|
Primary UDM Agent Variable |
If Primary UDM Agent Option is UDM Agent or UDM Agent Cluster; Allows the Primary UDM Agent field to accept a variable. |
||||||||||
|
Secondary UDM Agent Variable |
If Secondary UDM Agent Option is UDM Agent or UDM Agent Cluster; Allows the Secondary UDM Agent field to accept a variable. |
||||||||||
|
Primary UDM Agent Cluster |
If Primary UDM Agent Option is UDM Agent Cluster; Agent Cluster to use for the Primary UDM Agent. |
||||||||||
|
Primary UDM Agent Cluster Variable |
If Primary UDM Agent Option is UDM Agent Cluster; Allows the Primary UDM Agent Cluster field to accept a variable. |
||||||||||
|
Secondary UDM Agent Cluster |
If Secondary UDM Agent Option is UDM Agent Cluster; Agent Cluster to use for the Secondary UDM Agent. |
||||||||||
|
Secondary UDM Agent Cluster Variable |
If Secondary UDM Agent Option is UDM Agent Cluster; Allows the Secondary UDM Agent Cluster field to accept a variable. |
||||||||||
|
Primary Credentials |
If Primary UDM Agent Option is not Utility Agent; Credentials for the Primary UDM Agent; Select existing Credentials from the drop-down list or click the Credentials Details icon to create new Details. |
||||||||||
|
Secondary Credentials |
Credentials for the Secondary UDM Agent; Select existing Credentials from the drop-down list or click the Credentials Details icon to create new Details. |
||||||||||
|
Primary Credentials Variable |
Indication of whether the Primary Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Primary Credentials as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Primary Credentials reference to using a Primary Credentials variable, you must change the Primary Credentials Variable field to Yes and specify the Primary Credentials variable in the Primary Credentials Unresolved field. Conversely, to change from using a Primary Credentials variable to using a Primary Credentials reference, you must change the Primary Credentials Variable field to No and specify the Primary Credentials reference in the Primary Credentials field. |
||||||||||
|
Secondary Credentials Variable |
Indication of whether the Secondary Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Secondary Credentials as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Secondary Credentials reference to using a Secondary Credentials variable, you must change the Secondary Credentials Variable field to Yes and specify the Secondary Credentials variable in the Secondary Credentials Unresolved field. Conversely, to change from using a Secondary Credentials variable to using a Secondary Credentials reference, you must change the Secondary Credentials Variable field to No and specify the Secondary Credentials reference in the Secondary Credentials field. |
||||||||||
|
Form or Script |
Form or Script for this UDM File Transfer to use. Default is Form. |
||||||||||
|
Transfer Type |
Type of data transfer. Options:
|
||||||||||
|
UDM Operation |
If Form or Script is Form; UDM Operation to be executed. Options:
Default is Copy. |
||||||||||
|
Transfer Direction |
If Form or Script = Form and UDM Operation = Copy, Move, or Copy Directory; Direction of the transfer between the Primary and Secondary UDM Agents. Options:
Default is PUT. |
||||||||||
|
Primary File(s) |
File(s) on the Primary UDM Agent.
|
||||||||||
|
Secondary File(s) |
File(s) on the Secondary UDM Agent.
|
||||||||||
|
Use Regular Expression |
If UDM Operation is Copy, Move, Delete, or List; Allows the use of a regular expression when specifying file(s). Note If UDM Operation = Copy or Move:
If UDM Operation = Delete or List:
|
||||||||||
|
Codepage |
Options: |
||||||||||
|
Compress |
The type of data compression used in the transfer, if any. Options:
|
||||||||||
|
Encrypt |
The method of encryption that the Controller will use in the transfer. Options:
|
||||||||||
|
Destination File Creation Option |
If UDM Operation is Copy, Move, or Copy Directory; Specifies whether the transferred file should be created (new), appended, or replace any existing file. Options:
|
||||||||||
|
Runtime Directory |
|
||||||||||
| Advanced UDM Options |
Additional UDM Options. |
||||||||||
|
Trim Trailing Spaces |
If Form or Script is Form and Advanced UDM Options is selected; If enabled, specifies that the Controller should trim trailing spaces from lines on a text transfer. |
||||||||||
|
Network Fault Tolerant |
If Form or Script is Form and Advanced UDM Options is selected; Enable if the session is network fault tolerant. |
||||||||||
|
Show Progress |
If Form or Script is Form, UDM Operation is Copy, Move, or Copy Directory, and Advanced UDM Options is selected; Shows periodic file transfer progress messages in the UDM transfer output. |
||||||||||
|
Primary File System |
If Form or Script is Form and Advanced UDM Options is selected; Primary file system (applies to IBM System z and System i) Options:
|
||||||||||
|
Secondary File System |
If Form or Script is Form and Advanced UDM Options is selected; Secondary file system (applies to IBM System z and System i). Options:
|
||||||||||
|
Append Primary Open Options |
If Form or Script is Form and Advanced UDM Options is selected; Additional UDM open command options for the Primary UDM Agent. |
||||||||||
|
Append Secondary Open Option |
If Form or Script is Form and Advanced UDM Options is selected; Additional UDM open command options for the Secondary UDM Agent. |
||||||||||
|
Append UDM Options |
If Advanced UDM Options is selected; Any additional free-form Universal Data Mover command options. |
||||||||||
| Result Processing Details | This section contains assorted detailed information about result processing for this task. | ||||||||||
|
Exit Code Processing |
Specifies how the Controller should determine whether the executed command failed or completed successfully. Options:
|
||||||||||
|
Output Type-Exit Code |
Required if Exit Code Processing = Success Output Contains or Failure Output Contains; type of output. Options:
|
||||||||||
|
Exit Codes |
Required if Exit Code Processing = Success Exitcode Range or Failure Exitcode Range; range of exit codes. Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. Variables are supported. |
||||||||||
|
Scan Output For |
Required if Exit Code Processing = Success Output Contains or Failure Output Contains; text for which the Controller should scan the output file. The Controller will process this field as a regular expression. |
||||||||||
|
Output File-Exit Codes |
Required if Output Type = File; path and file name of the output file that should be scanned for the text in the Scan Output For field. |
||||||||||
|
Retry Options |
This section contains specifications for retrying the task. |
||||||||||
|
Retry Exit Codes |
Exit code range for which an auto-retry of tasks in FAILED status will occur. Exit code ranges must be in the same format as ranges specified in the Exit Codes field. Maximum Retries must be greater than 0. If this field is empty, any exit code potentially will cause a retry. Variables are supported. |
||||||||||
|
Maximum Retries |
User-defined; maximum number of times that the Controller should retry this task after it has started and gone to a failed state. |
||||||||||
|
Retry Indefinitely |
User-defined; indicates whether the Controller should continue trying indefinitely to run this task. If you enable this field, it overrides any value placed in the Maximum Retries field. |
||||||||||
|
Retry Interval (Seconds) |
User-defined; number of seconds between each retry. |
||||||||||
|
Suppress Intermediate Failures |
User-defined; If the task instance is in the Failed status, indicates whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:
|
||||||||||
|
Wait / Delay Options |
This section contains specifications for waiting to start and/or delaying on start the task. |
||||||||||
|
Wait To Start |
Amount of time to wait before starting a task from the time that it was launched.
|
||||||||||
|
Wait Time |
If Wait To Start = Time or Relative Time; Time of day (in 24-hour time) to wait until before starting the task. |
||||||||||
|
Wait Day Constraint |
If Wait To Start = Time or Relative Time; Specification for whether or not to advance the wait time to another day. Valid values:
Default is – None --. |
||||||||||
|
Wait Duration |
If Wait To Start = Duration; Number of days, hours, minutes, and seconds to wait before starting the task. |
||||||||||
|
Wait Duration In Seconds |
If Wait To Start = Seconds; Number of seconds to wait before starting the task. |
||||||||||
|
Delay On Start |
Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.
|
||||||||||
|
Delay Duration |
If Delay On Start = Duration; Number of days, hours, minutes, and seconds to delay after starting the task. |
||||||||||
|
Delay Duration In Seconds |
If Delay On Start = Seconds; Number of seconds to delay after starting the task. |
||||||||||
|
Workflow Only |
Specification for whether or not to apply the Wait To Start and Delay On Start specifications only if the task is in a Workflow.
|
||||||||||
|
Time Options |
This section contains time-related specifications for the task. |
||||||||||
|
Late Start |
If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time. The Started Late field displays in the task instance Details only if the user specified a Late Start in the task Details. |
||||||||||
|
Late Start Type |
Required if Late Start is enabled. Options:
|
||||||||||
|
Late Start Time |
If Late Start Type = Time; Time after which the task start time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Start Day Constraint |
If Late Start Type = Time; Specification for whether or not to advance the late start time to another day.
Default is – None --. |
||||||||||
|
Late Start Nth Amount |
If Late Start Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Start Duration |
If Late Start Type = Duration; Duration (amount of relative time) after which the task is considered to have started late. For a task within a workflow, the duration is the period between the time the workflow starts and the time the task itself starts. For example, a task might have a Late Start Duration of 60 minutes. If the workflow starts at 9:00 a.m. but the task itself does not start until 10:30, the task has started late. For a task that is not within a workflow, Late Start Duration has meaning only if the task has been held upon starting. For example, if a task has a Late Start Duration of 60 minutes and the Hold on Start field is enabled, if the task is not released from hold within the amount of time specified in the Late Start Duration field, the task has started late. |
||||||||||
|
Late Finish |
If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. This field only appears on the task instance if the user specified a Late Finish in the task definition. |
||||||||||
|
Late Finish Type |
Required if Late Finish is enabled. Options:
|
||||||||||
|
Late Finish Offset Type |
|
||||||||||
|
Late Finish Percentage Offset ( + ) |
Required if Late Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset ( + ) |
Required if Late Finish Offset Type = Duration; Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset Unit |
|
||||||||||
|
Late Finish Time |
If Late Finish Type = Time; Time after which the task finish time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Finish Day Constraint |
If Late Finish Type = Time; Specification for whether or not to advance the late finish time to another day.
Default is – None --. |
||||||||||
|
Late Finish Nth Amount |
If Late Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Finish Duration |
If Late Finish Type = Duration; Longest amount of time this task instance should take to run. |
||||||||||
|
Early Finish |
If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. This field only appears on the task instance if the user added Early Finish specifications to the task definition. |
||||||||||
|
Early Finish Type |
Required if Early Finish is enabled. Options:
|
||||||||||
|
Early Finish Offset Type |
|
||||||||||
|
Early Finish Percentage Offset ( - ) |
Required if Early Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset ( - ) |
Required if Early Finish Offset Type = Duration; Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset Unit |
|
||||||||||
|
Early Finish Time |
If Early Finish Type = Time; Time before which the task finish time is considered early. That is, enter a time at which the task should still be running. Use HH:MM, 24-hour time. |
||||||||||
|
Early Finish Day Constraint |
If Early Finish Type = Time; Specification for whether or not to advance the early finish time to another day.
Default is – None --. |
||||||||||
|
Early Finish Nth Amount |
If Early Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Early Finish Duration |
If Early Finish Type = Duration; Shortest amount of time this task instance should take to run. |
||||||||||
|
User Estimated Duration |
Required if Early Finish Type or Late Finish Type = Average Duration; Estimated amount of time it should normally take to run this task. The Controller uses this information to calculate the User Estimated End Time on a task instance record. User Estimated Duration is used when the Average Duration is not available; for example, on the first launch of a task. |
||||||||||
|
Critical Path Options |
This section contains Critical Path-related specifications for the task. |
||||||||||
|
CP Duration |
Optional; Allows you to override the estimated Critical Path Duration of the task when running in a Workflow; used in conjunction with the CP Duration Unit field. In most cases, this field should be left blank, which implies that the Controller will estimate the Critical Path Duration based on historical executions. Valid values are any integer equal to or greater than 0. Variables and Functions are supported. |
||||||||||
|
CP Duration (Resolved) |
Displays the current resolved value of the CP Duration field, which may contain variables or functions that will be displayed as unresolved until the task instance starts. The CP Duration (Resolved) field can continue to change value until the task instance starts, at which time CP Duration will display as resolved and CP Duration (Resolved) will no longer be visible unless there was an issue resolving the variables and/or functions contained within CP Duration. If the Controller is unable to resolve CP Duration or it resolves to an invalid value, CP Duration will be ignored and the Controller will estimate the Critical Path Duration based on historical executions. |
||||||||||
|
CP Duration Unit |
Type of CP Duration; used in conjunction with the CP Duration field. For example, for a CP Duration of two minutes, specify 2 in the CP Duration field and select Minutes in this field. Options:
Default is Minutes. |
||||||||||
|
Workflow Execution Options |
This section contains Execution Restriction specifications for the task if it is within a Workflow. |
||||||||||
|
Execution Restriction |
Specification for whether or not there is a restriction for this task to be run, skipped, or held. Options are:
If Execution Restriction on a task is Run or Skip, then when it is part of a Workflow that is being launched, the Restriction Period is evaluated. The task instance will be skipped if Execution Restriction is Skip and the date is within the Restriction Period or Execution Restriction is Run and the date is not within the Restriction Period. Execution Restriction can be set to Skip with a Restriction Period of - None -, meaning the restriction is always active and the task will be skipped when it is part of a Workflow. |
||||||||||
|
Restriction Period |
If Execution Restriction = Run, Skip, or Hold; Period of time when the task is restricted. Options are:
|
||||||||||
|
Before Date |
If Restriction Period = Before or Span; Date before which the restriction is valid. |
||||||||||
|
Before Time |
If Restriction Period = Before or Span; Time on the selected date before which the restriction is valid. |
||||||||||
|
After Date |
If Restriction Period = After or Span; Date after which the restriction is valid. |
||||||||||
|
After Time |
If Restriction Period = After or Span; Time on the selected date after which the restriction is valid. |
||||||||||
|
Date List |
If Restriction Period = On; Date(s) on which the restriction is valid. |
||||||||||
|
Statistics |
This section contains time-related statistics for task instances of the task. |
||||||||||
| First Execution |
System-supplied; End Time of the first instance of this task to complete. |
||||||||||
|
Last Execution |
System-supplied; End Time of the last instance of this task to complete. |
||||||||||
|
Last Instance Duration |
System-supplied; Amount of time the task took to run the last time it ran. |
||||||||||
|
Lowest Instance Time |
System-supplied; Lowest amount of time this task has taken to run. |
||||||||||
|
Average Instance Time |
System-supplied; Average amount of time this task takes to run. |
||||||||||
|
Highest Instance Time |
System-supplied; Highest amount of time this task has taken to run. |
||||||||||
|
Number of Instances |
System-supplied; Number of instances in the database for this task. |
||||||||||
|
Metadata |
This section contains Metadata information about this record. |
||||||||||
|
UUID |
Universally Unique Identifier of this record. |
||||||||||
|
Updated By |
Name of the user that last updated this record. |
||||||||||
|
Updated |
Date and time that this record was last updated. |
||||||||||
|
Created By |
Name of the user that created this record. |
||||||||||
|
Created |
Date and time that this record was created. |
||||||||||
|
Status History |
History of all statuses that the task instance has gone through. |
||||||||||
|
Buttons |
This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |
||||||||||
|
Save |
Saves a new task record in the Controller database. |
||||||||||
|
Save & New |
Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
||||||||||
|
Save & View |
Saves a new record in the Controller database and continues to display that record. |
||||||||||
|
New |
Displays empty (except for default values) Details for creating a new task. |
||||||||||
|
Update |
Saves updates to the record. |
||||||||||
|
Launch Task |
|
||||||||||
|
View Parents |
Displays a list of any parent Workflow tasks for this task. |
||||||||||
|
Copy |
Creates a copy of this task, which you are prompted to rename. |
||||||||||
|
Delete |
Deletes the current record. Note You cannot delete a task if it is either:
|
||||||||||
|
Refresh |
Refreshes any dynamic data displayed in the Details. |
||||||||||
|
Close |
For pop-up view only; closes the pop-up view of this task. |
||||||||||
|
Tabs |
This section identifies the tabs across the top of the Task Details that provide access to additional information about the task. |
||||||||||
|
Variables |
|
||||||||||
|
Actions |
Allows you to specify actions that the Controller will take automatically based on events that occur during the execution of this task. Events are:
Actions are:
|
||||||||||
|
Virtual Resources |
|
||||||||||
|
Mutually Exclusive |
|
||||||||||
|
Instances |
Lists all instances of the task. |
||||||||||
|
Triggers |
List of all triggers that reference this task in the Task(s) field of the trigger Details; that is, a list of all triggers that have been defined to launch this task. Also allows you to add new triggers. If you add a new trigger from this location, the Controller automatically constructs a default trigger name as follows: <current task name>#TRIGGER#. You can change the default name if desired. For instructions on creating triggers, see Triggers. |
||||||||||
|
Notes |
|
||||||||||
|
Versions |
|
Viewing a File Transfer Task Instance
When a File Transfer task is launched, the Controller creates a task instance record of that task.
A task instance contains detailed information about a single execution of that task.
You can access a task instance from:
- Instances tab on the FTP/SFTP/FTPS/FTPES or UDM File Transfer Task Details for that task
- Activity Monitor
- Task Instances list
FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details
The following FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details contains information on the execution of the task shown in the FTP/SFTP/FTPS/FTPES File Transfer Task Details.
FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in FTP/SFTP/FTPS/FTPES File Transfer Task Instance Details.
|
Field Name |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
General |
This section contains general information about the task instance. |
||||||||||
|
Instance Name |
Name of this task instance. |
||||||||||
|
Instance Number |
System-supplied; Sequentially assigned number, maintained per task, representing the creation order of the instance. |
||||||||||
|
Description |
Description of this record. Maximum length is 255 characters. |
||||||||||
|
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
||||||||||
|
Task |
Name of the task that was run to create this task instance. Click the icon to display Task Details for the task. |
||||||||||
| Source Version |
Version of the task that was run to create this task instance. |
||||||||||
|
Launch Source |
System-supplied; Source from which this task was launched. Options:
|
||||||||||
|
Source Instance |
System-supplied; UUID of the source instance.
|
||||||||||
|
Invoked by |
System-supplied; how the task instance was launched. Options:
|
||||||||||
|
Execution User |
System-supplied; If the task was launched manually; ID of the user who launched it. |
||||||||||
|
Calendar |
Calendar associated with the task instance. |
||||||||||
|
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
||||||||||
|
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
||||||||||
|
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
||||||||||
| Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
||||||||||
|
Status |
This section contains information about the current status of the task instance. |
||||||||||
|
Status |
|
||||||||||
|
Exit Code |
System-supplied; the exit code captured by the Agent when executing the task (for example, a command or script). |
||||||||||
|
Status Description |
System-supplied; additional information, if any, about the status of the task instance. |
||||||||||
|
Operational Memo |
User-defined operational memo. |
||||||||||
|
Evaluation Time |
If time zone of user is different than time zone of task instance; Time at which Execution Restrictions and Run Criteria were evaluated based upon the requested time zone. (Time zone of task instance displays in parentheses.) |
||||||||||
|
Critical |
Indicates that this task is in the Critical Path of a workflow. |
||||||||||
| Critical Endpoint |
Indicates that this task was defined as a Critical Endpoint of a Critical Path in a workflow. |
||||||||||
|
Wait Until Time |
Amount of time calculated to wait before the task was started, based on Wait To Start and Delay On Start times. |
||||||||||
|
Queued Time |
System-supplied; Date and time the task was queued for processing. |
||||||||||
|
Trigger Time |
System-supplied; Date and time the task instance was triggered. |
||||||||||
|
Launch Time |
System-supplied; Date and time the task instance was launched. |
||||||||||
|
Start Time |
System-supplied; Date and time the task instance started. |
||||||||||
|
End Time |
System-supplied; Date and time the task instance completed. |
||||||||||
|
Duration |
System-supplied; amount of time the task instance took to run. |
||||||||||
|
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
||||||||||
|
Cluster |
Indication that selecting an Agent Cluster is required and selecting Broadcast, which lets you select a Cluster Broadcast, is optional. If Cluster is selected, selecting an Agent is not required unless Agent Variable is selected. |
||||||||||
|
Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify an Agent, you must specify an Agent Cluster or Cluster Broadcast. |
||||||||||
|
Agent Variable |
Indication of whether the Agent field is a reference field for selecting a specific Agent (unchecked) or a text field for specifying the Agent as a variable (checked). Use the format: ${variable name}. The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent reference to using an Agent variable, you must change the Agent Variable field to Yes and specify the Agent variable in the Agent Unresolved field. Conversely, to change from using an Agent variable to using an Agent reference, you must change the Agent Variable field to No and specify the Agent reference in the Agent field. |
||||||||||
|
Agent Cluster |
If Cluster is selected and Broadcast is not selected; Group of Agents, one of which the Controller will choose to run this task (compare with Cluster Broadcast). You can specify an agent cluster in addition to or in place of a specific Agent. If you specify an Agent and an agent cluster, the Controller first tries to run the task on the specific agent. If the Agent is not available, the Controller reverts to the agent cluster. See Agent Clusters for more information. |
||||||||||
|
Agent Cluster Variable |
Indication of whether the Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Agent Cluster as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using an Agent Cluster reference to using an Agent Cluster variable, you must change the Agent Cluster Variable field to Yes and specify the Agent Cluster variable in the Agent Cluster Unresolved field. Conversely, to change from using an Agent Cluster variable to using an Agent Cluster reference, you must change the Agent Cluster Variable field to No and specify the Agent Cluster reference in the Agent Cluster field. |
||||||||||
|
Credentials |
Credentials under which an Agent runs this task. These Credentials override any Credentials provided in the Agent Details for any Agent running this task. If the user does not have a login shell, add a - character in front of the runtime credentials name. The Controller will provide a shell for that user and strip the - character from the name. Required if the Agent Credentials Required Universal Controller system property is true. When required, if the Credential is specified as a variable, and the variable resolves to blank, a Start Failure will occur. |
||||||||||
|
Credentials Variable |
Indication of whether the Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Credential as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Credentials reference to using a Credentials variable, you must change the Credentials Variable field to Yes and specify the Credentials variable in the Credentials Unresolved field. Conversely, to change from using a Credentials variable to using a Credentials reference, you must change the Credentials Variable field to No and specify the Credentials reference in the Credentials field. |
||||||||||
|
File Transfer Details |
This section contains assorted detailed information about the task instance. |
||||||||||
|
Transfer Protocol |
Type of transfer protocol for this file transfer. Options:
|
||||||||||
|
Command |
File Transfer command being executed. Options:
|
||||||||||
|
Job Card (z/OS only) |
For z/OS, the job card information for the JCL statement. Example:
|
||||||||||
|
Subcommands (z/OS only) |
For z/OS, any subcommands used in the JCL statement. |
||||||||||
| Verify Host Name |
If Transfer Protocol = FTPS or FTPES; Indication of whether to verify the DNS name or IP address of the FTP server's certificate against the host system. |
||||||||||
| Authenticate Peer |
If Transfer Protocol = FTPES; Indication of whether to use a CA certificate configured in the agent to authenticate the FTP server's certificate. |
||||||||||
|
Transfer Type |
Data format of the file being transferred. Options:
|
||||||||||
|
Transfer Mode |
|
||||||||||
|
Remote Server |
Required if Transfer Protocol = FTP, SFTP, FTPS, or FTPES; name or IP address of the File Transfer server. This machine may or may not be the same as the Agent machine. |
||||||||||
|
FTP Credentials |
Login credentials that the Agent will use to access the FTP or SFTP server machine. If the File Transfer server and Agent are running on the same machine, enter the same credentials as those you entered in the Credentials field. |
||||||||||
|
FTP Credentials Variable |
Indication of whether the FTP Credentials field is a reference field for selecting a specific /wiki/spaces/UC71x/pages/5178443 (unchecked) or a text field for specifying the FTP Credentials as a variable (checked). Use the format: The variable must be a supported type as described in /wiki/spaces/UC71x/pages/5177616. Note When updating multiple Tasks, to change from using an FTP Credentials reference to using an FTP Credentials variable, you must change the FTP Credentials Variable field to Yes and specify the FTP Credentials variable in the FTP Credentials Unresolved field. Conversely, to change from using an FTP Credentials variable to using an FTP Credentials reference, you must change the FTP Credentials Variable field to No and specify the FTP Credentials reference in the FTP Credentials field. |
||||||||||
|
Local Filename |
Required if Transfer Type = FTP, SFTP, FTPS, or FTPES; Path and file name on the local server. That is, the "transfer from" file name. |
||||||||||
|
Use Regular Expression |
Enables the use of a regular expression in the Local Filename field. |
||||||||||
|
Remote Filename |
Required if Transfer Type = FTP, SFTP, FTPS, or FTPES; Path and file name on the remote server. That is, the "transfer to" file name. |
||||||||||
|
Move |
If Transfer Protocol = FTP, SFTP, FTPS, or FTPES, and Command = GET, MGET, PUT, or MPUT; Modifies the behavior of GET/MGET and PUT/MPUT by deleting the source file(s) after being transferred to the destination. |
||||||||||
|
Retry Options |
This section contains specifications for retrying the task. |
||||||||||
|
Maximum Retries |
User-defined; maximum number of times that the Controller should retry this task after it has started and gone to a failed state. |
||||||||||
|
Retry Indefinitely |
User-defined; indicates whether the Controller should continue trying indefinitely to run this task. If you enable this field, it overrides any value placed in the Maximum Retries field. |
||||||||||
|
Retry Interval (Seconds) |
User-defined; number of seconds between each retry. |
||||||||||
|
Current Retry Count |
System-supplied; current number of times that the Controller has retried the task after it first went to failure status. |
||||||||||
|
Suppress Intermediate Failures |
User-defined; If the task instance is in the Failed status, indicates whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:
|
||||||||||
|
Next Retry Time |
System-supplied for a task instance in the Failed status that is scheduled for automatic retry; Next time that a retry will be made. If a task instance is not scheduled for automatic retry, Next Retry Time does not display in the task instance Details. |
||||||||||
|
Wait / Delay Options |
This section contains specifications for waiting to start and/or delaying on start the task. |
||||||||||
|
Wait To Start |
Amount of time to wait before starting a task from the time that it was launched.
|
||||||||||
|
Wait Time |
If Wait To Start = Time or Relative Time; Time of day (in 24-hour time) to wait until before starting the task. |
||||||||||
|
Wait Day Constraint |
If Wait To Start = Time or Relative Time; Specification for whether or not to advance the wait time to another day. Valid values:
Default is – None --. |
||||||||||
|
Wait Duration |
If Wait To Start = Duration; Number of days, hours, minutes, and seconds to wait before starting the task. |
||||||||||
|
Wait Duration In Seconds |
If Wait To Start = Seconds; Number of seconds to wait before starting the task. |
||||||||||
|
Delay On Start |
Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.
|
||||||||||
|
Delay Duration |
If Delay On Start = Duration; Number of days, hours, minutes, and seconds to delay after starting the task. |
||||||||||
|
Delay Duration In Seconds |
If Delay On Start = Seconds; Number of seconds to delay after starting the task. |
||||||||||
|
Time Options |
This section contains time-related statistics for the task instance. |
||||||||||
|
Late Start |
If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time. The Started Late field displays in the task instance Details only if the user specified a Late Start in the task Details. |
||||||||||
|
Started Late |
System-supplied; this field is flagged if the task started later than the time specified in the Late Start fields. |
||||||||||
|
Late Start Type |
Required if Late Start is enabled. Options:
|
||||||||||
|
Late Start Time |
If Late Start Type = Time; Time after which the task start time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Start Day Constraint |
If Late Start Type = Time; Specification for whether or not to advance the late start time to another day.
Default is – None --. |
||||||||||
|
Late Start Nth Amount |
If Late Start Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Start Duration |
If Late Start Type = Duration; Duration (amount of relative time) after which the task is considered to have started late. For a task within a workflow, the duration is the period between the time the workflow starts and the time the task itself starts. For example, a task might have a Late Start Duration of 60 minutes. If the workflow starts at 9:00 a.m. but the task itself does not start until 10:30, the task has started late. For a task that is not within a workflow, Late Start Duration has meaning only if the task has been held upon starting. For example, if a task has a Late Start Duration of 60 minutes and the Hold on Start field is enabled, if the task is not released from hold within the amount of time specified in the Late Start Duration field, the task has started late. |
||||||||||
|
Computed Late Start Time |
If Late Start is enabled, the computed Date/Time for when the task instance will be Late Started. |
||||||||||
|
Late Finish |
If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. This field only appears on the task instance if the user specified a Late Finish in the task definition. |
||||||||||
|
Finished Late |
System-supplied; this field is flagged if the task finished later than the time or duration specified in the Late Finish fields. |
||||||||||
|
Late Finish Type |
Required if Late Finish is enabled. Options:
|
||||||||||
|
Late Finish Offset Type |
|
||||||||||
|
Late Finish Percentage Offset ( + ) |
Required if Late Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset ( + ) |
Required if Late Finish Offset Type = Duration; Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset Unit |
|
||||||||||
|
Late Finish Time |
If Late Finish Type = Time; Time after which the task finish time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Finish Day Constraint |
If Late Finish Type = Time; Specification for whether or not to advance the late finish time to another day.
Default is – None --. |
||||||||||
|
Late Finish Nth Amount |
If Late Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Finish Duration |
If Late Finish Type = Duration; Longest amount of time this task instance should take to run. |
||||||||||
|
Computed Late Finish Time |
If Late Finish is enabled, the computed Date/Time for when the task instance will be Late Finished. |
||||||||||
|
Early Finish |
If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. This field only appears on the task instance if the user added Early Finish specifications to the task definition. |
||||||||||
|
Finished Early |
System-supplied; this field is flagged if the task finished earlier than the time specified in the Early Finish fields. |
||||||||||
|
Early Finish Type |
Required if Early Finish is enabled. Options:
|
||||||||||
|
Early Finish Offset Type |
|
||||||||||
|
Early Finish Percentage Offset ( - ) |
Required if Early Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset ( - ) |
Required if Early Finish Offset Type = Duration; Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset Unit |
|
||||||||||
|
Early Finish Time |
If Early Finish Type = Time; Time before which the task finish time is considered early. That is, enter a time at which the task should still be running. Use HH:MM, 24-hour time. |
||||||||||
|
Early Finish Day Constraint |
If Early Finish Type = Time; Specification for whether or not to advance the early finish time to another day.
Default is – None --. |
||||||||||
|
Early Finish Nth Amount |
If Early Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Early Finish Duration |
If Early Finish Type = Duration; Shortest amount of time this task instance should take to run. |
||||||||||
|
Projected Late |
System-provided if Late Start Time, Late Start Duration, or Late Finish Time is specified; This field is flagged if the task instance is projected to be late based on critical path projected end times (see Critical Path Projected Late Action Maximum and Critical Path Projected Late Threshold In Minutes Universal Controller system properties). . |
||||||||||
|
Critical Path Options |
This section contains Critical Path-related specifications for the task. |
||||||||||
|
CP Duration |
Optional; Allows you to override the estimated Critical Path Duration of the task when running in a Workflow; used in conjunction with the CP Duration Unit field. In most cases, this field should be left blank, which implies that the Controller will estimate the Critical Path Duration based on historical executions. Valid values are any integer equal to or greater than 0. Variables and Functions are supported. |
||||||||||
|
CP Duration (Resolved) |
Displays the current resolved value of the CP Duration field, which may contain variables or functions that will be displayed as unresolved until the task instance starts. The CP Duration (Resolved) field can continue to change value until the task instance starts, at which time CP Duration will display as resolved and CP Duration (Resolved) will no longer be visible unless there was an issue resolving the variables and/or functions contained within CP Duration. If the Controller is unable to resolve CP Duration or it resolves to an invalid value, CP Duration will be ignored and the Controller will estimate the Critical Path Duration based on historical executions. |
||||||||||
|
CP Duration Unit |
Type of CP Duration; used in conjunction with the CP Duration field. For example, for a CP Duration of two minutes, specify 2 in the CP Duration field and select Minutes in this field. Options:
Default is Minutes. |
||||||||||
|
Workflow Execution Options |
This section contains Execution Restriction specifications for the task if it is within a Workflow. |
||||||||||
|
Execution Restriction |
Specification for whether or not there is a restriction for this task to be run, skipped, or held. Options are:
If Execution Restriction on a task is Run or Skip, then when it is part of a Workflow that is being launched, the Restriction Period is evaluated. The task instance will be skipped if Execution Restriction is Skip and the date is within the Restriction Period or Execution Restriction is Run and the date is not within the Restriction Period. Execution Restriction can be set to Skip with a Restriction Period of - None -, meaning the restriction is always active and the task will be skipped when it is part of a Workflow. |
||||||||||
|
Restriction Period |
If Execution Restriction = Run, Skip, or Hold; Period of time when the task is restricted. Options are:
|
||||||||||
|
Before Date |
If Restriction Period = Before or Span; Date before which the restriction is valid. |
||||||||||
|
Before Time |
If Restriction Period = Before or Span; Time on the selected date before which the restriction is valid. |
||||||||||
|
After Date |
If Restriction Period = After or Span; Date after which the restriction is valid. |
||||||||||
|
After Time |
If Restriction Period = After or Span; Time on the selected date after which the restriction is valid. |
||||||||||
|
Date List |
If Restriction Period = On; Date(s) on which the restriction is valid. |
||||||||||
|
Statistics |
This section contains time-related statistics for the task instance. |
||||||||||
|
User Estimated End Time |
System-supplied; If the user entered information into the User Estimated Duration field in the task Details, the Controller uses this information to calculate an end time for the task instance, based on the date/time the task instance started. |
||||||||||
|
Lowest Estimated End Time |
System-supplied; Lowest estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
|
Average Estimated End Time |
System-supplied; Average estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
|
Highest Estimated End Time |
System-supplied; Highest estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
| Projected Start Time |
System-supplied; projected start time of the task instance, calculated by the Controller based on Projected End Time minus Projected Duration. |
||||||||||
|
Projected End Time |
System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. |
||||||||||
|
Metadata |
This section contains Metadata information about this record. |
||||||||||
|
UUID |
Universally Unique Identifier of this record. |
||||||||||
|
Updated By |
Name of the user that last updated this record. |
||||||||||
|
Updated |
Date and time that this record was last updated. |
||||||||||
|
Created By |
Name of the user that created this record. |
||||||||||
|
Created |
Date and time that this record was created. |
||||||||||
|
Status History |
History of all statuses that the task instance has gone through. |
||||||||||
|
Buttons |
This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. |
||||||||||
|
Update |
Saves updates to the record. |
||||||||||
|
Force Finish |
|||||||||||
|
Hold |
|
||||||||||
|
Skip |
|
||||||||||
|
Re-run |
See Re-running a Task Instance. Note If the Re-run (Suppress Intermediate Failures) Permitted Universal Controller system property is set to true, the Re-run button is a drop-down list containing the following options:
The Re-run button does not display if the task instance does not qualify for Re-run. If the task instance qualifies for Re-run, but already has Retry Options enabled, Re-run (Suppress Intermediate Failures) displays as disabled in the drop-down list. |
||||||||||
|
View Parent |
Displays the task instance Details for the parent Workflow of this task instance. |
||||||||||
|
Delete |
Deletes the current record. |
||||||||||
|
Refresh |
Refreshes any dynamic data displayed in the Details. |
||||||||||
|
Close |
For pop-up view only; closes the pop-up view of this task instance. |
||||||||||
|
Tabs |
This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance. |
||||||||||
| Actions | Actions that the Controller took automatically based on events that occurred during the execution of this task. Events are:
Actions are:
|
||||||||||
|
Virtual Resources |
|
||||||||||
|
Exclusive Requests |
|
||||||||||
|
Output |
Displays output generated from the process. Note For File Transfer task instances, output always is automatically retrieved and is available from the Output tab. |
||||||||||
|
Notes |
|
UDM File Transfer Task Instance Details
The following UDM File Transfer Task Instance Details contains information on the execution of the task shown in the UDM File Transfer Task Details.
UDM File Transfer Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in UDM File Transfer Task Instance Details.
|
Field Name |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
General |
This section contains general information about the task instance. |
||||||||||
|
Instance Name |
Name of this task instance. |
||||||||||
|
Instance Number |
System-supplied; Sequentially assigned number, maintained per task, representing the creation order of the instance. |
||||||||||
|
Description |
Description of this record. Maximum length is 255 characters. |
||||||||||
|
Member of Business Services |
User-defined; Allows you to select one or more Business Services that this record belongs to. (You also can Check All or Uncheck All Business Services for this record.) You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service. If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted. |
||||||||||
|
Task |
Name of the task that was run to create this task instance. Click the icon to display Task Details for the task. |
||||||||||
| Source Version |
Version of the task that was run to create this task instance. |
||||||||||
|
Launch Source |
System-supplied; Source from which this task was launched. Options:
|
||||||||||
|
Source Instance |
System-supplied; UUID of the source instance.
|
||||||||||
|
Invoked by |
System-supplied; how the task instance was launched. Options:
|
||||||||||
|
Execution User |
System-supplied; If the task was launched manually; ID of the user who launched it. |
||||||||||
|
Calendar |
Calendar associated with the task instance. |
||||||||||
|
Time Zone Preference |
User-defined; Allows you to specify the time zone that will be applied to the task. Options:
|
||||||||||
|
Virtual Resource Priority |
Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task. Options: 1 (high) - 100 (low). Default is 10. |
||||||||||
|
Hold Resources on Failure |
If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped. |
||||||||||
| Mutually Exclusive With Self |
If enabled, the task will not be allowed to run concurrently with itself. Task will not start until the instance that is running finishes. An instance will transition to Exclusive Wait status if it cannot start due to another instance already running. |
||||||||||
|
Status |
This section contains information about the current status of the task instance. |
||||||||||
|
Status |
|
||||||||||
|
Exit Code |
System-supplied; the exit code captured by the Agent when executing the task (for example, a command or script). |
||||||||||
|
Status Description |
System-supplied; additional information, if any, about the status of the task instance. |
||||||||||
|
Operational Memo |
User-defined operational memo. |
||||||||||
|
Evaluation Time |
If time zone of user is different than time zone of task instance; Time at which Execution Restrictions and Run Criteria were evaluated based upon the requested time zone. (Time zone of task instance displays in parentheses.) |
||||||||||
|
Critical |
Indicates that this task is in the Critical Path of a workflow. |
||||||||||
| Critical Endpoint |
Indicates that this task was defined as a Critical Endpoint of a Critical Path in a workflow. |
||||||||||
|
Wait Until Time |
Amount of time calculated to wait before the task was started, based on Wait To Start and Delay On Start times. |
||||||||||
|
Queued Time |
System-supplied; Date and time the task was queued for processing. |
||||||||||
|
Trigger Time |
System-supplied; Date and time the task instance was triggered. |
||||||||||
|
Launch Time |
System-supplied; Date and time the task instance was launched. |
||||||||||
|
Start Time |
System-supplied; Date and time the task instance started. |
||||||||||
|
End Time |
System-supplied; Date and time the task instance completed. |
||||||||||
|
Duration |
System-supplied; amount of time the task instance took to run. |
||||||||||
|
Agent Details |
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
||||||||||
|
Cluster |
Indication that selecting a Utility Agent Cluster is required. If Cluster is selected, selecting a Utility Agent is not required unless Utility Agent Variable is selected. |
||||||||||
|
Utility Agent |
Name of the Agent resource that identifies the machine where the operation will run. If you do not specify a Utility Agent, you must specify a Utility Agent Cluster or Utility Cluster Broadcast. |
||||||||||
|
Utility Agent Variable |
If enabled, the Utility Agent field converts from a reference field (where you browse and select a record) into a text field that allows you to enter a variable. Use the format:
The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Utility Agent reference to using a Utility Agent variable, you must change the Utility Agent Variable field to Yes and specify the Utility Agent variable in the Utility Agent Unresolved field. Conversely, to change from using a Utility Agent variable to using a Utility Agent reference, you must change the Utility Agent Variable field to No and specify the Utility Agent reference in the Utility Agent field. |
||||||||||
|
Utility Agent Cluster |
If Cluster is selected; Group of Agents, one of which the Controller will choose to run this task. You can specify a Utility Agent Cluster in addition to or in place of a specific Utility Agent. If you specify a Utility Agent and a Utility Agent Cluster, the Controller first tries to run the task on the specific Utility Agent. If the Utility Agent is not available, the Controller reverts to the Utility Agent Cluster. See Agent Clusters for more information. |
||||||||||
|
Utility Agent Cluster Variable |
Indication of whether the Utility Agent Cluster field is a reference field for selecting a specific Agent Cluster (unchecked) or a text field for specifying the Utility Agent Cluster as a variable (checked). Use the format:
The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Utility Agent Cluster reference to using a Utility Agent Cluster variable, you must change the Utility Agent Cluster Variable field to Yes and specify the Utility Agent Cluster variable in the Utility Agent Cluster Unresolved field. Conversely, to change from using a Utility Agent Cluster variable to using a Utility Agent Cluster reference, you must change the Utility Agent Cluster Variable field to No and specify the Utility Agent Cluster reference in the Utility Agent Cluster field. |
||||||||||
|
Utility Credentials |
Required if the Agent Credentials Required Universal Controller system property is true. |
||||||||||
|
Utility Credentials Variable |
Indication of whether the Utility Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Utility Credentials as a variable (checked). Use the format: Note When updating multiple Tasks, to change from using a Utility Credentials reference to using a Utility Credentials variable, you must change the Utility Credentials Variable field to Yes and specify the Utility Credentials variable in the Utility Credentials Unresolved field. Conversely, to change from using a Utility Credentials variable to using a Utility Credentials reference, you must change the Utility Credentials Variable field to No and specify the Utility Credentials reference in the Utility Credentials field. |
||||||||||
|
File Transfer Details |
This section contains assorted detailed information about the task instance. |
||||||||||
|
Transfer Protocol |
Type of transfer protocol for this file transfer. Options:
|
||||||||||
| Primary UDM Agent Option |
Type of definition to use for the Primary UDM Agent selection. Options:
If Form or Script = Form; Default is Utility Agent. If Form or Script = Script; Default is -- None -- . |
||||||||||
| Secondary UDM Agent Option |
Type of definition to use for the Secondary UDM Agent selection. Options:
If Form or Script = Form; Default is UDM Agent. If Form or Script = Script; Default is -- None -- . |
||||||||||
| Primary UDM Agent |
If Primary UDM Agent Option is not Utility Agent or --None--; Agent to use as the Primary UDM Agent. |
||||||||||
| Secondary UDM Agent |
If Secondary UDM Agent Option is not --None-- ; Agent to use as the Secondary UDM Agent. |
||||||||||
| Primary UDM Agent Variable |
If Primary UDM Agent Option is UDM Agent or UDM Agent Cluster; Allows the Primary UDM Agent field to accept a variable. |
||||||||||
| Secondary UDM Agent Variable |
If Secondary UDM Agent Option is UDM Agent or UDM Agent Cluster; Allows the Secondary UDM Agent field to accept a variable. |
||||||||||
| Primary UDM Agent Cluster |
If Primary UDM Agent Option is UDM Agent Cluster; Agent Cluster to use for the Primary UDM Agent. |
||||||||||
| Primary UDM Agent Cluster Variable |
If Primary UDM Agent Option is UDM Agent Cluster; Allows the Primary UDM Agent Cluster field to accept a variable. |
||||||||||
| Secondary UDM Agent Cluster |
If Secondary UDM Agent Option is UDM Agent Cluster; Agent Cluster to use for the Secondary UDM Agent. |
||||||||||
| Secondary UDM Agent Cluster Variable |
If Secondary UDM Agent Option is UDM Agent Cluster; Allows the Secondary UDM Agent Cluster field to accept a variable. |
||||||||||
| Primary Credentials |
If Primary UDM Agent Option is not Utility Agent; Credentials for the Primary UDM Agent; Select existing Credentials from the drop-down list or click the Credentials Details icon to create new Details. |
||||||||||
| Secondary Credentials |
Credentials for the Secondary UDM Agent; Select existing Credentials from the drop-down list or click the Credentials Details icon to create new Details. |
||||||||||
| Primary Credentials Variable |
Indication of whether the Primary Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Primary Credentials as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Primary Credentials reference to using a Primary Credentials variable, you must change the Primary Credentials Variable field to Yes and specify the Primary Credentials variable in the Primary Credentials Unresolved field. Conversely, to change from using a Primary Credentials variable to using a Primary Credentials reference, you must change the Primary Credentials Variable field to No and specify the Primary Credentials reference in the Primary Credentials field. |
||||||||||
| Secondary Credentials Variable |
Indication of whether the Secondary Credentials field is a reference field for selecting a specific Credential (unchecked) or a text field for specifying the Secondary Credentials as a variable (checked). Use the format: The variable must be a supported type as described in Variables and Functions. Note When updating multiple Tasks, to change from using a Secondary Credentials reference to using a Secondary Credentials variable, you must change the Secondary Credentials Variable field to Yes and specify the Secondary Credentials variable in the Secondary Credentials Unresolved field. Conversely, to change from using a Secondary Credentials variable to using a Secondary Credentials reference, you must change the Secondary Credentials Variable field to No and specify the Secondary Credentials reference in the Secondary Credentials field. |
||||||||||
|
Form or Script |
Form or Script for this UDM File Transfer to use. Default is Form. |
||||||||||
|
Transfer Type |
Type of data transfer. Options:
|
||||||||||
|
UDM Operation |
If Form or Script is Form; UDM Operation to be executed. Options:
Default is Copy. |
||||||||||
|
Transfer Direction |
If Form or Script = Form and UDM Operation = Copy, Move, or Copy Directory; Direction of the transfer between the Primary and Secondary UDM Agents. Options:
Default is PUT. |
||||||||||
|
Primary File(s) |
File(s) on the Primary UDM Agent.
|
||||||||||
|
Secondary File(s) |
File(s) on the Secondary UDM Agent.
|
||||||||||
|
Use Regular Expression |
If UDM Operation is Copy, Move, Delete, or List; Allows the use of a regular expression when specifying file(s). Note If UDM Operation = Copy or Move:
If UDM Operation = Delete or List:
|
||||||||||
|
Codepage |
Options: |
||||||||||
|
Compress |
The type of data compression used in the transfer, if any. Options:
|
||||||||||
|
Encrypt |
The method of encryption that the Controller will use in the transfer. Options:
|
||||||||||
|
Destination File Creation Option |
If UDM Operation is Copy, Move, or Copy Directory; Specifies whether the transferred file should be created (new), appended, or replace any existing file. Options:
|
||||||||||
|
Runtime Directory |
|
||||||||||
| Advanced UDM Options |
Additional UDM Options. |
||||||||||
|
Trim Trailing Spaces |
If Form or Script is Form and Advanced UDM Options is selected; If enabled, specifies that the Controller should trim trailing spaces from lines on a text transfer. |
||||||||||
|
Network Fault Tolerant |
If Form or Script is Form and Advanced UDM Options is selected; Enable if the session is network fault tolerant. |
||||||||||
|
Show Progress |
If Form or Script is Form, UDM Operation is Copy, Move, or Copy Directory, and Advanced UDM Options is selected; Shows periodic file transfer progress messages in the UDM transfer output. |
||||||||||
|
Primary File System |
If Form or Script is Form and Advanced UDM Options is selected; Primary file system (applies to IBM System z and System i) Options:
|
||||||||||
|
Secondary File System |
If Form or Script is Form and Advanced UDM Options is selected; Secondary file system (applies to IBM System z and System i). Options:
|
||||||||||
|
Append Primary Open Options |
If Form or Script is Form and Advanced UDM Options is selected; Additional UDM open command options for the Primary UDM Agent. |
||||||||||
|
Append Secondary Open Option |
If Form or Script is Form and Advanced UDM Options is selected; Additional UDM open command options for the Secondary UDM Agent. |
||||||||||
|
Append UDM Options |
If Advanced UDM Options is selected; Any additional free-form Universal Data Mover command options. |
||||||||||
| Result Processing Details | This section contains assorted detailed information about result processing for this task. | ||||||||||
|
Exit Code Processing |
Specifies how the Controller should determine whether the executed command failed or completed successfully. Options:
|
||||||||||
|
Output Type-Exit Code |
Required if Exit Code Processing = Success Output Contains or Failure Output Contains; type of output. Options:
|
||||||||||
|
Exit Codes |
Required if Exit Code Processing = Success Exitcode Range or Failure Exitcode Range; range of exit codes. Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. Variables are supported. |
||||||||||
|
Scan Output For |
Required if Exit Code Processing = Success Output Contains or Failure Output Contains; text for which the Controller should scan the output file. The Controller will process this field as a regular expression. |
||||||||||
|
Output File-Exit Codes |
Required if Output Type = File; path and file name of the output file that should be scanned for the text in the Scan Output For field. |
||||||||||
|
Retry Options |
This section contains specifications for retrying the task. |
||||||||||
|
Maximum Retries |
User-defined; maximum number of times that the Controller should retry this task after it has started and gone to a failed state. |
||||||||||
|
Retry Indefinitely |
User-defined; indicates whether the Controller should continue trying indefinitely to run this task. If you enable this field, it overrides any value placed in the Maximum Retries field. |
||||||||||
|
Retry Interval (Seconds) |
User-defined; number of seconds between each retry. |
||||||||||
|
Current Retry Count |
System-supplied; current number of times that the Controller has retried the task after it first went to failure status. |
||||||||||
|
Suppress Intermediate Failures |
User-defined; If the task instance is in the Failed status, indicates whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:
|
||||||||||
|
Next Retry Time |
System-supplied for a task instance in the Failed status that is scheduled for automatic retry; Next time that a retry will be made. If a task instance is not scheduled for automatic retry, Next Retry Time does not display in the task instance Details. |
||||||||||
|
Wait / Delay Options |
This section contains specifications for waiting to start and/or delaying on start the task. |
||||||||||
|
Wait To Start |
Amount of time to wait before starting a task from the time that it was launched.
|
||||||||||
|
Wait Time |
If Wait To Start = Time or Relative Time; Time of day (in 24-hour time) to wait until before starting the task. |
||||||||||
|
Wait Day Constraint |
If Wait To Start = Time or Relative Time; Specification for whether or not to advance the wait time to another day. Valid values:
Default is – None --. |
||||||||||
|
Wait Duration |
If Wait To Start = Duration; Number of days, hours, minutes, and seconds to wait before starting the task. |
||||||||||
|
Wait Duration In Seconds |
If Wait To Start = Seconds; Number of seconds to wait before starting the task. |
||||||||||
|
Delay On Start |
Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.
|
||||||||||
|
Delay Duration |
If Delay On Start = Duration; Number of days, hours, minutes, and seconds to delay after starting the task. |
||||||||||
|
Delay Duration In Seconds |
If Delay On Start = Seconds; Number of seconds to delay after starting the task. |
||||||||||
|
Time Options |
This section contains time-related specifications for the task instance. |
||||||||||
|
Late Start |
If enabled, and if the task instance starts after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late start (see Late Start Type). To determine whether a task instance started late, open the task instance and locate the Started Late field; the field is checked if the instance started after the specified time. The Started Late field displays in the task instance Details only if the user specified a Late Start in the task Details. |
||||||||||
|
Started Late |
System-supplied; this field is flagged if the task started later than the time specified in the Late Start fields. |
||||||||||
|
Late Start Type |
Required if Late Start is enabled. Options:
|
||||||||||
|
Late Start Time |
If Late Start Type = Time; Time after which the task start time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Start Day Constraint |
If Late Start Type = Time; Specification for whether or not to advance the late start time to another day.
Default is – None --. |
||||||||||
|
Late Start Nth Amount |
If Late Start Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Start Duration |
If Late Start Type = Duration; Duration (amount of relative time) after which the task is considered to have started late. For a task within a workflow, the duration is the period between the time the workflow starts and the time the task itself starts. For example, a task might have a Late Start Duration of 60 minutes. If the workflow starts at 9:00 a.m. but the task itself does not start until 10:30, the task has started late. For a task that is not within a workflow, Late Start Duration has meaning only if the task has been held upon starting. For example, if a task has a Late Start Duration of 60 minutes and the Hold on Start field is enabled, if the task is not released from hold within the amount of time specified in the Late Start Duration field, the task has started late. |
||||||||||
|
Computed Late Start Time |
If Late Start is enabled, the computed Date/Time for when the task instance will be Late Started. |
||||||||||
|
Late Finish |
If enabled, and if the task instance finishes after the time or period specified, the task instance is flagged as late. You can specify a time or duration to determine a late finish (see Late Finish Type). To determine whether a task instance finished late, open the task instance and locate the Finished Late field; the field is checked if the instance finished after the specified time or lasted longer than expected. This field only appears on the task instance if the user specified a Late Finish in the task definition. |
||||||||||
|
Finished Late |
System-supplied; this field is flagged if the task finished later than the time or duration specified in the Late Finish fields. |
||||||||||
|
Late Finish Type |
Required if Late Finish is enabled. Options:
|
||||||||||
|
Late Finish Offset Type |
|
||||||||||
|
Late Finish Percentage Offset ( + ) |
Required if Late Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset ( + ) |
Required if Late Finish Offset Type = Duration; Duration to use as an offset. The late finish time is calculated by adding the offset to the Average Duration. |
||||||||||
|
Late Finish Duration Offset Unit |
|
||||||||||
|
Late Finish Time |
If Late Finish Type = Time; Time after which the task finish time is considered late. Use HH:MM, 24-hour time. |
||||||||||
|
Late Finish Day Constraint |
If Late Finish Type = Time; Specification for whether or not to advance the late finish time to another day.
Default is – None --. |
||||||||||
|
Late Finish Nth Amount |
If Late Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Late Finish Duration |
If Late Finish Type = Duration; Longest amount of time this task instance should take to run. |
||||||||||
|
Computed Late Finish Time |
If Late Finish is enabled, the computed Date/Time for when the task instance will be Late Finished. |
||||||||||
|
Early Finish |
If enabled, and if the task instance finishes before the time or period specified, the task instance is flagged as early. You can specify a time or duration to determine an early finish (see Early Finish Type). To determine whether a task instance finished early, open the task instance and locate the Finished Early field; the field is checked if the instance finished before the specified time or did not last as long as expected. This field only appears on the task instance if the user added Early Finish specifications to the task definition. |
||||||||||
|
Finished Early |
System-supplied; this field is flagged if the task finished earlier than the time specified in the Early Finish fields. |
||||||||||
|
Early Finish Type |
Required if Early Finish is enabled. Options:
|
||||||||||
|
Early Finish Offset Type |
|
||||||||||
|
Early Finish Percentage Offset ( - ) |
Required if Early Finish Offset Type = Percentage; Percentage of Average Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset ( - ) |
Required if Early Finish Offset Type = Duration; Duration to use as an offset. The early finish time is calculated by subtracting the offset from the Average Duration. |
||||||||||
|
Early Finish Duration Offset Unit |
|
||||||||||
|
Early Finish Time |
If Early Finish Type = Time; Time before which the task finish time is considered early. That is, enter a time at which the task should still be running. Use HH:MM, 24-hour time. |
||||||||||
|
Early Finish Day Constraint |
If Early Finish Type = Time; Specification for whether or not to advance the early finish time to another day.
Default is – None --. |
||||||||||
|
Early Finish Nth Amount |
If Early Finish Day Constraint = Nth Day; Number of days to advance. |
||||||||||
|
Early Finish Duration |
If Early Finish Type = Duration; Shortest amount of time this task instance should take to run. |
||||||||||
|
Projected Late |
System-provided if Late Start Time, Late Start Duration, or Late Finish Time is specified; This field is flagged if the task instance is projected to be late based on critical path projected end times (see Critical Path Projected Late Action Maximum and Critical Path Projected Late Threshold In Minutes Universal Controller system properties). . |
||||||||||
|
Critical Path Options |
This section contains Critical Path-related specifications for the task. |
||||||||||
|
CP Duration |
Optional; Allows you to override the estimated Critical Path Duration of the task when running in a Workflow; used in conjunction with the CP Duration Unit field. In most cases, this field should be left blank, which implies that the Controller will estimate the Critical Path Duration based on historical executions. Valid values are any integer equal to or greater than 0. Variables and Functions are supported. |
||||||||||
|
CP Duration (Resolved) |
Displays the current resolved value of the CP Duration field, which may contain variables or functions that will be displayed as unresolved until the task instance starts. The CP Duration (Resolved) field can continue to change value until the task instance starts, at which time CP Duration will display as resolved and CP Duration (Resolved) will no longer be visible unless there was an issue resolving the variables and/or functions contained within CP Duration. If the Controller is unable to resolve CP Duration or it resolves to an invalid value, CP Duration will be ignored and the Controller will estimate the Critical Path Duration based on historical executions. |
||||||||||
|
CP Duration Unit |
Type of CP Duration; used in conjunction with the CP Duration field. For example, for a CP Duration of two minutes, specify 2 in the CP Duration field and select Minutes in this field. Options:
Default is Minutes. |
||||||||||
|
Workflow Execution Options |
This section contains Execution Restriction specifications for the task if it is within a Workflow. |
||||||||||
|
Execution Restriction |
Specification for whether or not there is a restriction for this task to be run, skipped, or held. Options are:
If Execution Restriction on a task is Run or Skip, then when it is part of a Workflow that is being launched, the Restriction Period is evaluated. The task instance will be skipped if Execution Restriction is Skip and the date is within the Restriction Period or Execution Restriction is Run and the date is not within the Restriction Period. Execution Restriction can be set to Skip with a Restriction Period of - None -, meaning the restriction is always active and the task will be skipped when it is part of a Workflow. |
||||||||||
|
Restriction Period |
If Execution Restriction = Run, Skip, or Hold; Period of time when the task is restricted. Options are:
|
||||||||||
|
Before Date |
If Restriction Period = Before or Span; Date before which the restriction is valid. |
||||||||||
|
Before Time |
If Restriction Period = Before or Span; Time on the selected date before which the restriction is valid. |
||||||||||
|
After Date |
If Restriction Period = After or Span; Date after which the restriction is valid. |
||||||||||
|
After Time |
If Restriction Period = After or Span; Time on the selected date after which the restriction is valid. |
||||||||||
|
Date List |
If Restriction Period = On; Date(s) on which the restriction is valid. |
||||||||||
|
Statistics |
This section contains time-related statistics for the task instances of this task. |
||||||||||
|
User Estimated End Time |
System-supplied; If the user entered information into the User Estimated Duration field in the task Details, the Controller uses this information to calculate an end time for the task instance, based on the date/time the task instance started. |
||||||||||
|
Lowest Estimated End Time |
System-supplied; Lowest estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
|
Average Estimated End Time |
System-supplied; Average estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
|
Highest Estimated End Time |
System-supplied; Highest estimated end time of the task instance, calculated by the Controller based on the date/time the task instance started. |
||||||||||
| Projected Start Time |
System-supplied; projected start time of the task instance, calculated by the Controller based on Projected End Time minus Projected Duration. |
||||||||||
|
Projected End Time |
System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. |
||||||||||
|
Metadata |
This section contains Metadata information about this record. |
||||||||||
|
UUID |
Universally Unique Identifier of this record. |
||||||||||
|
Updated By |
Name of the user that last updated this record. |
||||||||||
|
Updated |
Date and time that this record was last updated. |
||||||||||
|
Created By |
Name of the user that created this record. |
||||||||||
|
Created |
Date and time that this record was created. |
||||||||||
|
Status History |
History of all statuses that the task instance has gone through. |
||||||||||
|
Buttons |
This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. |
||||||||||
|
Update |
Saves updates to the record. |
||||||||||
|
Force Finish |
|||||||||||
|
Hold |
|
||||||||||
|
Skip |
|
||||||||||
|
Re-run |
See Re-running a Task Instance. Note If the Re-run (Suppress Intermediate Failures) Permitted Universal Controller system property is set to true, the Re-run button is a drop-down list containing the following options:
The Re-run button does not display if the task instance does not qualify for Re-run. If the task instance qualifies for Re-run, but already has Retry Options enabled, Re-run (Suppress Intermediate Failures) displays as disabled in the drop-down list. |
||||||||||
|
View Parent |
Displays the task instance Details for the parent Workflow of this task instance. |
||||||||||
|
Delete |
Deletes the current record. |
||||||||||
|
Refresh |
Refreshes any dynamic data displayed in the Details. |
||||||||||
|
Close |
For pop-up view only; closes the pop-up view of this task instance. |
||||||||||
|
Tabs |
This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance. |
||||||||||
| Actions | Actions that the Controller took automatically based on events that occurred during the execution of this task. Events are:
Actions are:
|
||||||||||
|
Virtual Resources |
|
||||||||||
|
Exclusive Requests |
|
||||||||||
|
Output |
Displays output generated from the process. Note For File Transfer task instances, output always is automatically retrieved and is available from the Output tab. |
||||||||||
|
Notes |
|
Output Redirection
An Agent processes File Transfer (UDM), Universal Command, and SAP tasks differently than Windows and Linux/Unix tasks. File Transfer (UDM), Universal Command, and SAP command lines are sent to the user process via standard input, so any redirection operators entered as task command input are not processed as expected.
If you want to direct output from a File Transfer (UDM ) task to your file system, the -uagstdio command option lets you specify the same output redirection commands that are available for Windows and Linux/Unix tasks. UAG will apply the user-specified value for -uagstdio directly to the command image.
The I/O redirection commands that you can use with -uagstdio are dependent on the OS/command shell. You should be able to set up any redirection that the OS/command shell supports (just as with Windows and Linux/Unix tasks).
The syntax of -uagstdio is similar to Universal Data Mover, Universal Command, and Universal Connector command line options; option followed by value.
For a File Transfer (UDM ) task, you can specify uagstdio in the following field:
-uagstdio Examples
If the -uagstdio value contains spaces, it must be enclose in double quotation marks ( " ):
If the quoted value itself requires double quotation marks, they must be doubled ( "" ):
Specifying When a Task Runs
You can run the task as part of a workflow, specify triggers that run the task automatically based on times or events, or run the task manually.
Running a File Transfer Task
You can run a File Transfer task:
- Manually, by clicking the Launch Task or Launch Task with Variables button in the File Transfer tasks list or File Transfer Task Details Action menu.
- As part of a workflow.
- Specify triggers that run the task automatically based on times or events.
Monitoring Task Execution
You can monitor all system activity from the Activity Monitor and can view activity history from the History list.
Code Pages
The following table identifies all supported code pages for a UDM File Transfer task.
|
ISO8859-1 |
op437 |
IBM Portugal 037 |
|
ISO8859-2 |
op737 |
IBM German 273 |
|
ISO8859-3 |
op775 |
IBM Danish and Norwegian 277 |
|
ISO8859-4 |
op850 |
IBM Sweden and Finland 278 |
|
ISO8859-5 |
op852 |
IBM Italian 280 |
|
ISO8859-6 |
op855 |
IBM Spanish 284 |
|
ISO8859-7 |
op857 |
IBM International 500 |
|
ISO8859-8 |
op860 |
IBM Greek 875 |
|
ISO8859-9 |
op861 |
IBM Latin-1 1047 |
|
ISO8859-10 |
cp862 |
IBM Portugal 1140 |
|
ISO8859-13 |
cp863 |
IBM German 1141 |
|
ISO8859-14 |
cp864 |
IBM Danish 1142 |
|
ISO8859-15 |
cp865 |
IBM Finish 1143 |
|
|
cp866 |
IBM Italian 1144 |
|
|
cp869 |
IBM Spanish 1145 |
|
|
cp874 |
IBM UK 1146 |
|
|
cp1250 |
IBM Swiss 1148 |
|
|
cp1251 |
IBM Greek 4971 |
|
|
cp1252 |
|
|
|
cp1253 |
|
|
|
cp1254 |
|
|
|
cp1255 |
|
|
|
cp1256 |
|
|
|
cp1257 |
|
|
|
cp1258 |
|