Wiki source code of Desktop Client Installation v2.0.0
Last modified by Scott Gagan on 2024/03/12 15:48
Show last authors
author | version | line-number | content |
---|---|---|---|
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 | |||
14 | {{toc/}} | ||
15 | |||
16 | {{layout-section ac:type="single"}} | ||
17 | {{layout-cell}} | ||
18 | = (% style="color:#000000; font-size:24px; line-height:24px" %)1. Download The Desktop Client Installer(%%) = | ||
19 | |||
20 | ((( | ||
21 | There are two methods to download the Desktop Client installer. Both methods will download the appropriate installer for your host OS. | ||
22 | ))) | ||
23 | |||
24 | == Download From The Client Web Interface == | ||
25 | |||
26 | 1. Log into the iSymphony Client Interface. See [[doc:Connecting To The Client Interface]]. | ||
27 | 1. Open the user menu in the top right hand corner of the Client Interface. | ||
28 | 1. Select **Desktop Client**. | ||
29 | 1. Copy the URL that is specified in the dialog that is opened. We will need this URL later. | ||
30 | 1. Select **Download Desktop Client**. | ||
31 | |||
32 | {{note}} | ||
33 | Some browsers may flag the download as un-trusted and show a warning. Simply ignore the warnings and proceed with the download. | ||
34 | {{/note}} | ||
35 | |||
36 | == Download Directly From The URL == | ||
37 | |||
38 | You can enter the following URL in your browser to download the Desktop Client installer: | ||
39 | |||
40 | {{code}} | ||
41 | http://<ip or hostname of your iSymphony server>:58080/client/desktop/client | ||
42 | {{/code}} | ||
43 | |||
44 | = (% style="color:#000000" %)2. Install The Desktop Client(%%) = | ||
45 | |||
46 | (% style="color:#000000" %)The installation method will vary depending on the OS you are installing on. | ||
47 | |||
48 | == (% style="color:#000000" %)Windows(%%) == | ||
49 | |||
50 | (% style="color:#000000" %)To execute the installer on Windows simply double click the downloaded installer package, and the installation process will commence. | ||
51 | |||
52 | (% style="color:#000000" %)Alternatively the installer can be called from the command line with the following options: | ||
53 | |||
54 | * (% style="color:#000000" %)/S - makes the installer silent | ||
55 | * (% style="color:#000000" %)/AllUsers - Installs the desktop client for all users (administration privileges required) | ||
56 | |||
57 | * | ||
58 | ** (% style="color:#000000" %)Default install directory is program files | ||
59 | * (% style="color:#000000" %)/CurrentUser - Installs the desktop client for the current user only (default is CurrentUser) | ||
60 | |||
61 | * | ||
62 | ** (% style="color:#000000" %)Default install directory is ~~/AppData | ||
63 | * (% style="color:#000000" %)/D=<directory name> - forces the desktop client to be installed into a certain directory (__this needs to be the last option!__) | ||
64 | ** (% style="color:#000000" %)Default directory for depends on the install mode (AllUsers or CurrentUser) | ||
65 | |||
66 | (% style="color:#000000" %)For example: | ||
67 | |||
68 | {{code}} | ||
69 | iSymphonyDesktopSetup.exe /S /AllUsers /D=C:\foo\bar\isymdesktop | ||
70 | {{/code}} | ||
71 | |||
72 | |||
73 | |||
74 | == (% style="color:#000000" %)OS X(%%) == | ||
75 | |||
76 | 1. (% style="color:#000000" %)Mount the downloaded dmg file by double clicking on it. | ||
77 | |||
78 | 1. (% style="color:#000000" %)Once mounted copy the iSymphony file to your Applications directory.(%%) | ||
79 | 1. Unmount the dmg. | ||
80 | |||
81 | == Linux == | ||
82 | |||
83 | 1. ((( | ||
84 | Extract the desktop client: | ||
85 | |||
86 | {{code}} | ||
87 | tar xvf isymphony_desktop_client_2_0_0.tar.gz -C installation_location | ||
88 | {{/code}} | ||
89 | ))) | ||
90 | 1. ((( | ||
91 | Run the program: | ||
92 | |||
93 | {{code language="bash"}} | ||
94 | ./installation_location/isymphonydesktop | ||
95 | {{/code}} | ||
96 | ))) | ||
97 | |||
98 | = Uninstalling The Desktop Client = | ||
99 | |||
100 | The uninstall procedure differs for each OS. | ||
101 | |||
102 | == (% style="color:#000000" %)Windows(%%) == | ||
103 | |||
104 | 1. Open your **Start Menu** and navigate to **Control Panel->Programs and Features**. | ||
105 | 1. Right click on **iSymphony** and select **uninstall**. | ||
106 | |||
107 | == OS X == | ||
108 | |||
109 | Simply delete the** iSymphony.app** file from your Applications directory. | ||
110 | |||
111 | == Linux == | ||
112 | |||
113 | Delete the directory the .tar.gz was extracted to. | ||
114 | |||
115 | = Using The Desktop Client Application = | ||
116 | |||
117 | For information on how to use the Desktop Client Application see [[doc:Desktop Client]]. | ||
118 | |||
119 | |||
120 | |||
121 | {{/layout-cell}} | ||
122 | {{/layout-section}} | ||
123 | {{/layout-section}} | ||
124 | {{/layout}} |