|
|
Automate Schedule - Wait for job |
Declaration
<AMSKYBOT ACTIVITY="wait_job" SESSION="text" IP="text" PORT="number" USERNAME="text" PASSWORD="text (encrypted)" HTTPS="YES/NO" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)"" INSTANCEID="text" RESULTVARIABLE="text" TIMEOUT="number" />
Description
Waits for an instance of a job (specified by the instance ID or job run number) to complete before continuing to the next step.
NOTE: To
wait for jobs, you must have View, Change, or Execute authority
to the "Jobs" secured object.
Practical usage
Used to ensure that a particular job instance has completed in order to perform other activities on it during subsequent steps.
Parameters
Connection
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Connection | --- | --- | --- | --- | Indicates
where this activity's Automate Schedule credentials should originate from.
The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Connection - Session
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Session | Text | Yes, if Connection is set to Session | Automate ScheduleSession1 | SESSION="Session1" | The name of the session to associate this activity with. This parameter is active only if the Connection parameter is set to Session. If the Connection parameter is set to Host, this parameter is ignored and the remainder of the parameters specified below becomes active. |
Connection - Host > Credentials
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Server | Number/Text | Yes | (Empty) | IP="xxx.xxx.xxx.xxx" | The Domain Name System (DNS) name (for example, www.domain.com) or IP address (for example, xxx.xxx.xxx.xxx ) of the Automate Schedule Server of where to establish communication. |
| Port | Number | Yes | (Empty) | PORT="0880" | The TCP/IP port assigned to enable communication with the Automate Schedule server. |
| User name | Text | No | (Empty) | USERNAME="jdoe" | A
valid username of a user configured to access the Automate Schedule
Server. NOTE: Certain Automate Schedule activities
may or may not be permitted depending on the permissions set for
the user. |
| Password | Text | No | (Empty) | PASSWORD="text (encrypted)" | The correct password for the user entered above. |
| Session | Text | Yes | (Empty) | SESSION="SkySession" | The name of the session to use to link to other Automate Schedule activities. |
| Use Https | Yes/No | No | No | HTTPS="YES" | If selected, specifies that the server protocol type is HTTPS (secure HTTP). If disabled, the server protocol type is HTTP. This parameter is disabled by default. |
Connection - Host > Proxy
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Proxy type | Text (options) | No | Default |
|
The
type of proxy required for Automate Schedule connections that pass through
a proxy server. The available options are:
|
| Use authentication | --- | --- | --- | --- | If
enabled, indicates that proxy authentication is implemented. This parameter is active only if the Proxy
type parameter is set to HTTP. NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
| Proxy server | Text | No | (Empty) | PROXYSERVER="proxy.host.com" | The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. |
| Proxy username | Text | No | (Empty) | PROXYUSERNAME="ProxyUser" | The proxy username to use to authenticate and establish the connection. This parameter is available only if the Use authentication parameter is enabled. |
| Proxy password | Text | No | (Empty) | PROXYPASSWORD="encrypted" | The proxy password to use to authenticate and establish the connection. This parameter is available only if the Use authentication parameter is enabled. |
| Proxy port | Number | No | 8008 | PROXYPORT="8008" | The port to use to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 8008. |
Job
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Instance ID | Text | Yes | (Empty) | INSTANCEID="text" | The instance ID or job run number of the Automate Schedule job to wait for. |
| Populate variable with result | Text | Yes | (Empty) | RESULTVARIABLE="text" | An existing variable to populate with the completion result of the Automate Schedule job to wait for. |
| Time out (seconds) | Number | Yes | (Empty) | TIMEOUT="60" | The maximum number of seconds that Automate Desktop will wait for the job to complete before a timeout error occurs. |
Additional notes
Enabling Automate Schedule Web Service
By default, Automate Schedule has the web services option disabled. This will prevent Automate Schedule actions from running. To enable the Automate Schedule Web Service, log into Automate Schedule's UI and select from the main menu Admin > System Settings. Scroll down to the Configure Features section and select EDIT. Select Allow Web Service Requests (as shown below) and save the settings.
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
Wait Instance ID "1027". Automate Schedule session "Skybot_1".
Copy
<AMSKYBOT ACTIVITY="wait_job" SESSION="Skybot_1" INSTANCEID="1027" TIMEOUT="30" />