Appendix: Order Capture Delivered Business Processes and Web Services

This appendix discusses the delivered Business Process Execution Language (BPEL) business processes and web services, and provides guidelines on how to view message elements.

See Also

Understanding Web Services

Delivered Business Processes

This section discusses:

• Communications New Order process flow.

• Mobile Number Portability process flow.

• Change Service process flow.

• Prepaid to Postpaid Account Conversion process flow.

• Port Authorization Code (PAC) Request process flow.

• Service Management Activate Service process flow.

• Service Management Suspend Service process flow.

• Service Management Suspend and Change Service process flow.

• Service Management Resume Service process flow.

• Service Management Disconnect Service process flow.

• Lost or Stolen Handset process flow.

• Service Management Port In process flow.

• Use of sub and stub business processes in delivered business processes.

Communications New Order Process Flow

This process is initiated when an order for communications is created and submitted after passing through any holds.

Payload is created with order details in it and is passed onto this business process as part of the initiation process.

This diagram illustrates the Communications New Order process flow:

Communications New Order process flow (1 of 2)

Communications New Order process flow (2 of 2)

Note. If this is a storefront transaction, change the source from Phone to Storefront to ensure the correct New Order flow is used. A storefront order skips shipping and does not go to fulfillment.

When this business process is initiated, it:

1. Checks if this is a prepaid order.

   No credit check is required if it is a prepaid order.

2. Performs a credit check through an external web service call if it is a postpaid order and if a new account creation has been requested as part of the order.

   If the credit check does not meet the threshold value that is defined for the business process, the business process is terminated.

3. If the New Account option is enabled, creates an account in the CRM system through an internal web service call.

   This applies to both prepaid and postpaid accounts.

4. Creates an account in the prepaid or postpaid billing system, depending on whether this is a prepaid or postpaid account.

   The account creation is done through an external web service call.

5. Receives the response from the external billing system with the newly created account in the Active status.

   If the account is created with a nonactive status, the business process waits for a defined period of time for the account to become active.

6. Sends the account information to the CRM system through an internal web service call to update the order as well as the corresponding internal billing account.

7. Creates installed products for all products available in the order with the appropriate relationships through an internal web service call.

8. Cumulates the information for all the line items that require shipment.

   This information is published to an external fulfillment system through an external web service call.

9. Receives the shipment notice from the external fulfillment system.

   This notice can contain one or many lines. The business process waits for all the shipment information, which can be returned in multiple batches from the external system.

10. Updates the corresponding installed product (that is, the serial ID) for each received shipment notice.

    This is done through an internal web service call.

11. Updates the corresponding order line status to Shipped for each received shipment notice.

12. Performs these activities for each line item in the order if the nature of the product in the line item is Wireless:

    • If the category of the product is SIM (Subscriber Identity Module):

      i. The process relates the corresponding phone numbers (which are related to the line item to which this SIM is associated) to this SIM, through an internal web service call.

      ii. The SIM status is set to Active.

    • If the category of the product is Phone, the phone number status is set to Pending Activation.

    • If the line item has a port-in request, the Mobile Number Portability business process is invoked.

      After the completion of the Mobile Number Portability business process, the control is returned to this business process.

      See Mobile Number Portability Process Flow.

    • If the line item is associated with a sub-business process, a call to the subbusiness process is made and the control is returned to the main calling business process.

    All line-level activities are completed.

13. Creates service orders for installed products, if applicable, through an internal web service call.

14. Creates an agreement for the order, if applicable, through an internal web service call.

15. Sets the order status to Completed through an internal web service call, which also sets the status of all lines to Completed if they are not already in the Completed, Shipped, or Cancelled status.

16. If any of the line items requires shipping, sets the status of the parent installed product to Pending Call Activation through an internal web service call, which also takes care of updating the status of all child installed products to Pending Call Status.

17. If no line items require shipping, invokes the Service Management Activate Service business process.

    After the Service Management Activate Service business process is completed, the control is returned to this main business process.

    See Service Management Activate Service Process Flow.

The Communications New Order business process ends.

While this business process is in progress, a cancellation message is sent to it if the corresponding new order is being cancelled. When that happens, the business process terminates regardless of the stage it is in.

Mobile Number Portability Process Flow

This process is typically initiated from the Communications New Order business process. For each port-in found on an order, an instance of this process exists. This process is responsible for validating the details provided for the port-in.

See Communications New Order Process Flow.

This diagram illustrates the Mobile Number Portability process flow:

Mobile Number Portability process flow (1 of 2)

Mobile Number Portability process flow (2 of 2)

When this business process is initiated from the Communications New Order business process it:

1. Examines the payload for the port-in details.

   If the details indicate that a system validation is needed, the process calls a third-party service to validate the porting details. Otherwise, it assumes that the details are validated already.

2. If system validation is needed, sets the order line status to 1200 : Port-In Processing if its current status is 1000 : New.

   This is accomplished by calling a delivered service operation.

   A loop is performed until either the port-in details become valid or the maximum number of Retry Attempts (default = 3) is reached. Then it:

   1. Calls the RB_CUSTOMER_GET_CUSTOMER (Get Customer Information) service operation of the delivered Customer web service to retrieve customer details.

      If the order has a contact BO (business object) ID, the ID is used to obtain customer information. Otherwise, the customer BO ID is used.

      See Business Object Delivered Web Services.

   2. Copies all needed customer details and payload data into the Port Request message.

   3. Calls the third-party web service (it is a placeholder that customers need to replace with their own web services) for the port-in request.

      The purpose of this routine is to validate the details and respond with the validation results. This is an asynchronous call.

   4. Receives a response from the third-party system and checks for the validity of the details.

   5. If the details are valid, it:

      i. Calls a delivered web service to update the order line status to 1230 : Port In Validated.

      ii. Returns to the top of the loop with the details marked as valid.

   6. If the details are invalid, it:

      i. Calls a delivered web service to update the order line status to 1210 : Invalid Port-In.

      ii. Calls the RO_SERVICEMGT_ADDNOTE service operation to add a note with the validation message that is returned from the third-party system.

      iii. Calls the CREATE_WORKLIST_ITEM service operation to add a worklist entry for this order, indicating that the port-in details are invalid.

      At this point, the process waits until a manual update of the worklist item takes place, which typically happens after a customer service representative makes the necessary changes to the port-in details on the order and resubmits the order.

      iv. Increases the retry count by 1 after the worklist notification is received and returns to the top of the loop to try again.

3. If port-in details are valid, it calls the RO_SERVICEMGT_ADDSUBMIT service operation to create a service management order (with Port-In action) and have it submitted, which launches the Service Management Port In business process to continue the porting procedure.

   See Service Management Port In Process Flow.

4. Copies the input payload to the output data.

5. Notifies the Communications New Order business process that the Mobile Number Portability business process is complete.

The Mobile Number Portability business process ends.

Note. If the MNP order is cancelled, the status of the installed products does not change.

Change Service Process Flow

This process is initiated when a service management order for communications is created with a line action of Change. Also, it gets initiated from the Service Management Suspend and Change Service business process as a subbusiness process.

See Service Management Suspend and Change Service Process Flow.

This diagram illustrates the Change Service process flow:

Change Service process flow

When this business process is initiated, it:

1. Checks if the first line item of the service management order has an action of Change or SuspendAndChange.

   Note. Steps 2 through 6 are line-level activities.

2. Checks the action of every line item other than the first one.

3. If line item action is of type Change Number, it:

   • Obtains the parent installed product details through an internal web service call.

   • Relates the new phone number to the SIM of the parent installed product.

   • Ends the relationship between the old phone number and the SIM of the parent installed product through an internal web service call.

   • Creates the history for new phone number through an internal web service call.

   • Updates the installed product for the product with the new phone number through an internal web service call.

   • Sets the status of the old phone number to Aging through an internal web service call.

   • Sets the status of the new phone number to Active through an internal web service call.

4. If line item action is of type Remove Product, it:

   • Sets the installed product status to Pending Disconnect through an internal web service call.

   • Publishes details to the external provisioning system about disconnecting the installed product through an external web service call.

   • Sets the installed product status to Disconnected through an internal web service call.

   • If the removed product has a phone number, sets the phone number status to Aging through an internal web service call.

   • Updates the pricing on the parent installed product through an internal web service call.

5. If line item action is of type Add Product, it:

   • Creates an installed product through an internal web service call.

   • Publishes details to the external provisioning system about the new installed product through an external web service call.

   • Sets the installed product status to Installed through an internal web service call.

   • If the added product has a phone number, sets the phone number status to Active through an internal web service call.

6. For all line items within this order (those that are in any of the mentioned action type and those that are not), the process updates the attributes of their installed products accordingly.

   The information is available on the order as well.

7. The status of the order is changed to Completed, which also takes care of updating all the line statuses to Completed if they are not already in the Completed, Cancelled, or Shipped status.

The Change Service business process ends.

Prepaid to Postpaid Account Conversion Process Flow

This process is called from the Service Management Activate Service business process. It performs various tasks, which includes closing down the prepaid account, moving its installed products to the new postpaid account, and if applicable, notifying the prepaid billing system to transfer any balances. It also links the prepaid and postpaid accounts to maintain history.

See Service Management Activate Service Process Flow.

This diagram illustrates the Prepaid to Postpaid Account Conversion process flow:

Prepaid to Postpaid Account Conversion process flow

When this business process is initiated, it:

1. Calls the RBT_ACCT_LINK (Link Accounts) service operation of the delivered Billing Account web service to establish the link between the old prepaid and new postpaid accounts.

2. Invokes the Service Management Disconnect Service business process to disconnect the installed products of the prepaid account.

3. Calls the RBT_ACCT_CONVERT (Complete Account Conversion) service operation of the delivered Billing Account web service to clone any installed products that are carried over from the prepaid account to the postpaid account.

   Products that can be moved include the USIM (UMTS Subscriber Identity Module), phone number, and handset.

4. Calls the RBT_ACCT_UPDT (Update Account) service operation of the delivered Billing Account web service to set the status of the prepaid account to Closed.

5. Sends a message to the prepaid billing system to transfer and balances on the prepaid account to the postpaid account.

   As delivered, the prepaid billing system is simulated by the PrepaidBillingSystemWebService business process. Customers need to replace it with their own integration partner.

The Prepaid to Postpaid Account Conversion business process ends, and returns the control back to the Service Management Activate Service business process.

See Service Management Disconnect Service Process Flow.

PAC Request Process Flow

This process is initiated from service management orders in which the PAC request action is performed. It validates if a PAC is issued. If a PAC is issued, the installed product is updated with the information. If not, the service management order is updated with a note.

This diagram illustrates the PAC Request process flow:

PAC Request process flow

When this business process is initiated, it:

1. Copies payload values into the PAC validation simulator message.

   With this data, it calls a third-party web service called MNPThirdPartySimulator (it is a placeholder that customers need to replace with their own web services). The simulator responds with an outcome of true or false.

   A reason for denial is provided in the response if the outcomes is false.

2. If the outcome is true, calls the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service to update the PAC value and the PAC expiration date.

   PAC expiration date = current date + 30 days

   See Delivered Web Services.

3. If the outcome is false, calls the RO_SERVICEMGT_ADDNOTE service operation to add a note to the service management order stating the reason for denying the PAC request.

The PAC Request business process ends.

Service Management Activate Service Process Flow

This process can be called from service management orders (activate service) or new orders. It performs various activation tasks, such as updating the phone number, updating the SIM, invoking the Prepaid to Postpaid Account Conversion business process, updating the installed product status, and communicating with both the provisioning and billing systems.

See Prepaid to Postpaid Account Conversion Process Flow.

This diagram illustrates the Service Management Activate Service process flow:

Service Management Activate Service process flow (1 of 2)

Service Management Activate Service process flow (2 of 2)

When this business process is initiated, it:

• Calls the RO_SERVICEMGT_GETACTSRVCMSG (Get Activate Service Message) service operation of the delivered RO_SERVICEMGT (Service Management) web service to get inputs for the RBTActivateService business process.

• If it is a service management order, performs the following activities:

  • If the phone number is assigned during activation:

    First, it calls the RO_NUMMGT_SETNUMBERSTATUS (Set Number Status) service operation of the delivered RO_NUMMGT (Number Management) web service to update the phone number status to Pending Activation.

    Then, it calls the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered RF_INST_PRODUCT (Installed Product) web service to update the phone number on the installed products.

    Next, it calls the BillingActivateServiceRequest service operation of a third-party web service (BillingSimulator) to notify them about the phone number.

  • If the SIM is in pending activation:

    First, it calls the RO_NUMMGT_SETSIMSTATUS (Set SIM Card Status) service operation of the delivered RO_NUMMGT_SETSIMSTATUS (Number Management) web service to the update SIM status to Activated.

    Then, it calls the ProvisioningActivateRequest service operation of the third-party web service (ProvisioningSimulator) to notify them of SIM change. Then, it calls the RO_SERVICEMGT_IMSI_CHG (IMSI change operation) service operation of the delivered RO_SERVICEMGT (Service Management) web service to update SIM on installed products.

    Lastly, this service activation business process stops.

    See Delivered Web Services.

• If the order is for prepaid to postpaid conversion, performs the following activities:

  • It calls the RO_SERVICEMGT_GETDISSRVCMSG (Get Disconnect Service Details) service operation of the delivered RO_SERVICEMGT (Service Management) web service to get inputs for the ConvertPreToPostPaid business process.

  • It calls the delivered RBTConvertPreToPostPaid business process to convert the product from prepaid to postpaid.

• Calls the ProvisioningActivateRequest operation of the third-party web service (ProvisioningSimulator) to publish information about account details and installed products.

• Calls the RO_NUMMGT_SETNUMBERSTATUS (Set Number Status) service operation of the delivered RO_NUMMGT (Number Management) web service to set the phone number status to Assigned.

• If order is for a prepaid account, calls the AccountBalanceRequest operation of the third-party web service (BillingSimulator) to get the account balance.

• If the account balance is greater than zero or it is not a prepaid account, calls the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered RF_INST_PRODUCT (Installed Product) web service to update to update the installed product status to Activated.

• If the account balance is equal to zero and it is a prepaid account, performs the following activities:

  • Calls the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered RF_INST_PRODUCT (Installed Product) web service to update the installed product status to Pending Top-Up.

  • Calls the HotlineRequest operation of the third-party web service (HotlineSimulator).

• If it is a service management order, calls the RO_ORDER_COMPLETE (Order Completion) service operation of the delivered RO_ORDER (Order) web service to change the order status to Complete.

The Service Management Activate Service business process ends.

See Delivered Web Services.

Service Management Suspend Service Process Flow

This process performs various tasks on service management orders for suspending services, which includes notifying billing and provisioning systems, updating install product statuses, processing lost or stolen handsets, as well as creating up-sell or cross-sell email and leads.

This diagram illustrates the Service Management Suspend Service process flow:

Service Management Suspend Service process flow

This diagram illustrates the Delayed Email and Lead process flow:

Delayed Email and Lead process flow

When this business process is initiated, it performs these high-level tasks in parallel:

• Suspends the customer's service.

  1. It updates the high-level installed product or installed service status to Pending Suspension.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

  2. It publishes a message to both the billing (prepaid or postpaid) and provisioning systems notifying them of the service suspension.

     This activity contains three stub processes: Prepaid Billing System, Postpaid Billing System, and Provisioning System.

     Note. Customers need to replace stub processes with actual web services that interact with their billing and provisioning systems.

  3. It waits for the first response message from either the billing or provisioning system.

  4. It updates the high-level installed product or installed service status to Suspended.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

• Processes up-sell or cross-sell lead and email.

  This is a conditional activity that is based on the business unit settings and whether or not a replacement handset has already been purchased by the customer.

  It initiates the Delayed Email and Lead subbusiness process, which creates a lead and an email in parallel:

  1. Creates lead:

     i. Waits x number of days before the process continues (if specified in the business unit settings).

     ii. Validates that the service is still in the status of suspended.

     This is accomplished using the RF_INST_PROD_GET (Get Installed Product) service operation of the delivered Installed Product web service.

     iii. Creates a lead.

     This is accomplished using the RSF_LEAD_CREATE (Create Lead) service operation of the delivered Sales web service.

  2. Creates email:

     i. Waits y number of days before the process continues (if specified in the business unit settings).

     ii. Validates that the service is still in the status of suspended.

     This is accomplished using the RF_INST_PROD_GET (Get Installed Product) service operation of the delivered Installed Product web service.

     iii. Creates an email correspondence request.

     This is accomplished using the delivered CMF_WS_ENABLE web service.

• Processes lost or stolen handset.

  This is a conditional activity that is based on the customer's reason for suspending the service.

  It initiates the Lost or Stolen Handset business process. This process consists of sending a message to the Equipment Identity Registry (EIR) system to blacklist the lost or stolen handset and is documented separately.

  See Lost or Stolen Handset Process Flow.

After all parallel tasks are completed, the process updates the service management order status to Complete. This is accomplished using the RO_ORDER_COMPLETE (Order Completion) service operation of the delivered Order web service.

The Service Management Suspend Service business process ends.

See Business Object Delivered Web Services, Delivered Web Services, Delivered Web Services and Service Operations.

Service Management Suspend and Change Service Process Flow

This process is a combination of the Suspend Service and Change Service business processes. It is invoked from service management orders, supporting all the capabilities provided by each of the two standalone processes. The Suspend Service and Change Service business processes are executed in serial order.

This diagram illustrates the Service Management Suspend and Change Service process flow:

Service Management Suspend and Change Service process flow

When this business process is initiated, it performs two high-level tasks in serial:

1. Suspends the customer's service.

   See Service Management Suspend Service Process Flow.

2. Changes the customer's service.

   See Change Service Process Flow.

The Service Management Suspend and Change Service business process ends.

Service Management Resume Service Process Flow

The process performs various tasks on service management orders for resuming services, which includes notifying billing and provisioning systems, updating install product statuses, processing previously lost or stolen handsets, as well as creating up-sell or cross-sell email and leads.

This diagram illustrates the Service Management Resume Service process flow:

Service Management Resume Service process flow

This diagram illustrates the Delayed Email and Lead process flow:

Delayed Email and Lead process flow

When this business process is initiated, it performs these high-level tasks in parallel:

• Resumes the customer’s service.

  1. It updates the high-level installed product or installed service status to Pending Resume.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

  2. It publishes a message to both the billing (prepaid or postpaid) and provisioning systems notifying them of the service resumption.

     This activity contains three stub processes: Prepaid Billing System, Postpaid Billing System, and Provisioning System.

  3. It waits for the first response message from either the billing or provisioning system.

  4. It updates the high-level installed product or installed service status to Activated.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

• Processes up-sell or cross-sell lead and email.

  This is a conditional activity that is based on the business unit settings.

  It initiates the Lead and Email subbusiness process, which creates a lead and an email in parallel:

  1. Creates lead:

     i. Waits x number of days before the process continues (if specified in the business unit settings).

     ii. Creates a lead.

     This is accomplished using the RSF_LEAD_CREATE (Create Lead) service operation of the delivered Sales web service.

  2. Create Email:

     i. Wait Y number of days before the process continues (if specified in the business unit settings).

     ii. Create an email correspondence request. This is accomplished using the delivered CMF_WS_ENABLE web service.

• Process previously lost or stolen handset.

  This is a conditional activity that is based on the customer's reason for resuming the service.

  It initiates the Lost or Stolen Handset business process. This process consists of sending a message to the EIR system to whitelist the found handset and is documented separately.

  See Lost or Stolen Handset Process Flow.

After all parallel tasks are completed, the process updates the service management order status to Complete. This is accomplished using the RO_ORDER_COMPLETE (Order Completion) service operation of the delivered Order web service.

See Also

Referral or Lead-Related Business Process Flow

Delivered Web Services

Delivered Web Services

Service Management Disconnect Service Process Flow

This process performs various tasks on service management orders for disconnecting services, which include notifying billing and provisioning systems, updating install product statuses, processing lost or stolen handsets, as well as creating up-sell or cross-sell email and leads.

This diagram illustrates the Disconnect Service process flow:

Disconnect Service process flow (1 of 2)

Disconnect Service process flow (2 of 2)

This diagram illustrates the Delayed Email and Lead process flow:

Delayed Email and Lead process flow

When this business process is initiated, it performs these high-level tasks in parallel:

• Disconnects the customer's service.

  This is accomplished by invoking a business process called Disconnect Installed Product, which performs the following tasks:

  1. Updates the high-level installed product or installed service status to Pending Disconnect.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

  2. Publishes a message to both the billing (prepaid or postpaid) and provisioning systems notifying them of the service disconnection.

     This activity contains three stub processes: Prepaid Billing System, Postpaid Billing System, and Provisioning System.

  3. Waits for the first response message from either the billing or provisioning system.

  4. Updates the high-level installed product or installed service status to Disconnected.

     This is accomplished using the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service.

  5. Sets any disconnected phone numbers that are associated with the service to aging.

     This is accomplished using the RO_NUMMGT_SETAGING (Set Number to Aging) service operation of the delivered Number Management web service.

  6. Retires any SIM cards that are associated with the disconnected service.

     This is accomplished using the RO_NUMMGT_SETSIMSTATUS (Set SIM Card Status) service operation of the delivered Number Management web service.

     See Service Management Disconnect Service Process Flow.

• Processes up-sell or cross-sell lead and email.

  This is a conditional activity that is base on the business unit settings.

  It initiates the Delayed Email and Lead subbusiness process, which creates a lead and an email in parallel:

  1. Creates lead:

     i. Waits x number of days before the process continues (if specified in the business unit settings).

     ii. Creates a lead.

     This is accomplished using the RSF_LEAD_CREATE (Create Lead) service operation of the delivered Sales web service.

  2. Creates email:

     i. Waits y number of days before the process continues (if specified in the business unit settings).

     ii. Creates an email correspondence request.

     This is accomplished using the delivered CMF_WS_ENABLE web service.

• Processes lost or stolen handset.

  This is a conditional activity that is based on the customer's reason for disconnecting the service.

  It initiates the Lost or Stolen Handset business process. This process consists of sending a message to the EIR system to blacklist the lost or stolen handset and is documented separately.

After all parallel tasks are completed, the process updates the service management order status to Complete. This is accomplished using the RO_ORDER_COMPLETE (Order Completion) service operation of the delivered Order web service.

The Service Management Disconnect Service business process ends.

See Also

Referral or Lead-Related Business Process Flow

Delivered Web Services

Lost or Stolen Handset Process Flow

This process handles lost, stolen, or found handsets that are associated with customers' services. A handset is blacklisted if it is lost or stolen. A handset is whitelisted if it is found.

Note. Lost or Stolen Handset is a subbusiness process that is called from these main business processes: Service Management Disconnect Service, Service Management Suspend Service, and Service Management Resume Service business processes.

This diagram illustrates the Lost or Stolen Handset process flow:

Lost or Stolen Handset process flow

When this business process is initiated, it:

1. Verifies the make, model, and serial number of the handset provided.

2. Blacklists the handset in the Equipment Identity Registry (EIR) registry, if the handset is being reported as lost or stolen and service is being suspended or disconnected.

   If the handset is being reported as found and the service is being resumed, the process whitelists the handset in the EIR registry.

3. Returns control to the calling business process.

The EIR is delivered as a stub web service, which represents a customer's or a third-party EIR service.

Service Management Port In Process Flow

This process is initiated from service management orders which contain the Port In action. The process controls the flow of business events involved in porting in a phone number from one wireless carrier to another. This process is only executed after a separate process has successfully validated all customer account, address, phone and billing information.

This diagram illustrates the Service Management Port In process flow:

Service Management Port In process flow

When this business process is initiated, it:

1. Copies payload values into a PortIn Date Request message.

   With this data, it then calls a stub process (a placeholder for a third-party web service) called PortInDateRequest. This is an asynchronous call. The third-party web service responds with an agreed port-in date.

2. Processes the response that is received from the third-party system.

   • If the response indicates that the number porting procedure cannot happen, this process logs the exception message and ends.

   • If the response returns a port-in date successfully, it calls the RF_INST_PROD_UPDATE (Update Installed Product) service operation of the delivered Installed Product web service to update the port-in date on the installed product.

     If the update fails, this process logs a message and ends.

3. Calls a third-party web service to request the port in completion notification.

   This is a stub process (a placeholder for a third-party web service) called PortInCompleteNotification. This is an asynchronous process.

   When the Complete Notification response is received, the third-party system has completed its part of the porting process. Remaining porting tasks continue in the CRM system.

4. If a temporary number is assigned to the port-in, calls the RO_NUMMGT_SETAGING (Set Number to Aging) service operation of the delivered Number Management web service to release this temporary number back to inventory with the standard aging.

5. Calls the RO_NUMMGT_SETNUMBERSTATUS (Set Number Status) service operation of the delivered Number Management web service to set the port-in number to Active.

6. Calls the ProvisioningChgRequest service operation from the delivered RBTProvisioningSimulator placeholder to let an external billing system know that the port-in number is now active.

7. Sets the service management order status to Complete by calling the RO_ORDER_COMPLETE (Order Completion) service operation of the delivered Order web service.

The Service Management Port In business process ends.

See Delivered Web Services.

Use of Sub and Stub Business Processes in Delivered Business Processes

This table lists the subbusiness processes and stub business processes that are used in each of the delivered Order Capture business process (an x marks the inclusion of the sub or stub business process in the corresponding main business process):

Use of sub and stub business processes in delivered Order Capture business processes

Delivered Web Services

This section discusses:

• The Agreement web service.

• The Billing Account web service.

• The Order web service.

• The Phone Number Administration web service.

• The Service Management web service.

• The Service Order web service.

See Also

Understanding Web Services

Agreement

PeopleSoft delivers the Agreement Creation For Order service operation for the Agreement (RO_AGREEMENT) web service. This operation creates agreements for orders. It takes a capture ID and returns a successful status if the agreement is created. The service operation handler takes care of validating the various requirements before the agreement is created. An error message is returned if the operation fails.

This table provides the technical name, operation type, and messages names of the Agreement Creation For Order service operation:

Billing Account

PeopleSoft delivers these service operations for the Billing Account (RBT_BILLING_ACCOUNT) web service:

• Complete Account Conversion.

  This operation takes a prepaid billing account number that needs to be converted to postpaid account and returns a successful status if the account conversion is completed. An error message is returned if the operation fails

• Link Accounts.

  This operation takes the numbers of two billing accounts (for example, a prepaid account and a postpaid account) to be linked, and returns a successful status if the account linkage is built. An error message is returned if the operation fails.

• Update Account.

  This operation takes a billing account number and the status to which the account needs to be updated, and returns a successful status if the status update is completed. An error message is returned if the operation fails.

• Create Billing Account.

  This operation takes a capture ID and returns the number of the billing account that is created for that order.

This table provides the technical names, operation type, and message names of the service operations that are related to the Billing Account web service:

Order

PeopleSoft delivers these service operations for the Order (RO_ORDER ) web service:

• Order Completion.

  This operation sets the status of the order to Completed. It also sets the status of all line items in the order to Completed if they are not already in the Completed, Canceled or Shipped. It takes a capture ID and returns a successful status if the order is set to completed. An error message is returned if the operation fails.

• Create Installed Product for Order.

  This operation creates installed products for orders. It also creates relationships amongst all the created installed products. It takes a capture ID and returns a successful status if the installed product is created. An error message is returned if the operation fails.

• Order Shipment Notification.

  This operation receives advanced shipping notices (ASNs) for orders from an external fulfillment system. It takes care of updating the line item status of the received shipment to Shipped. It also establishes the relationship between the line item and the line item-SIM records.

• Relate Services to SIM.

  This operation associates SIMs with installed services. It takes an setID, installed service ID, and ICCID, and returns a successful state if the association is complete. An error message is returned if the operation fails.

This table provides the technical name, operation type, and message names of the service operations that relate to the Order web service:

Phone Number Administration

PeopleSoft delivers these service operations for the Phone Number Administration (RO_NUMMGT) web service:

• Add Number History.

  This operation generates history details for phone numbers. It takes inputs such as customer ID, customer's role type ID, contact ID, contact's role type ID, and phone number, and returns a successful status if the operation is completed. An error message is returned if the operation fails.
  This operation can be used whenever a phone number is assigned to a customer.

• End Number to SIM Relationship.

  This operation disassociates phone numbers from their related ICCIDs (Integrated Circuit Card Identifier), which are serial numbers of the SIM cards. It takes a phone number and its related ICCID, and returns a successful status if the operation is completed. An error message is returned if the operation fails.

  This operation can be used whenever a phone number is no longer in service or transferred to another SIM or ported out to a different carrier.

• Set Number to Aging.

  This operation changes the status of a phone number to aging. It takes a phone number and returns a successful status if the operation is completed. An error message is returned if the operation fails.

  This operation can be used when a phone number is either disconnected or released by an external carrier.

• Set Number Status.

  This operation sets the status of a phone number. It takes a phone number and the status to which the phone number needs to be set, and returns a successful status if the status update is completed. An error message is returned if the operation fails.

  This operation can be used to set the status of the phone number during the life cycle of a phone number.

• Set SIM Card Status.

  This operation sets the status of a SIM card. It takes an ICCID and the status to which the ICCID needs to be set, and returns a successful status if the status update is completed. An error message is returned if the operation fails.

  This operation can be used to set the status of the SIM card during the life cycle of a SIM.

• Relate a Number to a SIM.

  This operation assigns phone numbers to SIMs. It takes a phone number and an ICCID, and returns a successful status if the phone number is linked to the ICCID. An error message is returned if the operation fails.

  This operation is can be used whenever a phone number is activated on a SIM.

This table provides the technical names, operation type, and message names of the service operations that are related to the Phone Number Administration web service:

Service Management

PeopleSoft delivers these service operations for the Service Management (RO_SERVICEMGT) web service:

• Add Install Product.

  This operation creates installed products for service management, for lines with the Add action code. It takes a capture ID and line number, and returns a successful status if the operation is completed. An error message is returned if the operation fails.

• Service Management - Add Note to Order.

  This operation adds notes to service management orders. It takes inputs such as the capture ID, notes summary, note details, note type, and the visibility option, and returns a successful status if the note is added. An error message is returned if the operation fails.

  Note that this operation may also be used on non-Service Management orders.

• Service Management - Add and Submit Order.

  This operation adds and submits service management orders. It takes inputs such as the business unit, customer BO ID, install product ID, action, action reason, associated capture ID, start and end dates, and returns the status of the operation, as well as the capture ID and status of the new order if the operation is completed. An error message is returned if the operation fails.

• Get Activate Service Message.

  This operation gets the inputs for the Service Management Activate Service business process. It takes the capture ID as input and returns the message structure that the Service Management Activate Service business process requires to activate a service.

• Get Attribute for an Installed Product.

  This operation takes a capture ID and line number and returns the attribute information of the installed product for the corresponding line item.

• Get Disconnect Service Details.

  This operation gets the inputs for a call to the Prepaid to Postpaid Account Conversion business process. It is called by the Activate Service business process immediately before it calls the Prepaid to Postpaid Account Conversion business process. This operation takes an account ID and returns information about this account that has disconnected its service.

• IMSI (International Mobile Subscriber Identity) Change Operation.

  This operation is used when the SIM on a service is changed. It sets the installed product status for the old SIM to be Disconnected and the installed product status for the new SIM to be Installed. It moves all child install products from the old SIM to the new SIM and ends the relationship between the old SIM and the phone number. It takes a capture ID and returns a successful status if the operation is completed. An error message is returned if the operation fails.

• Remove Installed Product.

  This operation removes installed products from service management orders, for lines with the Remove action code. It takes a capture ID and line number and returns a successful status if the operation is completed. An error message is returned if the operation fails.

• Update Service Management Order Status.

  This operation updates the status of service management orders. It takes a capture ID, a line number, and current status code, and returns a successful status if the operation is completed. An error message is returned if the operation fails.

The Get New Service Message service operation is not being used.

This table provides the technical names, operation type, and message names of the service operations that are related to the Service Management web service:

Service Order

PeopleSoft delivers the Service Order Create service operation for the Service Order (RO_SERVICE_ORDER) web service. This operation creates service orders for the orders. The service operation handler takes care of validating various requirements for the creation of service orders and subsequently creates them. It takes a capture ID and returns a successful status if the status update is completed. An error message is returned if the operation fails.

This table provides the technical name, operation type, and messages names of the service operation that is related to the Service Order web service:

Viewing Message Elements

You can view the elements and fields that are included in each operation message through PeopleTools.

To view a list of field names and aliases for a particular message:

1. Select PeopleTools, Integration Broker, Integration Setup, Messages.

2. Enter the name of the message that you want to view in the Message Name field and click Search.

   The Message Definition page appears.

3. Click the message name link under the Parts grid.

   The system opens the Message Definition page in a new browser. This step is required only if you selected a container message. If you selected a parts message in step 2 above, proceed directly to step 4.

   Note. The system utilizes both container messages and parts messages. A container message may contain one or more parts. The parts message has the actual list of data fields.

4. Click the plus sign next to the table name at the bottom of the page to view the fields and aliases associated with the message.