Sample configuration installation overview

Installing the sample configuration involves running InstallService to unpack the .jar file, and then running provided Ant scripts to install, validate, and activate the sample configuration components.

The sample setup comprises the following components:

Configuration Data
This component consists of the basic configuration data required for an application, including new organizations, common codes, and rules.
In the Activated mode, the newly provided events, user exits, and pipelines in the factory setup are activated. During the validation process, if any of the records exist in a state that is different from the standard Sterling Order Management factory setup, the validation process fails. Otherwise, it succeeds.
Demo Data
This component comprises Master Data, which consists of an example data that can be used to demonstrate the application, including sample items. This data is not used in a production environment. The master data comprises the following data:
  • Master Catalog
  • Items
  • UOMs
  • Item UOM master
  • Item Attributes
  • Classification Purpose
  • Item Assets
  • Resource Pools
  • Item Service Associations
  • Item Price List
  • Rules
Note: In the sample data, some catalog items are associated with 'Return' service items and 'Delivery' service items. Ensure that these service items are configured as items in WebSphere Commerce such that WebSphere Commerce identifies the service items as valid part numbers.

Validating the sample data

When you run the install, validate, or noactivator target, the validator validates the following configurations:

  • User Exit Implementation

    IBM Sterling Call Center and IBM Sterling Store applications provide implementation for some of the user exits. If the user exit implementations are not modified or overridden, the validation process succeeds. Otherwise, it fails.

    An implementation is provided for the following user exits:
    • YCDVerifyAddressWithAVSUE
    • YCDProcessOrderFraudCheckUE
    • YCDSendFutureOrderCustomerAppeasementUE
    • YCDgetTrackingNumberURLUE
    • YCDGetAppeasementOffersrUE
    • YCDGetCarrierServiceOptionsForOrderingUE
  • Pipeline Determination

    IBM Sterling Call Center, and IBM Sterling Store applications provide pipelines and the associated pipeline determination rules. The validation process succeeds if the pipeline determination rules are not modified or overridden. Otherwise, the validation process fails.

    The pipeline determination rules for the following process types are validated:
  • Events

    The following table lists the events for which the event handlers are configured.

    Event Transaction ID
    On Collection Failure PAYMENT_EXECUTION
    On Success ORDER_CREATE
    On Success ORDER_CHANGE
    On hold type status change ORDER_CHANGE
    On Cancel ORDER_CHANGE
    On Cancel SCHEDULE.0001
    On Cancel RELEASE.0001
    Address Verification Failed YCD_VERIFY_ADDRESS.0001
    Sent Notification YCD_SHIP_NOTIFICATION.0001
    On Fraudulent Order YCD_FRAUD_CHECK.0001
    On Duplicate Order YCD_DUPLICATE_ORDER.0001
    On Success MANAGE_STOP_DEL.0001
    On Success RECEIVE_RECEIPT.0003
    On Account Limit modification CUSTOMER_DEFINITION
    On hold type status change DRAFT_ORDER_CONFIRM

Restarting after a failed installation

When the sample configuration is installed, .restart files are created under the <INSTALL_DIR>/database/FactorySetup/oms/install directory. The .restart files record the points in the sample configuration that are complete.

If the sample configuration installation fails and if you rerun the installation scripts, the .restart files are read to resume installation from the point where the installation failed.

If you want to start the installation of the sample configuration from the beginning, delete the .restart files before you rerun the installation.