Skip to Content

Wiki source code of Desktop Client Installation

Version 6.1 by ryanp 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 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.
7
8 {{note}}
9 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.
10 {{/note}}
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 = (% style="color: rgb(0, 0, 0); font-size: 24px; line-height: 24px" %)1. Download The Desktop Client Installer(%%) =
25
26 (((
27 There are two methods to download the Desktop Client installer. Both methods will download the appropriate installer for your host OS.
28 )))
29
30 == Download From The Client Web Interface ==
31
32 1. Log into the iSymphony Client Interface. See [[doc:Connecting To The Client Interface]].
33 1. Open the user menu in the top right hand corner of the Client Interface.
34 1. Select **Desktop Client**.
35 1. Copy the URL that is specified in the dialog that is opened. We will need this URL later.
36 1. Select **Download Desktop Client**.
37
38 {{note}}
39 Some browsers may flag the download as un-trusted and show a warning. Simply ignore the warnings and proceed with the download.
40 {{/note}}
41
42 == Download Directly From The URL ==
43
44 You can enter the following URL in your browser to download the Desktop Client installer:
45
46 {{code}}
47 http://<ip or hostname of your iSymphony server>:58080/client/desktop/client
48 {{/code}}
49
50 (% style="color: rgb(0,0,0);" %)If you are on a legacy version (version < 2.0.0) of the desktop module use the following URL instead:
51
52 (% style="color: rgb(0,0,0);" %)
53
54 {{code}}
55 http://<ip or hostname of your iSymphony server>:58080/client/desktop
56 {{/code}}
57
58 (% style="color: rgb(0,0,0);" %)
59
60
61 = (% style="color: rgb(0,0,0);" %)2. Install The Desktop Client(%%) =
62
63 (% style="color: rgb(0,0,0);" %)The installation method will vary depending on the OS you are installing on.
64
65 == (% style="color: rgb(0,0,0);" %)Windows(%%) ==
66
67 (% 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.
68
69 {{note}}
70 If you are installing a legacy version (version < 2.0.0) Windows will open a warning mentioning that the installer is un-trusted. You can ignore this warning and proceed with the download.
71 {{/note}}
72
73 {{note}}
74 The installer will not provide a notification that the installation was complete. The installer will simply exit when completed.
75 {{/note}}
76
77 == (% style="color: rgb(0,0,0);" %)OS X(%%) ==
78
79 1. (% style="color: rgb(0,0,0);" %)Mount the downloaded dmg file by double clicking on it.
80
81 1. (% style="color: rgb(0,0,0);" %)Once mounted copy the iSymphony file to your Applications directory.(%%)
82 1. Unmount the dmg.
83
84 == Linux ==
85
86 1. (((
87 Extract the installer files:
88
89 {{code}}
90 tar xfv isymphony_desktop_client_2_0_0.tar.gz -C directory_to_extract_to
91 {{/code}}
92 )))
93 1. (((
94 Run the executable to start the client:
95
96 {{code}}
97 cd iSymphonyDesktop-2.0.0
98 ./isymphonydesktop
99 {{/code}}
100 )))
101
102 For Legacy Versions of the desktop client (version < 2.0.0):
103
104 1. (((
105 Make the installer executable:
106
107 {{code language="bash"}}
108 chmod +x isymphony_install_<version>.bsx
109 {{/code}}
110 )))
111 1. (((
112 Run the installer:
113
114 {{code language="bash"}}
115 ./isymphony_install_<version>.bsx
116 {{/code}}
117 )))
118
119 = Uninstalling The Desktop Client =
120
121 The uninstall procedure differs for each OS.
122
123 == (% style="color: rgb(0,0,0);" %)Windows(%%) ==
124
125 1. Open your **Start Menu** and navigate to **Control Panel->Programs and Features**.
126 1. Right click on **iSymphony** and select **uninstall**.
127
128 == OS X ==
129
130 Simply delete the** iSymphony.app** file from your Applications directory.
131
132 == Linux ==
133
134 Delete the directory the .tar.gz was extracted to.
135
136 For Legacy Versions: Delete the following directory and files:
137
138 {{code language="bash"}}
139 /home/<username>/iSymphony
140 /home/<username>/.local/share/applications/iSymphony.desktop
141 /home/<username>/.local/share/applications/iSymphony-app.desktop
142 {{/code}}
143
144 = Using The Desktop Client Application =
145
146 For information on how to use the Desktop Client Application see [[doc:Desktop Client]].
147
148
149
150
151 {{/layout-cell}}
152 {{/layout-section}}
153 {{/layout}}