Workflow and Method Reference for Order Management Interface

Some features of the order management interface are based on Siebel workflows. You can modify these workflows to suit your own business model using Siebel Business Process Designer. For more information, see Siebel Business Process Framework: Workflow Guide.

This chapter explains the Siebel workflows used by the order management interface, and the methods called by these workflows. This chapter does not include workflows for asset-based ordering, which are covered in Workflow Reference for Employee Asset-Based Ordering.

This chapter covers the following topics:

Order Management Interface Workflow Reference

The order management interface uses the following workflows:

Workflows for creating a quote or order:
Workflows for validating a quote, order, or agreement:
Workflows for approving a quote, order, or agreement:

Note: The functionality of these workflows may depend on the exact setting of the arguments for the methods called. For detailed information about the argument settings for the methods called by workflow processes, refer to the workflow process definition in Siebel Tools Online Help.

Account - New Order Workflow

Account - New Order Workflow, shown in the following figure, creates a new Quote for the current Account. It then navigates to Order Entry - Detail Orders View.

It is triggered by the Accounts Screen, Account List applet menu.

Workflow Description

This workflow does the following:

Create New Order. Creates an order
Goto Order View. Calls a Sub-process called Goto_Order, which navigates to Order Entry - Detail Orders View

Account - New Quote Workflow

Account - New Quote Workflow, shown in the following. creates a new Quote for the current Account. It then navigates to Quote Item Detail View.

It is triggered from the Accounts screen, Account List applet menu.

Workflow Description

This workflow does the following:

Create New Quote. Creates a quote
Goto Order View. Calls a sub-process called Goto_Quote, which uses Interactive workflow step to navigate to Quote Item Detail View.

Contact - New Order Workflow

Contact - New Order Workflow, shown in the following figure, creates a new Order for the current Contact. It then navigates to the Order Entry screen, Detail Orders View.

It is triggered from the Contacts screen, Contact List applet menu.

Workflow Description

This workflow does the following:

Create New Order. Creates an order for a contact.
Goto Order View. Calls a Sub-process called Goto_Order, which navigates to Order Entry - Detail Orders View

Contact - New Quote Workflow

Account - New Quote Workflow, shown in the following figure, creates a new Quote for the current Account. It then navigates to the Quote Item Detail View.

It is triggered from the Contacts Screen, Contact List applet menu.

Workflow Description

This workflow does the following:

Create New Quote. Creates a quote
Goto Quote View. Calls a sub-process called Goto_Quote, which uses interactive workflow step to navigate to Quote Item Detail View.

Goto_Quote Workflow

Goto_Quote workflow, shown in the following figure, navigates to Quote Item Detail View

It is triggered by the Account - New Quote and Contact - New Quote workflows.

Workflow Description

This workflow does the following:

This sub-process uses an interactive workflow step to navigate to Quote Item Detail View.

Goto_Order Workflow

Goto_Order workflow, shown in the following figure, navigates to Order Entry - Detail Orders View.

It is triggered by the Account - New Order and Contact - New Order workflows.

Workflow Description

This workflow does the following:

This sub-process uses an interactive workflow step to navigate to Order Entry - Detail Orders View.

Verify Header (Quote) Workflow

Verify Header (Quote) workflow, shown in the following figure, is used to verify a quote, verify a promotion, and verify line items of a quote. It displays promotion violations, data validation rule violations, and complex product violations.

It is triggered when the user clicks the Verify button in a quote header or selects Verify from the menu of the quote line item applet.

Workflow Description

This workflow does the following:

Verify Promotion. Calls the ISS Promotion Verify SubProcess workflow to verify promotion status.
Data Validation. Calls the ISS Validation (Quote) workflow to verify Data Validation Rules.
Validate CP All. Calls the VORD Validate Complex Product All (Quote) workflow to validate all complex products under the Quote.
Display Messages. Displays all messages generated by the earlier steps.

ISS Validation (Agreement) Workflow

ISS Validation (Agreement) workflow, shown in the following figure, validates the Agreement according to the Rule Set definition for the agreement in Administration - Data Validation.

It is triggered by the VerifyItem signal, which is called by the Agreement screen, Verify applet menu.

Workflow Description

This workflow does the following:

This workflow calls the Validate method of the Data Validation Manager Business Service. This workflow validates the Agreement according to the Rule Sets that are defined in Administration - Data Validation view. For more information, see Validate Method.

Process Properties

Name	Business Object	Data Type	Comments
Error Code	Service Agreement	String	The Error Code that is returned if an error occurs.
Error Message	Service Agreement	String	The Error Message that is returned if an error occurs.
Object Id	Service Agreement	String	The Row ID of the current object.
Process Instance Id	Service Agreement	String	The Row ID of the current workflow process.
Return Code	Service Agreement	String	The Return Code that is defined in the Rule Set.
Return Message	Service Agreement	String	The Return Message that is defined in the Rule Set.
Siebel Operation Object Id	Service Agreement	String	The Row ID of the Siebel Operation Object.
Store Messages	Service Agreement	String	Variable to determine if the validation messages must be stored in the validation tables.
Validation Ruleset Name	Service Agreement	String	The name of the Rule Set that is defined in the Data Validation Administration screen.

ISS Validation (Order) Workflow

ISS Validation (Order) workflow, shown in the following figure, validates the Order according to the Rule Set definition in Administration - Data Validation view for orders.

It is triggered by the VerifyItem signal, which is called by the Verify applet menu item of the Order Header menu.

Workflow Description

This workflow does the following:

This workflow calls the Validate method of the Data Validation Manager Business Service. This workflow validates the Order according to the Rule Sets that are defined in Administration - Data Validation. For more information, see Validate Method.

Process Properties

Name	Business Object	Data Type	Comments
Error Code	Order Entry	String	The Error Code that is returned if an error occurs.
Error Message	Order Entry	String	The Error Message that is returned if an error occurs.
Object Id	Order Entry	String	The Row ID of the current object.
Process Instance Id	Order Entry	String	The Row ID of the current workflow process.
Return Code	Order Entry	String	The Return Code that is defined in the Rule Set.
Return Message	Order Entry	String	The Return Message that is defined in the Rule Set.
Siebel Operation Object Id	Order Entry	String	The Row ID of the Siebel Operation Object.
Store Messages	Order Entry	String	Variable to determine if the validation messages must be stored in the validation tables.
Validation Ruleset Name	Order Entry	String	The name of the Rule Set that is defined in the Data Validation Administration screen.

ISS Validation (Quote) Workflow

ISS Validation (Quote) workflow, shown in the following figure, validates the Quote according to the Rule Set definition for quotes in Administration - Data Validation.

It is triggered from VerifyItem signal which is called by the Verify Applet Menu item on the Quote Header.

Workflow Description

This workflow does the following:

This workflow calls the Validate method of the Data Validation Manager Business Service. This workflow validates the Quote according to the Rule Sets that are defined in Administration - Data Validation. For more information, see Validate Method.

Process Properties

Name	Business Object	Data Type	Comments
Error Code	Quote	String	The Error Code that is returned if an error occurs.
Error Message	Quote	String	The Error Message that is returned if an error occurs.
Object Id	Quote	String	The Row ID of the current object.
Process Instance Id	Quote	String	The Row ID of the current workflow process.
Return Code	Quote	String	The Return Code that is defined in the Rule Set.
Return Message	Quote	String	The Return Message that is defined in the Rule Set.
Siebel Operation Object Id	Quote	String	The Row ID of the Siebel Operation Object.
Store Messages	Quote	String	Variable to determine if the validation messages must be stored in the validation tables.
Validation Ruleset Name	Quote	String	The name of the Rule Set that is defined in the Data Validation Administration screen.

ISS Approval (Quote) Workflow

ISS Approval (Quote) workflow, shown in the following figure, validates approval rules and creates approval items if necessary.

It is triggered when the user selects the Generate Approvals menu item on the Quote Header applet menu. This menu item raises the ApproveItem Signal, which calls this workflow.

Workflow Description

This workflow does the following:

Validation Service. Calls the Validate method of the Data Validation Manager Business Service, which validates the Quote according to the Rule Sets that are defined. For more information, see Validate Method.
Exception Found. If the validation service returns a null, then the workflow ends.
Approval Business Service. If it returns a non-null value, then the workflow calls CreateNewApprovalTasks method, which creates a new approval task for the quote. For more information, see CreateNewApprovalTasks Method.
Refresh Applet. Calls the Refresh Business Component method of the SIS OM PMT Service Business Service, which refreshes the Quote, so the approval items appear in the approvals view.

ISS Approval (Order) Workflow

ISS Approval (Order) workflow, shown in the following figure, validates approval rules and creates approval items if necessary.

It is triggered when the user selects the Generate Approvals menu item on the Order Header applet menu. This menu item raises the ApproveItem Signal, which calls this workflow.

Workflow Description

This workflow does the following:

Validate. Calls the Validate method of the Data Validation Manager Business Service, which validates the Order according to the Rule Sets that are defined. For more information, see Validate Method.
Exception Found. If the validation service returns a null, then the workflow ends.
Approval Bus Service. If it returns a non-null value, then the workflow calls the CreateNewApprovalTasks method of the ISS Approval Bus Service, which creates a new approval task for the Order. For more information, see CreateNewApprovalTasks Method.
Refresh Applet. Calls the Refresh Business Component method of the SIS OM PMT Service Business Service, which refreshes the Order, so the approval items appear in the approvals view.

ISS Approval (Agreement) Workflow

ISS Approval (Agreement) workflow, shown in the following figure, validates approval rules and create approval items if necessary.

It is triggered when the user selects the Generate Approvals menu item on the Agreement Header applet menu. This menu item raises the ApproveItem Signal, which calls this workflow.

Workflow Description

This workflow does the following:

Validation Service. Calls the Validate method of the Data Validation Manager Business Service. For more information, see Validate Method.

Exception Found. If the validation service returns a null, then the workflow ends.
Approval Bus Service. If it returns a non-null value, then the workflow calls the CreateNewApprovalTasks method of the ISS Approval Bus Service. For more information, see CreateNewApprovalTasks Method.
Refresh Applet. Calls the Refresh Business Component method of the SIS OM PMT Service Business Service, which refreshes the Agreement, so the approval items appear in the Approvals view.

ISS Post Approval Workflow (Quote) Workflow

ISS Post Approval Workflow (Quote) workflow, shown in the following figure, checks whether any additional approvals are needed.

It is triggered when a user approves an Quote to see if additional approvals are needed.

Workflow Description

This workflow does the following:

Calls the SetApprovalDecision method. This will set the status of the current approval item and check to see if additional approval is needed.

Process Properties

Name	Business Object	Data Type	Comments
ActionLIC	Quote	String	The Language Independent Code for the Action Field
Approval Level Name	Quote	String	The name of the Approval Level that is defined in the Approval Administration screen.
Error Code	Quote	String	The Error Code that is returned if an error occurs.
Error Message	Quote	String	The Error Message that is returned if an error occurs.
InboxItemId	Quote	String	The Row ID of the current Universal Inbox Item.
InboxTypeName	Quote	String	The Universal Inbox Type.
Object Id	Quote	String	Obsolete.
ObjectId	Quote	String	The Row ID of the current object.
OwnerInfoId	Quote	String	The Row ID of the approver.
Process Instance Id	Quote	String	The Row ID of the current workflow process.
Returned Status	Quote	String	The Status of the Approval Item.
SendEmail	Quote	String	Variable to determine if email is sent to the person who needs to approve the current item.
SeqNum	Quote	String	The Sequence Number for the current approval level.
Siebel Operation Object Id	Quote	String	The Row ID of the Siebel Operation Object.
StageId	Quote	String	The Row ID of the current Approval Stage.

ISS Post Approval Workflow (Order) Workflow

ISS Post Approval Workflow (Order) workflow, shown in the following figure, checks whether any additional approvals are needed.

It is triggered when a user approves an Order to see if additional approvals are needed.

Workflow Description

This workflow does the following:

Calls the SetApprovalDecision method of the ISS Approval Bus Service Business Service. This will set the status of the current approval item and check to see if additional approval is needed.

Process Properties

Name	Business Object	Data Type	Comments
ActionLIC	Order Entry	String	The Language Independent Code for the Action Field
Approval Level Name	Order Entry	String	The name of the Approval Level that is defined in the Approval Administration screen.
Error Code	Order Entry	String	The Error Code that is returned if an error occurs.
Error Message	Order Entry	String	The Error Message that is returned if an error occurs.
InboxItemId	Order Entry	String	The Row ID of the current Universal Inbox Item.
InboxTypeName	Order Entry	String	The Universal Inbox Type.
Object Id	Order Entry	String	Obsolete.
ObjectId	Order Entry	String	The Row ID of the current object.
OwnerInfoId	Order Entry	String	The Row ID of the approver.
Process Instance Id	Order Entry	String	The Row ID of the current workflow process.
Returned Status	Order Entry	String	The Status of the Approval Item.
SendEmail	Order Entry	String	Variable to determine if email is sent to the person who needs to approve the current item.
SeqNum	Order Entry	String	The Sequence Number for the current approval level.
Siebel Operation Object Id	Order Entry	String	The Row ID of the Siebel Operation Object.
StageId	Order Entry	String	The Row ID of the current Approval Stage.

ISS Post Approval Workflow (Agreement) Workflow

ISS Post Approval Workflow (Agreement) workflow, shown in the following figure, checks whether any additional approvals are needed.

It is triggered when a user approves an Agreement to see if additional approvals are needed.

Workflow Description

This workflow does the following:

Calls the SetApprovalDecision method of the ISS Approval Bus Service Business Service. This will set the status of the current approval item and check to see if additional approval is needed.

Process Properties

Name	Business Object	Data Type	Comments
ActionLIC	Service Agreement	String	The Language Independent Code for the Action Field
Approval Level Name	Service Agreement	String	The name of the Approval Level that is defined in the Approval Administration screen.
Error Code	Service Agreement	String	The Error Code that is returned if an error occurs.
Error Message	Service Agreement	String	The Error Message that is returned if an error occurs.
InboxItemId	Service Agreement	String	The Row ID of the current Universal Inbox Item.
InboxTypeName	Service Agreement	String	The Universal Inbox Type.
Object Id	Service Agreement	String	Obsolete.
ObjectId	Service Agreement	String	The Row ID of the current object.
OwnerInfoId	Service Agreement	String	The Row ID of the approver.
Process Instance Id	Service Agreement	String	The Row ID of the current workflow process.
Returned Status	Service Agreement	String	The Status of the Approval Item.
SendEmail	Service Agreement	String	Variable to determine if email is sent to the person who needs to approve the current item.
SeqNum	Service Agreement	String	The Sequence Number for the current approval level.
Siebel Operation Object Id	Service Agreement	String	The Row ID of the Siebel Operation Object.
StageId	Service Agreement	String	The Row ID of the current Approval Stage.

Order Management Interface Methods Reference

The following methods are called by the order management interface workflows:

Validate Method

This method validates a quote, order, or agreement according to the Rule Sets that are defined in Administration - Data Validation.

Arguments

Input Argument	Type	Property Name	Comments
Rule Set Name	Process Property	Validation Ruleset Name	None
Store Messages	Process Property	Store Messages	This flag determines whether the validation messages are stored in the table.

Output Argument	Type	Property Name	Comments
Return Code	Output Argument	Return Code	Returns the error code. Depending on the code, the workflow determines whether approval is needed.
Return Message	Output Argument	Return Message	Returns the error message from the validation engine

SetApprovalDecision Method

This method sets the status of the current approval item and checks to see if additional approval is needed. This method is part of the ISS Approval Bus Service Business Service.

Arguments

Input Argument	Type	Property Name	Comments
ActionLIC	Process Property	ActionLIC	Approval status. Values are Approved, Rejected.
InboxItemId	Process Property	InboxItemId	ID of the current Inbox Item to be approved or rejected.
InboxTypeName	Process Property	InboxTypeName	Inbox Type defined in the Administration inbox screen; for example, Quote, Sales Order, Agreement, and so on.
ObjectId	Process Property	ObjectId	Row ID of the item to be approved; for example, the Quote ID, Order ID, and so on.
OwnerInfoId	Process Property	OwnerInfoId	Login ID of the person who is approving or rejecting the Inbox Item.
SendEmail	Process Property	SendEmail	Determines whether to send an email to the approver. Values are TRUE, FALSE.
SeqNum	Process Property	SeqNum	Sequence Number of the current Approval Stage.
StageId	Process Property	StageId	ID of the current Approval Stage.

CreateNewApprovalTasks Method

This method creates a new approval task for a quote, order, or agreement. This method is part of ISS Approval Business Service.

Arguments

Input Argument	Type	Property Name	Comments
Approval Level Context	Process Property	Approval Level Context	Added to accommodate Self-Service applications. Contains the Account ID.
Approval Item ID	Process Property	Object Id	Row ID of the item that needs to be approved; for example, Quote ID, Order ID, and so on.
Approval Level Name	Process Property	Approval Level Name	Name of the Approval Item that is defined in the Administration - Application screen, Approval Admin view.
Inbox Type	Process Property	Inbox Type	Inbox Type that is defined in the Administration Inbox screen; for example, Quote, Sales Order, Agreement, and so on.
Line Item #	Process Property	Line Item #	Not currently used.
Line Item Name	Process Property	Line Item Name	Not currently used.
Requesting Buscomp	Process Property	Requesting Buscomp	Business component that triggers the approval procedure. Used for dynamic drilldown (Quote, Order Entry - Orders, Service Agreement, and so on).
Return Message	Process Property	Return Message	Return Message defined in the Rule Set in the Administration - Data Validation screen, Rule Set view.
SendEmail	Process Property	SendEmail	Determines whether to send an email to the approver. Values are TRUE, FALSE.

GetApprovalStatus Method

This method returns the approval status for the inbox item. The status is one of the following: Approved, Declined, or In Progress. You must pass in the Approval Level Name, Approval Item ID, Inbox Type, and Object Id. This method is part of ISS Approval Business Service.

Input Arguments

The following table describes the GetApprovalStatus method input arguments.

Table GetApprovalStatus Method Input Arguments

Argument	Type	Property Name
Approval Item ID	Process Property	Approval Identifier
Approval Level Name	Process Property	Approval Item Name
Inbox Type Name	Process Property	Inbox Type Name

Output Arguments

The following table describes the GetApprovalStatus method output arguments.

Table GetApprovalStatus Method Output Arguments

Argument	Type	Property Name
Approval Item Status	Process Property	Approval Status

RefreshBusinessComponent Method

This method refreshes the display of a quote, order, or agreement. This method is part of the SIS OM PMT Service Business Service.

Arguments

Input Argument	Type	Value
Business Component Name	Literal	The name of the business component (such as Approval History - Quote, Approval History - Order, or Approval History - Agreement)
Business Object Name	Literal	The name of the business component (such as Quote, Order Entry (Sales), or Service Agreement).