Siebel Business Process Framework: Workflow Guide > About Workflow Policies > About Views and Applets Used to Define a Workflow Policy >

Applets Used to Define a Workflow Policy Action


This topic provides information about the views and applets used to define a workflow policy group.

About the Actions Applet

Table 40 describes fields of the Workflow Policies Actions applet.

Table 40. Description of Fields in the Actions Applet
Field
Usage
Possible Value

Name

Define the name of the workflow policy action.

A descriptive name that is:

  • Consistent with your overall naming strategy
  • Meaningful to the policy maker

Program

Define the workflow policy program associated with the action.

This program is chosen from a picklist. For more information, see Using the Run External Programs Type.

Workflow
Object

Define the workflow policy object that this action is associated with. This action is now available only to policies that are based on this workflow policy object.

Chosen from a picklist of workflow policy objects.

Comments

Define comments describing the purpose or use of this action.

Enter comments text.

About the Arguments Applet

This topic describes how the arguments applet works.

For a description of each workflow policy program type, the available workflow policy program arguments and valid values, see About Predefined Workflow Policy Program Types.

Applets Refresh Automatically

The applets displayed in the Workflow Policies view change automatically depending on the program type you choose for the workflow policy action. This behavior is different from most views you use in the Siebel client.

For example, when navigating to Administration-Business Process > Policies, the following applets are displayed: Policies List, Conditions, Actions, Arguments. If you choose Send Page to Opportunity Sales Rep in the Action field of the Actions applet, the Arguments applet is automatically replaced with the Send Page Arguments applet.

Other Considerations to Weigh

Other considerations to weigh include:

  • Program arguments are case sensitive. You must enter the correct case. Use the argument picklists when possible instead of entering the arguments yourself.
  • Before using email or paging, you must perform the setup procedures described in About Workflow Policy Administration.
Using the Run External Programs Type

The External Programs Arguments applet appears if a Run External workflow policy program type is chosen in the Program field of the Actions applet.

For more information, see Example of a Workflow Policy Action That Runs an External Program.

Table 41 describes arguments for the Run External workflow policy program.

Table 41. Description of the Run External Workflow Policy Program Type
Argument
Description

Executable Name

Path and name of executable to run.

For example, the executable launches from the Siebel Server.

The executable can be a batch program.

Command Line

The command line to use.

Include the parameters that you need to pass to the executable.

If passing multiple substitution parameters, you must include a space between each parameter. For example: "[FirstName]"^"[LastName]", where ^ is a space.

A substitution parameter that contains spaces must be encased in quotes. Note that the quotes are also passed as part of the parameter.

For more information, see Siebel Object Types Reference.

Execute Type

Settings for Execute Type include:

  • Wait. Workflow Policies waits for the external program to finish and examines the return code of the external program. If the return code is not 0, an error condition occurs.
  • No Wait. Workflow Policies executes the external program in the background then continues processing. The return code is not checked.

Note that for Visual Basic programs which create files, set Execute Type to Wait to avoid possible corruption of files. When set to No Wait, Visual Basic attempts to write files twice, thus corrupting the data.

Available Substitutions

Dynamic fields that can be used as command line parameters.

When the action executes, the substitution value is populated with the value from the record in violation.

If no path is supplied for the Executable Name argument, the executable is assumed to be in the current path of Workflow Policies running on the Siebel Server. For example, if your Siebel Server is installed on C:\siebsrvr, then the default path for the executable name is C:\siebsrvr\bin.

NOTE:  The external program cannot be one that is interactive, requires a user interface, or accesses the Windows desktop.

About the Recipients Applet

The Action Recipients applet is only available when a Send Email, Send Page, or Send Message Broadcast program is chosen in the Actions applet. Table 42 describes fields in the Recipients applet.

Table 42. Description of Fields in the Recipients Applet
Field
Usage
Possible Value

Type

Define the possible values that are dependent on the workflow policy program defined for the action. Recipients apply to workflow policy programs of the following types: Send Email, Send Page, and Send Broadcast Message.

Possible values include:

  • Send to Employee. Picklist of employees.
  • Send to Position. Picklist of positions.
  • Send to Contact. Picklist of contacts.
  • Send to Relative. Send to an individual or group of individuals, such as a service request owner or opportunity team member, related to the Workflow object, such as an Opportunity or Service Request.
  • Send to Address. Represents a direct email address for programs that send email.

Name

Define the Name of the recipient based on the recipient type.

Contact name, employee name, position, or relative of workflow policy object to send an email, page, or broadcast message.

Note that messages are sent based on position. When choosing an employee as the recipient, if multiple employees occupy the same position, the message is sent to every employee, even though you are only choosing one employee as the recipient.

About the Send to Relative Recipient Type

The Send to Relative recipient type sends an email or page to an individual or position associated with the current record. For example, you can send an email to the primary sales representative of an opportunity when the conditions of the policy are met.

Send to Relative is also used when you need to configure a custom Send to [xxxx] recipient. Because you must use one of the Recipient Type choices in the picklist, you use Send to Relative to define a custom recipient type. The Recipient Type choices are Send to Employee, Position, Contact, or Relative.

Email Manager does not send email to the same recipient twice for the same action. If it detects that an email has already been sent to a specific email address, another one is not sent. If the Send to Relative type returns more than one recipient, each recipient is sent an email as long as each email address is unique.

Sending an Email to Multiple Relative Recipients

A workflow policy can be configured so that the same email message is sent to a number of different relative recipients.

to send an email to multiple relative recipients

  1. Create an action for the policy program.
  2. In the Recipients applet, add a new record and set the Type field to Send to Relative and the Name field to the name of the first recipient.
  3. Repeat step Step 2 for each additional recipient, updating the Name field in the Recipients applet for each recipient.
  4. Associate the action with the workflow policy.
Siebel Business Process Framework: Workflow Guide Copyright © 2008, Oracle. All rights reserved.