Working with PeopleSoft Order Capture Business Projects

This chapter provides an overview of PeopleSoft Order Capture business projects and discusses how to:

See Also

Setting Up Business Projects

Using Business Projects

Click to jump to top of pageClick to jump to parent topicUnderstanding PeopleSoft Order Capture Business Projects

PeopleSoft Customer Relationship Management (PeopleSoft CRM) delivers business projects that automatically manage certain predefined application processes. Using a business project to manage these tasks simplifies the management of conditional logic that often varies based on industry and customer-specific needs.

PeopleSoft Order Capture delivers three prebuilt business projects, each of which is a combination of phases and tasks designed to manage the order capture business process. PeopleSoft Order Capture business projects are advantageous because they automate the processing steps for orders and quotes. To enable the configuration of key order processing events, PeopleSoft Order Capture uses business projects as the agent to initiate and verify those events. Specifically, they trigger and confirm the status of key events such as email confirmation, creation of installed product records, publishing of data to a fulfillment system, and notification of shipment completion.

Note. PeopleSoft Order Capture business projects are registered as actions related to the order and can therefore be found on the Related actions page of the Order Capture component.

This table describes the three PeopleSoft Order Capture business projects that the PeopleSoft system delivers:

Business Project

Object Name

Event Name

Internal Description

Triggering Event

Order

CORE_ORDER_BP

CoreOrderBP

Order Capture BP

The order status changes to Open. The business project is instantiated when the STATUS_CODE field on the RO_HEADER record equals a code status of 1000.

Order Maintenance

CORE_ORD_CHG_BP

CoreMaintBP

Order Change BP

When an order is maintained and submitted, the system saves changes to the order to RO_HISTORY. When an RO_HISTORY record is created with Open status, this triggers the CoreMaintBP event. The business project is instantiated when the RO_HISTORY_STATUS field on the RO_HISTORY record changes to OPEN status.

Quote

CORE_QUOTE_BP

CoreQuoteBP

Quote BP

The quote status changes to Open. The business project is instantiated when the STATUS_CODE field on the RO_HEADER record equals a code status of at least 1000.

Note. PeopleSoft Order Capture also supports several industry-specific business projects. Applications such as PeopleSoft Enterprise Phone Number Administration, PeopleSoft Enterprise Client Management, PeopleSoft Enterprise Policy and Claims Presentment, PeopleSoft Enterprise Banking Transactions, PeopleSoft Enterprise Bill Presentment and Account Management, and PeopleSoft CRM for High Technology include their own business projects that are tailored to the specific needs of their respective industries. Consult the documentation for those applications to better understand how their business projects plug in to the PeopleSoft Order Capture framework.

Click to jump to top of pageClick to jump to parent topicDefining PeopleSoft Order Capture Business Projects

This section supplements the general PeopleSoft CRM documentation, which explains how to set up business projects for all PeopleSoft CRM applications. Because PeopleSoft Order Capture delivers a centralized Capture Type Workbench, the method by which you set up your business projects is slightly different from other PeopleSoft CRM applications.

This section provides an overview of business project definition and discusses how to set up and view PeopleSoft Order Capture business projects.

See Also

Setting Up Business Projects

Click to jump to top of pageClick to jump to parent topicUnderstanding Business Project Definition

Order, quote, and maintenance business projects, like other business projects, are broken down into phases, tasks, and transition rules. Tasks are the basic unit of work in a business project. Phases represent groups of tasks. When you create your phases, tasks, and transition rules, you define the central element of the business projects. Transition rules establish the conditions by which the business project moves from one phase to the next.

Phases

Phases encapsulate one or more related tasks and constitute the main steps of the business project. Phases are always performed sequentially. For each phase in a business project, you define its possible target phases and the conditions under which each target is appropriate. These conditions are called transition rules.

PeopleSoft Order Capture business projects contain several phases. For example, there are eight main phases in the order business project (CORE_ORDER_BP), but there are only two phases in the quote business project (CORE_QUOTE_BP). These specific phases are identified and explained below.

Tasks

When you set up a phase, you define the sequence of tasks in the phase. Tasks are single actions that directly correspond to an Application Engine program or Data Mover script. A new task begins when all preceding tasks in a phase are complete.

Tasks within a single phase can be performed either in parallel or in sequence. To define tasks in parallel, you assign each task the same sequence number. Sequence numbers for several tasks in PeopleSoft Order Capture business projects possess the same sequence number and are therefore performed simultaneously.

Note. To view sequence numbers, access the Capture Type Workbench, Business Projects page.

See Defining Business Project Conditions.

Transition Rules

Transition rules determine the transition from one phase to the next, based on the success or failure of tasks within that phase. The outcome of a task can be:

  • Cancelled.

  • Complete - Success.

  • Complete - Failed.

See Also

Defining Tasks

Defining Phases

Click to jump to top of pageClick to jump to parent topicSetting Up and Viewing PeopleSoft Order Capture Business Projects

Business project setup for PeopleSoft Order Capture can be broken down into three main steps:

  1. Access the Business Projects component: Set Up CRM, Common Definitions, Business Projects.

    There, you define all of the elements of the business project, including the phases, tasks, and transition rules, as well as any time delays.

    Note. PeopleSoft Order Capture delivers predefined business projects. In this step you need only verify that these predefined business projects work for your business model.

    See Setting Up Business Projects.

  2. Access the Event Definition component: Setup CRM, Common Definitions, Event Definition.

    Here, you define the triggering action that first launches the business project. The PeopleSoft system has predefined the triggering action for each of the business projects that the PeopleSoft system delivers. If these triggering events need to change for your business, you can change them here.

    Note. The PeopleSoft system delivers a check every 120 minutes that repeats for the Order and Order Maintenance business projects. These two business projects repeatedly check the fulfillment system every two hours to see if the maintenance that has been requested has been processed. You should adjust this workflow action value to best suit your business needs, as smaller time delays cause more frequent processing activity on Process Scheduler and thus increase the load on your system.

  3. Access the Business Project Events page in Capture Type Workbench: Set Up CRM, Product Related, Order Capture, Capture Type Workbench, Business Project Events.

    Here you can perform the following tasks:

See Also

Setting Up Business Projects

Click to jump to top of pageClick to jump to parent topicViewing PeopleSoft Order Capture Business Projects

This section discusses how to:

See Also

Using Business Projects

Click to jump to top of pageClick to jump to parent topicPage Used to View PeopleSoft Order Capture Business Projects

Page Name

Object Name

Navigation

Usage

Business Project Status

RC_BP_STATUS

Orders and Quotes, Search Orders and Quotes, Related Actions

Click the View Details button on the Related Objects page.

View the status of all three PeopleSoft Order Capture business projects.

Click to jump to top of pageClick to jump to parent topicViewing the PeopleSoft Order Capture Business Project Tree

Access the Business Project Status page.

The PeopleSoft Order Capture business project tree provides a visual representation of the business project. The left side of the page displays all phases and their possible targets. Clicking a phase causes the right side of the page to display details such as the phase's task list and the transition rules for each of its targets. The first phase appears at the top of the tree, and each time there is a transition to a different phase, that new phase is added to the tree. Because business project definitions permit any phase to transition to any other phase, a single phase can be instantiated more than once and, as a result, can appear multiple times in the tree.

Note. Only phases that have been instantiated appear in the tree. The system does not display future phases because it cannot tell which ones will be instantiated.

Status

Enter the overall status of the PeopleSoft Order Capture business project. When you first invoke a business project, the status is In Process. You can manually change the status to Cancel any time before the business project is finished. When the project is finished, the system updates the status to Complete.

You cannot manually set the business project status to Complete. The only way to complete a business project is to transition out of the last activity (either manually or automatically).

Outcome

Appears only for sub-business projects whose outcomes are set manually. Once the sub-business project is complete, set the outcome to either Success or Failed.

Description

Displays the text from the field specified on the Parent Object page of the business project definition. If the information is not descriptive enough, return to the parent object to modify it.

The description is the only information provided about the parent object from which this business project was invoked.

and

These icons appear at the top level of the tree hierarchy; they indicate phases that have been instantiated. They enable you to expand and collapse the tree.

Indicates the second level of the tree hierarchy.

Indicates that the task or phase is in progress.

Indicates that the task or phase is canceled.

Indicates that the task was successfully completed or that the phase is complete.

Note. Phases do not distinguish between successful and unsuccessful completion.

Indicates that the task has failed.

Note. This does not necessarily mean that the task will end. For example, the Order Maintenance business project automatically checks shipment status every 120 minutes. If there has been no shipment or if the order has not been canceled, the task displays this icon, and the business project repeats the task. The task continues to kick off every two hours (placing this icon in the Tree Viewer each time) until successful. For each instance that there has been no shipment or order cancelation, you see this icon in the tree.

Phase Detail

This region appears when you select a phase from the business project summary region.

Phase

Displays the name of the phase currently selected in the business project tree.

Status

Displays the phase status. Values are: In Process, Complete, or Canceled. (If you cancel a business project, the phase that was in progress is also canceled.)

Phase statuses don't distinguish between successful and unsuccessful completion.

Transition Rule

Displays how the system transitioned to the selected phase, or indicates that transition was performed manually. If the phase is not complete, no text appears.

Target Phase

To make a manual transition, select the next phase and save the page. You can do this only if the transition definition specifies a manual transition.

Manually transitioning out of a phase changes the source phase's status to Complete, but it does not affect the status of any of the incomplete tasks in the source phase.

Updating the Tree

Save and Update Tree

Click to save changes to the page and to update the business project tree based on those changes. For example, click this button to complete a manual transition after you select a phase from the Target Phase drop-down list box.

Click to jump to top of pageClick to jump to parent topicViewing the Order Business Project

Access the Business Project Status page.

Order Business Project Phases

Contract Request

When the PeopleSoft Contracts integration is in effect, this phase examines the Contract Mapping table for the Customer and Business Unit on the order to determine if there is a Contract number. If there is, this phase is marked complete. If there is no Contract number for this customer and business unit, a Contract Request message is sent to the PeopleSoft Contracts system, and the phase will wait until CRM receives a response from PeopleSoft Contracts with the contract number. Once the response is received, this phase will be marked Complete.

If the PeopleSoft Contracts integration is not active, this phase will immediately be marked Completeand the next phase of the business project executes.

Note. The Workflow Rule RO Contract Request, which is the event performed by the CONTRACT_REQ task, runs the Application Engine program RO_CONTR_EIP.

Installed Product Creation

For order lines that require installed products, this phase creates the installed products with the status as indicated in the Product Definition component. The order may contain products that require an installed product, as indicated by the Installed Product page in the Product Definition component.

In addition, when creating installed products for serialized items, the system creates one installed product for each quantity ordered. For nonserialized items, the system creates a single installed product for the entire quantity ordered on the order line.

Installed products contain values from the order, such as customer information, site, order ID, and quantity ordered.

Note. The Workflow rule, RO_Create Inst Prod, which is the event performed by the CREATE_IP task, runs the Application Engine program RO_CREATE_IP.

See Defining Products.

Agreement Creation

When the order contains an agreement product, the Agreement Creation Phase will create the new agreement, or update the selected existing agreement with the products being covered.

Note. The Workflow Rule RO_Create Agreement which is the event performed by the CREATE_AG task, runs the Application Engine program RO_CREATE_AG.

See Setting Up and Managing Agreements and Warranties.

Publish Order

When the order is fulfilled by an external system, this phase publishes the order details, provided the application message CRM_SALES_ORDER is active.

When the PeopleSoft Contracts integratin is in effect, and the order contains service or agreement products, this phase will publish the CONTRACT_TXN application message, if the message is active.

Note. The Workflow rule, RO_EIP Publish, which is the event performed by the PUB_NEW_ORDER task, runs the Application Engine program RO_EIP_PUB.

See Integrating with Fulfillment and Billing Systems.

Order Email Confirmation

This phase uses the Multi-Channel Framework to send an email confirmation to the primary email address of the contact on the order. On completion of this phase, the system creates a “correspondence” entry on the Related Objects page of the order. The confirmation email provides a current snapshot of the order, including order number, status, order line details, order totals, and shipping details.

If no primary email address exists for the order contact, no email confirmation is sent.

Note. The Workflow rule, RO Order Email Confirmation, which is the event performed by the ORDER_EMAIL task, runs the Application Engine program RO_SND_EMAIL.

Shipment Completion

This phase examines the status of the order header for a Completed or Cancelled status. If the order is found to be complete or canceled, this phase exits with a Successful status.

If the order contains service or agreement products, the order line status for these products will be set to Complete as no fulfillment process is necessary. If it is found that this order contains only service or agreement products, the order header status will be set to Completed and this phase exits with a Successful status.

Should this order contain products requiring fulfillment, this phase will wait until the fulfillment process notifies the business project that all lines are fulfilled. This can happen through the Advanced Shipping Notice, Sales Order Status or Real-Time Status EIPs. Once the business project is notified that all lines are fulfilled, this phase exits with a Successful status.

Note. The Workflow rule RO_Check Shipment Completion, which is the event performed by the CHK_SHP_COMPLETE task, runs the Application Engine program RO_SHP_OVR.

Service Order Creation

Installed products created in an earlier phase may need a service order created. This phase creates service orders for any installed products that are flagged as Service Order Required on the Product Definition page. The service listed on the Product Definition page is used to create the service orders. This phase is the final phase of the business project, and it does not run until the order is completed or canceled.

Note. The Workflow rule RO_Create Service Order, which is the event performed by the CREATE_SO task, runs the Application Engine program RO_CREATE_SO.

Click to jump to top of pageClick to jump to parent topicViewing the Order Maintenance Business Project

Access the Business Project Status page.

Order Maintenance Business Project Phases

Order Email Confirmation

This is the same phase that is used in the Order Capture business project. It provides the current snapshot of the order following order maintenance.

Publish Order Change

When the order is to be fulfilled by an external system, this phase publishes the order maintenance details, if the application message CRM_SALES_ORDER_CHANGE is active.

When the PeopleSoft Contracts integratin is in effect, and the order contains service or agreement products, this phase will publish the CONTRACT_TXN application message, if the message is active.

Note. The Workflow rule RO EIP Change Pub, which is the event performed by the PUB_CHG_ORDER task, runs the Application Engine program RO_EIP_CHPUB.

See Integrating with Fulfillment and Billing Systems.

Order Changes Complete

This phase examines the status of the order history (RO_HISTORY) by looking for any change history records with Open status. If no open history records are found, this phase exits with a successful completion. If the open history records exist, this phase will wait until it is notified that the changes have been processed.

The Sales Order Change Notice EIP will inform the business project that the requested changes have been processed and will allow this phase to exit with a Successful status.

Note. The Workflow rule RO_Check Order Changes, which is the event performed by the CHK_ORDCH_COMPL task, runs the Application Engine program RO_ORDCH_OVR.

Installed Product Creation

The order may contain products that require an installed product, as indicated by the Installed Product page in the Product Definition component. For any order lines that were maintained that require installed products, this phase adds, changes, or deletes the installed products as necessary.

Maintenance actions involved in adding, creating, or deleting installed products include adding new lines to the order, changing the quantity of existing lines on the order, or canceling lines on the order.

In addition, when creating installed products for serialized items, the system creates one installed product for each quantity ordered. For nonserialized items, the system creates a single installed product for the entire quantity ordered on the order line.

Installed products inherit values from the order, such as the customer information, site, order ID, and quantity ordered.

Note. The Workflow rule RO_Create Inst Prod, which is the event performed by the CREATE_IP task, runs the Application Engine program RO_CREATE_IP.

Order Notification

This phase determines the confirmation or rejection of the requested order maintenance by examining the order history (RO_HISTORY). Should notifications be required for the order, as defined in the Order Capture business unit setup, this phase uses correspondence management to create a maintenance confirmation email, and may also create a worklist entry for the customer service representative who entered the most recent order maintenance.

Note. The Workflow rule RO Order Change Notification, which is the event performed by the ORDER_NOTIFY task, runs the Application Engine program RO_ORD_NOTIF.

See Integrating with Fulfillment and Billing Systems.

Click to jump to top of pageClick to jump to parent topicViewing the Quote Business Project

Access the Business Project Status page.

Phases

Order Email Confirmation

This is the same phase that is used in the Order Capture business project. It provides the current snapshot of the quote.

Publish Order

When using an external fulfillment system, this phase publishes the quote details, if the application message CRM_QUOTE is active.

Note. The Workflow rule RO_EIP Publish, which is the event performed by the PUB_NEW_ORDER task, runs the Application Engine program RO_EIP_PUB.

See Integrating with Fulfillment and Billing Systems.

See Also

Monitoring Business Projects