Siebel Business Process Framework: Workflow Guide > Manipulating Data in a Workflow Process > Using Process Properties >

Using Predefined Process Properties


Table 19 describes some of the process properties that come predefined with Siebel CRM.

Table 19. Predefined Process Properties
Predefined Process Property
Description

Object Id

The Siebel row ID of the record that Siebel CRM uses when it starts a workflow process. For more information, see Object Id Process Property.

Error Code

An error symbol that Siebel CRM uses if a step returns an error. It automatically populates this process property if an error occurs.

Error Message

The text error message if a step returns an error. It automatically populates this process property if an error occurs.

Siebel Operation Object Id

The Siebel row ID of the record that Siebel CRM updates, creates, or queries during a Siebel operation step. It automatically populates this process property when a Siebel operation step is run.

Process Instance Id

A unique number that Siebel CRM assigns to the workflow process instance that is currently running. It automatically populates this process property when a workflow process runs and if persistence is activated.

Object Id Process Property

The Object Id process property is the Siebel Row Id of the primary business component record that Siebel CRM uses when it starts a workflow process.

Run-Time Event Behavior

If a run-time event starts a workflow process, then Siebel CRM sends the business component instance that starts the run-time event to Siebel Workflow. The row that the Object Id property defines receives this run-time event. Siebel Workflow receives and processes this event only if the business component and the workflow process references the same business object. If Siebel Workflow can receive this event, then Siebel CRM sets the Object Id process property to the active row of the primary record in the business object.

If the business component that starts the run-time event is not the primary business component, then Siebel CRM does not update the active row of the business component in the Object Id process property, and it must get this row through some extra processing.

The long-running, interactive, and service workflow processes use the following behavior:

  • The Object Id must match the Row ID of the active row for the primary business component. If the Object Id process property is different from the active row, then Siebel CRM runs the primary business component again to make the active row the same as the Object Id.
  • To change the active row, you can configure Siebel CRM to assign a new Row Id to the Object Id property. If Siebel Workflow detects that a new Row Id is assigned to the Object Id property, then it runs the business component again and makes the new Row ID the active row.
  • If you set the Object Id to an empty string, then Siebel Workflow does not enforce the must match rule. However, Siebel Workflow cannot use objects that require an Object Id, such as the run-time event or Siebel operation step, until it sets the Object Id to a new Row ID.
Changing the Active Row in a Workflow Process Step

You can add a step that changes the active row.

To change the active row in a workflow process step

  1. Add a Siebel operation or business service step that performs an operation that causes Siebel CRM to change the active row.
  2. For more information, see Adding Workflow Process Steps.
  3. Update the value of the Object Id process property to the new value of the active Row ID that resides in the output argument of the workflow process step you added in Step 1.

    After a workflow process step finishes and Siebel Workflow evaluates output arguments, it makes sure the Object Id matches the active row. The Object Id property in this step must include the change to the active row.

Using the In/Out Process Property

If necessary, you can run a workflow process to avoid receiving response data. For example, to prevent Siebel CRM from inserting records in the S_SRM_DATA table that can cause a heavy backlog. If the Type field of a process property is Out or In/Out, then Siebel CRM sends a reply to the object that called the workflow process. For example, it sends a reply to the Server Request Processor. If the caller:

  • Receives a reply that is not null, then it writes this reply in the S_SRM_DATA table.
  • Receives no reply, then it does not write a reply in the S_SRM_DATA table.

Siebel CRM does the following:

  • If it inserts a request in the S_SRM_REQUEST table, then it also inserts one or more rows in the S_SRM_DATA table for the component request parameters and input arguments that the request uses.
  • When it sends this request, the MSG_TYPE_CD column of the S_SRM_DATA table contains a value of REQ_DATA, which indicates that Siebel CRM must request data or input for the request.
  • If the request finishes, then it inserts a set of rows in the S_SRM_DATA table and sets the value of the MSG_TYPE_CD column to REQ_RESPONSE, which indicates that the request returned a reply to the caller. In this situation, the request is in the S_SRM_REQUEST table, which indicates that the Server Request Processor component is the caller.
Running a Workflow Process to Avoid a Response Data Insert

You can run a workflow process to avoid response data inserts.

To run a workflow process to avoid a response data insert

  1. Do one of the following options:
    • Leave the In/Out property of the process property set to In/Out until immediately upstream of the end of the workflow process.
    • Immediately upstream of the end of the workflow process, call another step that nulls out values that Siebel CRM stores in the process properties.

      If you use this configuration, then Siebel CRM does not send reply text to the Server Request Processor and it does not insert a record in the S_SRM_DATA table.

  2. Review the process properties, and then set the In/Out property to NONE.
Siebel Business Process Framework: Workflow Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.