Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Reference of Workflow Policy Object Properties >

Properties of the Workflow Policy Program Argument


A workflow policy program argument defines recipients, database actions, and available substitutions. Each workflow policy program typically has several program arguments. The argument fields that display in this view depend on the type of workflow policy program you choose. A workflow policy program argument is a child of a workflow policy program.

CAUTION:  Certain text is not allowed in the Default Value workflow policy program argument. Do not use trailing spaces, [newline], or escape characters. Using this text can cause problems, such as failure of Workflow Monitor Agent during run time.

Table 125 describes properties displayed in the Workflow Policy Program Arguments OBLE.

Table 125. Description of Properties of the Workflow Policy Program Argument
Property
Required
Usage

Applet

Optional

Define the Picklist applet.

Default Value

Optional

Define the text value of a type that depends on the Name of the program argument-an SQL statement, the text of a message, the email address of a recipient, and so forth.

Maximum length is 2000 characters.

When setting this property, be sure to note the caution information described in this topic.

Name

Required

Define the parameter from a predefined set of values.

For a description of values, see Workflow Policy Program Argument Values for the Name Property.

Note that the value is entered manually. You do not choose from a picklist.

Picklist

Optional

Define the Picklist object.

Required

Boolean

Specify whether or not data entry is required. Value is TRUE or FALSE.

Source Field

Optional

Specify the Picklist Source field.

Visible

Boolean

Specify whether the data supplied by this argument is displayed. Value is TRUE or FALSE.

Inactive

(This cell is intentionally empty.)

Checked if program is not active.

Date Formats with Workflow Policy Programs

Formats to use when setting a Default Value for time/date fields include:

  • Date Column format: 2001-03-16
  • Time Column format: 19:26:26
  • Date Time Column format: 2001-04-05 21:25:00

Note that a workflow policy program is executed by the Siebel Server that connects to Oracle through ODBC. As part of this process, the required data is retrieved from the database through this connection. The format of a date in an email is the format returned by the ODBC driver, which might be different to that used by Oracle.

Workflow Policy Program Argument Values for the Name Property

You can add functionality to a workflow policy program by creating a new workflow policy program argument. A workflow policy program argument determines how the workflow policy program behaves, including what substitutions are available for a workflow policy program and how the recipients are defined.

TIP:   To familiarize yourself with how workflow Policy Program Arguments are used, examine some of the predefined object definitions. For example, in the Workflow Policy Programs OBLE, query the Name property for Run External Program. Note that this object definition references some of the common workflow policy program arguments described in Table 126. Next, query the Name property for Send Email. Note that this Workflow Policy Program references several Workflow Policy Program Arguments specific to sending a message, as described in Table 127.

Table 126 describes valid values for workflow policy program arguments common to workflow policy programs.

Table 126. Description of Arguments in the Name Property of the Workflow Policy Program Arguments OBLE
Common Argument
Usage
Allowable Default Value

Primary Id

The row ID of the violating row that the Workflow policy program is acting on.

Empty.

Primary Table

Define the base table to which the action is applied.

The base table can be unrelated to the record of the primary ID. For example, the violating row is in a child table and you now need to insert or update a record in the parent table.

Tables can also be updated that are not related to the primary ID table. For example, create a Broadcast Message record when a certain monitored condition in the Opportunity record is true.

Tables defined within the Siebel business object repository, as compared to the workflow business object. Workflow business objects are used for monitoring conditions but are not used in the coding of action programs.

Update Row ID

Define the row ID of a table other than the primary table of the workflow policy object.

You can associate a workflow policy action with a workflow policy that updates a table.

This value is used only when the Operation Type is set to update.

The row ID you need to update.

Operation Type

Define the operation to perform: update or insert.

Two possible values for DB Operation: Update or Insert.

Field Name

Define the Name of the column in the base table to which the operation is performed.

This is one of two field column pairs.

Allowable values: Text, Variable, Function.

New Row ID

For insert operations, this argument is automatically populated with the row ID of the row about to be inserted.

Empty.

Field Name (Column)

Define the Field Name, which must be identical to the Field Name of the first column pair and (Column) appended to the name.

This is the second of two Column Pairs.

Actual field name in the base table.

The value can not contain leading spaces.

Sql Statement

Used as a way to identify more data from the database to be used as substitutions when the action is performed.

Valid SQL query statement for the RDBMS used: Oracle, MS SQL, Informix, or Sybase.

Sql Statement Inputs

Define the Name of the column in the base table on which the operation is performed.

(This cell is intentionally empty.)

Sql Statement Outputs

Use as a placeholder for the values chosen in the SQL Statement argument.

Variable Name.

Considerations to weigh include:

  • The value is entered manually into the Name property of the Workflow Policy Program Arguments OBLE.
  • When you run a database operation with Insert as the Operation Type, you can choose a Default Value, New Row ID, as described previously, which provides the value for the ROW_Id field for the row being inserted.

Passing Multiple Variables into SQL Program Arguments

Multiple variables can be passed into SQL program arguments.

To pass multiple variables into SQL program arguments

  1. In the Workflow Policy Program Arguments OBLE, choose Sql Statement Inputs.
  2. Enter the variable names into the Default Value property.

    Use the following format: [variable1], [variable2], [variable n]

Send Message Program Arguments

Table 127 describes program arguments specific to the Send Message program.

Table 127. Description of Properties of the Send Message Program Argument
Value in Name Property
Usage
Value

Email Message

Define the body of the email message.

Text with available substitutions.

Email Message Repeated

Define the text that is repeated when the Consolidate feature is used.

Text with available substitutions.

Email Subject

Define the text in subject line of the email message.

Any text.

Send to Contact

Define the contacts available in Siebel.

(This cell is intentionally empty.)

Send to Position

Define the list of the positions available in Siebel.

(This cell is intentionally empty.)

Send to Employee

Define the list of employees available in Siebel.

(This cell is intentionally empty.)

Send Page Program Arguments

Table 128 describes program arguments specific to the Send Page program,

Table 128. Description of Properties of the Send Page Program Argument
Value in Name Property
Usage
Value

Send to Contact

Define the contacts available in Siebel.

Picklist of contacts.

Send to Employee

Define the list of employees available in Siebel.

Picklist of employees.

Send to Position

Define the list of the positions available in Siebel.

Picklist of positions.

Send to Relative

Specify to send to an individual or group of individuals related to the Workflow object.

(This cell is intentionally empty.)

Alpha Numeric Page Message

Define the body of the text message.

Text with available substitutions.

Numeric Page Message

Define the body of the numeric message.

Text with available substitutions.

Run External Program Arguments

Table 129 describes program arguments specific to the Run External Program.

Table 129. Description of Properties of the Run External Program Argument
Value in Name Property
Usage
Value

Command Line

Define the parameters to pass to the executable.

(This cell is intentionally empty.)

Executable Name

Define the full path to the executable to execute.

(This cell is intentionally empty.)

Executable Type

Define the mode in which the Workflow Action Agent executes the external program.

Wait.

No wait.

Siebel Business Process Framework: Workflow Guide Copyright © 2008, Oracle. All rights reserved.