Skip to Content

Wiki source code of Desktop Client

Version 2.1 by michaely on 2021/09/09 18:01
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]].
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 server URL. If you downloaded the Desktop Client Installer from the iSymphony Client interface (See [[doc:Desktop Client Installation]]), simply paste the URL that you were provided and click **OK**.
27
28 If you did not copy the URL, or you downloaded the installer outside of the Client interface, enter the following URL:
29
30 {{code}}
31 ws://<ip or hostname of your iSymphony server>:58080
32 {{/code}}
33
34 = Settings =
35
36 To access the settings for the Desktop Client Application select **File->Settings** from the top application menu.
37
38 |=(% colspan="2" %)(% colspan="2" %)
39 (((
40 General
41 )))
42 |=(((
43 iSymphony Server:
44 )))|(((
45 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.
46
47 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.
48 )))
49 |=(((
50 Global Hotkey:
51 )))|(((
52 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.
53 )))
54 |=(% colspan="2" %)(% colspan="2" %)
55 (((
56 CRM Integration
57 )))
58 |=(((
59 Predefined:
60 )))|(((
61 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.
62 )))
63 |=(% colspan="1" %)(% colspan="1" %)
64 (((
65 Custom
66 )))|(% colspan="1" %)(% colspan="1" %)
67 (((
68 This section allows you to specify a custom configuration for the CRM application popup.
69
70 **Application Path: **The path to the executable used for the popup.
71
72 **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.
73 )))
74
75 = Application Popups =
76
77 One of the major advantages of the Desktop Client Application is that you can now popup application based CRMs, just like web based CRMs.
78
79 1. Add a CRM Widget to your dashboard like you normally would for web based CRMs. See [[doc:CRM Widget]].
80 1. Set the **Type** to **Application.**
81 1. Open the settings for the Desktop Client Application and choose a Predefined CRM configuration, or set up a Custom Configuration. See Settings above.
82
83 = Clear Settings =
84
85 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.
86
87 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.
88
89 {{note}}
90 Do not delete or rename this file while the Desktop Client Application is running.
91 {{/note}}
92
93 == (% style="color: rgb(0,0,0);" %)Windows(%%) ==
94
95 {{code}}
96 C:\Users\<username>\AppData\Roaming\iSymphony\iSymphony.json
97 {{/code}}
98
99 == OS X ==
100
101 {{code}}
102 /Users/<username>/Library/Application Support/iSymphony.json
103 {{/code}}
104
105 == Linux ==
106
107 {{code}}
108 /home/<username>/iSymphony/iSymphony.json
109 {{/code}}
110 {{/layout-cell}}
111 {{/layout-section}}
112 {{/layout}}