Launching Sterling Call Center from another application

Edit online

You might need to embed certain capabilities of Sterling Call Center within other web applications. In such cases, you can launch a specific wizard or screen of Sterling Call Center from the application.

Procedure

In your invoking application, embed an iframe and specify the required URL request parameters for the iframe.

By default, the application provides support to launch certain screens from the external application. Those screens and the corresponding URL parameters are described in the following table:

Table 1. URL parameters for screens supported by default
Screen name Parameters
Order Summary 
screenID=OrderSummary
OrderHeaderKey=<order header key>
OrderNo=<order number>
EnterpriseCode=<enterprise code of the organization>
Return Summary 
screenID=ReturnSummary
OrderHeaderKey=<return order header key>
OrderNo=<return order number>
EnterpriseCode=<enterprise code of the organization>
Shipment Summary 
screenID=ShipmentSummary
OrderHeaderKey=<order header key>
OrderNo=<order number>
EnterpriseCode=<enterprise code of the organization>
Business Customer Details 
screenID=CustomerDetails
CustomerID=<ID of the customer>
CustomerKey=<unique customer key>
CustomerName=<customer name>
OrganizationCode=<organization code>
Note: CustomerName parameter internally maps to OrganizationName attribute
Notes:
  • URL parameters may be different depending on the screen that you want to launch from the invoking application.
  • The parameters are not validated and this should be taken care by the external application.
  • ScreenID is the unique identifier for a screen or wizard in Sterling Call Center application. So this is a mandatory parameter to launch any screen in the application.
  • embedded is an optional parameter that can be used to hide the application header when a Sterling Call Center screen is launched. To hide the header, set the value of the parameter to Y in the URL. To show the header, set it to N
Sample request parameters for the iframe:
http://<serverip>:<port>/isccs/isccs/container/home.do?scFlag=Y&screenID=OrderSummary&OrderHeaderKey=<order header key>&OrderNo=<order_number>&EnterpriseCode=Matrix-B&embedded=Y
To launch screens using other parameters or to launch screens which are not supported by default, you need to customize the application by performing the following steps:
  1. Extend the home screen.
  2. Create an event listener for the init screen event and add a subscriber to the afterScreenLoad event.
  3. Write code to launch the screen in the event listener method created in step b.
  4. Use the method document.getElementsById to retrieve any parameter passed in the URL. For example, to get the screen ID, you can use the following code:var screenID = document.getElementById("screenID").value.
For more information about the methods, refer to the Javascript documentation, which can be found in the Settings drop-down menu of the Sterling Call Center application deployed in the developer mode.