When the widget option is used, the Agent Application is directly embedded into a host application (e.g., Jacada WorkSpace). The source code of the widget is included in the host page.
The first step of integration involves constructing an iframe element that will create an embedded widget suitable for the 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 NameDescriptionDefault Value
url
The location of the widget, which is also the location
of the Jacada Interaction Server. For example:
https://gointeract.io/interact/agent-app/index.html
 
showSearch Determines whether the Search tool is shown or hidden. false
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. false
theme
The absolute or relative name of the theme
or jQueryUI theme file. If another theme is defined
for the application in the Admin Console, the theme parameter will be overridden.
cupertino
appkey
Unique identifier for the application. This parameter is required.  
accountId
Identifier for the tenant's account. This parameter is required.  
showTabs
Determines whether Interactions are openedin new tabs. true
showInformationArea
Determines whether the area showing data relevant to the customer or the system is shown or hidden.  false
showAddNote Determines whether the Add Note link that enables the agent to insert notes is shown or hidden.  
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.  
lang Language locale. This parameter overrides the default language of the browser.  

The following example shows an iframe element that will create an embedded widget suitable for the Agent application:

<iframe type="text/html" width="100%" height="100%" 
src=“https://gointeract.io:443/agent-app/index.html
?showSearch=true
&appkey=524bd189f7a42c49c5dd601b
&accountId=12345678
&showTabs=true
&showAddNote=false
&oauthMode=redirect
&interaction=1385023600964-8777b884ab8b4060fec56b60bb7c14279bd483a-32a9
&embedded=true
&lang=en wmarginheight="0" marginwidth="0" frameborder="0" style="border: none;”>
</iframe>

For details about embedding the widget in the host application, refer to Creating the Host Page.

Revision:

Comments