Back to contents

Available variables

When you are passing variables to a URL, there are some convenient built-in variables to simplify your task. You can pass any of these:

  • %deskalerts_id%. This is a unique application ID, which stays the same even when the DeskAlerts application is updated or reinstalled.
  • %user_name%. Once you set this variable using JavaScript, you could pass it on for processing through a button URL or other redirect.

Using Unicode for non-latin text

Conf.xml file should be saved in UTF-8.

If you can’t save it in UTF-8, please do the following: non-Latin text and special characters should be written using their Unicode equivalents. In Unicode, for example, if 00E4 is the code for “a”, then you would specify that character as &#x00E4.

A list of Unicode symbol codes is available at Unicode site charts.

The version.txt file

The version.txt file contains one line of code, something like: DeskAlerts v6.0.0.0

Be sure to update the number of version in this file when you are preparing a new version of DeskAlerts for release, so the autoupdate function can recognize the new release and install it.

Configuring OPTIONS page

DeskAlerts Client Options page is data\version\options.html. In its default form it yields an options page that looks something like this:

 

Declare the window in the conf.xml file something like this:

Options.

<OPTION name=”option” window=”optionwindow1″ filename=”%root_path%\options.html”/>

<WINDOW name=”optionwindow1″ captionhref=”%root_path%\defcaption.html” caption=”Options” width=”400″ height=”300″ leftmargin=”5″ topmargin=”28″ rightmargin=”5″ bottommargin=”13″ position=”right-bottom” transparency=”220″ transp_color=”00F0FF” />

Provide access to the options page by binding it to the menu item.

If there are options you do not want to expose to users, simply remove them from the HTML page.

Note: You can post your options.html file anywhere on the server and set the href attribute to call it from there.

Standby mode

The standby mode can be set up in DeskAlerts to allow the software to go idle following a specified period of inactivity. Once the user has failed to move the mouse or hit a key on the keyboard for a sufficiently long period of time, DeskAlerts temporarily ceases to check messages, or uses an alternate specified time period between message checks. When the user resumes activity using the mouse or keyboard, DeskAlerts leaves standby mode and likewise resumes its normal activity.

To incorporate standby mode in DeskAlerts, simply make a few easy modifications to the conf.xml file.

  • Open the conf.xml file using a text or XML editor.
  • Modify the normaltostandbyexpire property to toggle the use of standby mode. Use 0 to disallow standby mode, and use the positive value to allow DeskAlerts to go into standby mode.<PROPERTY id=”normaltostandbyexpire” default=”5″ />indicates that the use of standby mode has been enabled and DeskAlerts switch to standby mode after 5 minutes of user inactivity.
  • Set the frequency of message checks in standby mode by modifying the standby_expire property. If you want DeskAlerts to not completely cease checking messages when in standby mode, enter the number 0. Otherwise, you can specify the standby message checking period in minutes:<PROPERTY id=”standby_expire” default=”30″ />.In this example, when in standby mode, DeskAlerts will check messages every 30 minutes (half hour).