Display operations

This category contains operations that can be used in a bot to allow a user to control the mobile app’s user interface.

Usually, the chat page displays a list of exchanged messages from chat attendees. Operations of the Display type all send a message of type Display to the chat. This message activates the UI mode of the messaging page in the mobile app, which overlays the usual messaging page with corresponding HMI. The most recent message of the Display type in the chat takes the priority.

If the chat is associated with a zone (i.e. Local chat), then the HMI is also displayed on that zone’s page (home page). In this case, the display Tiles operation extends a set of action tiles available in the zone. Other display operations activate the mixed HMI, so that both action tiles and the operation’s HMI are displayed.

Display message

Writes a text message to the given chat and displays it full screen in the chat’s page, and in the home page (for currently visible local chats). This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Message text	String	Content of the message to send. This property supports usage of internal bot variables.
Image name	String	Name of the image from the project or a library that will be displayed along with the Message text.
Display only to users	String	Space separated user names that will have the rights to see this message HMI.

Display question

Displays a full screen text message with an optional image and some UI elements depending on the expected response. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Message text	String	Content of the message to send. This property supports usage of internal bot variables.
Image name	String	Name of the image from the project or a library that will be displayed along with the Message text.
Response options	Enum	User Interface to display in the Mobile app. The following values are available. Buttons – Shows the given set of auto response buttons Buttons From File – Shows a set of auto-response buttons loaded from the given text file Text input – Shows a text entry. Text input is expected. Numeric input – Shows a set of controls to specify a numeric value. Audio – Shows a set of controls to record an audio message. Photo – Shows a set of controls to take a photo or to select an existing one from a library. Video – Shows a set of controls to take a video or to select an existing one from a library Signature – Shows a signature pad where a user can manually draw a digital signature.
File path	String	Absolute or relative Uri path to the file with all available responses in separate lines. This property supports usage of internal bot variables. The specified path is relative to the following directory. <projectFolder>\MsgData\Bots This property is only available for the Buttons From File response option.
Number of decimal digits	Enum	Amount of decimal digits for the expected number. This property affects the format of input values in the Mobile app. Values from 0 to 8 are available. This property is only available for the numeric input response option.
Limit the minimum	Boolean	True if the value range must be limited with a minimum value. If both minimum and maximum limits are defined, a slider will be available in the Mobile app UI. This property is only available for numeric input response option.
Limit the maximum	Boolean	True if the value range must be limited with a maximum value. If both minimum and maximum limits are defined, a slider will be available in the Mobile app UI. This property is only available for numeric input response option.
Minimum	Double	Minimum value for the variable value. This property supports usage of internal bot variables. This property is only available for the numeric input response option.
Maximum	Double	Maximum value for the variable value. This property supports usage of internal bot variables. This property is only available for the numeric input response option.
Display only to users	String	Space separated list of user names that have the right to see this message HMI.

Display list of alarms

Display a full-featured alarm list from the chat (same page as a classical SnapVue action – Show alarms). Note that this operation does not open an embedded view, but a new page.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Content description	String	Displayed text on the chat page after opening the Alarms page. This property supports usage of internal bot variables.
Branch	String	Branch filter for displayed list of alarms. This property supports usage of internal bot variables.
Domain	String	Domain filter for displayed list of alarms. This property supports usage of internal bot variables.
Nature	String	Nature filter for displayed list of alarms. This property supports usage of internal bot variables
Events	Set	Events filter for displayed list of alarms.
Minimum alarm priority	0 - 29	Minimum priority of displayed alarms.
Maximum alarm priority	0 - 29	Maximum priority of displayed alarms.

Display file

Sends an attachment to the given chat, and display the UI to download and open it using the default app for the corresponding file type. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
File path	String	Full Uri path to the file for sending. This property supports usage of internal bot variables. The specified path is relative to the following directory. <projectFolder>\MsgData\Bots
File type	String	Extension of the file for sending. This extension is used to determine which app can open the corresponding file on the mobile device or in the PC. By default, the extension of the selected file is used. This property supports usage of internal bot variables.
Content description	String	Title to display along with the button to open the file. This property supports usage of internal bot variables.
Send value when opened	String	Text message to send to the chat when File is opened on the client device. This property supports usage of internal bot variables.
Back button value	String	Text message to send to the chat when a user returns to the Mobile app after opening the File in a Default viewer. This property supports usage of internal bot variables.
Display only to users	String	Space separated User Names what will have a right to see this message HMI.

Display Url

Displays a native web view component navigated to the given Url with specified HTTP request headers. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
URL	String	Url to open. This property supports usage of internal bot variables.
Request headers	Set	A set of HTTP headers to be included in the GET request. Both keys and values support usage of internal bot variables.
Display only to users	String	Space separated user names that will have the rights to see this message HMI.

Display phone number

Displays a Default app for calling the specified phone number. Note that only the Phone number field is prefilled, the call itself is not initiated by this operation. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Mobile phone number	String	Phone number to prefill in the Default Dial app. This property supports usage of internal bot variables.
Image name	String	Name of the image from the project or a library that will be displayed along with the phone number.
Back button value	String	Text message to send to the chat when a user returns to the mobile app after opening the default dial app. This property supports usage of internal bot variables.
Display only to users	String	Space separated user names what will have a right to see this message HMI.

Display SMS

Displays a default app for sending the specified SMS text. Note that only the text and recipients fields are pre-filled, the SMS itself is not sent by this operation. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
SMS text	String	SMS text to pre-fill in the Default SMS app. This property supports usage of internal bot variables.
Image name	String	Name of the image from the project or a library that will be displayed along with the phone number.
Recipients list	Set	List of phone numbers to use as the SMS recipients.
Back button value	String	Text message to send to the chat when a user returns to the mobile app after opening the default dial app. This property supports usage of internal bot variables.
Display only to users	String	Space separated User Names what will have a right to see this message HMI.

Display trend

Displays a trend viewer on the client device. This operation has the following properties.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Content Description	String	Title to display along with the button to open the Trend Viewer. This property supports usage of internal bot variables.
Curves	Set	A collection of trend lines to display. “Description” and “Variable” properties support usage of internal bot variables.
Back button value	String	Text message to send to the chat when a user returns to the Mobile app after opening the Trend Viewer page. This property supports usage of internal bot variables.
Display only to users	String	Space separated User Names what will have a right to see this message HMI.

Display tiles

Displays a set of tiles on the chat’s page. If the chat is associated with a zone (Local chat), then the HMI is also displayed on that zone’s page (home page). In this case, the Display Tiles operation extends a set of action tiles available in the zone.

Property name	Type	Description
Description	String	Displayed name of the operation. This property is only used in the HMI and has no effect at run-time.
Display only to users	String	Space separated user names that will have the rights to see this message HMI.

A Configure button allows a user to configure the displayed tiles. The following properties are common to all tiles.

Property name	Type	Description
Description	String	Title of the tile. This property supports usage of internal bot variables.
Value	String	Text that is sent to the Chat when user taps on the tile.
Display title	Enum	Alignment and Visibility of the tile’s title. The following values are available. On the left On the center On the right Do not display
Text color	String	HEX code of the color for the text on the tile.
Background color	String	HEX code of the tile’s background color.
Bottom background color	String	HEX code of the tile’s second background color. Two background colors make the Gradient background for the tile.
Tile size	Enum	Size of the tile in the grid. Numbers specify how many rows and columns the tile will occupy. Grid usually has 4 columns on Phone devices. Amount of grid columns depends on the device’s screen size.
Priority	Integer	A number used for ordering the tiles. Tiles with a higher priority are arranged first and appear higher on the screen.

Image

Displays a static image on the tile. This tile has the following specific properties.

Property name	Type	Description
Image name	String	Name of the Image in the project library. This property supports usage of internal bot variables.

Variable value

Displays a value of the given variable and an image depending on the variable’s value. This tile has the following specific properties.

Property name	Type	Description
Variable name	String	The full variable name, including branch. The variable name is prefixed with the current bot’s branch unless the @ symbol is used. This property supports usage of internal bot variables.
Default image name	String	Name of an Image from the project library, to display by default (when the variable value is not NS and does not match any specified option). This property supports usage of internal bot variables.
Image on NS	String	Name of an Image from the project library, to display when the variable value is NS. This property supports usage of internal bot variables.
Images on values	Set	Values and associated names of images, from the project library, to display when the variable has the corresponding value. This property supports usage of internal bot variables.

Image on bit

Displays an image on the tile depending on the bit variable value. This tile has the following specific properties.

Property name	Type	Description
Variable name	String	The full variable name, including branch. The variable name is prefixed with the current bot’s branch unless the @ symbol is used. This property supports usage of internal bot variables.
Image on 1	String	Name of the Image, from the project library, to display when the given bit variable has the value of 1. This property supports usage of internal bot variables.
Image on 0	String	Name of the Image, from the project library, to display when the given bit variable has the value of 0. This property supports usage of internal bot variables.
Image on NS	String	Name of the Image, from the project library, to display when the given bit variable is NS. This property supports usage of internal bot variables.

Image on register

Displays an image on the tile depending on the register variable value. This tile has the following specific properties.

Property name	Type	Description
Variable name	String	The full variable name, including branch. The variable name is prefixed with the current bot’s branch unless the @ symbol is used. This property supports usage of internal bot variables.
Default image name	String	Name of the image, from the project library, to display by default (when the variable value is not NS and does not match to any specified option). This property supports usage of internal bot variables
Image on NS	String	Name of the Image, from the project library, to display when the variable’s value is NS. This property supports usage of internal bot variables
Images on values	Set	Set of values and associated names of images, from the project library, to display when the variable has the corresponding value or less. This property supports usage of internal bot variables.

Option picker

Displays a static image on the tile. A tap on the tile allows the mobile app’s user to change the Image to the next in the options list. After the last option in the list, it starts all over from the first one. This tile has the following specific parameters:

Property name	Type	Description
Initial index	Int	Index of the initial option in the list of Images. This property supports usage of internal bot variables.
Images on values	Set	Set of values and associated names of Images, from the project library, to display. When the user taps on the tile the image is changed to the next in the list and the corresponding value is sent to the chat.

Remove tiles

Removes tiles with the specified names from the screen. If no tile remains on the screen, the messaging page exits the UI mode and switches back to the normal mode where a list of chat messages is displayed. This operation has the following properties.

Property name	Type	Description
Tile names	String	A space separated list of tile names to hide. If the value is empty, then all tiles are removed and the messaging page switches from the UI mode back to the normal mode. This property supports usage of internal bot variables.
Display only to users	String	Space separated list of user names that will have the right to see this message HMI.