Wiki source code of Desktop Client

Last modified by michelk on 2021/09/09 20:56
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 = Overview =
5
6 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.
7
8 If you have not already installed the Desktop Client Application, see [[doc:Desktop Client Installation v2\.0\.0]].
9
10
11 {{/layout-cell}}
12
13 {{layout-cell}}
14 {{panel title="On this page:"}}
15
16
17 {{toc maxLevel="2" indent="1"/}}
18 {{/panel}}
19 {{/layout-cell}}
20 {{/layout-section}}
21
22 {{layout-section ac:type="single"}}
23 {{layout-cell}}
24 = Initial Setup =
25
26 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.
27
28 If you are unsure of the port or hostname, you can check the iSymphony Client interface (See [[doc:Desktop Client Installation v2\.0\.0]]).
29
30 (% style="color: rgb(0,0,0);font-size: 24.0px;" %)Initial Setup for Legacy Client
31
32 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**.
33
34 If you did not copy the URL, or you downloaded the installer outside of the Client interface, enter the following URL:
35
36 {{code}}
37 ws://<ip or hostname of your iSymphony server>:58080
38 {{/code}}
39
40 = Settings =
41
42 To access the settings for the Desktop Client Application select **File->Settings** from the top application menu.
43
44 |=(% colspan="2" %)(% colspan="2" %)
45 (((
46 General
47 )))
48 |=(((
49 iSymphony Server:
50 )))|(((
51 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.
52
53 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.
54 )))
55 |=(% colspan="1" %)(% colspan="1" %)
56 (((
57 Host parameters
58 )))|(% colspan="1" %)(% colspan="1" %)
59 (((
60 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
61
62 {{code}}
63 restartApplication&locale=en_us
64 {{/code}}
65 )))
66 |=(((
67 Global Hotkey:
68 )))|(((
69 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.
70 )))
71 |=(% colspan="2" %)(% colspan="2" %)
72 (((
73 CRM Integration
74 )))
75 |=(((
76 Predefined:
77 )))|(((
78 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.
79 )))
80 |=(% colspan="1" %)(% colspan="1" %)
81 (((
82 Custom
83 )))|(% colspan="1" %)(% colspan="1" %)
84 (((
85 This section allows you to specify a custom configuration for the CRM application popup.
86
87 **Application Path: **The path to the executable used for the popup.
88
89 **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.
90 )))
91
92 = Application Popups =
93
94 One of the major advantages of the Desktop Client Application is that you can now popup application based CRMs, just like web based CRMs.
95
96 1. Add a CRM Widget to your dashboard like you normally would for web based CRMs. See [[doc:CRM Widget]].
97 1. Set the **Type** to **Application.**
98 1. Open the settings for the Desktop Client Application and choose a Predefined CRM configuration, or set up a Custom Configuration. See Settings above.
99
100 {{info title="Special Notes For OS X"}}
101 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.
102
103 For example, if we want to open a URL in Firefox, we can use the following settings:
104
105 |=(((
106 **Application Path:**
107 )))|(((
108 /usr/bin/open
109 )))
110 |=(((
111 **Argument Format String**:
112 )))|(((
113 http:~/~/www.getisymphony.com?q=${PBX(UNIQUEID)
114
115 {{{-n -a "/Applications/FireFox.app" --args }}}}
116 )))
117
118
119
120 The documentation for the open command can be found here:
121
122 [[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"]]
123 {{/info}}
124
125
126
127 = Clear Settings =
128
129 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.
130
131 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.
132
133 {{note}}
134 Do not delete or rename this file while the Desktop Client Application is running.
135 {{/note}}
136
137 == (% style="color: rgb(0,0,0);" %)Windows(%%) ==
138
139 {{code}}
140 Version 2.1+: C:\Users\<username>\AppData\Roaming\iSymphony Desktop\iSymphonyDesktop.json
141 Version 1.x: C:\Users\<username>\AppData\Roaming\iSymphony\iSymphony.json
142 {{/code}}
143
144 == OS X ==
145
146 {{code}}
147 Version 2.1+: /Users/<username>/Library/Application Support/iSymphony Desktop/iSymphonyDesktop.json
148 Version 1.0: /Users/<username>/Library/Application Support/iSymphony.json
149 {{/code}}
150
151 == Linux ==
152
153 {{code}}
154 Version 2.1+: /home/<username>/iSymphony/iSymphony Desktop/iSymphonyDesktop.json
155 Versin 1.0: /home/<username>/iSymphony/iSymphony.json
156 {{/code}}
157 {{/layout-cell}}
158 {{/layout-section}}
159 {{/layout}}

Search

Navigation

iSymphony