Next-generation platformDeprecated

Launching Sterling Store Engagement from another application

You might want to embed certain capabilities of Sterling Store Engagement within other web applications. In such cases, you can launch a specific wizard of Sterling Store Engagement from another application.

Assumptions

  • In case of SSO, if you are not authenticated the login screen displays. Post authentication you are taken to the requested URL. If you are already authenticated, you are directly taken to the requested URL.
  • In case of non-SSO, you are already authenticated and there is a valid active Sterling Order Management System session.

Procedure

  1. Identify the URL for a particular business flow by launching the application in any environment and navigate to the flow.
  2. Copy the URL from the address bar in the browser.

    Any URL used in Sterling Store Engagement can have static and dynamic content.

    For example, https://<localhost>:<port number>/isf/store/store/shipment-summary/SO20200818CSHPKey. In this URL, isf/store/store/shipment-summary/ is the static content and SO20200818CSHPKey is the dynamic content, which is the shipment key. The shipment key is different for each shipment.

    For more information about routing definition, see the routing-module ShipmentSummaryRoutingModule that is present in <Store source>/app/features/shipment-summary/shipment-summary-routing.module.ts

    To understand the dynamic content of a URL, see the angular route definition of a particular feature.

const routes: Routes = [
                                     {
                                        path: ':shipmentKey',
                                        component: ShipmentSummaryPageComponent,
                                      }
                                         ];

From the route definition, you can view the dynamic content that maps to the shipment key.

When an external application launches the shipment summary of a particular shipment, the URL is https://<localhost>:<port number>/isf/store/store/shipment-summary/<ShipmentKey>