SMS installation manual

V3.032ALL RIGHTS RESERVED

SMS installation manual2

© 2011 ICARE Ltd

Table of Contents

Part I Introduction 3

Part II Quick installation (Demo version) 4

Part III Server 6

................................................................................................................................... 61 Firebird

................................................................................................................................... 62 Server & Manager

................................................................................................................................... 73 Manager settings

Part IV Clients 8

Part V Installing updates 9

Part VI TIPS 10

Part VII Error messages 11

3

© 2011 ICARE Ltd

1 IntroductioniCare SMS is a Client/Server application. It includes 4 components:

The installation procedure consists in the installation of- Firebird SQL (on the server computer)- Server & Manager (on the server computer)- Clients (on each end-user's computer)

Note 1: In case of a demonstration version, all 4 components should be installed on the samecomputer

Note 2: It is recommended to install the SMS client also on the server computer (it will be used fromtime to time to upgrade the database and to execute the installation wizard)

Note 3: Once installed, iCare SMS will install its upgrades on the server (on request) andautomatically dispatch the latest releases to the clients.

4 SMS installation manual

© 2011 ICARE Ltd

2 Quick installation (Demo version)The following is a simplified installation procedure applicable to the demonstration version. In case oftrouble using this procedure, refer to the fully documented section.The files which are referenced by the following procedure can be downloaded from www.i-care-sms.com (select the "save target" option when you start a download, then execute the downloaded file)

Firebird installation:1/ Execute the installation setup of Firebird (32 or 64 bits as applicable)2/ Follow the on screen instructions and choose the following installation options:

- Mode: Classic super server- Use the Guardian- Install as a service- Copy the Firebird client library to the <system> directory (all options checked)

5

© 2011 ICARE Ltd

SMS Server (on the same computer):1/ Execute the installation setup file <SMS_Server_setup.exe> and follow the on-screen instructions

Choose <C:\SMS\> as the installation directory2/ Execute iCare SMS Server (Windows start menu -> programs -> SMS -> SMS Server)

- If a message from your firewall is raised (usually from the Windows firewall), then authorize thecommunication

- If no message is raised (perhaps you are not using a firewall), check that the Windows firewallis disabled or the program <SMS_Srvr.exe> is set as an exemption.

Note: The server's function is to respond to the SMS Clients. It has no menu or button to interactwith the user but only displays a window to show that it is running.

Note: There is no need to execute the SMS Manager with a demonstration version

SMS Client (on the same computer):1/ Execute the installation setup file <SMS_Client_setup.exe> and follow the on-screen instructions

Choose <C:\SMS\> as the installation directory2/ Execute iCare SMS Server (Windows start menu -> programs -> SMS -> SMS Server) 3/ Execute iCare SMS Client (Click on the SMS shortcut placed on your desktop or Windows start

menu -> programs -> SMS -> SMS Client)- An installation wizard is displayed: follow the instructions to check and finalize the installation.- Click the "Connection details" button of the connection window and check the followingparameters:

- TYPE = TCP- SERVER = 127.0.0.1:217- DATABASE = EXAMPLE- DB PASSWORD is void- LOGO SET = 0

- Click on the "CONNECT" button

6 SMS installation manual

© 2011 ICARE Ltd

3 Server

3.1 Firebird

1/ Execute the installation setup of FirebirdNote: Use the installation file applicable to your system (32 or 64 bits)

2/ Follow the on screen instructions and choose the following installation options:- Mode: Classic super server- Use the Guardian- Install as a service- Copy the Firebird client library to the <system> directory (all options checked)

Note: See the Firebird setup screenshots in the Quick Installation section

3.2 Server & Manager

WARNING: If you are re-installing iCare SMS, make sure that you have a backup copy of yourdatabase.

1/ Execute the installation setup file <SMS_Server_setup.exe> and follow the on-screen instructionsNote: The choice of the installation directory is important. It is recommended to use a dedicateddirectory as proposed by the installation program (DO NOT choose <C:\Program files\ as theinstallation directory, <C:\SMS\> is recommended). This installation directory must beaccessible (with read and write permission) to the interactive user (the user currently logged onthe computer). The installation directory shall NOT be shared over the network.Note: If the installation directory was set in the <C:\Program files\> folder (not recommended), theSMS Manager (Manager.exe) will raise an error and stop working. Even if this installationdirectory is not recommended, you can solve this problem by running the Manager with anadministrator privilege (right click on Manager.exe -> Execute as administrator)

2/ Execute the SMS Server (Windows start menu -> programs -> SMS -> SMS Server) using anadministrator account (the first time only)- If a message from your firewall is raised (usually from the Windows firewall), then authorize the

communication - If no message is raised (perhaps you are not using a firewall), check that the Windows firewall

is disabled or the program <SMS_Srvr.exe> is set as an exemption.

3/ Install a first client on the same computer (the server computer) as per the procedure exposed inthe next chapter.

OPTIONAL SETTINGS

1/ When using the Server in application mode (default), it is important to start the Server and theManager automatically at the IPL (initial boot) by adding a connection script on the server or byusing shortcuts to SMS Server & Manager in the startup menu. By default, the installation programcreates the shortcuts in the target system "startup" directory.

7

© 2011 ICARE Ltd

2/ To install the Server and the Manager as a service, refer to the installation supplement manual<install-as-service>

3/ By default, the server is waiting for client connections (listening) on port 217. This setting can bechanged by editing the file <config-srvr.ini> which is located in the server installation directory (theserver needs to be restarted if this setting is changed). If this setting is modified, it is also required toset the manager to connect to the newly assigned port by editing the file <"serverdirectory"\Manager\config-mgr.ini>

4/ When the server in installed as per the above procedure, it is accessible to all clients located onyour local network (LAN). To use iCare SMS worldwide with an internet connection, a port needs tobe opened on your router (refer to the TIPS section of this manual)

3.3 Manager settings

The SMS Manager is executed on the same computer that the SMS Server. Its role is to provideregular services including:- The automatic hot backups- Database maintenance service- Calculation of alerts & e-mail services

To activate the SMS Manager's services, it is necessary to define on which databases theservices should be executed:- Select the "DATABASE" tab- The list of databases is displayed on the left side. Click the "Add" button and specify the name of

the database to be added (by default "DATA").- Define the hour when the services should start (usually over night)- Let the "IPL" check box unchecked (to be checked only upon request from the customer support)- Check the box "Backup of databases ..." and define the folder where the backup files should be

written (see note 1)- Check the box "Calculation of alerts"- Validate the changes

Note 1: Several technical points are to be considered when setting the backup directory:- This directory must be located on a different physical drive than the database (otherwise both the

database and the backups will be lost in case of a hardware failure)- By default, the ACL accounts used to backup the database are: the "system" account and the

"interactive user" account (to backup the attached documents located in the \doc\ sub-directory). These two accounts must have a read and write permission granted on the backupdestination folder.

Check the Firebird installation, one time after installation, as follows:- Select the "UTILITIES" tab- Click on the button "check Firebird installation"Note: this checking is also performed by the Client, if an iCare SMS client is installed on the server

computer. If you encounter some problems checking the Firebird installation, execute the SMSClient on the server computer and run the installation wizard (it will give more information aboutthe problem and the way to solve it)

Check that you are using the latest release (if this is your first use of iCare SMS):- Select the "UTILITIES" tab

8 SMS installation manual

© 2011 ICARE Ltd

- Click on the button "Check for latest releases"

4 Clients1/ Execute the installation setup file <SMS_Client_setup.exe> and follow the on-screen instructions

Note: The choice of the installation directory is important. It is recommended to use a dedicateddirectory as proposed by the installation program. For the automatic update functions to workproperly, the interactive user (the logged user) must have a read / write privilege on this directory(which is usually not the case of the <program files> directory).

2/ Make sure the Server is running on the server computer

3/ Execute the ClientIf this is your first connection, the installation wizard will check that all components are runningand are ready to connect.- If you are installing a client on a remote computer (not the same computer as the server) thenclose this wizard and connect normally (specify the connection details for the first connection asexplained below - Optional settings\ 3\).- If you are installing a client on the server computer, then run the entire wizard and follow the on-screen instructions.

See also: Checking and installing the latest release

OPTIONAL SETTINGS

1/ To set the logo of your company (as displayed on the various reports), copy it in the directory<"Client directory"\Logo\>. The files must be named <OwnerLogoX.bmp> and <DefReportX.bmp>where X is an integer value. Several logo sets can be used (represented by the X value) and theactive logo set will be specified upon client connection (<Logo set> field displayed in the connectionoptions). These two files must be in the Bitmap format and not exceed 250 x 150 pixels.

2/ To register your copy of iCare SMS, place the licence file in the client installation directory andrestart the client.

3/ The "connection details" button is used to specify the server location and the connection options.SERVER: <SERVER NAME> or <IP ADDRESS><:PORT>

Example: "WST-SMS:217" or "192.168.11.08:217"TYPE: <TCP> or <HTTP>

Use TCP (HTTP is provided for specific use)DATABASE: The name of the database to connect to

Default = "DATA"DB PASSWORD: the database password

Default = <void>LOGO SET: <integer value>

Defines the company logo (see item 1)

9

© 2011 ICARE Ltd

5 Installing updatesiCare SMS has a single point administration to download the latest release and dispatch it

automatically to all installed Clients:

1/ Execute the SMS Manager, select the "Utilities" tab and click on the button "Check for latestreleases".If a newest release is available thena- Close the Manager and the Server (but let the updater opened)b- Accept the upgradec- Wait until the release is downloaded and installed

2/ Execute the Server and the Manager

3/ Execute a Client to upgrade the database structure:a- Always make a backup copy of your database before upgrading its structureb- Execute a Client normally and try to log in. A message prompts to automatically upgrade theClient - accept. c- Execute a Client and click on the connection options (the bulb button of the logon window),

then click on the button "upgrade the database" Note: This function increments the database to the next available structure (DDL). If you are

applying several upgrades (ex: from V3.025 to V3.029) then execute the "upgrade database"function several times until the database structure match the upgrade version (as displayed onthe logon window).

All clients will be upgraded automatically (they will receive the same message than in 3.b above)

Note: if you are using several databases, repeat step 3 above for each database.

10 SMS installation manual

© 2011 ICARE Ltd

6 TIPSWhat is my external IP Address ?

If your are connecting from a computer which is not actually logged on your local network (LAN), theconnection string to use in the "Server" field of the "Connection details" cannot be a local IP (like192.168.xxx.xxx) or a local server name (like WST-SMS). This field must be set to match theexternal IP address of your LAN (followed by ":"<port number>).You can determine your external IP address by using a dedicated web site (ex: http://www.whatismyip.com) or by checking the WAN status of your router. To use this external IP address asa connection string with i-Care SMS (followed by ":"<port number>), your router must be configuredto route the external calls to your Server (see below).

Configure my router for remote access

Each router has a different interface. The user manual of your router usually include a section named"port forwarding". Depending on your router model, the procedure can be found at http://portforward.com/english/routers/port_forwarding/With the default tcp settings (listening on port 217), your router must be configured to route allincoming traffic on port 217 to the server (same port)Example:- your external IP address is 215.15.124.12- your Server is installed on a computer using the following local IP address: 192.168.10.18 and is

listening on port 217- Configure your router to forward all incoming traffic on port 217 to 192.168.10.18:217- Your connection string to connect to iCare SMS from the Internet is now: 215.15.124.12:217

The above procedure assumes that your external IP address is fixed (that your ISP (Internet ServiceProvider) does not change this address from time to time). If not, then you need to use a dynamicDNS service (www.dyndns.com) to associate a name (fixed) with an IP address (changing). Once aDynDNS domain has been defined, your connection string will look like: "mycompany.dyndns.com:217".

11

© 2011 ICARE Ltd

7 Error messages

# Message Reason / Solution

10 Unable to connect to the TCP server:Socket Error #11001Host not found.

This message means the client cannot establish aconnection to the server computer. Possible causes:- The Server address or connection type specified inthe connection details are wrong. To confirm theerror, try the same connection string using theWindows explorer (remove the port number and startwith "\\")- Your network might be temporally unavailable- A firewall (on the client or on the server side) isactivated

20 Unable to connect to the TCP server:Socket Error #10060Connection timed out

- This error can be raised by the same causes thanabove- Check that iCare Server is running

30 Unsupported on disk structure for file......\DATA.FDB; found XX.X, support XX.XError Class: TDBXError

The firebird version currently installed on the server isnot compatible with the database structure. Uninstallfirebird and re-install the recommended version

40 Windows socket error: an establishedconnection has been canceled (10053),with the API 'recv'

The connection you are trying to use has beencanceled by the server due to a long inactivity or theserver has been rebooted since your initialconnection. Close the client and re-connect.

50 Your user name and password are notdefined. Ask your database administratorto set up a Firebird login

Firebird is installed but the login accounts are notdefined. Execute the Manager and run the Firebirdinstallation checker on the server ("Utilities" tab)

60 File not found 'fbclient.dll' The option "copy client library to <system>directory" was probably unchecked when installingFirebird. Copy the file fbclient.dll from the firebirdinstallation directory to your <system> directory

iCare

SMS