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 the application.

About this task

Important: If you are using IBMid authentication for Sterling Order Management, the following customization approach cannot be applied to embed the Sterling Store Engagement screens within third-party applications.

Procedure

Set up Single Sign On (SSO) for Sterling Store Engagement, by performing the following steps:
1. Implement the YCPSSOManager and IYFSAuthenticateType classes. For more information, you can look up these classes in the IBM Sterling Order Management: Javadoc.
2. Add the following properties in the customer_overrides.properties file.
  - yfs.yfs.security.singlesignon.enabled=Y
  - yfs.yfs.login.singlesignon.class=path.<class name>
  - yfs.yfs.login.singlesignon.checkuser=N
  - yfs.yfs.authentication.type.class=path.<class name>

In your invoking application, embed an iframe and specify the following URL request parameters for the iframe:

Table 1. URL request parameters
Parameter	Description
`scCSRFToken`	A security parameter to prevent malicious attacks or unauthenticated access. It is automatically generated.
`StoreId`	Unique identifier of the store to which the user logs in.
`ScreenID` [Mandatory]	Unique identifier for a Sterling Store Engagement screen or wizard. To get the screen identifier for the wizard that you want to embed, view the corresponding wizard definition file in the `<INSTALL_DIR>/repository/eardata/wsc/war/wizardxmls` directory.
`ShipmentKey` [Mandatory]	Unique identifier for a shipment.
`OrderHeaderKey`	Unique identifier for an order.
`embedded`	If you want to hide the application header and screen header when a Sterling Store Engagement wizard is launched, set the value of the parameter to `Y` in the URL. To show the headers, set it to `N`.

Sample request parameters for the iframe:

Desktop version of Sterling Store Engagement:

<iframe src = "/wsc/store/container/home.do?scCSRFToken=&scFlag=Y&StoreId=Mtrx_Store_1&ShipmentKey=CAPE66666&ScreenID=wsc.components.shipment.backroompick.
BackroomPickupWizard&embedded=Y"></iframe>

Mobile version of Sterling Store Engagement:

<iframe src = "/wsc/store/mobile/container/home.do?scCSRFToken=&scFlag=Y&StoreId=Mtrx_Store_1&ShipmentKey=CAPE66666&ScreenID=wsc.components.shipment.backroompick.
BackroomPickupWizard&embedded=Y"></iframe>