Changes for page Desktop Client

Last modified by michelk on 2021/09/09 20:56

From 8.1 to 7.1 From 12.1 to 11.1

From version 11.1

edited by michelk
on 2021/09/09 18:01

Change comment: Import

To version 8.1

edited by michaely
on 2021/09/09 18:01

Change comment: Import

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.michelk
++XWiki.michaely

Content

@@ -3,11 +3,11 @@
  {{layout-cell}}
  = 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.
++This document covers how to install the Desktop Client Application on your machine. 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 [[doc:Desktop Client Installation v2\.0\.0]].
--
--
++{{note}}
++In order to have access to the Desktop Client Application you must first install the Desktop Client Module. See [[doc:Desktop Client Module Installation]] for more information.
++{{/note}}
  {{/layout-cell}}
  {{layout-cell}}
@@ -21,139 +21,100 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--= Initial Setup =
++= (% style="color: rgb(0, 0, 0); font-size: 24px; line-height: 24px" %)1. Download The Desktop Client Installer(%%) =
--When you first launch the Desktop Client Application you will prompted to enter the hostname and port of the server you want to connect to. If no port is specified, the default port of 58080 will be used. The connection attempt will be validated.
++(((
++There are two methods to download the Desktop Client installer. Both methods will download the appropriate installer for your host OS.
++)))
--If you are unsure of the port or hostname, you can check the iSymphony Client interface (See [[doc:Desktop Client Installation v2\.0\.0]]).
++== Download From The Client Web Interface ==
--(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Initial Setup for Legacy Client
++1. Log into the iSymphony Client Interface. See [[doc:Connecting To The Client Interface]].
++1. Open the user menu in the top right hand corner of the Client Interface.
++1. Select **Desktop Client**.
++1. Copy the URL that is specified in the dialog that is opened. We will need this URL later.
++1. Select **Download Desktop Client**.
--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 [[doc:Desktop Client Installation v1\.0\.1]]), simply paste the URL that you were provided and click **OK**.
++{{note}}
++Some browsers may flag the download as un-trusted and show a warning. Simply ignore the warnings and proceed with the download.
++{{/note}}
--If you did not copy the URL, or you downloaded the installer outside of the Client interface, enter the following URL:
++== Download Directly From The URL ==
++You can enter the following URL in your browser to download the Desktop Client installer:
++
  {{code}}
--ws://<ip or hostname of your iSymphony server>:58080
++http://<ip or hostname of your iSymphony server>:58080/client/desktop
  {{/code}}
--= Settings =
++= (% style="color: rgb(0,0,0);" %)2. Install The Desktop Client(%%) =
--To access the settings for the Desktop Client Application select **File->Settings** from the top application menu.
++(% style="color: rgb(0,0,0);" %)The installation method will vary depending on the OS you are installing on.
--|=(% colspan="2" %)(% colspan="2" %)
--(((
--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.
++== (% style="color: rgb(0,0,0);" %)Windows(%%) ==
--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.
--)))
--|=(% colspan="1" %)(% colspan="1" %)
--(((
--Host parameters
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--This allows the user to add additional parameters to the configured iSymphony server. For example: this could be used to set the language of the application by providing the parameter
++(% style="color: rgb(0,0,0);" %)To execute the installer on Windows simply double click the downloaded installer package, and the installation process will commence.
--{{code}}
-- restartApplication&locale=en_us
--{{/code}}
--)))
--|=(((
--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.
--)))
--|=(% colspan="2" %)(% colspan="2" %)
--(((
--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.
--)))
--|=(% colspan="1" %)(% colspan="1" %)
--(((
--Custom
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--This section allows you to specify a custom configuration for the CRM application popup.
++{{note}}
++Windows will open a warning mentioning that the installer is un-trusted. You can ignore this warning and proceed with the download.
++{{/note}}
--**Application Path: **The path to the executable used for the popup.
++{{note}}
++The installer will not provide a notification that the installation was complete. The installer will simply exit when completed.
++{{/note}}
--**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 [[doc:CRM Widget]] for more information.
--)))
++== (% style="color: rgb(0,0,0);" %)OS X(%%) ==
--= Application Popups =
++1. (% style="color: rgb(0,0,0);" %)Mount the downloaded dmg file by double clicking on it.
--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. (% style="color: rgb(0,0,0);" %)Once mounted copy the iSymphony file to your Applications directory.(%%)
++1. Unmount the dmg.
--1. Add a CRM Widget to your dashboard like you normally would for web based CRMs. See [[doc:CRM Widget]].
--1. Set the **Type** to **Application.**
--1. Open the settings for the Desktop Client Application and choose a Predefined CRM configuration, or set up a Custom Configuration. See Settings above.
++== Linux ==
--{{info title="Special Notes For OS X"}}
--OS X requires the use of the open application in order to launch .app files. This means that the application you will be running is open , while the arguments will specify the path to the .app file to launch, along with any other arguments.
++1. (((
++Make the installer executable:
--For example, if we want to open a URL in Firefox, we can use the following settings:
--
--|=(((
--**Application Path:**
--)))|(((
--/usr/bin/open
++{{code language="bash"}}
++chmod +x isymphony_install_<version>.bsx
++{{/code}}
  )))
--|=(((
--**Argument Format String**:
--)))|(((
--http:~/~/www.getisymphony.com?q=${PBX(UNIQUEID)
++1. (((
++Run the installer:
--{{{-a /Applications/FireFox.app --args }}}}
++{{code language="bash"}}
++./isymphony_install_<version>.bsx
++{{/code}}
  )))
--
++= Uninstalling The Desktop Client =
--The documentation for the open command can be found here:
++The uninstall procedure differs for each OS.
--[[https:~~/~~/developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/open.1.html>>url:https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/open.1.html||shape="rect"]]
--{{/info}}
++== (% style="color: rgb(0,0,0);" %)Windows(%%) ==
--
++1. Open your **Start Menu** and navigate to **Control Panel->Programs and Features**.
++1. Right click on **iSymphony** and select **uninstall**.
--= Clear Settings =
++== OS X ==
--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.
++Simply delete the** iSymphony.app** file from your Applications directory.
--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.
++== Linux ==
--{{note}}
--Do not delete or rename this file while the Desktop Client Application is running.
--{{/note}}
++Delete the following directory and files:
--== (% style="color: rgb(0,0,0);" %)Windows(%%) ==
--
--{{code}}
--Version 2.1+: C:\Users\<username>\AppData\Roaming\iSymphony Desktop\iSymphonyDesktop.json
--Version 1.x: C:\Users\<username>\AppData\Roaming\iSymphony\iSymphony.json
++{{code language="bash"}}
++/home/<username>/iSymphony
++/home/<username>/.local/share/applications/iSymphony.desktop
++/home/<username>/.local/share/applications/iSymphony-app.desktop
  {{/code}}
--== OS X ==
++
--{{code}}
--Version 2.1+: /Users/<username>/Library/Application Support/iSymphony Desktop/iSymphonyDesktop.json
--Version 1.0: /Users/<username>/Library/Application Support/iSymphony.json
--{{/code}}
++
--== Linux ==
--
--{{code}}
--Version 2.1+: /home/<username>/iSymphony/iSymphony Desktop/iSymphonyDesktop.json
--Versin 1.0: /home/<username>/iSymphony/iSymphony.json
--{{/code}}
++
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}

Changes for page Desktop Client

Summary

Details

Search

Navigation