NewWayService 4 Installation Guide

Transcription

1 Installation Guide Copyright OroLogic Inc. Revision 4.01

2 Contents I Contents Installation Guide 3 Introduction 3 Installing 3 Installing NewWayService in stand-alone mode 4 Installing NewWayService in multi-user mode 5 Installing NewWayService in multi-user mode with a Windows server 5 Installing NewWayService in multi-user mode with a Linux server or other Unix platforms 9 Installing NewWayService in multi-user mode with a server on other platforms 14 Migrating NewWayService 3 to 15 How to proceed 15 Data transfer utility 15 When to proceed? 16 Transferring reports 17 Migrating NewWayService 2 to 18 How to proceed 18 Data transfer utility 18 When to proceed? 19 Notes about importing reports from NewWayService 2 to 19 Starting NewWayService 21 web version 22 Installing the web service of 22 The Windows service of 25 Installing the NewWayService service 25 Connections manager 28 Some information about connection parameters 28 Saving connection parameters in a file 29 Centralizing connection parameters in a file 29 Working with several databases 29 Creating a database identical to your current one 29 Creating an empty database 29 Licensing 31 Number of licenses required 31 Adding licenses into NewWayService 31 License assignation 31 Backing up the database 33 Backing up the database using the Backup option from the Utilities menu 33 Backing up the database using the database utility 33 Backing up the database using the FIREBIRD GBAK utility 34 Restoring the database using the database utility 36 Restoring the database using the FIREBIRD GBAK utility 37 Technical support 39 Support via our web site : 39 Online support request: 39

3 Contents II Error messages: 39 Copyright 40 40

4 Installation Guide 3 Installation Guide Introduction This installation guide explains how to install in stand-alone mode as well as in multi-user mode. In stand-alone mode, the NewWayService program as well as the NewWayService database are located on the same computer. This mode is perfect when used by a single user on a single computer or to evaluate the software. In multi-user mode, the NewWayService program is installed on several computers (client computers) while the database is installed on a remote server. So, several users can access the centralized database simultaneously. If you are currently using version 3 of NewWayService, refer to the section Migrating from NewWayService 3 to first. If you are currently using version 2 of NewWayService, refer to the section Migrating from NewWayService 2 to first. Installing The following section explains how to install NewWayService starting from the compressed file previously downloaded. If you don t have NewWayService yet, you can download it from our web site at You must first install the software in order to use it. We recommend that you follow all steps below in order to ensure that the software will properly work on your computer. can be installed on Windows 2000, Windows 2003, Windows XP, Windows Vista, Windows 2008 or Windows 7 operating systems. The minimum requirement to run is a computer IBM compatible with a 1 Ghz processor with a minimum of 256Mb of RAM. 300 Mb of free disk space is also required. NewWayService is using the FIREBIRD database to keep its data. FIREBIRD is a robust Open Source relational database and is completely free. Visit the official FIREBIRD web site at for more information about FIREBIRD. Note that in multi-user mode, the FIREBIRD database can be installed on a Windows platform as well as a Linux platform. FIREBIRD is also available on other platforms such as MacOs X and several Unix flavors. Visit the FIREBIRD web site for more details. NewWayService can be used on a single computer (in stand-alone mode) or in network mode (in multi-user mode) in order to allow several users to access the same NewWayService data simultaneously. Note that NewWayService was specifically developed to be used in multi-user mode. To install NewWayService on a single computer, refer to the section Installing NewWayService in stand-alone mode. To install NewWayService in network environment, refer to the section Installing NewWayService in multiuser mode.

5 Installation Guide 4 Installing NewWayService in stand-alone mode If you want to install NewWayService and use it in stand-alone mode, follow the steps below. Note that installing NewWayService in stand-alone mode is perfect to evaluate the software or use it from a single computer. Note that later, if needed, you will be able to reinstall NewWayService in multi-user mode without any problem. Note that when installing NewWayService under Windows, you must be connected with the Administrator user or a user that has the same rights so that the installation can run without any problem. Double-click on the file previously downloaded to start the installation. Once the installation is started, click Next. The installation program displays the license agreement of the product. You must accept the license agreement by clicking the radio button I agree with all these terms and click Next to continue with the installation. At next step, select the option Installation in stand-alone mode then click Next to continue. Then, you have to choose where NewWayService will be installed. We recommend you to install NewWayService in the suggested default installation folder C:\Program Files\OroLogic\NewWayService4. However, if you decide to install NewWayService in another folder than the suggested one, change it using the Browse button. Click Next to continue. Now, select the group of programs where icons will be installed. We recommend you to install icons in the suggested group of programs. Choose the group of programs or let the suggested one then click Next. The installation program is now ready to copy files on your computer. Answer Yes to the confirmation to start file copy.

6 Installation Guide 5 When all files are copied, the installation program asks you if you want a shortcut on your desktop. Answer to the question by clicking Yes or No. The installation program ends by displaying Installation successful. Click OK to finish. When the installation is over, you are ready to use the software. NewWayService for more information. Refer to the section Starting Installing NewWayService in multi-user mode Note that for this part of the installation, a qualified computer/network technician is recommended. If you want that several computers access simultaneously the same NewWayService database, the database must be located on a computer that will act as the database server. NewWayService uses the FIREBIRD database engine (note that the Windows version of FIREBIRD is already included with NewWayService). It s not obligatory to have a dedicated server for FIREBIRD. FIREBIRD can be installed on your current server or if you don t have one, the computer of one of your users can act as the server and at the same time be used by this user. However, note that if you expect to have several users or a lot of data, installing FIREBIRD on a dedicated server is recommended for better performances. Whereas must obligatory be executed on a Windows platform (Win32), the FIREBIRD database engine can be installed on several different platforms such as Windows, Linux and several other ones. Note that FIREBIRD supports the TCP/IP protocol for all these platforms. NewWayService can run in a Local Area Network (LAN) as well as in Wide Area Network (WAN / INTERNET). However, note that since NewWayService is a client/server software, when using NewWayService, a lot of data can be transferred on your network between the NewWayService program and the FIREBIRD database. So, if you expect to use NewWayService on a WAN and/or INTERNET, be sure that you have a fast enough communication link so that NewWayService can run at an acceptable speed. Note that a web version (that can be used by technicians to consult and print work orders or enter actions or used by customers to enter a work order or consult the status of them) is also available and included with. Refer to the section web version for more information. Note that some solutions available on the market allow users to run client/server software (such as ) on a WAN or Internet with a low speed link. For example, you could use solutions such as Windows 2000/2003/2008 Terminal Service, Citrix, etc. or other kind of software such as Symantec pcanywhere or VNC. Ask you computer equipment supplier for more information about these solutions. To install NewWayService in multi-user mode with a Windows server, refer to the section Installing NewWayService in multi-user mode with a Windows server. To install NewWayService in multi-user mode with a Linux server or other Unix platforms, refer to the section Installing NewWayService in multi-user mode with a Linux server or other Unix platforms. To install NewWayService in multi-user mode with a server on other platforms such as MacOS X, refer to the section Installing NewWayService in multi-user mode with a server on other platforms. Installing NewWayService in multi-user mode with a Windows server Here are the main steps to follow for installing NewWayService in multi-user mode with a Windows server: 1. Installation of NewWayService on the Windows server. 2. Installation and configuration of NewWayService on each client computer.

7 Installation Guide 6 1. Installation of NewWayService on a Windows server. Note that when installing NewWayService under Windows, you must be connected with the Administrator user or a user that has the same rights so that the installation can run without any problem. Double-click on the file previously downloaded to start the installation. Once the installation is started, click Next. The installation program displays the license agreement of the product. You must accept the license agreement by clicking the radio button I agree with all these terms and click Next to continue with the installation. At the next step, select the option Installation in multi-user mode, then, select the sub-option SERVER part: This computer will act as the server. The NewWayService database will be located on this computer then click Next to continue. Then, you have to choose where NewWayService will be installed. We recommend you to install NewWayService in the suggested default installation folder C:\Program Files\OroLogic\NewWayService4. However, if you decide to install NewWayService in another folder than the suggested one, change it using the Browse button. Click Next to continue. Now, select the group of programs where icons will be installed. We recommend you to install icons in the suggested group of programs. Choose the group of programs or let the suggested one then click Next. The installation program is now ready to copy files on your computer. Answer Yes to the confirmation to start file copy. When all files are copied, the installation program asks you if you want a shortcut on your desktop. Answer to the question by clicking Yes or No. After it, the installation program automatically starts the installation of FIREBIRD server (since the Windows version of FIREBIRD is already included with NewWayService). After the installation of FIREBIRD server, the installation program displays important information that you will have

8 Installation Guide 7 to enter when you will configure NewWayService on each client computer. We strongly recommend you to print these information. The installation program ends by displaying Installation successful. Click OK to finish. You can now install and configure NewWayService on each client computer. Follow instructions at the next step to do that. 2. Installing and configuring NewWayService on each client computer Note that when installing NewWayService under Windows, you must be connected with the Administrator user or a user that has the same rights so that the installation can run without any problem. Before using NewWayService in multi-user mode you must install NewWayService on each client computer that will need it. To do that, from the client computer on which you want to install NewWayService, doubleclick on the file previously downloaded to start the installation. Once the installation is started, click Next. The installation program displays the license agreement of the product. You must accept the license agreement by clicking the radio button I agree with all these terms and click Next to continue with the installation. At the next step, select the option Installation in multi-user mode, then, select the sub-option CLIENT part: This computer will access the NewWayService database that is located on a remote server then click Next to continue. Then, you have to choose where NewWayService will be installed. We recommend you to install NewWayService in the suggested default installation folder C:\Program Files\OroLogic\NewWayService4. However, if you decide to install NewWayService in another folder than the suggested one, change it using the Browse button. Click Next to continue. Now, select the group of programs where icons will be installed. We recommend you to install icons in the suggested group of programs. Choose the group of programs or let the

9 Installation Guide 8 suggested one then click Next. The installation program is now ready to copy files on your computer. Answer Yes to the confirmation to start file copy. When all files are copied, the installation program asks you if you want a shortcut on your desktop. Answer to the question by clicking Yes or No. After it, the installation program automatically starts the installation of FIREBIRD client (the client part of FIREBIRD is used to communicate with your server on which FIREBIRD server is installed). After the installation of FIREBIRD client, the installation program asks you if you want to configure the connection to the database now. Answer Yes to the question. You must enter parameters in different fields to indicate to NewWayService where is located the database. To enter these parameters, just use information that you printed when you installed NewWayService on your Windows server. After having entered connection parameters, click OK to continue. Then the installation program tests the connection to the NewWayService database using parameters you entered. If the test is successful, the installation program ends by displaying Installation successful. Click OK to finish. When the installation is over, you are ready to use the software. Refer to the section Starting NewWayService for more information. If the connection test fails, the installation program displays an error message then you can verify parameters that you entered. Note that if for any reason, you are not able to configure NewWayService properly (because the connection test always fails), just continue and finish the installation. Later, you will just have to run the connections manager then configure your connection to the database. You will not have to reinstall NewWayService. For more information about the connections manager, refer to the section Connections manager.

10 Installation Guide 9 Installing NewWayService in multi-user mode with a Linux server or other Unix platforms Note: Two different versions of FIREBIRD can be installed on a Linux or Unix server. The Classic Server version and the Super Server version. We recommend you to install the Super Server version because this version offers more functionalities. Visit the FIREBIRD web site for more information about differences between these two versions. Note also that on some Linux or Unix platforms, only one version or the other is available. Before installing FIREBIRD on your Linux or Unix server, we recommend you to take a look at Quick Start Guide for Firebird guide that contains useful information about installing FIREBIRD. This guide is available for download on the FIREBIRD web site at Here are the main steps to follow for installing NewWayService in multi-user mode and the FIREBIRD database on a Linux or Unix server: 1. Download of FIREBIRD for Linux or Unix from the FIREBIRD web site. 2. Installation of FIREBIRD server on the Linux or Unix server. 3. Transfer of the file nwsbtf.fbk on the Linux or Unix server. 4. Creation of the database file nws.fdb on the Linux or Unix server. 5. Installation and configuration of NewWayService on each client computer. 1. Download of FIREBIRD for Linux or Unix from the FIREBIRD web site Only the Windows version of FIREBIRD is included with NewWayService. So, it s for this reason that you must first, download the FIREBIRD version for Linux or Unix according to your platform. To download FIREBIRD for free, visit the FIREBIRD web site at then, access the Downloads section and download the version of FIREBIRD according to your platform. Note that you can also download FIREBIRD from the web site of IBPhoenix at Important notes: At the time this documentation was written, NewWayService was tested with the version of FIREBIRD. We recommend you to download and install a version 2.1.x of FIREBIRD (version or higher such as 2.1.2). Once you downloaded FIREBIRD, continue to the next step to install it on your server. 2. Installation of FIREBIRD server on the Linux or Unix server Since the FIREBIRD installation can differ according to your platform, refer to the documentation included with FIREBIRD to install it on your specific platform. Also, the help of a qualified person about Linux or Unix is indispensable for this part of the installation. Before continuing at the step 3, after the installation of FIREBIRD on Linux or Unix, be sure that FIRBIRD is running properly. When installing FIREBIRD on Linux or Unix, example databases are also installed. Connect to one of these database to check if FIREBIRD is running properly. Example of a connection test to FIREBIRD: Suppose that FIREBIRD is installed in the /opt/firebird folder on Linux or Unix and you want to access the employee.fdb database that is located in the examples folder of FIREBIRD, type the following command line under Linux or Unix (in one line) to connect to the database: /opt/firebird/bin/isql user sysdba password masterkey /opt/firebird/examples/employee.fdb

11 Installation Guide 10 Once you are connected, you can run a query on the employee table to display the technician list of this database by typing the following command: select * from employee; Type the following command to quit the ISQL utility: quit; As indicated above, you can also take a look at the Quick Start Guide for Firebird guide that contains useful information about how to verify if the server is properly running. For more information on FIREBIRD configuration and management utilities, refer to the FIREBIRD documentation. Important notes: Since FIREBIRD is derived from INTERBASE 6, if you already have INTERBASE installed on your Linux or Unix server, in that case, you will have to configure FIREBIRD so that it uses another port. In fact, both databases FIREBIRD and INTERBASE use the same port number to communicate (port TCP/3050) that can cause conflicts if both database engines are running simultaneously on the server. For example, to configure FIREBIRD so that it uses the port number 3051 instead of the port number 3050, from the FIREBIRD folder (for example /opt/firebird, edit the file firebird.conf then remove the # character before the line #RemoteServicePort = 3050 then change the port number from 3050 to Then, stop and restart FIREBIRD on the server. Original line : #RemoteServicePort = 3050 Modified line : RemoteServicePort = 3051 Note that if you change the port on which FIREBIRD communicate, do not forget to specify this new port number when you will configure the NewWayService connection on each client computer. For more information about FIREBIRD configuration, take a look at the documentation included with FIREBIRD. Once the installation of FIREBIRD is completed on Linux or Unix server, continue to the next step to transfer the NewWayService database on your server. 3. Transfer of the file nwsbtf.fbk on the Linux or Unix server The NewWayService database file is named nws.fdb and is included with NewWayService. However, since the FIREBIRD database format differ from a Windows platform vs. a Linux or Unix platform, and the file nws.fdb that is included by default with NewWayService is in the format of FIREBIRD for Windows, you cannot just copy this file on your Linux or Unix server. Instead, you must create your database file using the file nwsbtf.fbk (FIREBIRD transportable backup file format also included with NewWayService) as explained at the next step (Creation of the database file nws.fdb on the Linux or Unix server). However, before doing that, you must first transfer the file nwsbtf.fbk on your Linux or Unix server as indicated below. The following procedure explains how to transfer the file nwsbtf.fbk on your Linux or Unix server. However, if it is not already done, you must first install NewWayService on at least one computer to be able to access the file nwsbtf.fbk. So, install NewWayService on one of your computers and just select the option Installation in stand-alone mode. The file needed (nwsbtf.fbk) will be automatically copied in the installation folder. Later, you will just have to reinstall NewWayService on this computer then select the option Installation in multi-user mode as indicated at step 5. For more information

12 Installation Guide 11 about installing NewWayService in stand-alone mode, refer to the section Installing NewWayService in stand-alone mode. From the computer where you installed NewWayService, transfer the file nwsbtf.fbk using an FTP utility (Transfer method Binary) or any other transfer utility. The file nwsbtf.fbk is uncompressed by the installation program and located in the C:\Program Files\OroLogic\NewWayService4 folder. Before transferring your file, create a new folder on your Linux or Unix server where your file will be transferred and where the database file will be created. For example, you can create a folder named newwayservice4 in the /home folder of your server. Then transfer your file nwsbtf.fbk in the /home/newwayservice4 folder on your Linux or Unix server. 4. Creation of the database nws.fdb on the Linux or Unix server To create the database file on your Linux or Unix server, from this one, connect with the root user or any other user that have enough rights. Type the following command line (in one line) to create the database file (by supposing that FIREBIRD was installed in the /opt/firebird folder and the file nwsbtf.fbk was transferred in the /home/newwayservice4 folder) : /opt/firebird/bin/gbak rep user sysdba password masterkey /home/newwayservice4/nwsbtf.fbk /home/newwayservice4/nws.fdb masterkey is the default password of the FIREBIRD SYSDBA user. If you changed the password of the FIREBIRD SYSDBA user, just replace masterkey by this new password. Once this command has been executed, if no message is displayed, is it because the database was successfully created. Verify that the created file nws.fdb exists in the /home/newwayservice4 folder using the ls command. If you receive an error message, verify that you correctly entered the command line. The database creation is now completed. 5. Installation and configuration of NewWayService on each client computer Note that when installing NewWayService under Windows, you must be connected with the Administrator user or a user that has the same rights so that the installation can run without any problem. Before using NewWayService in multi-user mode you must install NewWayService on each client computer that will need it. To do that, from the client computer on which you want to install NewWayService, doubleclick. on the file previously downloaded to start the installation. Once the installation is started, click Next. The installation program displays the license agreement of the product. You must accept the license agreement by clicking the radio button I agree with all these terms and click Next to continue with the installation.

13 Installation Guide 12 At the next step, select the option Installation in multi-user mode, then, select the sub-option CLIENT part: This computer will access the NewWayService database that is located on a remote server then click Next to continue. Then, you have to choose where NewWayService will be installed. We recommend you to install NewWayService in the suggested default installation folder C:\Program Files\OroLogic\NewWayService4. However, if you decide to install NewWayService in another folder than the suggested one, change it using the Browse button. Click Next to continue. Now, select the group of programs where icons will be installed. We recommend you to install icons in the suggested group of programs. Choose the group of programs or let the suggested one then click Next. The installation program is now ready to copy files on your computer. Answer Yes to the confirmation to start file copy. When all files are copied, the installation program ask you if you want a shortcut on your desktop. Answer to the question by clicking Yes or No. After it, the installation program automatically starts the installation of FIREBIRD client (the client part of FIREBIRD is used to communicate with your server on which FIREBIRD server is installed). After the installation of FIREBIRD client, the installation program ask you if you want to configure the connection to the database now. Answer Yes to the question. You must enter parameters in different fields to indicate to NewWayService where is located the database.

14 Installation Guide 13 Enter the name of your Linux or Unix server (or its IP address) in the first field. Note: To verify that the server name you entered is valid, you can open a command shell and type the following command line: ping myserver substituting myserver by the name that you entered in the first field. If you get a timeout message, this indicates that the server name is not valid or that the name resolution (resolution of the name into an IP address) does not work. In that case, ask your network administrator to fix it. After it, select TCP/IP from the Protocol drop-down list. Note that the protocol TCP/IP is the only protocol available with. Be sure that your Linux or Unix server as well as all your client computers that will use NewWayService are properly configured with the TCP/IP protocol. Do not change the port number (usually 3050) unless you configured FIREBIRD on your server to use another port number to communicate. After it, enter the full path where is located the NewWayService database file such as /home/newwayservice4/nws.fdb (refer to step 4 above for more information). Warning: You must enter the LOCAL path (for example /home/newwayservice4/nws.fdb ) as if you were sat in front of the server console and not a network path such as Z:\NEWWAYSERVICE3\NWS.FDB or \\MYSERVER\NEWWAYSERVICE3\NWS.FDB else the connection will not work. A FIREBIRD database file is not a simple file (such as an MS Access file) that you share in a folder and users just have to access it. FIREBIRD is a real relational database engine and it is only through the "FIREBIRD Server" process that run on the server that clients can access the database.

15 Installation Guide 14 Note that under Linux or Unix, file and folder names are case-sensitive. If the file or folder name contains capital letters, then you will have to enter the path and database file name the same way. Finally, if you have changed the password of the FIREBIRD SYSDBA user on your server, enter the new password else let the default one (the default password is masterkey in lowercase). After having entered connection parameters, click OK to continue. Then the installation program tests the connection to the NewWayService database using parameters you entered. If the test is successful, the installation program ends by displaying Installation successful. Click OK to finish. When the installation is over, you are ready to use the software. Refer to the section Starting NewWayService for more information. If the connection test fails, the installation program displays an error message then you can verify parameters you entered. Note that if for any reason, you are not able to configure NewWayService properly (because the connection test always fails), just continue and finish the installation. Later, you will just have to run the connections manager then configure your connection to the database. You will not have to reinstall NewWayService. For more information about the connections manager, refer to the section Connections manager. Installing NewWayService in multi-user mode with a server on other platforms In addition to be able to install FIREBIRD on Windows platforms as well as on different flavors of Linux or Unix, FIREBIRD can also be installed on other platforms such as MacOS X. Visit the FIREBIRD web site at to get the complete platform list compatible with FIREBIRD. Note: According to the platform chosen, two different versions of FIREBIRD can be installed on your server. The Classic Server version and the Super Server version. We recommend you to install the Super Server version because this version offers more functionalities. Visit the FIREBIRD web site for more information about differences between these two versions. Note also that on some platforms, only one or the other is available. Before installing FIREBIRD on your server, we recommend you to take a look at Quick Start Guide for Firebird guide that contains useful information about installing FIREBIRD. This guide is available for download on the FIREBIRD web site at To install NewWayService in multi-user mode and the FIDEBIRD database on another platform, we recommend you to follow same steps as the installation of NewWayService in multi-user mode with a Linux server or other Unix platforms. The only differences are mainly the way you specify a path and/or a file name. Here are some recommendations: - At step 1, download the version of FIREBIRD according to your platform. - At step 2, refer to the documentation included with the FIREBIRD to install it on the platform chosen. - At step 3, transfer the file nwsbtf.fbk on your server. - At step 4, create the database file using the gbak utility included with the FIREBIRD version you downloaded and installed on your server. - At step 5, just configure the connection and enter exactly the path where is located the database file on your server.

16 Installation Guide 15 Migrating NewWayService 3 to This section explains you how to proceed when you are currently using version 3 of NewWayService and you want to migrate to version 4. and NewWayService 3 are two completely independent software versions. Unlike other software, you could use both versions simultaneously. NewWayService 3 could access an NewWayService 3 database while could access an database. NewWayService 3 and are installed in two different folders. Usually, NewWayService 3 is installed in the C:\Program Files\OroLogic\NewWayService3 folder while is usually installed in the C:\Program Files\OroLogic\NewWayService4 folder. When you install, no file in the NewWayService 3 folder is altered. Also, uses a different database than NewWayService 3. now use a database of type FIREBIRD while NewWayService 3 used a database of type INTERBASE. How to proceed Just begin by installing according to the procedure in the Installing section above. Then, when everything is properly configured and working, it only remains to transfer your data from the NewWayService 3 database to the database using the data transfer utility already included with. Please note that using this utility, data in the NewWayService 3 database are not altered. NewWayService 3 data are simply read then copied in the database. So, even after a transfer, the NewWayService 3 database will be still working for all NewWayService 3 users. Data transfer utility To transfer data from a NewWayService 3 database to a database, you must run the data transfer utility included with. To run this utility, from the Windows Start button, select Programs Data transfer v3 to v4. Please note that before being able to transfer data, NewWayService 3 as well as must be installed and properly working on the computer from which you want to run the transfer. In the main data transfer utility window, from the NewWayService connection version 3 section, click on the List of connections of NewWayService 3 button then select the connection to the NewWayService 3 database you want. Then, from the NewWayService connection version 4 section, click on the List of connections of button then select the connection to the database you want. After it, click the Transfer data button to start the transfer and answer to the confirmation message. WARNING: The data transfer utility will automatically erase all data contained in the NewWayService 4 database before transferring data from the NewWayService 3 database. Before running this utility, if there is some information in the database that you want to keep, we suggest you to print it or to keep a copy of the database. Please, also note that you cannot make a partial transfer. Indeed, when transferring data, all NewWayService 3 data are transferred in the database.

17 Installation Guide 16 When the transfer starts, if the security in the NewWayService 3 database is enabled, you will have to enter a valid technician code of NewWayService 3 that as administrator rights as well as its password. After it, if the security in the database is enabled, you will also have to enter a valid technician code of that as administrator rights as well as its password to continue. Be sure that nobody access the database while the transfer is running. Once the transfer is done, the transfer utility ask you if you would like to transfer reports or forms that you customized in version 3. To transfer some reports or forms, answer Yes to the question then follow steps on screen. If you did not customize reports or forms, just answer No to the question. Note that you can also transfer customized reports or forms later simply by running the transfer utility again and by selecting the tab Transfer reports. Once the transfer is done, all passwords of technicians of the database become automatically identical to the passwords of technicians of the NewWayService 3 database. When to proceed? After having tested and you are ready that your users start using version 4 instead of version 3, no matter if you already made a data transfer in the past (for example, for tests purpose), you must run the transfer again so that the database contains all data that was entered in the NewWayService 3 database. Please note that all users must obligatory start using at the same time. You cannot just migrate a part of the users. This is because the data transfer utility cannot just transfer a part of the database. The whole database must be transferred. As indicated above, since NewWayService 3 and are two completely independent versions, NewWayService 4 can be installed in advance on each computer without interfering with NewWayService 3. Once the transfer is done, your users will be able to use version 4 of NewWayService instead of version 3. All their data will be in the database. From this moment, your users must not use version 3 anymore. They must all use version 4. Else, if some users still use version 3 and other use version 4, you will have new data in two different databases. In a such case, you will not be able to transfer data again since the data transfer utility cannot just transfer a part of the database. If you run the transfer again, you will loose new data entered in version 4.

18 Installation Guide 17 Transferring reports All reports and forms of NewWayService 3 are automatically included with. However, if you created new reports or customized existing ones, you can transfer these reports using the data transfer utility v3 to v4. To transfer reports or forms (if you did not transferred them at the same time you transferred data), you must run the data transfer utility v3 to v4 included with. To run this utility, from the Windows Start button, select Programs Data transfer v3 to v4. In the main data transfer utility window, from the NewWayService connection version 3 section, click on the List of connections of NewWayService 3 button then select the connection to the NewWayService 3 database you want. Then, from the NewWayService connection version 4 section, click on the List of connections of button then select the connection to the database you want. After it, select the tab Transfer reports then click on the Transfer reports button to be able to select reports and forms to transfer. Before to be able to select reports and forms, if the security in the NewWayService 3 database is enabled, you will have to enter a valid technician code of NewWayService 3 that as administrator rights as well as its password. After it, if the security in the database is enabled, you will also have to enter a valid technician code of that as administrator rights as well as its password to continue.

19 Installation Guide 18 Migrating NewWayService 2 to This section explains you how to proceed when you are currently using version 2 of NewWayService and you want to migrate to version 4. and NewWayService 2 are two completely independent software versions. Unlike other software, you could use both versions simultaneously. NewWayService 2 could access an NewWayService 2 database while could access an database. NewWayService 2 and are installed in two different folders. Usually, NewWayService 2 is installed in the C:\Program Files\OroLogic\NewWayService2 folder while is usually installed in the C:\Program Files\OroLogic\NewWayService4 folder. When you install, no file in the NewWayService 2 folder is altered. Also, uses a different database than. now use a database of type FIREBIRD while NewWayService 2 used a database of type INTERBASE. How to proceed Just begin by installing according to the procedure in the Installing section above. Then, when everything is properly configured and working, it only remains to transfer your data from the NewWayService 2 database to the database using the data transfer utility already included with. Please note that using this utility, data in the NewWayService 2 database are not altered. NewWayService 2 data are simply read then copied in the database. So, even after a transfer, the NewWayService 2 database will be still working for all NewWayService 2 users. Data transfer utility To transfer data from a NewWayService 2 database to a database, you must run the data transfer utility included with. To run this utility, from the Windows Start button, select Programs Data transfer v2 to v4. Please note that before being able to transfer data, NewWayService 2 as well as must be installed and properly working on the computer from which you want to run the transfer. In the main data transfer utility window, from the NewWayService connection version 2 section, click on the List of connections of NewWayService 2 button then select the connection to the NewWayService 2 database you want. Then, from the NewWayService connection version 4 section, click on the List of connections of button then select the connection to the database you want. After it, click the Transfer data button to start the transfer and answer to the confirmation message. WARNING: The data transfer utility will automatically erase all data contained in the NewWayService 4 database before transferring data from the NewWayService 2 database. Before running this utility, if there is some information in the database that you want to keep, we suggest you to print it or to keep a copy of the database. Please, also note that you cannot make a partial transfer. Indeed, when transferring data, all NewWayService 2 data are transferred in the database.

20 Installation Guide 19 When the transfer starts, if the security in the NewWayService 2 database is enabled, you will have to enter a valid technician code of NewWayService 2 that as administrator rights as well as its password. After it, if the security in the database is enabled, you will also have to enter a valid technician code of that as administrator rights as well as its password to continue. Be sure that nobody access the database while the transfer is running. When the transfer is terminated, just quit the transfer utility then run to check that data were properly transferred. When to proceed? After having tested and you are ready that your users start using version 4 instead of version 2, no matter if you already made a data transfer in the past (for example, for tests purpose), you must run the transfer again so that the database contains all data that was entered in the NewWayService 2 database. Please note that all users must obligatory start using at the same time. You cannot just migrate a part of the users. This is because the data transfer utility cannot just transfer a part of the database. The whole database must be transferred. As indicated above, since NewWayService 2 and are two completely independent versions, NewWayService 4 can be installed in advance on each computer without interfering with NewWayService 2. Once the transfer is done, your users will be able to use version 4 of NewWayService instead of version 2. All their data will be in the database. From this moment, your users must not use version 2 anymore. They must all use version 4. Else, if some users still use version 2 and other use version 4, you will have new data in two different databases. In a such case, you will not be able to transfer data again since the data transfer utility cannot just transfer a part of the database. If you run the transfer again, you will loose new data entered in version 4. Notes about importing reports from NewWayService 2 to If you designed customized reports into NewWayService 2, if you want, you can import them into. Indeed, even if you transfer your data from NewWayService 2 to using the data transfer utility, not all customized reports and forms are transferred.

21 Installation Guide 20 To import a report or form from NewWayService 2 to, run the reports generator for NewWayService 2. Open the report you want to export. From the File menu select Save to file. Select the folder where you want to save the report, type a name and click the Save button. Quit the reports generator for NewWayService 2 then now run the reports generator for. Create a new report. After it, from the File menu, select Load from file, select the file you just saved and click the Open button. Your report in now into. Important: Note that henceforth, into, codes in the modules Customers, Products, Serial numbers, Spare parts, Technicians and Articles can now be edited any time. So, these fields had to be renamed. For example, if in a report, you were using the field CUSCOD to print the customer code, then now, you will have to use the field CUSCODDES. Indeed, the field CUSCODDES contains the customer code that you can now edit and that is displayed in the software. On the other side, the field CUSCOD contains a unique identifier that never change and that is used to link database tables together. This field is never displayed in the software. If you were using the field PROCOD to print the product code, then now, you will have to use the field PROCODDES. If you were using the field SERCOD to print the serial number code, then now, you will have to use the field SERCODDES. If you were using the field PARCOD to print the spare part code, then now, you will have to use the field PARCODDES. If you were using the field TECCOD to print the technician code, then now, you will have to use the field TECCODDES. If you were using the field ARTCOD to print the article code, then now, you will have to use the field ARTCODDES. In most of the cases, you will have to edit the query of the report to add these fields that did not exist in NewWayService 2. If you started from a report of NewWayService 2 and you only performed some changes (such as adding a company logo), in such case, it could be easier to start from a report of and customize it again instead of transferring your report from NewWayService 2 to. However, if you made several changes, in such case, transfer your report then edit it according to instructions indicated previously. If you get problems when editing your report, contact the OroLogic support team. In such case, please, send us your report or form (.RTM file) in attachment of your . It will be easier for us to answer your support request. Please note that we also provide services to edit or customize your reports and forms. Contact the OroLogic support team for more information about this service.

22 Installation Guide 21 Starting NewWayService Before being able to start NewWayService, you must first install it if it is not already done. For more information about installing NewWayService, refer to the section Installing. To start NewWayService, from the Windows Start button, select Programs. After a few seconds, you will be in the program ready to use it. If you cannot start NewWayService and/or an error message is displayed, refer to the section Technical support.

23 Installation Guide 22 web version A web version of is also included with the product. This web version is divided in three sections: Technician access, Customer access (New work order) and Customer access (Consult a work order). All other options of the software to manage data as well as reports are only available through the standard program. Before users be able to access this web version, you must install it. The web version of NewWayService is only available in the form of a Windows service. This Windows service is a real independent web server that is only used for. So, you don't need to install a web server on your server to use the web version of. Note that if there is already a web server installed on your server such as IIS (Internet Information Services) from Microsoft, it will not conflict because by default, the web service of is using a different port number (port 8889) than the default port of other web servers (port 80). Note however that you can change the port number that will be used by the web service of NewWayService for any other port number. The web service of is already included with NewWayService. However, the installation program does not install it systematically on each computer since this service needs to be executed on one computer only (usually on your server). As indicated above, the web service of NewWayService is a Windows service. So, this one can only be executed on a Windows 2000, Windows XP, Windows 2003, Windows Vista, Windows 2008 or Windows 7 platform. The service cannot be executed on other Windows versions or on other platforms such as Linux or Unix. However, note that the service could run on a Windows server while the database could be located on a Linux server or other plate-form. If your server is a Windows platform, we recommend you to simply install the service on your server. If your server is on another platform, then just install the service on another server or a Windows client computer. No matter that you install the web service of NewWayService on a server or one of your client computers, what is important here is that the computer where the service is installed be always running so that users could access the web version anytime Installing the web service of Here are the main steps to follow to install the NewWayService web service: 1. Be sure that NewWayService is properly installed and configured on the computer where you want to install the web service of. 2. Install and start the web service of. 3. Test the web service of. 1. Be sure that NewWayService is properly installed and configured on the computer where you want to install the web service of. If it is not already done, install NewWayService on the computer on which you want to install the web service. You must install NewWayService in multi-user mode. Refer to the section Installing NewWayService in multi-user mode above for more information. Then, run NewWayService on this computer to be sure that you can connect to the database without any problem. After it, just quit NewWayService then continue to next step. 2. Install and start the web service of. Using the Windows File Explorer, go to the NewWayService installation folder (usually C:\Program Files\OroLogic\NewWayService4), then, double-click on the file srvman.exe to start the Service

24 Installation Guide 23 manager for utility. Then select the service named Web service from the Service dropdown list and click on the Install service button to install the service. Installing the service takes approximately one second. Once installed, the status on screen should change from Not installed to Started. If not, click the button Refresh to refresh the status of the service on screen. To verify that the service was correctly installed and started, go to the Windows control panel, double-click on the Administrative tools icon then double-click on the Services icon. Verify that the service named NewWayService4Web is in the list of services and that the status is Started. Also, verify that the startup type is Automatic so that the service start automatically each time Windows is started. The web service is now installed. You can continue to the next step. 3. Test the web service of. From the computer where you installed the web service, start your Internet browser (such as Microsoft Internet Explorer) then enter the following address by replacing servername by the name of the computer where the web service is running. For example, if the name of the computer is server1, enter The home page should be displayed in your browser. If no page is displayed, maybe that the server name you entered is not recognized. You could enter the IP address of the server instead of it's name. For example, if the IP address of your server is , you could enter in your browser. If an error page is displayed, verify that there is no firewall or any other security program that could block communications on the 8889 port. Ask your network administrator for more information. Note that you can also change the port number on which the web service is running simply by editing the file NWSWEB.INI located in the installation folder (usually C:\Program Files\OroLogic\NewWayService4) of on the computer where the web service is running. Edit this file using a text editor then change the port number on the line Port=. After it, save your changes then stop and restart the web service so that the new port number be used. Also, for example, if

25 Installation Guide 24 you changed the port number from 8889 to 1234, then enter this new port number instead of the old one in your browser as the following: When everything is working well using the browser directly on the server, try to access the same address from another client computer. Again, if an error page is displayed, verify that there is no firewall or any other security program that could block communications on that port. Ask your network administrator for more information. Finally, you could add a link to the NewWayService web version directly in a web page of your corporate Internet or Intranet web site so that your users had only to click this link instead of always entering your server address followed by the pot number. If you do not specify the port number in your browser, by default the browser will try to access port 80 (as indicated above, the web service if configured on port 8889) and no page will be displayed. Refer to the section web version in the user's guide for more information about options available in the web version.

26 Installation Guide 25 The Windows service of A program named NewWayService service (Windows service) is also included with. This service was specifically developed to automate some tasks such as automatically generating recursive work orders, sending s for alerts and events (such as when the status of a work order change) as well as sending s for technician appointment reminders. This service take care of these tasks even when no user are connected to NewWayService. The NewWayService service is already included with NewWayService. However, the install program do not install it systematically on each computer since this service needs to be executed on one computer only (usually on your server). Warning: Do not execute the service on more than one computer unless to be sure that each service access different databases else you could get problems when using NewWayService if more than one service access the same database. Note also that only one service could take care of several different databases. As indicated above, the NewWayService service is a Windows service. So, this one can only be executed on a Windows 2000, Windows XP, Windows 2003, Windows Vista, Windows 2008 or Windows 7 platform. The service cannot be executed on other Windows versions or on other platforms such as Linux or Unix. If your server is a Windows platform, we recommend you to simply install the service on your server. If your server is on another platform, then just install the service on another server or a Windows client computer. No matter that you install the NewWayService service on a server or one of your client computers, what is important here is that the computer where the service is installed be always running else some tasks will stop working. Installing the NewWayService service Here are the main steps to follow to install the NewWayService service: 1. Be sure that NewWayService is properly installed and configured on the computer where you want to install the NewWayService service. 2. Install and start the NewWayService service. 3. Indicate which database the NewWayService service must access. 4. Configure the database to indicate that the NewWayService service will take care of this database. 1. Be sure that NewWayService is properly installed and configured on the computer where you want to install the NewWayService service. If it is not already done, install NewWayService on the computer on which you want to install the NewWayService service. You must install NewWayService in multi-user mode. Refer to the section Installing NewWayService in multi-user mode above for more information. Then, run NewWayService on this computer to be sure that you can connect to the database without any problem. After it, just quit NewWayService then continue to next step. Warning: The NewWayService service will not work if NewWayService is installed in stand-alone mode. The NewWayService service works only in multi-user mode. 2. Install and start the NewWayService service. Using the Windows File Explorer, go to the NewWayService installation folder (usually C:\Program Files\OroLogic\NewWayService4), then, double-click on the file srvman.exe to start the Service manager for NewWayService utility. Then select the service named from the Service dropdown list and click on the Install service button to install the service. Installing the

27 Installation Guide 26 service takes approximately one second. Once installed, the status on screen should change from Not installed to Started. If not, click the button Refresh to refresh the status of the service on screen. To verify that the service was correctly installed and started, go to the Windows control panel, double-click on the Administrative tools icon then double-click on the Services icon. Verify that the service named NewWayService4 is in the list of services and that the status is Started. Also, verify that the startup type is Automatic so that the NewWayService service start automatically each time Windows is started. The NewWayService service is now installed. You can continue to the next step. 3. Indicate which database the NewWayService service must access. Even if the NewWayService service is started, by default, the service does not access any database. It just runs without really doing anything. You must indicate which database the service must access to perform tasks. To indicate to the NewWayService service which database it must access, you must check an option in the connection parameters to this database using the Connections manager utility. Directly from the computer where the service is installed, run the connections manager (from the Windows Start button, select Programs Connections manager) to access the connection list. By default (and in most cases), there should be only one connection in the list. However, if you configured several databases, you will probably have several connections in the list. Double-click the connection that correspond to the database which you want that the NewWayService service take care of. Then, check the box I allow the Windows service to access this database then click OK to validate changes. Finally, quit the connections manager to save changes in the connections file. Please note that you can indicate to the NewWayService service to take care of several databases by checking the option I allow the Windows service to access this database in each connection to different databases. The NewWayService service that is currently running will automatically start to access the database you specified using the connections manager. However, the service will do nothing until you configure the database itself to indicate that some tasks will now be performed by the NewWayService service. Continue to the next step to activate this last option.

28 Installation Guide Configure the database to indicate that the NewWayService service will take care of this database. To indicate to the database that the service will take cake of it, just run NewWayService then connect to the database using the technician code ADMIN or any other technician that has administrative rights. Note that by default the password of the Administrator technician is OROLOGIC. Go to the menu Configuration Parameters General, select the tab Windows service then check the option Use service. After it, enter some other asked parameters then click OK to save changes. Starting from now, as indicated above, some tasks will now be performed by the NewWayService service. The NewWayService service generates a log file named NWSSRV.LOG and it is located in the NewWayService installation folder (usually C:\Program Files\OroLogic\NewWayService4). Consult this file that contains error messages when (for any reason), the NewWayService service is not able to access the database. If the NewWayService service can access the database, in that case, errors will be logged into the database itself and available through the menu Utilities Error log of NewWayService.

29 Installation Guide 28 Connections manager The connections manager utility allows you to manage the list of database connections. When installing NewWayService in multi-user mode, the installation program ask you for some connection parameters then automatically create a connection for you. Usually, you only have to work with one database so you will only have one connection in the list. However, if for a specific reason, you have to work with several NewWayService databases, in that case, you will probably have several connections in the list, usually one connection for each different database. Refer to the section Working with several databases below for more information. By default, when you run NewWayService, the program uses the default connection then connect to the database specified in this connection. If you are working with several databases, you could indicate in the connections manager to always display the list of connections at startup so that you could choose each time which database you want to connect to. To indicate to NewWayService to always display the list of connections at startup, you just have to check the option Always display the list of connections at startup in the main screen. Note that to tag a connection as the default connection, on the left side of the connection, click the radio button Default. Some information about connection parameters When configuring a connection, the username as well as the password are always a FIREBIRD username and password. Do not confuse with technician codes and passwords of NewWayService. Since NewWayService has its own security, just enter SYSDBA as the user name and masterkey (in lowercase) as the password. If you changed the password of the FIREBIRD SYSDBA user, enter the new password instead of masterkey. When you enter the full path to the database, always enter the local path as you were sat in front of the server. For example, if your database is located on a Windows server, the full path should usually be C:\Program Files\OroLogic\NewWayService4\NWS.FDB. If your database is located on a Linux server, the full path should usually be /home/newwayservice4/nws.fdb. Never enter a network path such as Z:\MyFolder\NWS.FDB or \\MyServer\MyFolder\NWS.FDB, else it will not work. Please, also note that you never have to share the folder where is located the NewWayService database. The NewWayService database is of type FIREBIRD. A FIREBIRD database file is not a simple file (such as an MS Access file) that you share in a folder and users just have to access. FIREBIRD is a real relational database and it is only through the FIREBIRD process that runs on the server that clients can access the database.

30 Installation Guide 29 Using the TCP/IP protocol, you can enter the server name or its IP address where is located the FIREBIRD database. Saving connection parameters in a file Parameters of a connection can be saved in a file. To save a connection to a file, right-click on the connection then select Save to file. Enter the name of the file then click Save. This file can be retrieved from the connections manager on another computer. This allows you to configure other computers without having to reenter connection parameters each time. Do not forget to test your connection using the Test button on other computers also to be sure that communication is working fine between this other computer and your database server. Centralizing connection parameters in a file It is also possible to indicate for a connection to always retrieve its parameters from a file previously saved (see above). To do that, select the option This connection always uses parameters from the following file then select the file that contains connection parameters using the button. This can be very useful when you want to centralise connection parameters of all NewWayService users in a single location on your network. Working with several databases In some cases, it could happen that you need more than one NewWayService database. For example, if you want to have a test database in addition to your real database. You could create a new database from the existing one (you would have an identical copy of the database that contains same data) or you could create a new empty database. Creating a database identical to your current one To create a new database starting from your current one, using the database utility, make a backup copy if your current database. Then, using the backup file, restore the database on a different name such as NWS-B.FDB. Refer to the section Backing up the database for more information about how to backup or restore databases. After the creation of the new database, you must create a new connection to access it. To do that, run the connections manager, then add a new connection that point on the new database instead of the default one. For example, if you named your new database NWS-B.FDB and it is located in the C:\Program Files\OroLogic\NewWayService4 folder, then you should enter C:\Program Files\OroLogic\NewWayService4\nws-b.fdb in the field Full path to the database. Under Linux, if you named you new database nws-b.fdb and it is located in the /home/newwayservice4 folder, then you should enter /home/newwayservice4/nws-b.fdb. After creating your new connection, test it to be sure that it works using the Test button. Then, check the box Always display the list of connections at startup. So, when you will run NewWayService, you will be able to choose which database to access. Finally, quit the connections manager, run NewWayService then select a connections to access one or the other of your databases. Creating an empty database An empty database in FIREBIRD backup format is included with NewWayService. When installing NewWayService, this file named NWSBTF.FBK is automatically copied in the installation folder (usually C:\Program Files\OroLogic\NewWayService4). You must use this file to create a new empty database.

31 Installation Guide 30 To create a new empty database, using the database utility, restore the file NWSBTF.FBK on a different name such as NWS-B.FDB. Refer to the section Backing up the database for more information about how to backup or restore databases. After the creation of the new database, you must create a new connection to access it. To do that, run the connections manager, then add a new connection that point on the new database instead of the default one. For example, if you named your new database NWS-B.FDB and it is located in the C:\Program Files\OroLogic\NewWayService4 folder, then you should enter C:\Program Files\OroLogic\NewWayService4\nws-b.fdb in the field Full path to the database. Under Linux, if you named you new database nws-b.fdb and it is located in the /home/newwayservice4 folder, then you should enter /home/newwayservice4/nws-b.fdb. After creating your new connection, test it to be sure that it works using the Test button. Then, check the box Always display the list of connections at startup. So, when you will run NewWayService, you will be able to choose which database to access. Finally, quit the connections manager, run NewWayService then select a connections to access one or the other of your databases.

32 Installation Guide 31 Licensing You can use for a free 45-day trial period. During this period, each time you start NewWayService and no valid license numbers are detected, a dialog box is displayed indicating the number of days remaining to your trial period. There is no software limitation when you are in trial mode. So, you can use NewWayService in stand-alone mode as well as in multi-user mode without any problem. After having evaluated NewWayService, if you decide to buy or rent it, you will have nothing to reinstall or reconfigure. Your data will also be preserved in the database even if the trial period is over. You will only have to enter license numbers that you will receive by to automatically unlock NewWayService and continue to use it. Number of licenses required To continue to use after the 45-day trial period, you must buy or rent licenses. Licenses are the same no matter if your users are using (the Windows program) or the web version. You need at least one license for each user that must use NewWayService. In fact, you can install NewWayService on any number of computers you want since licenses are managed per user instead of per computer. For example, if you have 5 users that must use NewWayService (no matter if they are using NewWayService simultaneously or not), you will need 5 licenses. Please note that licenses are not concurrent. So, even if there is never more than 3 users that are using NewWayService at the same time, you will even need 5 licenses. Please also note that the number of licenses does not limit the number of technicians you can create into NewWayService. For example, if only one user uses NewWayService to enter work orders for 50 technicians, in that case, you will only need one license since only one user will use NewWayService even if 50 technicians are created in the database. Please note also that no license is required for customers that enter a work order through the web version or customers that consult the status of a work order through the web version. Note also that the NewWayService Windows service does not require any license either. Adding licenses into NewWayService When you buy or rent NewWayService licenses, you will receive your licenses by (in a file in attachment). Once received, you must add it into NewWayService. To do that, double-click on the file that contains license numbers to open it. Select all text (including <BEGIN-LIC-NWS> and <END-LIC-NWS> tags) then copy all the text in the clipboard. After it, click on the button Add my licenses to NewWayService from the dialog box that displays the number of days remaining to your trial period, or click the Add button from the option Licenses manager available in the Configuration Licenses manager menu of NewWayService. Paste all the text in the edit box and click OK. License numbers will be automatically decrypted and NewWayService will be automatically unlocked for the number of users that corresponds to the number of licenses decrypted. Note that license numbers are kept directly into the database. So, you only need to add licenses once and from any computer. License assignation By default, when adding new licenses into NewWayService, these licenses are not assigned to any user (technicians). As users access NewWayService, a license is automatically assigned to them forever. So,

33 Installation Guide 32 even if the user quit NewWayService, the license remains assigned to this user any time. If a new user try to access NewWayService and all licenses are already assigned, this new user will receive a message indicating that no more licenses are available. NewWayService never unassign a license already assigned to a user. When a user does not need to use NewWayService anymore (for example, because this user does not work for your organization anymore), you can assign its license to another user. To do that, from the Licenses manager option available from the menu Configuration Licenses manager select the license you want to assign to another user then click the Assign button. Then, select Assign to then select the name of the new user. It can happen that for a license, NewWayService indicates that the user is connected to NewWayService but in fact, the user is not into NewWayService anymore (for example if the computer of this user had a problem and the user was not able to quit NewWayService by the correct way). In that case, if the user try to run back NewWayService, he could receive a message indicating that he is already connected on another computer if there is no more licenses available (non assigned). In a such case, if the user wait 15 minutes before running back NewWayService, NewWayService will detect the problem and will allow back the user to use NewWayService. However, if the user wants that the license be available immediately (because he cannot wait), then, you could manually unassign the license that this user is using. To do that, from the option Licenses manager available in the menu Configuration Licenses manager select the license you want to unassign then click the Assign button. Then, select Unassign from the menu. Warning: never unassign a license that is really in use by a user else NewWayService will stop working for this user. This technician will have to restart NewWayService. Please also note that usually, you never have to use the option Unassign.

34 Installation Guide 33 Backing up the database We strongly recommend that you backup your data on a regular basis. Backing up your data protects you from losing your data by a hardware failure (computer, hard disk, etc.) or a software failure (operating system, virus, electricity lost, etc.). NewWayService works with the FIREBIRD database. To make a backup copy of your database, you can use the option Backup available from the menu Utilities directly into NewWayService, the utility named database utility or the GBAK utility of FIREBIRD. No matter the way used when making a backup copy of your database, a copy of the database is created in a new file of type FIREBIRD backup format and this new file usually has the extension.fbk. Once that the backup file is created, we strongly recommend you to save this file on a cd-rom, a tape or any other media. For more information on different archive method or archive media, ask your computer supplier. Important note: If you are using a backup software, configure the software so that the software does not backup the database file. You must instead backup the backup file created using one of the methods indicated above. Indeed, if your backup software try to backup a database file that is in use, in some cases, this could damage the database. If later, you get a problem and you have to restore your database, and a backup file was created using any method indicated above, you will be able to restore your database using the utility named NewWayService 4 database utility or the GBAK utility of FIREBIRD. Note that you cannot just only rename a backup file from the extension.fbk to the extension.fdb. It will not work. A backup file must obligatory be restored using the utility named database utility or the GBAK utility of FIREBIRD. Refer to the sections Restoring a database using the database utility or Restoring a database using the GBAK FIREBIRD utility below for more information. Backing up the database using the Backup option from the Utilities menu This option is the simpler way to make a backup copy of your database. You just have to run the option Backup available from the menu Utilities and click on the button Start backup. No parameter is required. You can run this option even when employees are accessing the database. In fact, this option was specifically developed for this purpose. This option creates a copy of the database file (in FIREBIRD backup format) in the same folder where is located the database you are currently accessing. Usually, the name of the file will be the name of the database with the date and hour and the extension will be.fbk instead of.fdb. Backing up the database using the database utility You can make a backup using this utility even when users are accessing the database. In fact this option was specifically developed for this purpose. To make a backup using this utility, from the Windows Start button, select Programs Database utility. Then select the Backup tab. Click the button Connection list located on the right side of the Connection mode section then select the connection of the database you want to backup. Click OK so that information be automatically entered in different fields. In the

35 Installation Guide 34 Password field, enter the password of the FIREBIRD SYSDBA user. By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). By default, the utility suggest you to create a backup file in the same folder where is located the database. The suggested filename is the same than the database name except that the extension will be.fbk instead of.fdb. You can change the folder or the name of the backup file suggested if you want. Then, check the box Display log file after backup then click the button Start backup. After the backup process, you will receive a message telling you that if the backup was successfully made and after it the log describing all backup steps will be displayed on screen. Backing up the database using the FIREBIRD GBAK utility GBAK is a backup and restore utility that is included with FIREBIRD. GBAK is a command line utility and works the same way no matter if your database is located on a Windows, Linux or Unix server or on any other platform. One of the benefits of using GBAK is to be able to backup your database using script files (batch files on Windows). So, using any scheduling software, you could run script files, for example, to automatically backup your database each night. Also, since the GBAK utility was specifically developed for FIREBIRD

36 Installation Guide 35 databases, you can even backup your database while users are using NewWayService and are accessing the database. For more information about the FIREBIRD GBAK utility, refer to the documentation included with FIREBIRD. For more information about script files, refer to the documentation of the operating system where FIREBIRD server is installed. Example of backup using GBAK under Windows For our example here, the database is named nws.fdb and is located in the C:\Program Files\OroLogic\NewWayService4 folder. FIREBIRD is installed in the C:\Program Files\Firebird\Firebird_2_1 folder. From the Windows server where the database is located, start a command shell session and type the following command line (in one line and including double quotes): "C:\Program Files\Firebird\Firebird_2_1\bin\gbak" -B -USER SYSDBA -PASSWORD masterkey "C:\Program Files\OroLogic\NewWayService4\nws.fdb" "C:\Program Files\OroLogic\NewWayService4\nws.fbk" The parameter -B indicates to the GBAK utility to make a backup. The parameter -USER indicates the FIREBIRD user name to use. In this case, the SYSDBA FIREBIRD user is used (Do not confuse with employees of NewWayService). The parameter -PASSWORD indicates the FIREBIRD user password (in this case SYSDBA). By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). This command performs a backup of the nws.fdb database. The backup file will be named nws.fbk. Important notice: The command above will work only if it is run directly from the server console. This command will not work if you run it through a client terminal server session or for example if the command is run in background from a task scheduler software. In such case, you must specify the server name as well as the port number on which Firebird is running (TCP/IP syntax). Usually, the default port number used is Verify your NewWayService connection parameters to see which port number to use in the command. Here is the same example as above, except that the server name and port number are specified: "C:\Program Files\Firebird\Firebird_2_1\bin\gbak" -B -USER SYSDBA -PASSWORD masterkey "localhost/3050:c:\program Files\OroLogic\NewWayService4\nws.fdb" "C:\Program Files\OroLogic\NewWayService4\nws.fbk" In this example, the server is named localhost and the port number on which Firebird is running is Note that you must add the character / between the server name and the port number and add the character : after the port number. Please, also note that you could enter the IP address of the server instead of its name. Example of backup using GBAK under Linux or Unix For our example here, the database is named nws.fdb and is located in the /home/newwayservice4 folder. FIREBIRD is installed in the /opt/firebird folder. From the Linux or Unix server where the database is located, start a command shell session and type the following command line (in one line):

37 Installation Guide 36 /opt/firebird/bin/gbak -b -user SYSDBA -password masterkey /home/newwayservice4/nws.fdb /home/newwayservice4/nws.fbk The parameter -b indicates to the GBAK utility to make a backup. The parameter -user indicates the FIREBIRD user name to use. In this case, the SYSDBA FIREBIRD user is used (Do not confuse with employees of NewWayService). The parameter -password indicates the FIREBIRD user password (in this case SYSDBA). By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). This command performs a backup of the nws.fdb database. The backup file will be named nws.fbk. Restoring the database using the database utility First, be sure that nobody is accessing the database you want to restore. Then copy the backup file in the same folder where is located the database to restore. From the Windows Start button, select Programs Database utility. Then select the Restore tab. Click the button Connection list located on the right side of the Connection mode section then select the connection of the database you want to restore. Click OK so that information be automatically entered in different fields. In the Password field, enter the password of the FIREBIRD SYSDBA user. By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). Be sure that the name entered in the field Backup file name is valid and corresponds to the file you want to restore. Then, check the box Display log file after restore then click the button Start restore. After the restore process, you will receive a message telling you that if the restore was successfully made and after it the log describing all restore steps will be displayed on screen. When the restore is complete, you can run back and access your database.

38 Installation Guide 37 Restoring the database using the FIREBIRD GBAK utility First, be sure that nobody is accessing the database you want to restore. Then copy the backup file in the same folder where is located the database to restore. Example of Restore using GBAK under Windows For our example here, our backup file is named nws.fbk and is located in the C:\Program Files\OroLogic\NewWayService4 folder. FIREBIRD is installed in the C:\Program Files\Firebird\Firebird_2_1 folder. From the Windows server where the database is located, start a command shell session and type the following command line (in one line and including double quotes): "C:\Program Files\Firebird\Firebird_2_1\bin\gbak" -REP -USER SYSDBA -PASSWORD masterkey "C:\Program Files\OroLogic\NewWayService4\nws.fbk" "C:\Program Files\OroLogic\NewWayService4\nws.fdb" The parameter -REP indicates to the GBAK utility to make a restore. The parameter -USER indicates the FIREBIRD user name to use. In this case, the SYSDBA FIREBIRD user is used (Do not confuse with employees of NewWayService).

39 Installation Guide 38 The parameter -PASSWORD indicates the FIREBIRD user password (in this case SYSDBA). By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). This command restore the file nws.fbk over the file nws.fdb. Important notice: The command above will work only if it is run directly from the server console. This command will not work if you run it through a client terminal server session or for example if the command is run in background from a task scheduler software. In such case, you must specify the server name as well as the port number on which Firebird is running (TCP/IP syntax). Usually, the default port number used is Verify your NewWayService connection parameters to see which port number to use in the command. Here is the same example as above, except that the server name and port number is specified: "C:\Program Files\Firebird\Firebird_2_1\bin\gbak" -REP -USER SYSDBA -PASSWORD masterkey "C:\Program Files\OroLogic\NewWayService4\nws.fbk" "localhost/3050:c:\program Files\OroLogic\NewWayService4\nws.fdb" In this example, the server is named localhost and the port number on which Firebird is running is Note that you must add the character / between the server name and the port number and add the character : after the port number. Please, also note that you could enter the IP address of the server instead of its name. Example of Restore using GBAK under Linux or Unix For our example here, our backup file is named nws.fbk and is located in the /home/newwayservice4 folder. FIREBIRD is installed in the /opt/firebird folder. From the Linux or Unix server where the database is located, start a command shell session and type the following command line (in one line): /opt/firebird/bin/gbak -rep -user SYSDBA -password masterkey /home/newwayservice4/nws.fbk /home/newwayservice4/nws.fdb The parameter -rep indicates to the GBAK utility to make a restore. The parameter -user indicates the FIREBIRD user name to use. In this case, the SYSDBA FIREBIRD user is used (Do not confuse with employees of NewWayService). The parameter -password indicates the FIREBIRD user password (in this case SYSDBA). By default the password of the FIREBIRD SYSDBA user is masterkey (in lowercase). This command restore the file nws.fbk over the file nws.fdb.

40 Installation Guide 39 Technical support To get technical support on installation and/or use of here are the different sources of information available: Support via our web site : You can, 24 hours a day, 7 days a week, access the Support section of our web site, at The Support section of our web site is updated on a regular basis and you can consult the list of frequent problems and their suggested solutions. This service is free for all users of. Online support request: From the menu Help Online services Fill an online support request of NewWayService, you can fill an online support request. This option automatically open your browser and access the Online support request form in the Support section of our web site at Support requests made directly from this form are usually faster to answer and process since most information we need are automatically filled. This service is free for all users. Note that support requests from users that already bought or rent licenses will be processed in priority. If for any reason, you cannot run NewWayService and you do not have access to the NewWayService Help menu, you can access to the online support request form by accessing the Support section of our web site at Error messages: If you fill a support request, according to an error or problem you get when you are using NewWayService, please add this error message in the description of your support request. When an error message is displayed on screen, just click the More info button then click Copy to clipboard. After it, just paste it in your support request description.