Stored Procedure Task
Overview
A Stored Procedure task allows you to execute a stored procedure against the database specified in the task.
Note
Before you can run a Stored Procedure task, you first must create a Database Connection, which defines the information needed to locate and access the database.
Built-In Variables
The following built-in variables can be used in a Stored Procedure task to pass data where appropriate:
Creating a Stored Procedure Task
Step 1 | From the Automation Center navigation pane, select Tasks > Stored Procedure Tasks. The Stored Procedure Tasks list displays a list of all currently defined Stored Procedure tasks. |
|---|---|
Step 2 | Enter/select Details for a new Stored Procedure 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 button. The task is added to the database, and all buttons and tabs in the Task Details are enabled. |
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).
Stored Procedure Task Details
The following Stored Procedure Task Details is for an existing Stored Procedure task.
Depending on the values that you enter / select for these fields, and whether or not the Stored Procedure 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 Stored Procedure Task Details.
Stored Procedure Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Stored Procedure Task Details.
Field Name | Description |
|---|---|
General | This section contains general information about the task. |
Name | |
Version | |
Description | |
Member of Business Services | |
Resolve Name Immediately | |
Time Zone Preference | |
Hold on Start | |
Hold Reason | |
Virtual Resource Priority | |
Hold Resources on Failure | |
Mutually Exclusive With Self | |
Simulate | |
Override Previous Instance Wait | |
Stored Procedure Details | This section contains assorted detailed information about the task. |
Database Connection | |
Database Connection Variable | |
Credentials | |
Credentials Variable | |
Maximum Rows | |
Auto Cleanup | |
Stored Procedure Name | |
Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Result Processing | |
Exit Codes | |
Parameter Position | |
Column Name | |
Operator | |
Value | |
Retry Options | This section contains specifications for retrying the task. |
Maximum Retries | |
Retry Indefinitely | |
Retry Interval (Seconds) | |
Suppress Intermediate Failures | |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | |
Wait Time | |
Wait Day Constraint | |
Wait Duration | |
Wait Duration In Seconds | |
Delay On Start | |
Delay Duration | |
Delay Duration In Seconds | |
Workflow Only | |
Time Options | This section contains time-related specifications for the task. |
Late Start | |
Late Start Type | |
Late Start Time | |
Late Start Day Constraint | |
Late Start Nth Amount | |
Late Start Duration | |
Late Finish | |
Late Finish Type | |
Late Finish Offset Type | |
Late Finish Percentage Offset ( + ) | |
Late Finish Duration Offset ( + ) | |
Late Finish Duration Offset Unit | |
Late Finish Time | |
Late Finish Day Constraint | |
Late Finish Nth Amount | |
Late Finish Duration | |
Early Finish | |
Early Finish Type | |
Early Finish Offset Type | |
Early Finish Percentage Offset ( - ) | |
Early Finish Duration Offset ( - ) | |
Early Finish Duration Offset Unit | |
Early Finish Time | |
Early Finish Day Constraint | |
Early Finish Nth Amount | |
Early Finish Duration | |
User Estimated Duration | |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | |
CP Duration (Resolved) | |
CP Duration Unit | |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | |
Restriction Period | |
Before Date | |
Before Time | |
After Date | |
After Time | |
Date List | |
Self-Service Options | This section contains Self-Service specifications for the task. |
Enforce Variables | |
Lock Variables | |
Statistics | This section contains time-related statistics for task instances of the task. |
First Execution | |
Last Execution | |
Last Instance Duration | |
Lowest Instance Time | |
Average Instance Time | |
Highest Instance Time | |
Number of Instances | |
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 | |
Launch | |
View Parents | |
Copy | Creates a copy of this task, which you are prompted to rename. |
Delete | 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 instance. |
Stored Procedure Parameters | See Adding Stored Procedure Parameters, below. |
Variables | |
Actions | |
Virtual Resources | |
Mutually Exclusive | |
Instances | Lists all instances of the task. |
Triggers | |
Notes | |
Versions |
Viewing a Stored Procedure Task Instance
When a Stored Procedure 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.