/
Stored Procedure Task Properties

Stored Procedure Task Properties

Task Properties: Stored Procedure Task

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

autoCleanup

Auto Cleanup

Specification for whether or not data retrieved as the result of a SQL task and then written into a database table is discarded upon the successful completion of the task (or workflow if the task is contained within a workflow).

Boolean. Valid values: true or false. Default is false.

N


columnName

Column Name

If resultProcessing is Success Result Set Contains or Failure Result Set Contains; Name of a database column that is being checked for a specific value.


N


connection

Database Connection

Universal Controller Database Connection that defines the database.


Y
(unless connectionVar
is specified)

connectionVar

connectionVar

Database Connection Variable

Name of a variable that will be resolved at run time to the name of the Database Connection to use.


Y
(unless connection
is specified)

connection

exitCodes

Exit Codes

If resultProcessing is 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.

N


maxRows

Maximum Rows

Limit to the number of rows you want returned by the SQL statement. This value overrides any value specified in the selected Database Connection.

Integer.

N


parameterPosition

Parameter Position

If resultProcessing is Success Output Parameter or Failure Output Parameter; Position of this parameter within a list of parameters.

Integer.

N


resultOp

Operator

If resultProcessing is Success Result Set Contains, Failure Result Set Contains, Success Output Parameter, or Failure Output Parameter; Operator being used for the comparison.

Valid values:

  • As String = =, As Value = 1
  • As String = !=, As Value = 2
  • As String = >, As Value = 3
  • As String = >=, As Value = 4
  • As String = <, As Value = 5
  • As String = <=, As Value = 6
  • As String = regex, As Value = 7

Default is = (1).

N


resultProcessing

Result Processing

Specification for how the Controller should determine whether the Stored Procedure failed or completed successfully.

Valid values:

  • As String = Skip Result Processing, As Value = 1
  • As String = Success Exitcode Range, As Value = 2
  • As String = Failure Exitcode Range, As Value = 3
  • As String = Success Result Set Contains, As Value = 4
  • As String = Failure Result Set Contains, As Value = 5
  • As String = Success Output Parameter, As Value = 6
  • As String = Failure Output Parameter, As Value = 7

Default is Skip Result Processing (1).

N


resultValue

Value

If resultProcessing is Success Result Set Contains Range, Failure Result Set Contains, Success Output Parameter or Failure Output Parameter; Value being compared, using the operator specified in resultOp.


N


retryIndefinitely

Retry Indefinitely

Specification for whether or not the Controller should continue trying indefinitely to run this task. This value overrides any value in retryMaximum.

Boolean; Valid values: true/false. Default is false.

N


retryInterval

Retry Interval (Seconds)

Number of seconds between each retry.

Integer; Default is 60.

N


retryMaximum

Maximum Retries

Maximum number of times that the Controller should retry this task after it has started and gone to a failed state.

Integer; Default is 0.

N


retrySuppressFailure

Suppress Intermediate Failures

If the task instance is in the Failed status; Specification for whether or not the following will be suppressed until all scheduled retry attempts (a retryMaximum value has been specified or retryIndefinitely is true):

  • All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
  • Workflow conditional path processing; any Successors waiting on a failure path will not be released.
  • Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
  • Any Workflow containing the Failed task instance will not transition to the Running/Problems status.

Boolean; Valid values: true/false. Default is false.

N


storedProcName

Stored Procedure Name

Name of the file containing the stored procedure being executed against the database. Variables are supported.


Y


Task Instance Properties: Stored Procedure Task

PropertyUI Field NameDescription

sqlState

SQL State

System-supplied; resolves to a return code that indicates the outcome of the most recently executed SQL statement.

sqlErrorMessage

SQL Error Message

System-supplied; any error messages returned by the SQL procedure.

sqlRowsRetrieved

Rows Retrieved

The number of rows returned by the SQL statement

sqlResults

SQL Result

Results of executed SQL statements, if any.

storedProcParams

Stored Procedure Parameter

Parameters passed to the Stored Procedure.