Predefined message prompt commands

The message prompt commands cause a message to pop up on the desktop machine to convey information to the user.

You can use a pre-defined display message prompt, or to create or modify a pre-defined prompt by adding additional commands to control the text, style, and buttons in the dialog box. Various icons can be defined to display in the message prompt.

Predefined Display Message Prompts

Predefined Prompt	Display Message	Parameters
Display Basic Message Prompt	Displays a simple message dialog	Syntax:“<trigger passback parameters>” Optional: /k6 /h”Header message” Example: %FORMAT”Note: Recording is <MyTriggerPassbackRecordingState>” /k6 /h”Recording Status” The example displays the formatted trigger passback parameters in the body of a dialog box, with a heading “Recording Status”.
Display Confirmation Message Prompt	Displays dialog with a Success icon. Dialog automatically disappears after 5 seconds.	Syntax:“/m<trigger passback parameters>” Optional: /k6 /h”Header message” Example: /m”Step Completed!” /k6 /h”Congratulations” The example displays the “Step Completed!” in the body of the dialog, with a heading of “Congratulations”
Display Error Message Prompt	Displays dialog with an Error icon.	Syntax: “<trigger passback parameters>” Optional: none Example: “An error has occurred”
Display Information Message Prompt	Displays dialog with an Info icon.	Syntax: /m”<trigger passback parameters>” Optional: /h”Header message” Example: /m”Something interesting here” /h”Information” The example displays “Something interesting here” in the body of the dialog, with a heading of “Information”
Display Warning Message Prompt	Displays dialog with a Warning icon.	Syntax: “<trigger passback parameters>” Optional: none Example: “You should really be careful here!”

Optional Commands for Message Prompts

This table describes the additional commands that can be used to define the message prompts. Defining additional commands allow you to change the display box title, background color, icon, and add buttons and modify button text.

All commands use the format /<parameter>. No spaces are permitted between the / and the <parameter>. String parameters are always enclosed in quotation marks.

Command	Description	Optional Parameters
t	Title caption. Must be a string enclosed in quotation marks.	Syntax: /t“<caption string>” Optional: If not specified, the default value is “Verint - DPA”.
h	Popup header text next to the icon. Must be a string enclosed in quotation marks.	Syntax: /h“<header text string>” Optional: If not specified, the default value is empty. Example: /h”Important Power Outage Information”
k	Header color. Must be a number from 1 to 7: 1 Blue 2 Green 3 Red 4 White 5 Purple 6 Yellow 7 Orange	Syntax: /k<header color number> Optional: If not specified, header color depends on which /i (icon) command is used. If not specified and no icon selected, the default color is blue. Example: /k7 changes the popup header color to orange.
m	Message text. Must be a sting enclosed in quotation marks.	Syntax: /m“<message text string>” Optional. If not specified, the default value is “msgpop.” \n adds a line break \t adds a tab space Quotation marks are required to surround the string. Example: /m”First Line\nSecond Line\n\tThird Line starts after tab space”
i	Icon. Must be a number from 1 to 11.	Syntax: /i<icon number> Optional: If not specified, the default value is empty. Example: /i2 See Message Prompt Icons
c	Background color. Must be a number from 1 to 8: 1 Blue 2 Green 3 Red 4 White 5 Purple 6 Yellow 7 Orange 8 Gray	Syntax: /c<background color number> Optional: If not specified, the default color is white. The Button color is always blue. Example: /c2 changes the background of the message to green.
b	Button type. Must be a number from 1 to 5, or o. Bold indicates the default button selected. 1 OK and Cancel buttons 2 Abort, Retry, and Ignore buttons 3 Yes, No, and Cancel buttons 4 Yes and No buttons 5 Retry and Cancel buttons o Ignores the /b command	Format: /b<button number> Optional. If not specified, only an OK button is displayed and is selected as default button. The blue button is the default. Buttons are indented to the right. Example: /b1 causes the popup to display OK and Cancel buttons, with OK selected as the default button.
o	Overrides the default or defined button type with custom buttons. Must be a sting enclosed in quotation marks. Unlimited number of buttons can be specified	Format: /o”<custom button string>” Optional. If not specified, only an OK button is displayed. Use \n as delimiter to define multiple buttons. Button color is always gray. Buttons are indented to the right. Example: /o”Open\nSave\nDelete” creates three buttons: Open, Save, and Delete.
r%RECT	Positions the message prompt close to a screen control.	Format: /r%RECT<ControlName> Optional.
a	Auto-close: automatically closes the message prompt after 5 seconds, if not closed by a user button click.	Format: /a<auto-close number> Optional. If not specified, the default value is no time-out. For example: /a2
li1 u1	Link text for display on message prompt Http or https URL for link text	Format: /li1"<text link>" Format: /u"http://web.location.com/url/link" Up to three links can be set: li1, li2, li3, u1, u2, u3 Must be used in pair in the following order: /li and /u. Without pair u or li parameters, these are ignored. Example: /li1”Verint" /u1”https://www.verint.com” displays a hyperlink to the Verint website in the popup.
vo	Adds a trigger variable for button response.	Format: /vo"<trigger variable>" For example: /vo"btnResponse" The trigger variable btnResponse will be populated with the value of the button selected on the prompt.

Command

Description

Optional Parameters

Title caption.

Must be a string enclosed in quotation marks.

Syntax: /t“<caption string>”

Optional: If not specified, the default value is “Verint - DPA”.

Popup header text next to the icon.

Must be a string enclosed in quotation marks.

Syntax: /h“<header text string>”

Optional: If not specified, the default value is empty.

Example: /h”Important Power Outage Information”

Header color.

Must be a number from 1 to 7:

1 Blue

2 Green

3 Red

4 White

5 Purple

6 Yellow

7 Orange

Syntax: /k<header color number>

Optional: If not specified, header color depends on which /i (icon) command is used. If not specified and no icon selected, the default color is blue.

Example: /k7 changes the popup header color to orange.

Message text.

Must be a sting enclosed in quotation marks.

Syntax: /m“<message text string>”

Optional. If not specified, the default value is “msgpop.”

\n adds a line break
\t adds a tab space
Quotation marks are required to surround the string.

Example: /m”First Line\nSecond Line\n\tThird Line starts after tab space”

Icon.

Must be a number from 1 to 11.

Syntax: /i<icon number>

Optional: If not specified, the default value is empty.

Example: /i2

See Message Prompt Icons

Background color. Must be a number from 1 to 8:

1 Blue

2 Green

3 Red

4 White

5 Purple

6 Yellow

7 Orange

8 Gray

Syntax: /c<background color number>

Optional: If not specified, the default color is white.

The Button color is always blue.

Example: /c2 changes the background of the message to green.

Button type. Must be a number from 1 to 5, or o. Bold indicates the default button selected.

1 OK and Cancel buttons

2 Abort, Retry, and Ignore buttons

3 Yes, No, and Cancel buttons

4 Yes and No buttons

5 Retry and Cancel buttons

o Ignores the /b command

Format: /b<button number>

Optional. If not specified, only an OK button is displayed and is selected as default button.

The blue button is the default.
Buttons are indented to the right.

Example: /b1 causes the popup to display OK and Cancel buttons, with OK selected as the default button.

Overrides the default or defined button type with custom buttons.

Must be a sting enclosed in quotation marks.

Unlimited number of buttons can be specified

Format: /o”<custom button string>”

Optional. If not specified, only an OK button is displayed.

Use \n as delimiter to define multiple buttons.

Button color is always gray.
Buttons are indented to the right.

Example: /o”Open\nSave\nDelete” creates three buttons: Open, Save, and Delete.

r%RECT

Positions the message prompt close to a screen control.

Format: /r%RECT<ControlName>

Optional.

Auto-close: automatically closes the message prompt after 5 seconds, if not closed by a user button click.

Format: /a<auto-close number>

Optional. If not specified, the default value is no time-out.

For example: /a2

li1

Link text for display on message prompt

Http or https URL for link text

Format: /li1"<text link>"

Format: /u"http://web.location.com/url/link"

Up to three links can be set: li1, li2, li3, u1, u2, u3

Must be used in pair in the following order: /li and /u.

Without pair u or li parameters, these are ignored.

Example: /li1”Verint" /u1”https://www.verint.com” displays a hyperlink to the Verint website in the popup.

Adds a trigger variable for button response.

Format: /vo"<trigger variable>"

For example: /vo"btnResponse"

The trigger variable btnResponse will be populated with the value of the button selected on the prompt.

Message Prompt Icons

Number	Description	Icon
1, 2, 8	Error If no header color is specified with the /k option and this icon is selected, the header is red.
3	Help If no header color is specified with the /k option and this icon is selected, the header is gray.
4, 5, 6, 7, 11	Information If no header color is specified with the /k option and this icon is selected, the header is blue.
9	Success If no header color is specified with the /k option and this icon is selected, the header is green.
10	Warning If no header color is specified with the /k option and this icon is selected, the header is orange.