16Defining Billing Profile Workflows for Siebel Communications

Defining Billing Profile Workflows for Siebel Communications

This chapter includes the following topics:

• About Billing Profile Workflows for Siebel Communications

• Workflows for Synchronization

• Workflow to View Content in the Billing Profile Portal

• Workflows to Enter Adjustments in the Billing Profile Portal

• Workflows to Manage Contacts, Accounts, and Payments

About Billing Profile Workflows for Siebel Communications

A workflow process is a sequence of steps that automates a business function. Some workflow processes (also known as business processes) allow your company to manage operations associated with billing profiles.

Workflows for Synchronization

This group of workflows synchronizes data between the Siebel CRM application and the billing application. It consists of the following workflow processes:

• CMU Account Sync Workflow

• CMU Address Sync Workflow

• CMU Contact Sync Workflow

• CMU Profile Sync Workflow

• SWI Account Update Workflow

• SWI Address Update Workflow

• SWI Contact Update Workflow

• SWI Billing Profile Update Workflow

• SWI Special Rating - Synchronize Process

• SWIAdjustmentStatusUpdate

• CMU Credit Alert Status Sync

CMU Account Sync Workflow

This workflow synchronizes account data between the Siebel CRM application and the billing application.

The following shows this workflow.

A user initiates this workflow by creating an account record or by changing any field in the business component for an account record in the Siebel CRM application.

Workflow Description

This workflow performs the following actions:

1. Query Account. Queries for the updated account details.

2. Get Custom Attributes. Reads the enterprise details, such as the enterprise server name, language, and locale.

3. Set Custom Attributes. Sets the enterprise details as part of the request message.

4. Account Update Web Service. Calls an asynchronous proxy Web service to send the account details to the billing application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query Account	QueryById	CMU Query Account Service
Get Custom Attributes	GetEnterpriseParameters	CMU External Integration Service
Set Custom Attributes	SetAttributesToMessage	CMU External Integration Service
Account Update Web Service	UpdateCustomerParty	UpdateCustomerSiebelJMSProducer

CMU Address Sync Workflow

This workflow synchronizes address data between the Siebel CRM application and the billing application.

The following shows this workflow.

A user initiates this workflow by creating an address record or by changing any field for the business component for an address record in the Siebel CRM application.

Workflow Description

This workflow performs the following actions:

1. Query Address. Queries for the updated address details.

2. Get Custom Attributes. Reads the enterprise details, such as the enterprise server name, language, and locale.

3. Set Custom Attributes. Sets the enterprise details as part of the request message.

4. Address Update Web Service. Calls an asynchronous proxy Web service to send the address details to the billing application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query Address	QueryById	CMU Query Address Service
Get Custom Attributes	GetEnterpriseParameters	CMU External Integration Service
Set Custom Attributes	SetAttributesToMessage	CMU External Integration Service
Address Update Web Service	UpdateCustomerPartyAddress	UpdateCustomerSiebelJMSProducer

CMU Contact Sync Workflow

This workflow synchronizes contact data between the Siebel CRM application and the billing application.

The following shows this workflow.

A user initiates this workflow by creating a contact record or by changing any field for the business component for a contact record in the Siebel CRM application.

Workflow Description

This workflow performs the following actions:

1. Query Contact. Queries for the updated contact details.

2. Get Custom Attributes. Reads the enterprise details, such as the enterprise server name, language, and locale.

3. Set Custom Attributes. Sets the enterprise details as part of the request message.

4. Contact Update Web Service. Calls an asynchronous proxy Web service to send the contact details to the billing application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query Contact	QueryById	CMU Query Contact Service
Get Custom Attributes	GetEnterpriseParameters	CMU External Integration Service
Set Custom Attributes	SetAttributesToMessage	CMU External Integration Service
Contact Update Web Service	UpdateCustomerPartyContact	UpdateCustomerSiebelJMSProducer

CMU Profile Sync Workflow

This workflow synchronizes billing profile data between the Siebel CRM application and the billing application.

The following shows this workflow.

A user initiates this workflow by creating a billing profile record or by changing any field for the business component for a billing profile record in the Siebel CRM application.

Workflow Description

This workflow performs the following actions:

1. Query Billing Profile. Queries for the updated billing profile details.

2. Get Custom Attributes. Reads the enterprise details, such as the enterprise server name, language, and locale.

3. Set Custom Attributes. Sets the enterprise details as part of the request message.

4. Billing Profile Update Web Service. Calls an asynchronous proxy Web service to send the billing profile details to the billing application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query Billing Profile	QueryById	CMU Query Billing Profile Service
Get Custom Attributes	GetEnterpriseParameters	CMU External Integration Service
Set Custom Attributes	SetAttributesToMessage	CMU External Integration Service
Billing Profile Update Web Service	UpdateCustomerPartyBillingProfile	UpdateCustomerSiebelJMSProducer

SWI Account Update Workflow

This workflow calls the outbound service to synchronize the account details from the Siebel application with the external application. It is called when a change is made to account details.

The following shows this workflow.

Workflow Description

This workflow performs the following actions:

1. Query Customer Party. Queries for the Account Id of an account in which a change has been made. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Get Custom Attributes. Gets details about Oracle’s Siebel Enterprise Server, such as the language and locale details.

3. Set Custom Attributes. Sets the Siebel Enterprise Server details, such as the language and locale values, in the request message to make an outbound Web service call.

4. UpdateCustomerParty. Calls the Aggregateaccountevent method of the SyncCustomerSiebelEventAggregator business service and updates the customer party. If the response received contains an error, then the workflow proceeds to the Set Error Msg step.

5. Set Error Msg. If an error occurs in the previous step, then this step displays an error message.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
UpdateCustomerParty	Aggregateaccountevent	SyncCustomerSiebelEventAggregator
Set Error Msg	CheckAndSetError	SWI External Integration Service

SWI Address Update Workflow

This workflow calls the outbound service to synchronize the address details from the Siebel application with the external application. It is called when a change is made to the address details.

The following shows this workflow.

Workflow Description

This workflow performs the following actions:

1. Query Address. Queries for the Address Id of an address in which a change has been made. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Get Custom Attributes. Gets Siebel Enterprise Server, such as the language and locale details for the server.

3. Set Custom Attributes. Sets the Siebel Enterprise Server details, such as the language and locale values, in the request message to make an outbound Web service call.

4. UpdateCustomerPartyAddress. Calls the Aggregateaddressevent method of the SyncCustomerSiebelEventAggregator business service and updates the customer party. If the response received contains an error, then the workflow proceeds to the Set Error Msg step.

5. Set Error Msg. If an error occurs in the previous step, then this step displays an error message.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
UpdateCustomerPartyAddress	Aggregateaddressevent	SyncCustomerSiebelEventAggregator
Set Error Msg	CheckAndSetError	SWI External Integration Service

SWI Contact Update Workflow

This workflow calls the outbound service to synchronize the contact details from the Siebel application with the external application. It is called when a change is made to contact details.

The following shows this workflow.

Workflow Description

This workflow performs the following actions:

1. Query Contact. Queries for the Contact Id of a contact in which a change has been made. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Get Custom Attributes. Gets the language and locale details for the Siebel Enterprise Server.

3. Set Custom Attributes. Sets the Siebel Enterprise Server details, such as the language and locale values, in the request message to make an outbound Web service call.

4. UpdateCustomerPartyContact. Calls the aggregatecontactevent method of the SyncCustomerSiebelEventAggregator business service and updates the customer party. If the response received contains an error, then the workflow proceeds to the Set Error Msg step.

5. Set Error Msg. If an error occurs in the previous step, then this step displays an error message.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
UpdateCustomerPartyContact	aggregatecontactevent	SyncCustomerSiebelEventAggregator
Set Error Msg	CheckAndSetError	SWI External Integration Service

SWI Billing Profile Update Workflow

This workflow calls the outbound service to synchronize the billing profile details from the Siebel application with the external application. It is called when a change is made to the billing profile details.

The following shows this workflow.

Workflow Description

This workflow performs the following actions:

1. Query Billing Profile. Queries for the Billing Profile Id of a billing profile in which a change has been made. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Get Custom Attributes. Gets the language and locale details for the Siebel Enterprise Server.

3. Set Custom Attributes. Sets the Siebel Enterprise Server details, such as the language and locale values, in the request message to make an outbound Web service call.

4. Billing Profile Update Web Service. Calls the aggregatebpevent method of the SyncCustomerSiebelEventAggregator business service and updates the customer party. If the response received contains an error, then the workflow proceeds to the Set Error Msg step.

5. Set Error Msg. If an error occurs in the previous step, then this step displays an error message.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Billing Profile Update Web Service	aggregatebpevent	SyncCustomerSiebelEventAggregator
Set Error Msg	CheckAndSetError	SWI External Integration Service

SWI Special Rating - Synchronize Process

This workflow calls a proxy business service to query and synchronize an updated Special Rating List with the external Oracle Communications Billing and Revenue Management application.

The following shows this workflow.

This workflow is called when a user clicks the Synchronize button in the Accounts Screen, Profiles view, Special Rating Profile subview, and then Special Rating List applet.

Workflow Description

This workflow performs the following actions:

1. Query Special Rating List. Queries the modified Special Rating list details with Special Rating list ID and active Special Rating list items. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Synchronize. Synchronizes the special rating details through an outbound Web service call.

3. Update List Synch Date. Updates the value of the Last Synchronized Date field to the current timestamp for the updated special rating list.

4. Update Items Synch Date. Updates the value of the Last Synchronized Date field as the current timestamp for each of the updated special rating list items.

SWIAdjustmentStatusUpdate

This workflow updates the status, substatus, and description of an adjustment record that is sent by a billing application.

The following shows this workflow.

This workflow is called by the SWIAdjustmentStatusUpdate inbound Web service.

Workflow Description

This workflow performs the following action:

• EAI Update. Updates the Status, Sub Status, and Status Description fields of an adjustment record. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then any field of the type DTYPE_UTCDATETIME in the payload must be in UTCCanonical format. While writing these fields to the business component, these fields are converted to the locale-specific date and time.

CMU Credit Alert Status Sync

This workflow updates the status of a credit alert from Siebel Communications to the external Oracle Communications Billing and Revenue Management application.

The following shows this workflow.

A user initiates this workflow by changing the status of a credit alert to Closed, and clicking the Synch Status button.

Note: The Synch Status button is enabled only when a credit alert is created by a third-party application. Consequently, this workflow can be called only when the credit alert’s Integration ID is not NULL.

Workflow Description

This workflow performs the following actions:

1. Query Credit Alert. Queries the Siebel database for the credit alert ID. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Get Custom Attributes. Gets the parameters for the existing details from the server, such as the name, language, and locale, to add to the request message in the outbound Web service.

3. Set Custom Attributes. Adds the enterprise server parameters to the request message.

4. Credit Alert Update Web Service. Synchronizes the credit alert status with the external application.

Workflow to View Content in the Billing Profile Portal

This workflow allows users to view content in the Billing Profile portal. It consists of one workflow process.

SIA External Integration Process Workflow

This workflow retrieves and displays data from a billing application. This data consists of information about top-up requests, current account balances, and usage activity for an account. This workflow displays the content in the Billing Profile portal. This content includes balance group, usage that is not billed, bill, and bill payment information.

This workflow is called in the following situations:

• When the user clicks the Name field of a billing profile in the Billing Profile list of the Account Summary view.

• When the user accesses or navigates to the following views in the billing profile portal:

  • Balance Group

  • Unbilled Usage

  • Bills

  • Payments

This workflow is not called from within the Adjustments view.

The following shows the SIA External Integration Process workflow.

Workflow Description

This workflow performs the following actions:

1. Get Custom Attributes. Reads the enterprise details, such as the Siebel Enterprise Server name, language, and locale.

2. Set Custom Attributes. Sets the enterprise details as part of the request message.

3. Proxy Business Service. This step performs the following work:

   1. Calls the appropriate proxy business service as determined by the input that is passed to the business service.

   2. Calls the WSDL file on the integration server to get the response in Siebel Message format. In Oracle Application Integration Architecture 2.5, the workflow passes the Proxy BS Fault input argument for customized fault handling. If there is a fault, then the business service returns the fault code, a summary, and a detail in the output argument.

   Note: You must create the proxy business services that this workflow calls. Also, for the virtual business components (VBCs) that use these services, you must configure the user properties.

4. UpdateVBCRec. Retrieves the data from the Siebel message and stores the data in the property set.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Get Custom Attributes	GetEnterpriseParameters	CMU External Integration Service
Set Custom Attributes	SetAttributesToMessage	CMU External Integration Service
Proxy Business Service	InvokeAndValidateProxy	SWI External Integration Service
UpdateVBCRec	AddSiebelMessage	CMU External Integration Service

The business service names depend on the Name tags in the WSDL file that you generate when you create the proxy business services.

Workflows to Enter Adjustments in the Billing Profile Portal

This group of workflows allows users to enter adjustments for bills in the Billing Profile portal. It consists of the following workflow processes and subprocess:

• CMUInvoiceAdjustmentWF

  • CMUInvoiceQueryWF

• CMUItemChargeAdjustmentWF

  • CMUItemChargeQueryWF

• CMUEventDetailsAdjustmentWF

  • CMUEventDetailsQueryWF

• CMUBalanceDetailEventAdjustmentWF

  • CMU Adjustment View Sub Process

• CMU SIA Submit Adjustment Request to External

• CMUUnbilledEventAdjustmentWF Workflow

• CMUUnbilledNonCurrencyEventAdjustmentWF Workflow

CMUInvoiceAdjustmentWF

This workflow creates appropriate adjustment request detail when a user adjusts an entire bill.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for an entire bill.

Workflow Description

This workflow performs the following actions:

1. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check if the bill exists in the Siebel database. If the bill does not exist, then it creates the bill header. For more information, see CMUInvoiceQueryWF.

2. Create Adjustment Header. Creates the adjustment request header, and defaults the Request Amount and the Approved Amount to 0. The Bill Number is populated with the Bill Number of the bill on which the adjustment is being made. The Adjustment Class is set to Billed for all adjustments made on the bill, whether at the item, event, or bill level.

3. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the adjustment view. For more information, see CMU Adjustment View Sub Process.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Create Invoice Header	CMUInvoiceDataTransfer	CMU Util UI Service
Create Adjustment Header	CMUAdjustmentDataTransfer	CMU Util UI Service

CMUInvoiceQueryWF

This workflow finds a particular bill in the Siebel database.

The following shows this workflow.

The following workflows call this workflow as a subprocess:

• CMUInvoiceAdjustmentWF

• CMUItemChargeAdjustmentWF

• CMUEventDetailsAdjustmentWF

• CMUBalanceDetailsEventAdjustmentWF

Workflow Description

This workflow performs the following action:

• QueryInvoiceHeader. Checks if a bill exists in the Siebel database.

Associated Business Service Methods. The following table shows the step in this workflow that calls a business service method.

Workflow Step	Method Called	In Business Service
QueryInvoiceHeader	QueryInvoiceData	CMU Util UI Service

CMUItemChargeAdjustmentWF

This workflow creates appropriate adjustment request detail when a user adjusts bill item charges.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for item charges relating to a bill.

Workflow Description

This workflow performs the following actions:

1. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check if the bill exists in the Siebel database. If the bill does not exist, then it creates the bill header. For more information, see CMUInvoiceQueryWF.

2. Create Invoice Line Item. Calls the CMUItemChargeQueryWF workflow to check if the item charge exists in the Siebel database. If the item charge does not exist, then creates the bill line item. For more information, see CMUItemChargeQueryWF.

3. Create Adjustment Header. Creates the adjustment request header and populates some of the header fields.

4. Create Adjustment Line Item. Creates the adjustment request header, and defaults the Request Amount and the Approved Amount to 0. The Bill Number is populated with the Bill Number of the bill on which the adjustment is being made. The Adjustment Class is set to Billed for all adjustments made on the bill, whether at the item, event, or bill level.

5. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the adjustment view. For more information, see CMU Adjustment View Sub Process.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Create Invoice Header	CMUInvoiceDataTransfer	CMU Util UI Service
Create Invoice Line Item	CMUInvoiceDataTransfer	CMU Util UI Service
Create Adjustment Header	CMUAdjustmentDataTransfer	CMU Util UI Service
Create Adjustment Line Item	CMUAdjustmentDataTransfer	CMU Util UI Service

CMUItemChargeQueryWF

This workflow finds a particular item charge in the Siebel database.

The following shows this workflow.

The following workflows call this workflow as a subprocess:

• CMUItemChargeAdjustmentWF

• CMUEventDetailsAdjustmentWF

• CMUBalanceDetailsEventAdjustmentWF

Workflow Description

This workflow performs the following action:

• QueryInvoiceDetails. Checks if an item charge exists in the Siebel database.

Associated Business Service Methods. The following table shows the step in this workflow that calls a business service method.

Workflow Step	Method Called	In Business Service
QueryInvoiceDetails	QueryInvoiceData	CMU Util UI Service

CMUEventDetailsAdjustmentWF

This workflow creates appropriate adjustment request detail when a user adjusts bill events.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for events relating to a bill.

Workflow Description

This workflow performs the following actions:

1. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check if the bill exists in the Siebel database. If the bill does not exist, then it creates the bill header. For more information, see CMUInvoiceQueryWF.

2. Create Invoice Line Item. Calls the CMUItemChargeQueryWF workflow to check if the item charge exists in the Siebel database. If the item charge does not exist, then creates the bill line item. For more information, see CMUItemChargeQueryWF.

3. Create Invoice Details. Calls the CMUEventDetailsQueryWF workflow to check if the bill event detail exists in the Siebel database. If the bill event detail does not exist, then creates the bill event detail. For more information, see CMUEventDetailsQueryWF.

4. Create Adjustment Header. Creates the adjustment request header and populates some of the header fields.

5. Create Adjustment Line Item. Creates the adjustment request line item, and defaults the Request Amount and the Approved Amount to 0.

6. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the adjustment view. For more information, see CMU Adjustment View Sub Process.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Create Invoice Header	CMUInvoiceDataTransfer	CMU Util UI Service
Create Invoice Line Item	CMUInvoiceDataTransfer	CMU Util UI Service
Create Invoice Details	CMUInvoiceDataTransfer	CMU Util UI Service
Create Adjustment Header	CMUAdjustmentDataTransfer	CMU Util UI Service
Create Adjustment Line Item	CMUAdjustmentDataTransfer	CMU Util UI Service

CMUEventDetailsQueryWF

This workflow finds a particular event in the Siebel database.

The following shows this workflow.

The following workflows call this workflow as a subprocess:

• CMUEventDetailsAdjustmentWF

• CMUBalanceDetailsEventAdjustmentWF

Workflow Description

This workflow performs the following action:

• QueryInvoiceDetails. Checks if an event exists in the Siebel database.

Associated Business Service Methods. The following table shows the step in this workflow that calls a business service method.

Workflow Step	Method Called	In Business Service
QueryInvoiceDetails	QueryInvoiceData	CMU Util UI Service

CMUBalanceDetailsEventAdjustmentWF

This workflow creates appropriate adjustment request detail when a user adjusts a resource balance.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for a resource balance total relating to events.

Workflow Description

This workflow performs the following actions:

1. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check if the bill exists in the Siebel database. If the bill does not exist, then it creates the bill header. For more information, see CMUInvoiceQueryWF.

2. Create Invoice Line Item. Calls the CMUItemChargeQueryWF workflow to check if the item charge exists in the Siebel database. If the item charge does not exist, then creates the bill line item. For more information, see CMUItemChargeQueryWF.

3. Create Invoice Details. Calls the CMUEventDetailsQueryWF workflow to check if the bill event detail exists in the Siebel database. If the bill event detail does not exist, then creates the bill event detail. For more information, see CMUEventDetailsQueryWF.

4. Create Adjustment Header. Creates the adjustment request header and populates some of the header fields.

5. Create Adjustment Line Item. Creates the adjustment request line item, and defaults the Request Value and the Approved Value to 0.

6. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the adjustment view. For more information, see CMU Adjustment View Sub Process.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Create Invoice Header	CMUInvoiceDataTransfer	CMU Util UI Service
Create Invoice Line Item	CMUInvoiceDataTransfer	CMU Util UI Service
Create Invoice Details	CMUInvoiceDataTransfer	CMU Util UI Service
Create Adjustment Header	CMUAdjustmentDataTransfer	CMU Util UI Service
Create Adjustment Line Item	CMUAdjustmentDataTransfer	CMU Util UI Service

CMU Adjustment View Sub Process

This workflow navigates to the adjustment view.

The following shows this workflow.

The following workflows call this workflow as a subprocess:

• CMUInvoiceAdjustmentWF

• CMUItemChargeAdjustmentWF

• CMUEventDetailsAdjustmentWF

• CMUBalanceDetailsEventAdjustmentWF

Workflow Description

This workflow performs the following action:

• Goto View. Navigates to the Adjustment view.

CMU SIA Submit Adjustment Request to External

This workflow submits an adjustment request to an external application by invoking an outbound Web service and changes the status of the adjustment header to Submitted.

The following shows this workflow.

A user initiates this workflow by clicking the Submit button on the Billing Adjustments screen.

Workflow Description

This workflow performs the following actions:

1. Query Adjustment. Queries the Siebel database for the adjustment request to be submitted to the external application. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

2. Is Approved. Checks whether the adjustment is approved in the Siebel application, and goes to the following steps:

   • Change Status to Pending. If the adjustment request is not approved, then it changes the status of the adjustment record to Pending and ends the workflow.

   • Get EnterpriseServer Param. If the adjustment request is approved, then it gets the parameters from the existing server, such as the enterprise server name, language, and locale, to add to the adjustment request message in the outbound Web service, and then it proceeds to the next step.

3. SetAttributesToMessage. Adds the enterprise server parameters to the adjustment request message.

4. Adjustment Submit Outbound WS. Calls the SWICreateAdjustment outbound Web service, which sends a request to create an adjustment in the Oracle Communications Billing and Revenue Management AQ (Advanced Queue).

5. Change Status to Submitted. Changes the status of the adjustment record to Submitted.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query Adjustment	Query	EAI Siebel Adapter
Get EnterpriseServer Param	GetEnterpriseParameters	CMU External Integration Service
SetAttributesToMessage	SetAttributesToMessage	CMU External Integration Service
Adjustment Submit Outbound WS	CreateAdjustment	AdjustmentSiebelReqABCS

CMUUnbilledEventAdjustmentWF Workflow

This workflow processes an unbilled event adjustment.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for events relating to a bill.

Workflow Description

This workflow performs the following actions:

1. Read AIA Comm Pref. Reads the system preference to determine whether Oracle Application Integration Architecture is enabled.

2. Do Adjustments? Checks whether there are unbilled event adjustments to process. If there are, then proceeds with the workflow. If there are not, then stops the workflow.

3. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check whether the unbilled adjustment exists in the Siebel database. If the unbilled adjustment does not exist, then it creates the unbilled invoice header. For more information, see CMUInvoiceQueryWF.

4. Create Invoice Line Item. Calls the CMUItemChargeQueryWF workflow to check whether the unbilled item charge exists in the Siebel database. If the unbilled item charge does not exist, then it creates the unbilled invoice item. For more information, see CMUItemChargeQueryWF.

5. Create Invoice Details. Calls the CMUEventDetailsQueryWF workflow to check whether the unbilled item detail exists in the Siebel database. If the unbilled item detail does not exist, then it creates the unbilled invoice item details. For more information, see CMUEventDetailsQueryWF.

6. Create Adjustment Header. Creates the adjustment header for the unbilled event, and populates some of the header fields.

7. Create Adjustment Line Item. Creates the adjustment line item for the unbilled event. Defaults the Request Amount and the Approved Amount to 0. The Adjustment Class is set to Unbilled. The Bill Number remains blank in case of an unbilled adjustment.

8. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the Billing Adjustments screen, External Line Items view. For more information, see CMU Adjustment View Sub Process.

CMUUnbilledNonCurrencyEventAdjustmentWF Workflow

This workflow processes an unbilled noncurrency event adjustment.

The following shows this workflow.

A user initiates this workflow by clicking the Adjust button for a resource balance total relating to unbilled events.

Workflow Description

This workflow performs the following actions:

1. Read AIA Comm Pref. Reads the system preference to determine whether Oracle Application Integration Architecture is enabled.

2. Do Adjustments? Checks whether there are unbilled non-currency event adjustments to process. If there are, then proceeds with the workflow. If there are not, then stops the workflow.

3. Create Invoice Header. Calls the CMUInvoiceQueryWF workflow to check whether the unbilled adjustment exists in the Siebel database. If the unbilled adjustment does not exist, then this workflow step creates the unbilled invoice header. For more information, see CMUInvoiceQueryWF.

4. Create Invoice Line Item. Calls the CMUItemChargeQueryWF workflow to check whether the unbilled item charge exists in the Siebel database. If the unbilled item charge does not exist, then this workflow step creates the unbilled invoice item. For more information, see CMUItemChargeQueryWF.

5. Create Invoice Details. Calls the CMUEventDetailsQueryWF workflow to check whether the unbilled item detail exists in the Siebel database. If the unbilled item detail does not exist, then this workflow step creates the unbilled invoice item details. For more information, see CMUEventDetailsQueryWF.

6. Create Adjustment Header. Creates the adjustment header for the unbilled noncurrency event, and populates some of the header fields.

7. Create Adjustment Line Item. Creates the adjustment line item for the unbilled noncurrency event. Defaults the Request Value and Approved Value fields to 0.

8. Goto Adjustment View Sub Process. Calls the CMU Adjustment View Sub Process to navigate to the Billing Adjustments screen, External Line Items view. For more information, see CMU Adjustment View Sub Process.

Workflows to Manage Contacts, Accounts, and Payments

This group of workflows allows users to manage contacts, accounts, and payments. It consists of the following workflow processes and subprocess:

• SWI External Account Integration Process Workflow

• SWI External Contact Integration Process Workflow

• SWI External Customer Req Integration Process Workflow

• SWI External Contact Req Integration Process Workflow

• SWI External Account Request Sync Process Workflow

• SWI External Contact Request Sync Process Workflow

• SWISendPaymentAuthorization Workflow

• SWISendCreditCheck Workflow

SWI External Account Integration Process Workflow

This workflow is used to make outbound Web service calls to fetch data to populate the SWI Match Account VBC. It is called when the user clicks the Go button in the popup applet SWI Match Account List Applet.

The following shows the SWI External Account Integration Process workflow.

Workflow Description

This workflow performs the following actions:

1. Check Req Field. Checks if the required field values are entered in the popup applet SWI Match Account List Applet before sending a request to external application to query the account details.

2. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language and locale values, for the Siebel Server.

3. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message to make an outbound service call.

4. Proxy Business Service. Makes an outbound Web service call, validates the response message, and checks for service errors.

5. UpdateVBCRec. Updates the virtual business component, SWI Match Account VBC, to display the queried accounts in the popup applet SWI Match Account List Applet.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Check Req Field	CheckRequiredFiled	SWI External Integration Service
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
Proxy Business Service	InvokeAndValidateProxy	SWI External Integration Service
UpdateVBCRec	AddSiebelMessage	SWI External Integration Service

SWI External Contact Integration Process Workflow

This workflow is used to make outbound Web service calls to fetch data to populate the SWI Match Contact VBC. It is called when the user clicks the Go button in the popup applet SWI Match Contact List Applet.

The following shows the SWI External Contact Integration Process workflow.

Workflow Description

This workflow performs the following actions:

1. Check Req Field. Checks if the required field values are entered in the popup applet, SWI Match Contact List Applet, before sending a request to an external application to query the contact details.

2. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language and locale values, for the Siebel Server.

3. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message to make an outbound service call.

4. Proxy Business Service. Makes an outbound service call, validates the response message, and checks for service errors.

5. UpdateVBCRec. Updates the virtual business component, SWI Match Contact VBC, to display the queried accounts in the popup applet, SWI Match Contact List Applet.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Check Req Field	CheckRequiredFiled	SWI External Integration Service
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
Proxy Business Service	InvokeAndValidateProxy	SWI External Integration Service
UpdateVBCRec	AddSiebelMessage	SWI External Integration Service

SWI External Customer Req Integration Process Workflow

This workflow is used to make an outbound Web service synchronize queried accounts from the external application. If an account is not present in Siebel CRM, then a new account will be created. This workflow is called when a user clicks the Fetch button on the SWI Match Account List Applet, after querying the account details from the external application.

The following shows the SWI External Customer Req Integration Process workflow.

Workflow Description

This workflow performs the following actions:

1. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language and locale values, for the Siebel Server.

2. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message that is sent to make an outbound service call.

3. Proxy Business Service. Makes an outbound service call, validates the response message, and checks for service errors.

4. Add Siebel Message. Updates the virtual business component, SWI Match Account VBC, to display the queried accounts in the popup applet, SWI Match Account List Applet.

5. Retrieve Field Value. Retrieves the Account Id from the external application to verify if the account successfully synchronized with the Siebel Business Application from Oracle.

6. Customer Synced? Checks if the Account Id returned from the previous step is NULL. If Account Id is NULL, then the account is not synchronized. If Account Id is not NULL, then the account is synchronized.

7. Close Popup. Closes the popup applet, SWI Match Account List Applet.

8. Refresh View. Queries the account business component with the Account Id returned by the outbound service call and refreshes the view to display only the synchronized account details in the Accounts view.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
Proxy Business Service	InvokeAndValidateProxy	SWI External Integration Service
Add Siebel Message	AddSiebelMessage	SWI External Integration Service
Retrieve Field Value	RetriveFiledValue	SWI External Integration Service
Close Popup	ClosePopup	SWI Util UI Service
Refresh View	RefreshView	SWI Util UI Service

SWI External Contact Req Integration Process Workflow

This workflow is used to make an outbound service synchronize the queried contacts from the external application. If a contact is not present in Siebel CRM, then a new contact will be created. This workflow is called when a user clicks the Fetch button on the SWI Match Contact List Applet, after querying the contact details from the external application.

The following shows the SWI External Contact Req Integration Process workflow.

Workflow Description

This workflow performs the following actions:

1. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language and locale values, for the Siebel Server.

2. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message to make an outbound service call.

3. Proxy Business Service. Makes an outbound service call, validates the response message, and checks for service errors.

4. Add Siebel Message. Updates the virtual business component, SWI Match Contact VBC, to display the queried accounts in the popup applet, SWI Match Contact List Applet.

5. Retrieve Field Value. Retrieves the Contact Id from the Oracle Application Integration Architecture response message to verify if the contact successfully synchronized with the Siebel application.

6. Customer Synced? Checks if the Contact Id returned from the previous step is NULL. If Contact Id is NULL, then the contact is not synchronized successfully. If Contact Id is not NULL, then the contact is synchronized successfully.

7. Close Popup. Closes the popup applet, SWI Match Contact List Applet.

8. Refresh View. Queries the Account business component with the Contact Id that is returned by the external application, then refreshes the view to display only the synchronized account details in the Accounts view.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
Proxy Business Service	InvokeAndValidateProxy	SWI External Integration Service
Add Siebel Message	AddSiebelMessage	SWI External Integration Service
Retrieve Field Value	RetriveFiledValue	SWI External Integration Service
Close Popup	ClosePopup	SWI Util UI Service
Refresh View	RefreshView	SWI Util UI Service

SWI External Account Request Sync Process Workflow

This workflow synchronizes the account from the external application with the Siebel application. It is called when the user selects the Fetch menu item from the SIS Account List Applet.

The following shows the SWI External Account Request Sync Process workflow.

Workflow Description

This workflow performs the following actions:

1. Generate Template. Generates a template to query the contact details, which contain only the required fields, such as Account Id to make an outbound Web service call.

2. EAI UI Data Adapter. Fills the template generated in the previous step with the account information that is used to make an outbound Web service call to synchronize the account with the Siebel application. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

3. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language, and locale values, for the Siebel Server.

4. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message to make an outbound Web service call.

5. External Sync Service. Makes an outbound Web service call to synchronize the account details from the external application with the Siebel application.

6. Display Error. Retrieves the error message, if there is any during the outbound Web service call, and displays it in the Siebel application.

7. Retrieve Field Value. Retrieves the Account Id from the Web service response message to verify if the account successfully synchronized with the Siebel application.

8. Field Value Present. Checks if the Account Id returned from the previous step is NULL. If the Account Id is NULL, then the account is not synchronized. If the Account Id is not NULL, then the account is synchronized.

9. Refresh UI. If the account synchronized successfully, then this step refreshes the Account view so that the synchronized account is included in the Siebel application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Generate Template	GetTemplate	Generate Template Service
EAI UI Data Adapter	QueryPage	EAI UI Data Adapter
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
External Sync Service	CustomerPartyIOFetchAccount	FetchAccountSiebelReqABCSImplService
Display Error	CheckAndSetError	SWI External Integration Service
Retrieve Field Value	RetriveFiledValue	SWI External Integration Service
Refresh UI	RefreshCurrentApplet	FINS Teller UI Navigation

SWI External Contact Request Sync Process Workflow

This workflow synchronizes a contact from an external application with the Siebel application. It is called when the user selects the Fetch menu item in the Contact List applet.

The following shows the SWI External Contact Request Sync Process workflow.

Workflow Description

This workflow performs the following actions:

1. Generate Template. Generates a template to query the contact details, which contain only the required fields to make an outbound Web service call, such as Contact Id.

2. EAI UI Data Adapter. Fills the template generated in the previous step with the contact information used to make an outbound Web service call to synchronize the contact with the Siebel application. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

3. Get Custom Attributes. Gets the details of the Siebel Enterprise Server, such as the language and locale values, to be used by the Siebel Server.

4. Set Custom Attributes. Sets the details of the Siebel Enterprise Server, such as the language and locale values, in the request message to make an outbound Web service call.

5. External Sync Service. Makes an outbound Web service call to synchronize the account details from the external application with the Siebel application.

6. Display Error. Retrieves the error message from the Web service call, if any, and displays it in the Siebel application.

7. Retrieve Field Value. Retrieves the Contact Id from the Web service call response message to determine whether the contact successfully synchronized with the Siebel application.

8. Field Value Present. Checks if the Contact Id returned from the previous step is NULL. If yes, then the contact is not synchronized. If no, then the contact is synchronized.

9. Refresh UI. If the Contact is synchronized, then this step refreshes the Contact view so the synchronized contact appears in the Siebel client.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Generate Template	GetTemplate	Generate Template Service
EAI UI Data Adapter	QueryPage	EAI UI Data Adapter
Get Custom Attributes	GetEnterpriseParameters	SWI External Integration Service
Set Custom Attributes	SetAttributesToMessage	SWI External Integration Service
External Sync Service	CustomerPartyIOFetchAccount	FetchAccountSiebelReqABCSImplService
Display Error	CheckAndSetError	SWI External Integration Service
Retrieve Field Value	RetriveFiledValue	SWI External Integration Service
Refresh UI	RefreshCurrentApplet	FINS Teller UI Navigation

SWISendPaymentAuthorization Workflow

This workflow checks if this payment record is valid for the customer. The operator creates a new payment record as a credit card payment and fills all requested fields. This workflow is called when a user clicks the Authorize button.

The following shows the SWISendPaymentAuthorization workflow.

Workflow Description

This workflow performs the following actions:

1. Validate. Validates the input values.

2. Error. Checks whether the input is absent or invalid. If the input is absent or invalid, then the workflow proceeds to the Stop on Error step.

3. Query Payments. Queries the payment details from the Payments business component.

4. Query IO w/ right Payment. Queries the Siebel database for the correct set of payment details and prepares the Siebel XML file for transmission. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

5. Get AIA Parameters. Gets the Siebel Enterprise Server details and other parameters.

6. Set AIA Parameters. Formats the parameters into Siebel message format.

7. Call WS. Calls the outbound Web service and sends the payload.

8. Handle Fault. If an error occurs in the prior step, then this step displays an error message.

9. Update Payments. Updates the payment details. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then any field of the type DTYPE_UTCDATETIME in the payload must be in UTCCanonical format. While writing these fields into the business component, these fields are converted to the locale-specific date and time.

10. Refresh. Refreshes the applet so the synchronized information appears in the Siebel application.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Validate	Validate	FINS Validator
Query IO w/ right Payment	Query	EAI Siebel Adapter
Get AIA Parameters	GetEnterpriseParameters	SWI External Integration Service
Set AIA Parameters	SetAttributesToMessage	SWI External Integration Service
Call WS	PaymentAuthorization	PaymentAuthorizationSalesOrderSiebelReqABCSImplService
Handle Fault	CheckAndSetError	SWI External Integration Service
Update Payments	Upsert	EAI Siebel Adapter
Refresh	RefreshCurrentApplet	FINS Teller UI Navigation

SWISendCreditCheck Workflow

This workflow determines whether the Purchase Order method is a valid payment. It is called when the user clicks the Credit Check button.

The following shows the SWISendCreditCheck workflow.

Workflow Description

This workflow performs the following actions:

1. Query Payments. Queries payment details from the Payments business component.

2. Query By Example. Runs a query to obtain the correct set of payment details. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then the query returns data for any field of the type DTYPE_UTCDATETIME in UTC Canonical format.

3. Get AIA Parameters. Gets Oracle’s Siebel Enterprise Server details and other parameters.

4. Set AIA Parameters. Formats the parameters into Siebel message format.

5. Call WS Credit Check. Calls the outbound Web service and sends the payload.

6. Set Err Msg. If an error occurs in the previous step, then this step displays an error message.

7. Update Status. Updates credit check details received. Derives the value of the UTCCanonical input parameter for this step from the UTCCanonical process property. The default value of this property is N. If the value passed is Y, then any field of the type DTYPE_UTCDATETIME in the payload must be in UTCCanonical format. While writing these fields into the business component, these fields are converted to the locale-specific date and time.

8. Refresh. This step refreshes the applet so the synchronized information appears in the Siebel client.

Associated Business Service Methods. The following table shows the steps in this workflow that call business service methods.

Workflow Step	Method Called	In Business Service
Query By Example	Query	EAI Siebel Adapter
Get AIA Parameters	GetEnterpriseParameters	SWI External Integration Service
Set AIA Parameters	SetAttributesToMessage	SWI External Integration Service
Call WS Credit Check	CreditCheck	CreditCheckSalesOrderSiebelReqABCSImplService
Set Err Msg	CheckAndSetError	SWI External Integration Service
Update Status	Upsert	EAI Siebel Adapter
Refresh	RefreshCurrentApplet	FINS Teller UI Navigation