xApp: Init Session

Style Customization

Parameter	Type	Description
Background Color	CognigyScript	A color that is displayed in the background of all Shell Page Screens. You can use CSS background-color values such as `hex`, `hsl+a`, and `rgb+a`.
Text Color	CognigyScript	A color that is used for textual content on all Shell Page Screens. You can use CSS color values such as `hex`, `hsl+a`, and `rgb+a`. Make sure that the text color has high contrast with the background color.
Logo	List	You can choose to show the default logo, not any logo, or a custom logo. If you select the custom logo option, specify the Custom Logo URL.
Custom Favicon URL	CognigyScript	An image URL for the custom favicon.
Page Title	CognigyScript	A text shown as a tab or window title. The title is displayed on all Shell Page Screens.

xApp Screens

Parameter	Type	Description
’Loading’ Text	CognigyScript	Specify messages displayed to the user when the xApp page is loading
’Launch Error’ Text	CognigyScript	Specify messages displayed to the user when the xApp page fails for some reason
’xApp Error’ Text	CognigyScript	Specify messages displayed to the user when the xApp page encounters an error or is halted

Intermediate Screen

The intermediate screen appears on the xApps page while the xApp is inactive, for example, after you have submitted data in the xApp and no other xApp is triggered.

Parameter	Description
Customization Type	Sets whether and how to customize the . Select one of the following options: No customization — displays on the . This option is selected by default. Customized Texts — displays custom text on the . Replace with xApps — displays a custom page on the , optionally, with custom data. This option provides flexibility because you can create a page using HTML, CSS, and JavaScript and handle custom data dynamically.
Text Override	This parameter appears when you select Customized Texts in the Customization Type field. Enter the custom text to be displayed on the .
xApp Template	This parameter appears when you select Replace with xApps in the Customization Type field. Enter the URL to the custom page to be displayed on the .
xApp Template Data	This parameter is optional. It appears when you select Replace with xApps in the Customization Type field. Enter custom data in JSON format to be sent to the custom page. For example, you can use a CognigyScript expression in a JSON object, such as `{"name": "{{profile.firstname}}"}`, to fetch data from the Profile object and use it on the as a personalized message with the end user’s name.

Connection Screen

The connection screen appears while the browser is establishing the connection to the xApp page.

Parameter	Description
Customization Type	Sets whether and how to customize the . Select one of the following options: No customization — displays on the . This option is selected by default. Customized Texts — displays custom text on the . Replace with xApps — displays a custom page on the , optionally, with custom data. This option provides flexibility because you can create a page using HTML, CSS, and JavaScript and handle custom data dynamically.
Text Override	This parameter appears when you select Customized Texts in the Customization Type field. Enter the custom text to be displayed on the .
xApp Template	This parameter appears when you select Replace with xApps in the Customization Type field. Enter the URL to the custom page to be displayed on the .
xApp Template Data	This parameter is optional. It appears when you select Replace with xApps in the Customization Type field. Enter custom data in JSON format to be sent to the custom page. For example, you can use a CognigyScript expression in a JSON object, such as `{"name": "{{profile.firstname}}"}`, to fetch data from the Profile object and use it on the as a personalized message with the end user’s name.

Overview

AI Agents

Human Escalation

Platform Features

For Developers

Administration and Installation

Description

Without PIN

With PIN

Parameters

More Information

​Description

​Without PIN

​With PIN

​Parameters

​More Information

Description

Without PIN

With PIN

Parameters

More Information