Desktop Client

Version 2.1 by michaely on 2021/09/09 18:01
Warning
For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Overview

This document covers how use the Desktop Client Application. The Desktop Client Application allows users to utilize the iSymphony client interface from within a native application that runs on the user's machine. This allows iSymphony to act as a native application, with its own window and shortcuts. The Desktop Client Application also allows for functionality like Global Hot Key focusing and application based CRM popups. 

If you have not already installed the Desktop Client Application, see Desktop Client Installation.

 

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
 

Initial Setup

When you first launch the Desktop Client Application you will prompted to enter the server URL. If you downloaded the Desktop Client Installer from the iSymphony Client interface (See Desktop Client Installation), simply paste the URL that you were provided and click OK.

If you did not copy the URL, or you downloaded the installer outside of the Client interface, enter the following URL:

ws://<ip or hostname of your iSymphony server>:58080

Settings

To access the settings for the Desktop Client Application select File->Settings from the top application menu.

General

iSymphony Server:

This dropdown specifies the URL that the Desktop Client Application will use to connect to the server. You will have at least one Default server that is based on the URL you entered in the Initial Setup phase.

If the client requires additional URLs to access the panel, depending on the location of the user, they can be set up in the Administration interface. See Desktop Client Configuration.

Global Hotkey:

This field specifies the hot key sequence used to focus the Desktop Client Application. To change the hotkey, simply click the field and press the key sequence you want.

CRM Integration

Predefined:

This drop down specifies which predefined CRM configuration the Desktop Client Application should use for application based popups. The predefined CRM configurations can be set up in the iSymphony Administration interface. See Desktop Client Configuration.

Custom

This section allows you to specify a custom configuration for the CRM application popup.

Application Path: The path to the executable used for the popup.

Argument Format String: The string representing the arguments that will be passed to the popup application. You can use all the variables available in the web based CRM popup mechanism in this field. See CRM Widget for more information.

Application Popups

One of the major advantages of the Desktop Client Application is that you can now popup application based CRMs, just like web based CRMs.

  1. Add a CRM Widget to your dashboard like you normally would for web based CRMs. See CRM Widget.
  2. Set the Type to Application.
  3. Open the settings for the Desktop Client Application and choose a Predefined CRM configuration, or set up a Custom Configuration. See Settings above.

Clear Settings

In some case you will want to clear out all settings for the Desktop Client Application, and start from scratch, as if you just installed the application.

To clear the settings you will have to delete or rename the iSymphony.json file. The location of this file will differ depending the OS you are running on.

Warning

Do not delete or rename this file while the Desktop Client Application is running.

Windows

C:\Users\<username>\AppData\Roaming\iSymphony\iSymphony.json

OS X

/Users/<username>/Library/Application Support/iSymphony.json

Linux

/home/<username>/iSymphony/iSymphony.json