Creating the Web Self Service Widget
This client is a web application that is designed to be run in a browser as part of your company website, on the customer’s desktop or laptop computer. Using this web application, customers can perform self service Interactions directly from a company’s website.
Note
The following sections describe how to embed the Web Self Service application into a host web page. Alternatively, you may place a link on your web page that opens the application in a new tab. For details, refer to Sharing an Application Link.
The first step of integration is constructing an <iframe> element that will create an embedded widget that is suited for the Web Self Service application. The parameters that define the widget's settings are passed in the SRC property of the <iframe>. Available parameters are listed in the following table.
Parameter Name | Description | Default Value |
|---|---|---|
url | The location of the widget, which is also the location of the X‑Platform Server. For example:
| |
embedded | Indicates whether the application's settings are based on an embedded or a standalone design. In the embedded design, some application features (e.g., the search box) are hidden. | true |
theme | The absolute or relative name of the theme or jQueryUI theme file. If another theme is defined for the application in the X-Console, the theme parameter will be overridden. | breadcrumbs |
appkey | Unique identifier for the application. This parameter is required. | |
accountId | Identifier for the tenant's account. This parameter is required. | |
oauthMode | Indicates how to handle authentication when login is required to access secured Interactions. |
|
interaction | The Designer ID of the Interaction that starts running when the client is loaded. If this parameter is not provided, a list of Interactions is displayed. | |
access-token | The authentication token passed by the Authentication Server, for access to secured Interactions. | |
backFromLogin | Indicates whether there is a return to the application after a required login for secured Interaction access. When the value is true, the Interaction resumes at the point where the user encountered the authentication requirement. NoteThis parameter is relevant only when the value for the oauthMode parameter is redirect. | |
lang | Language locale. This parameter overrides the default language of the browser. |
The following example shows an <iframe> element that will create a embedded widget suitable for a Web Self Service application:
<html>
<body>
<iframe type=“text/html" height=100% width=100% style=“border:none"
src=“https://gointeract.io:443/webselfservice/index.html
&appkey=524bd189f7a42c49c5dd601b
&accountId=12345678
&oauthMode=redirect
&interaction=1385023600964-8777b884ab8b4060fec56b60bb7c14279bd48
3a-32a9
e1-20d4
&embedded=true
&lang=en wmarginheight="0" marginwidth="0" frameborder="0" style="border: none;”>For details about embedding the widget in the web host application, click here.