Management system desktop app settings
You can manage settings for the desktop app in the BlackBerry AtHoc management console.
To update desktop app settings, complete the following steps:
- Log in to the BlackBerry AtHoc management console as an administrator.
- In the navigation bar, click the
(Settings) icon.
- In the Devices section, clickDesktop App. The Desktop App window opens.
- Select the options you want according to the guidelines below.
General
The following options are available in the General section:
- Right-click to dismiss Desktop pop-upEnable this option to allow end users to dismiss the Desktop pop-up with a right-click.This option is stored in:hkcu\software\AtHoc[edition]\PROVIDER\ ENABLERCLICKCLEARPOPUP
- Show uninstall option in control panel and Start menuEnable this option to show the Uninstall button in the toolbar of the "Uninstall or change a program" dialog in Programs and Features when the AtHoc[edition] application is selected from the list of applications.This option is stored in:hkcu\software\AtHoc[edition]\PROVIDER\NoUninstall
- Collect workstation informationEnable this option to allow the desktop app to send the machine IP address, machine name, username, and domain to the BlackBerry AtHoc server. Disable this option to reduce the amount of user information that is transferred over the network. When this option is disabled, IP targeting does not work.The following table shows support for Collect Workstation Information in the desktop appCollect Workstation Information supportVersionNotes6.2.x.270Machine IP.6.2.x.271+Machine IP and machine name. The value is retrieved in a call to baseURL.asp.
- Stop checking for updates when Desktop is lockedThis option is useful in environments where users do not turn off their machines. When this option is not enabled, desktop apps continue to poll the server at the CU interval when end users are away. Server resources are used for no purpose, and the “Desktop User(s) OnLine” count and graph on the management system home page show artificially high values.This option is stored in:hkcu\software\AtHoc[edition]\PROVIDER\blockRequestIfLocked
- Email Address To Send Client LogsEnter an email address to send the desktop app log to. When the user selects the "Send <organization name> Log" in the Start menu for the desktop app, the email address entered in this field receives a copy of the log file.This option is stored in:hkcu\software\AtHoc[edition]\PROVIDER\clientLog
- ActiveX Object NameEnter the ActiveX object name for the desktop app. This is used when creating the JavaScript code that is sent by the server to the desktop app in response to requests and in alerts. For example, when the user selects the “Access Self Service” menu option, selects a response option, or clicks a button on an alert.The JavaScript code is generated dynamically and when it executes on the user’s machine it attempts to create an object using the value that appears in this field. For example,AtHocCorpGStlbar.GShelper. If the value does not match the desktop app edition, an error occurs. Depending on the feature accessed, the user may see “Error: Automation server can't create object” or “Validation Error.”
Audio
The following options are available in the Audio section:
- Speaker OptionsThis option specifies how the desktop app works with built-in speakers. Select "Consider end user system settings" to prevent the desktop app from overriding the end users' local system speaker settings. Select "Always turn on speaker" to override local speaker settings. When this option is selected, the Desktop Volume Threshold slider control appears.
- Desktop Volume ThresholdThis option specifies the volume level that the desktop app sets the audio to.The operating system does not provide a way for the desktop app to distinguish between headphones and speakers. When end users are wearing headphones that are plugged into the machine's audio jack, an incoming alert may sound extremely loud.
System Tray Menu
The following options are available in the System Tray Menu section:
- Display System tray iconThe system tray icon is the purple globe icon that appears in the system tray when the desktop app is running. Enable this option to show the icon.This option is stored in:hkcu\software\AtHoc[edition]\SYSTEM\systray-visibility
- Available Menu ItemsClick theManage Menu Itemslink to open the Desktop App Menu Items window. From this screen, you can add or edit a desktop tray menu item. When you add a menu item, note the ID that is displayed.
- Menu ConfigurationThe XML in the Menu Configuration field creates the exact representation of the desktop menu items that are seen by an end user. Menu items have this format:<Item Id="8009" Type="Link"/>where Id is the service ID. You can see the list of services in the Desktop App Menu manager.There are two item types: Separator and Link. Separators add a line in the menu that is used to separate groups of items.Addition or removal of a menu item is picked up by desktop apps at the next Check Update. Changes to a menu item take effect immediately (without CU) because the GS request is processed server-side, and the resulting service URL is passed back to the desktop app.The system tray menu is stored in the user’sAppData\Local\AtHoc[edition]folder, inSYSTRAY-MENU.XML.See System tray menu for more information about System Tray menu items.
Client server communications
The following options are available in the Client Server Communications section:
- System Setup URLThis is the URL to the server where BlackBerry AtHoc is installed.
- Check Update IntervalThe Check Update Interval (CU) determines how frequently the desktop app polls the server for updates, including alerts. A lower value causes end users to receive desktop pop-up alerts sooner. A higher value causes users to receive desktop pop-up alerts later. The recommended value is 2 minutes.This option is stored in:hkcu\software\AtHoc[edition]\system\KEEPER-INTERVAL
- Reconnect IntervalThe Reconnect Interval specifies the interval the desktop app waits before attempting to contact the server again when the connection is lost. When a CU fails due to a lost connection, either a timeout or no Internet connection is available, the desktop app uses the Reconnect Interval setting to determine the number of CU intervals to wait before attempting to connect again. The minimum value is 1. The maximum value is 10. The default value is 2.This option is used in conjunction with CONNECT-INTERVAL-WINDOW (stored inhkcu\software\AtHoc[edition]\SYSTEM\CONNECT-INTERVAL-WINDOW). For more information, see the "User key" section in Registry settings.This option is stored in:hkcu\software\AtHoc[edition]\SYSTEM\CONNECT-INTERVAL
- Recovery IntervalThe Recovery Interval specifies the number of CU intervals the desktop app waits before attempting to contact the server again when the server responds to a SO or CU with an error.The minimum value is 1. The maximum value is 10. The default value is 2.This option is stored in:hkcu\software\AtHoc[edition]\SYSTEM\RECOVERY-INTERVAL
- Start-up DelayThe Start-up Delay option is a fractional value between 0 and 1 inclusive that is used to determine the amount of delay before the desktop app first attempts to sign on. A value of 0 specifies no delay and a value of 1 specifies to wait one full Check Update interval. A value of .5 specifies a delay of 50% of the check update interval.This setting enables you to stagger desktop app sign-ons where users arrive or return to work at the same time and reduce server load caused by many simultaneous sign-ons.If there is no KEEPER-START value in the registry, the desktop app uses the value from the KEEPER-INTERVAL (the CU interval) as the random delay for sign-ons.This option is stored in:hkcu\software\AtHoc[edition]\SYSTEM\KEEPER-START
- Communication Session Expires AfterThis option determines when the desktop app session is reset on the server (and the record deleted from the session table). The default value is 86400 seconds (24 hours). When the desktop app session expires, the desktop app performs a sign on at the next CU.
- Override Default Communication Session Expiration Time AfterThis option provides a mechanism to expire desktop sessions that were created by the SYSTEM user. Sessions can be created by the SYSTEM user when desktop apps are deployed with SCCM and RUNAFTERINSTALL is set to "Y". Sessions can be created by the SYSTEM user when SCCM is used to update machines after the desktop app is installed.By expiring desktop sessions after an interval of inactivity, this option provides a mechanism to get desktop apps to perform a sign on in environments where users do not turn off their computer. Because redirection occurs during sign on, this option can be used to get desktop apps to redirect in environments where users do not turn off their computer.There is no registry value for this setting.
- Group-based Check Update IntervalThis option allows the system to override the check update interval for specific groups and give different users different check update intervals depending on the XML configuration. Select the Enable check box to view and edit the XML. Specify the value in seconds.
Failover
The following options are available in the Failover section:
- Failover Server URLSpecify the URL to a server for the desktop app to connect to when the primary server is unavailable. You can specify one failover server URL. You must have a failover server that has a copy of the primary database with the same values. The desktop app updates the failover server URL only during SO. The failover server URL value on the failover server should be changed to the primary URL for the primary server before the primary server allows desktop apps to connect.For more information, see Failover.This option is stored in:hkcu\software\AtHoc[edition]\alternateBaseUrl1
- Reconnect Attempts Before FailoverThis option specifies the number of attempts the desktop app performs before switching to the failover server.