09-SapphireOne Client Settings & Procedures

SapphireOne Client Settings & Procedures Application Overview

The SapphireOne Client Settings & Procedures Update Reference Guide is designed for SapphireOne users as a step by step guide to be followed when installing or upgrading the 4D Client application.

This Client application operates in conjunction with SapphireOne’s Server application without the requirement for the operating platform to have Client Server capabilities. It may be set up and operate on any Mac or Windows based computer, provided the computer has the required specifications.

SapphireOne’s Client application is designed to communicate directly with SapphireOne’s Server application. This Client application should be installed in the same location on the hard drive on either a Mac or Windows OS as SapphireOne’s server application. It is installed as a stand alone application on MacOS. For Windows OS it is also installed as a standalone application. It is not installed into the registry for the Windows OS.

For SapphireOne’s Client application there are two version numbers, they are both 4D and SapphireOne’s, so from 18.4.0.1 we extract the following.

  • 4D Version numbers – These the the first two numbers. I.e. 18.4
  • SapphireOne Version Numbers – The last two numbers. I.e. 0.1

Downloading Files from SapphireOne’s File Station

Please note that we have closed our ftp server and replaced it with SapphireOne’s File Station.

The Client application is platform dependent so the user will select the Mac or Windows version for download as required. Sometimes the exact version numbers are different but there will only be two files in the Client folder on the SapphireOne’s File Station. One for a Mac and another for Windows based platforms. The two listed below were the current files at the time of writing this article and are a good example as the version numbers are indeed different.

  • MacOS File – 18.4.0.30MacClient.zip which will unpack to SapphireOne 18.4.0.30 Client.app
  • Windows File – 18.4.0.0WinClient.zip which will unpack to SapphireOne 18.4.0.0 Client

Note carefully the unpacked folders for a Mac and Windows. The only difference is that the Mac folder has .app at the end of the folder name. The user will have to right click on the folder, and select Show Contents from the mouse right click options to view the contents of the folder.


Preparation

Files may now be downloaded from SapphireOne by using a web browser. Documentation for this procedure my be found on the SapphireOne Knowledge Base by going to our article on the SapphireOne File Station.

Each of our Clients has access to an individual Client folder, where they, and they only, may upload or download backup copies of their data files to these folders. There is also a common area where all files in the common Download folder may be downloaded, but no uploads are allowed. This is where the files in this article are stored in SapphireOne’s File Station.

For example the 4D Server Application, 4D Client application and SapphireOne builds, are all in separate folders for your convenience. Select and download the required files before starting the upgrade procedure documented from here on in this article.

The client application will have to be installed initially on each and every workstation when the SapphireOne server is started for the first time. From then on, the user will only have to install the client application on any new workstations that are to be used to access the SapphireOne database. Existing workstations, when they access the server with a 4D upgrade on it will perform an automatic upgrade.

For each platform the file size of the 4D Client application is between 100 and 150Mb.

The SapphireOne Client application MUST be run locally on each workstation and never from a shared/network drive. The SapphireOne Client application stores information in the folders that are below where the application is executed from and as such MUST have full and sole control of all subfolders.

As the Client application is platform dependent, each file as it is downloaded and unpacked will only have a single folder containing all required files for the installation.

The installation file once downloaded will unpack to a single folder with all files required contained inside that folder. Installation involves just the copying of that folder and its contents into a single location on the workstation.

Several decisions will have to be made before downloading SapphireOne’s Client application as follows.

  • Where on the workstation should SapphireOne’s Client application be placed.
    SapphireOne recommends the following locations for a Mac or Windows.
    • MacOSX – Create a folder named SapphireOne in the Applications Folder.
    • Windows – Create a folder named SapphireOne in the Program Files folder
  • When the unpacked folder is dropped into the SapphireOne folder the result should be as seen in the screen shot below. Both Mac and Windows folders a displayed together below.
SapphireOne Client Main FoldersMacWin-09-ClientSettings

While SapphireOne’s Client folder may be executed from any location on a workstation’s hard drive, we strongly recommend that the folder is installed as in the screen shot above.


Installation

For the Initial installation process the user has two choices.

  • Single Workstation – Download it from SapphireOne’s File Station to each workstation then copy SapphireOne’s Client folder into the required location on the local workstation’s hard Drive.
  • Multiple Workstations – Do as above for the first Workstation, then copy SapphireOne’s Client folder to a USB drive.
    • USB Drive – Go to each workstation and copy SapphireOne’s Client Folder from the USB Drive to all workstations that are required to have SapphireOne’s Client application installed on them.
  • Shortcuts- When initially installing SapphireOne’s Client Application onto any workstation, shortcuts should be created.
    • MacOS – Select the SapphireOne 18.4.0.0 Client.app folder, right click and select the Make Alias option.
    • Windows – in the SapphireOne 18.4.0.30 Client folder, and find the .exe executable. Then right mouse click and select the create shortcut option from the right click context menu.

However, once this initial installation has been completed, any future upgrades to the client application will be done automatically. The client application will, each time it connects to the server, check to see if it is current against what is on the server, and if not it will automatically perform the upgrade.

Since SapphireOne’s Client application executable file will remain in the same place, shortcuts will still operate as normal and will not have to be established again. There will also be a short delay while the upgrade is being processed by the local workstation and the SapphireOne Sever.


You can review our Blog and YouTube channel for additional information and resources on SapphireOne ERP, CRM and Business Accounting software.

Was this helpful?