FTP File Monitor
From OpsWise Documentation Wiki
Your trail:Displaying Trigger Forecast InformationEmailEmail ConnectionEmail TemplateFTP File Monitor
Contents |
Overview
The FTP File Monitor task allows you to monitor for a file on a remote machine where an FTP server is running. The FTP File Monitor connects to the FTP server rather than the machine's file system to monitor for files. The FTP File Monitor can be used only within a workflow; you cannot run a FTP File Monitor task based on a trigger. To run an FTP File Monitor task, you need a OpsWise Automation Center Linux/Unix, z/OS, or Windows agent to communicate with the FTP server. The agent can but does not have to be running on the same machine as the FTP server.
In the example shown below, the user wants to monitor for a file on a remote FTP Server that has an OpsWise Automation Center agent running on it. In this case, the login credentials for the OpsWise agent machine and the FTP server machine are the same.
In the example shown below, the user wants to monitor for a file on a remote FTP Server that does not have an OpsWise Automation Center agent running on it. In this case, the FTP File Monitor task definition provides an address and login credentials for the machine where the OpsWise Automation Center agent is running as well as address and login credentials for the FTP server.
Creating a New FTP File Monitor Task
- From the Navigation Pane, select FTP File Monitor.
- From the trigger wizard, select New. OpsWise Automation Center displays the FTP File Monitor Task screen.
- Using the field descriptions provided below as a guide, complete the fields as needed.
- Click the Submit button to save the record and return to the menu, or, right-click on the title bar and select Save to save the record and remain on the current display.
- If appropriate, repeat these steps for any additional tasks you want to add.
Shown below is a sample FTP File Monitor task screen. Task run statistics appear after the first time this task has been launched.
FTP File Monitor Task Field Descriptions
The table below describes the fields, buttons, and tabs on the FTP File Monitor task definition and task instance screens. Most fields appear on both screens; however they do not always appear at the same spot. In the latter case, the table provides a field description at the location found on the task definition screen. Some fields appear only on one of the screens. Field labels shown in bold appear only on the task instance screen and are labelled as such.
| Field Name | Description | |
|---|---|---|
| Task/Instance Name | Required. Name used within OpsWise Automation Center to identify this task. Up to 40 alphanumerics; variables supported. It is the user’s responsibility to develop a workable naming scheme for tasks. | |
| Invoked by | Task instance only; system-supplied. How the task instance was launched. Options:
Trigger: [Trigger Name] - The instance was launched by the named trigger. Workflow: [Workflow Name] - The instance was launched by the named workflow. Manually Launched - The instance was launched by a user. To identify the user who launched the instance: |
|
| Task | Task instance only; system-supplied. | |
| Execution User | Task instance only; system-supplied. | |
| Instance Reference Id | Task instance only; system-supplied. | |
| Credentials | Optional. The login credentials OpsWise Automation Center will use to access the machine where the OpsWise Automation Center agent is running. See Credentials. | |
| Credentials Variable | Optional. If enabled, the Credentials field (see above) 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: ${variable name}. The variable must be a supported type as described in Using Variables. | |
| Agent | Optional. The name of the agent resource that describes the machine where the application will run. If you do not specify an agent, you must specify an agent cluster (see below). | |
| Agent Cluster | Optional. You can specify an agent cluster in addition to or in place of a specific agent. An agent cluster is a group of agents, one of which the system will choose to run this task. If you specify an agent and an agent cluster, OpsWise Automation Center first tries to run the task on the specific agent. If the agent is not available, the system reverts to the agent cluster. See Configuring Agent Clusters for more information. | |
| Agent Variable | Optional. If enabled, the Agent field (see above) 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: ${variable name}. The variable must be a supported type as described in Using Variables. | |
| Agent Cluster Variable | Optional. If enabled, the Agent Cluster field (see above) 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: ${variable name}. The variable must be a supported type as described in Using Variables. | |
| Cluster Broadcast | Optional. You can specify a Cluster Broadcast in addition to or in place of a specific agent and/or Agent Cluster. When you specify an agent cluster in the Cluster Broadcast field, OpsWise Automation Center runs the task on all the agents in the cluster. If you specify an agent and an agent cluster, OpsWise Automation Center first tries to run the task on the specific agent. If the agent is not available, the system reverts to the agent cluster. See Configuring Agent Clusters for more information. | |
| Summary | User-supplied description of this task. | |
| Status | Task instance only; system-supplied. See Task Status. | |
| Status Description | Task instance only; system-supplied. Provides additional information, if any, about the status of the task. | |
| Start Time | Task instance only; system-supplied. The time the task started. | |
| Duration | Task instance only; system-supplied. The amount of time the task took to run. | |
| End Time | Task instance only; system-supplied. The time the task completed. | |
| Hold on Start | If enabled, when the task is launched it appears in the Activity display with a status of Held. The task runs when the user releases it. . | |
| Member of Groups | User-defined. Allows you to select one or more Opswise groups that this task definition belongs to. Click on the lock icon to unlock the field and select groups. | |
| User-Estimated Duration | The estimated amount of time it should normally take to run this task. The value in this field is used by OpsWise Automation Center to calculate the User Estimated End Time when the task is launched. You can view this information by selecting the Task Instance record from the Activity screen. | |
| Monitor Type | The type of event being monitored for. Options:
|
|
| Wait until Satisfied | If enabled, the task instance starts and continues to run until one of the following events occurs:
If not enabled, the task instance:
|
|
| Server Type | The type of FTP server. Options:
|
|
| Remote Server | The name or IP address of the FTP server. This machine may or may not be the same as the OpsWise agent machine. | |
| FTP Credentials | The login credentials the OpsWise agent will use to access the FTP server machine. If the FTP server and OpsWise agent are running on the same machine, enter the same credentials as those you entered for the Credentials field above. | |
| Transfer Mode | The transfer mode. Options:
|
|
| FTP Credentials Variable | Optional. If enabled, the FTP Credentials field (see above) 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: ${variable name}. The variable must be a supported type as described in Using Variables. | |
| Remote Filename | The path and file name being monitored for on the remote server. | |
| Job Card (z/OS Only) | For z/OS, the job card information for the JCL statement. Example://FTPJOB01 JOB (FTP,001),FANNY,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=&SYSUID,CLASS=A |
|
| User Estimated End Time | Task instance only; system-supplied. | |
| Shortest Estimated End Time | Task instance only; system-supplied. | |
| Average Estimated End Time | Task instance only; system-supplied. | |
| Longest Estimated End Time | Task instance only; system-supplied. | |
| Late Start | If enabled, and if the task instance starts after the time specified in the Late Start Time field (see below), the task instance is flagged as late. 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 late. | |
| Late Start Time (hh:mm) | The time after which the task start time is considered late. Use hh:mm, 24-hour time. | |
| 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 below). 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. | |
| Late Finish Type | If Late Finish is enabled, use this field to specify whether you want to use time (see Late Finish Time below) or duration (see Late Finish Duration below) to determine whether the task instance finished late. | |
| Late Finish Time (hh:mm) | If Late Finish Type is Time, use this to specify the time after which the task finish time is considered late. Use hh:mm, 24-hour time. | |
| Late Finish Duration | If Late Finish Type is Duration, use this to specify the longest amount of time this task instance should take to run. You can specify any combination of days, hours, minutes, and seconds. | |
| 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 below). 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. | |
| Early Finish Type | If Early Finish is enabled, use this field to specify whether you want to use time (see Early Finish Time below) or duration (see Early Finish Duration below) to determine whether the task instance finished early. | |
| Early Finish Time (hh:mm) | If Early Finish Type is Time, use this to specify the time before which the task finish time is considered early. Use hh:mm, 24-hour time. | |
| Early Finish Duration | If Early Finish Type is Duration, use this to specify the shortest amount of time this task instance should take to run. You can specify any combination of days, hours, minutes, and seconds. | |
| First Time Ran | System-supplied. Displays after task has been run. The date and time this task first ran. | |
| Lowest Instance Time | System-supplied. Displays after task has been run. The shortest amount of time this task has taken to run. | |
| Last Time Ran | System-supplied. Displays after task has been run. The last date and time the task ran. | |
| Average Instance Time | System-supplied. Displays after task has been run. The average amount of time this task takes to run. | |
| Number of Instances | System-supplied. Displays after task has been run. The number of times this task has run. | |
| Highest Instance Time | System-supplied. Displays after task has been run. The longest amount of time this task has taken to run. | |
| Last Instance Duration | System-supplied. Displays after task has been run. The amount of time the task took to run the last time it ran. | |
| Submit button | Submits the new record to the database. | |
| Update button | Saves updates to the record. | |
| Launch Task button | Manually launches the task. | |
| Delete button | Deletes the current record. | |
| Task Virtual Resources tab | Allows you to create virtual resource definitions for controlling access to resources by multiple tasks. See Creating Virtual Resources. | |
| Variables tab | Displays all variables associated with this task. | |
| Actions tab | Allows you to specify actions that the system will take automatically based on events that occur during the execution of this task. Events supported are task instance status, exit codes, late start, late finish, and early finish. Actions include:
|
|
| Task Instances tab | System-supplied. Displays a list of all instances generated by this task. | |
| Triggers tab | Displays a list of all triggers that have been defined to launch this task. Also allows you to add new triggers. For instructions, see Triggers. | |
| Notes tab | Displays all notes associated with this task. See Runbook Notes. | |
File Monitor Variables
Several built-in File Monitor variables are available for use in the File Monitor task. See Built-in Variables.
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.
Monitoring Task Execution
You can monitor all system activity from the Activity screen and can view activity history from the Activity History screen.
