|
Siebel Object Types Reference > Siebel Object Types Reference > Workflow Policy Program Object Types >
Workflow Policy Program Arg
A workflow policy program arg defines recipients, database actions, and substitutions. Each workflow policy program typically contains several workflow policy program arguments. This object type occurs in the following location in the object hierarchy:
Table 238 describes properties that Siebel CRM uses with a workflow policy program arg.
Table 238. Properties of the Workflow Policy Program Arg
|
|
Applet (O) |
Specifies the picklist applet. |
Default Value (O) |
Specifies a text value. This text depends on the type of workflow policy program arg. For example, an SQL statement, the text of a message, or the email address of a recipient. The maximum length is 2000 characters. CAUTION: Siebel CRM does not allow some kinds of text in the Default Value property of a workflow policy program arg. You must not include trailing spaces, newline, or escape characters. Using these characters might cause problems, such as a Workflow Monitor Agent failure at run time. You must create or modify a workflow policy program arg only with caution. For more information, see Siebel Business Process Framework: Workflow Guide.
|
Name (R) |
For more information, see Setting the Name Property of a Workflow Policy Program Arg. |
Picklist (O) |
Specifies the object definition of a picklist. |
Required (O) |
If TRUE, then data entry is required. |
Source Field (O) |
Specifies the picklist source field. |
Visible (O) |
If TRUE, then Siebel CRM displays the data that this argument provides. |
Setting the Default Value Property of a Workflow Policy Program Arg
To run a workflow policy program, the Siebel Server retrieves data from the Siebel database through an ODBC connection. The ODBC driver returns a date format that might be different from the format that the Siebel database uses. If you set the Default Value property of a workflow policy program arg, and if this workflow policy program arg references a time or date field, then you must use one of the following formats. This configuration makes sure the date formats are compatible:
- Date Column: 2001-03-16
- Time Column: 19:26:26
- Date and Time Column: 2001-04-05 21:25:00
Setting the Name Property of a Workflow Policy Program Arg
To familiarize yourself with how Siebel CRM uses a workflow policy program argument, you can examine some of the predefined arguments. For example, in the Workflow Policy Programs list, you can query the Name property for Run External Program. Table 239 describes some of the workflow policy program arguments that this object references. Note the following:
- You enter the value manually in the Name property of the workflow policy program arg.
- If you run a database operation with Insert as the Operation Type, then you can choose a Default Value, New Row ID that provides the value for the ROW_Id field for the inserted row.
Table 239 describes values for workflow policy program arguments that are common to a workflow policy program.
Table 239. Arguments in the Name Property of the Workflow Policy Program Arguments List
|
|
|
Primary Id |
Specifies the row ID of the violating row on which the workflow policy program runs. |
Empty. |
Primary Table |
Specifies the base table where this workflow policy program arg applies an action. The base table can be unrelated to 'the record of the primary ID. For example, the violating row resides in a child table and Siebel CRM must insert or update a record in the parent table. It can also update a table that is not related to the primary ID table. For example, to create a broadcast message when a monitored value in the opportunity becomes true. |
The name of a table in the repository, as compared to the business object that a workflow process references. Siebel CRM uses the business object that a workflow process references to monitor values but not to code an action program. |
Update Row ID |
Specifies the row ID of a table other than the primary table of the workflow policy object. You can configure Siebel CRM to associate a workflow policy action with a workflow policy object that updates a table. Siebel CRM uses the Update Row ID property only if the Operation Type is set to Update. |
The row ID that Siebel CRM must update. |
Operation Type |
Specifies to perform an update operation or insert operation. |
You can use one of the following values:
|
Field Name |
Specifies the Name of the column in the base table that this operation updates. This value is one of two field column pairs. |
You can use one of the following values:
|
New Row ID |
Specifies the row ID of the row that Siebel CRM must insert. Siebel CRM automatically populate this property with this row ID. |
Empty. |
Field Name (Column) |
Specifies the field name using the following format: Field_nameColumn
where:
- Field name is the field name of the first column pair
This is the second of two column pairs. |
Field name in the base table. This value cannot contain leading spaces. |
Sql Statement |
Specifies the data from the Siebel database that Siebel CRM uses to populate substitutions when it performs an action. |
Valid SQL query statement for one of the following RDBMS that your implementation uses:
- Oracle
- MS SQL
- Informix
- Sybase
|
Sql Statement Inputs |
Specifies the name of a column in the base table on which Siebel CRM performs an operation. |
Not applicable. |
Sql Statement Outputs |
Specifies a variable for the values that the SQL Statement argument chooses. |
Name of the variable. |
Sending Multiple Variables to SQL Program Arguments
Multiple variables can be sent into SQL program arguments. To send multiple variables to SQL program arguments
- In the Workflow Policy Program Arguments list, choose Sql Statement Inputs.
- Enter the variable names into the Default Value property.
Use the following format:
[variable1], [variable2], [variable n]
Arguments for a Workflow Policy Program that Sends a Message
Table 240 describes workflow policy program arguments that the Send Email workflow policy program references. These arguments are specific to sending a message. To view these arguments, you can query the Name property for Send Email.
Table 240. Properties of the Send Message Program Argument
|
|
|
Email Message |
Specifies the body of the email message. |
Text with available substitutions. |
Email Message Repeated |
Specifies the text that Siebel CRM repeats when it uses the Consolidate feature. |
Text with available substitutions. |
Email Subject |
Specifies the text in the subject line of the email message. |
Text. |
Send to Contact |
Specifies the contacts who are available in Siebel CRM. |
Not applicable. |
Send to Position |
Specifies the list of the positions that are available in Siebel CRM. |
Not applicable. |
Send to Employee |
Specifies the list of employees who are available in Siebel CRM. |
Not applicable. |
Arguments for a Workflow Policy Program that Sends a Page
Table 241 describes workflow policy program arguments that are specific to some workflow policy programs that send a page.
Table 241. Properties of the Send Page Program Argument
|
|
|
Send to Contact |
Specifies the contacts who are available in Siebel CRM. |
Picklist of contacts. |
Send to Employee |
Specifies the list of employees who are available in Siebel CRM. |
Picklist of employees. |
Send to Position |
Specifies the list of the positions that are available in Siebel CRM. |
Picklist of positions. |
Send to Relative |
Specifies to send to an individual or group of individuals who are related to the workflow process object. |
Not applicable. |
Alpha Numeric Page Message |
Specifies the body of the text message. |
Text with available substitutions. |
Numeric Page Message |
Specifies the body of the numeric message. |
Text with available substitutions. |
Arguments for a Workflow Policy Program that Runs an External Program
Table 242 describes workflow policy program arguments that are specific to some workflow policy programs that run an external program.
Table 242. Properties of the Run External Program Argument
|
|
|
Command Line |
Specifies the parameters that Siebel CRM sends to the executable. |
Not applicable. |
Executable Name |
Specifies the full path to the executable that Siebel CRM runs. |
Not applicable. |
Executable Type |
Specifies the mode the Workflow Action Agent uses to run the external program. |
You can use one of the following values:
|
|
