Using Session Dialogs

Session dialogs are custom windows shown at program startup, at session start, when desktop streaming is requested, or at the end of a session. You define them in a single file and upload it to a customization in ISL Conference Proxy. Please refer to ISL Conference Proxy manual for more information about session dialogs.

 

There are four types of session dialogs available:

  • Shown at program startup (called start-of-dialog, or SOD)
  • Shown at session start (called start-of-session, or SOS)
  • Shown at desktop streaming request (called stream-dialog)
    • User confirmation is required to begin desktop streaming
  • Shown at the end of the session (called end-of-session, or EOS)

SOD and SOS dialogs are usually disclaimers and include no user input apart from confirmation. The user can also decline an SOD or SOS dialog by pressing Esc or clicking the close window button, which terminates the program or session. The stream dialog remembers the user input internally. The EOS dialog reports results to ISL Conference Proxy, and those results are saved to the ISL Light session history.

 

All dialogs should be defined in a single file. You can specify one or more, depending on your needs.

 

Basic dialog definition syntax

Session dialogs are defined using a simple XML-like language with a root dialog element. All names are equal to names found in the C API of the Windows GUI. Child object names are window class names. You can use static, edit, button, combobox and others.

Each object can have a title, dimensions, style, exstyle and return value specified through the use of attributes. Names of window classes, styles, exstyles can be found on Microsoft Learn. Objects of type combobox have an additional attribute named delimiters. This attribute is used for parsing values that are inserted into the combobox.

Only those objects that have the result attribute specified will report the result to the ISL Conference Proxy. Each such object generates a key-value pair where the result attribute is used as a key.

 

Each entry (sod_dialog, sos_dialog, stream_dialog and eos_dialog) must be a single line to be interpreted correctly. The examples in this article include line breaks only for readability. Remove all line breaks from an entry before you use it.

The first line contains the language identifier, a 2-letter ISO 639 code. For example, en for English, sl for Slovenian or de for German.

Multiple languages can be set up, with each section starting with the corresponding language code inside square brackets. Make sure English is always present, because it is the default fallback in case the target “Windows display language” is set to a language that is not present in the dialogs.ini file.

 

 

Dialog examples

SOD example

[en]
sod_dialog=
<dialog title="Welcome!" width=110 height=40 style="WS_CAPTION|WS_POPUP|WS_SYSMENU" >
<static top=5 left=5 width=100 height=20 title="Welcome to the ISL Light system!" />
<button top=30 width=30 height=8 left=40 title="OK" id=IDOK />
</dialog>

 

 

SOS example

[en]
sos_dialog=
<dialog title="Welcome to ISL Light" width=110 height=40 style="WS_CAPTION|WS_POPUP|WS_SYSMENU" >
<static top=5 left=5 width=100 height=20 title="Welcome to the ISL Light session." />
<button top=30 width=30 height=8 left=40 title="OK" id=IDOK />
</dialog>

 

stream_dialog example

[en]
stream_dialog=
<dialog title="Start of Stream" width=200 height=160 style="WS_CAPTION|WS_POPUP|WS_SYSMENU">
<static top=5 left=5 width=190 height=15 title="You have started desktop streaming"/>
<static top=107 left=5 width=190 height=40 title="By accepting these terms and conditions you acknowledge that remote intervention may in some cases cause data and/or software corruption on your computer."/>
<button top=147 width=30 height=8 left=85 title="Accept" id=IDOK/>
<data type="script"><function key="on_command">
<if>
<eq>
<get><arg>0</arg></get>
<get>IDOK</get>
</eq>
<call key="stream_dialog_skip"></call>
<call key="stop_session"></call>
</if>
</function>
<function key="on_close_dialog">
<call key="stop_session"></call>
</function>
</data>
</dialog>

The dialog is shown when user initiates screen sharing functionality. The dialog can be defined in a way so that if the dialog is not accepted the session is terminated and if accepted then the start of streaming request is sent to the other side. Dialog can call the following two functions:

  • stream_dialog_skip: If the user confirms, desktop streaming starts and the choice is remembered.
  • stop_session: If the user denies desktop streaming, the session is closed.

For stream_dialog to appear, the client has to have the following command-line parameter set:

--on-load "customization?preselect_allow_remote_desktop_control=false"

 

 

EOS example

[en]
eos_dialog=
<dialog title="Questionnaire" width=160 height=110 style="WS_CAPTION|WS_POPUP|WS_SYSMENU" exstyle=WS_EX_APPWINDOW result="desk_issue_status" >
<static top=5 left=5 width=50 height=8 title=Supporter />
<edit top=5 left=55 width=100 height=8 title="Supporter 1" exstyle=WS_EX_CLIENTEDGE result="Supporter" />
<static top=15 left=5 width=50 height=8 title=Customer />
<edit top=15 left=55 width=100 height=8 title="" exstyle=WS_EX_CLIENTEDGE result="Customer" />
<static top=25 left=5 width=50 height=8 title="Company" />
<combobox top=25 left=55 width=100 height=50 delimiters=";" style=CBS_DROPDOWNLIST result="Company" >Company A;Company B;Company C;Company D </combobox>
<static top=35 left=5 width=50 height=8 title="Type of service" />
<combobox top=35 left=55 width=100 height=50 delimiters=";" style=CBS_DROPDOWNLIST result="Type" >Technical Error;Configuration Error;User Error </combobox>
<button top=45 width=50 height=8 left=5 title="Done" style=BS_AUTOCHECKBOX result="Done" >true</button>
<button top=45 width=100 height=8 left=55 title="Accounted" style=BS_AUTOCHECKBOX result="Bill" >true</button>
<static top=55 left=5 width=50 height=8 title="Content:" />
<edit top=65 width=150 height=30 left=5 title="" exstyle=WS_EX_CLIENTEDGE result="Content" />
<button top=100 width=30 height=8 left=55 title="OK" id=IDOK />
</dialog>

 

Add session dialogs to a customization

As an example, we will use only the EOS dialog. Save the EOS dialog definition from the EOS example to a file called dialogs.ini. Make sure the eos_dialog entry is a single line (without line breaks), otherwise it will not work. It should look similar to this:

 

[en]
eos_dialog=<dialog title="Questionnaire" width=160 height=110 style="WS_CAPTION|WS_POPUP|WS_SYSMENU" exstyle=WS_EX_APPWINDOW result="desk_issue_status" ><static top=5 left=5 width=50 height=8 title=Supporter /><edit top=5 left=55 width=100 height=8 title="Supporter 1" exstyle=WS_EX_CLIENTEDGE result="Supporter" /><static top=15 left=5 width=50 height=8 title=Customer /><edit top=15 left=55 width=100 height=8 title="" exstyle=WS_EX_CLIENTEDGE result="Customer" /><static top=25 left=5 width=50 height=8 title="Company" /><combobox top=25 left=55 width=100 height=50 delimiters=";" style=CBS_DROPDOWNLIST result="Company" >Company A;Company B;Company C;Company D </combobox><static top=35 left=5 width=50 height=8 title="Type of service" /><combobox top=35 left=55 width=100 height=50 delimiters=";" style=CBS_DROPDOWNLIST result="Type" >Technical Error;Configuration Error;User Error </combobox><button top=45 width=50 height=8 left=5 title="Done" style=BS_AUTOCHECKBOX result="Done" >true</button><button top=45 width=100 height=8 left=55 title="Accounted" style=BS_AUTOCHECKBOX result="Bill" >true</button><static top=55 left=5 width=50 height=8 title="Content:" /><edit top=65 width=150 height=30 left=5 title="" exstyle=WS_EX_CLIENTEDGE result="Content" /><button top=100 width=30 height=8 left=55 title="OK" id=IDOK /></dialog>

 

To add session dialogs:

  1. Log in to your ISL Conference Proxy configuration (https://<server_address>:7615/conf).
  2. Go to Configuration > Advanced > Customize.
  3. Click Create new customization or edit your existing customization.
    If you have already created a customization (for example, using the Customization wizard), click the customization name and proceed to step 5.
  4. Change the customization name from the randomly generated string to something simpler. This example uses mycustom.
  5. Click upload... next to the desired entry (for example, Dialog INI file), then Choose, then select a valid dialog file (for example, the dialogs.ini file with the single-line eos_dialog entry).
  6. Click Save at the bottom.

 

You have now created a customization with an EOS dialog and there are a few ways to use it. Each way has its own benefits and usage cases. For instructions on how to use the customization, see Using a customization in the Introduction article.

Was this article helpful?