iogas Desktop Installation Guide

Size: px

Start display at page:

Download "iogas Desktop Installation Guide"

Derick Powers
5 years ago
Views:

1 iogas Desktop Installation Guide December 2017

2 T able of Contents iogas Software Technical Specifications... 2 Install Desktop Software... 3 Microsoft Windows... 3 Apple Mac Licence Options Single Seat Licensing Send Machine ID Number Install Licence File Microsoft Windows Apple Mac Trouble-shooting Transfer Single Seat Licence Connect to Floating Server Licence Obtain Token Return Token Connect to Classic Server Licence Obtain Token Support Imdex Limited December 2017

3 iogas Software Technical Specifications Operating System Windows 7, 8 & 10 (32 or 64 bit, download corresponding installer) Mac OS X or later (Java 8 is bundled with installer) NB. Intel based Mac only as Power PC Macs do not support Java 1.8. CPU RAM Graphics Printer/Plotters Installation Permissions Runtime Permissions A Dual Core processor is recommended. An Intel Celeron processor is not recommended. 2+ GB recommended, 1 GB minimum required. Performance may vary with graphics card Uses operating system defaults MUST be installed while logged on with Administrator permissions. Administrator permissions are no longer required from release 4.5. Note Users must have permission to write to C:\ProgramData C:\Users\<USERNAME>\AppData\Roaming\ and to C:\Users\<USERNAME>\AppData\Local\Temp. This is allowed by default. Installation Disk Space Network Supporting Software URL Sites User must have access to the Windows WMIC command on the computer. This can be tested by running wmic csproduct get uuid command in Windows command prompt, and receiving two lines output and no error message. >100 Mb of free space on the Program Files drive is required for the installation process. Internet not required to run iogas. Licence keys are sent by . NONE required. It is recommended that can access any *.ioanalytics.net URL sites, in particular the following: Diagrams: Application: IMDEXHUB-IQ: Note: Some of these links may forward to other servers. 2 Imdex Limited December 2017

4 Install Desktop Software MICROSOFT WINDOWS 1. Download the latest iogas installer file from the iogas website at Registration is required in order to download from this site. Downloads can also be obtained via the Help>Check for Updates menu option within the iogas application. For Windows operating system there are two installers available: 32-bit version 64-version Both versions can be installed on the Windows 64-bit operating system but Windows 32-bit operating system can only support the iogas 32-bit version. 2. Browse to the location of the installer file and double click on the executable file to run. If the installer file has unpacked properly the Setup Wizard screen is displayed. Click Next in the Setup Wizard to continue. If iogas is already installed on the machine the following dialog may be displayed first of all. Welcome 3 Imdex Limited December 2017

5 If you are upgrading from a previous version or re-installing the same version it should be fine to overwrite the existing installation. If you are unsure, uninstall the existing program via Control Panel or use the uninstall.exe in the installation folder before proceeding. Setup wizard 3. Read and accept the Licence Agreement and click Next to continue. A copy of this licence agreement (eula.txt) is available in the iogas installation folder on your computer for future reference. 4 Imdex Limited December 2017

6 Licence agreement 4. If there is no existing iogas installation or you selected No, install into a different directory in the first setup window, this is where you can specify the installation location. Either accept the default location (recommended) or enter the desired installation file path. If there is a previous version installed in the default location the iogas folder will already exist. The default installation folders are as follows: Windows 32-bit installation C:\Program Files\ioAnalytics\ioGAS (or C:\Program Files (x86)\ioanalytics\iogas if installed on 64-bit machine) Windows 64-bit installation C:\Program Files\ioAnalytics\ioGAS-64 Click Next to continue. 5 Imdex Limited December 2017

7 Select destination directory (Windows 64-bit operating system default location) 5. Select the Start Menu Folder name (default is shown below). The option to Create shortcuts for all users can also be selected in this window. Click Next to continue. 6 Imdex Limited December 2017

8 Setup start menu and shortcuts 6. The Select File Associations window enables the iogas application to open when an iogas file is double-clicked in Windows Explorer. Click Next to continue. 7 Imdex Limited December 2017

9 Select file associations 7. To create an iogas desktop icon, check the box in the Select Additional Tasks window. Click Next to continue. 8 Imdex Limited December 2017

10 Select additional tasks 8. Click Next to start the installation. 9 Imdex Limited December 2017

11 9. To start the iogas program either select Start>Program Files>ioAnalytics>ioGAS or doubleclick on the iogas desktop icon if created during the installation process. 10 Imdex Limited December 2017

APPLE MAC To install iogas 6.2 or later on an Apple Mac operating system the computer must be running Mac OS X 10.8.3 (Mountain Lion) or later as these versions support Java 8. iogas 6.0 6.

12 APPLE MAC To install iogas 6.2 or later on an Apple Mac operating system the computer must be running Mac OS X (Mountain Lion) or later as these versions support Java 8. iogas require Java 7 which is supported on Mac OS X (Lion) or later. Older versions of Mac OS X (Snow Leopard, etc.) require Java 1.6 to be installed, as the Java Runtime Environment (JRE) was not bundled with iogas prior to version 6.0. The latest version of iogas that can run on Snow Leopard is version Download the latest iogas Mac OS X installer file from the iogas website at Registration is required in order to download. Downloads can also be obtained via the Help>Check for Updates menu option within the iogas application. 2. Browse to the location of the installer file on the computer and double click to run. Download installer file to computer 3. If the installer file has unpacked properly the Setup Wizard screen is displayed. Click Next in the Setup Wizard to continue. 11 Imdex Limited December 2017

13 Setup wizard 4. Read and accept the Licence Agreement and click Next to continue. A copy of this licence agreement is available in the iogas installation folder on your computer for future reference. 12 Imdex Limited December 2017

14 Licence agreement 5. The Select File Associations window enables the software to open when an iogas generated file is double-clicked in Finder. Click Next to continue. 13 Imdex Limited December 2017

15 Select file associations 6. To create an iogas desktop icon, check the box in the Select Additional Tasks window. Click Next to continue. Select additional tasks 14 Imdex Limited December 2017

16 7. In the final Setup Wizard window click on the Finish button. 8. Once installed iogas will now be displayed in the Applications list: 15 Imdex Limited December 2017

17 Licence Options The following iogas licence options are available: Single Seat Licence (Perpetual) - Perpetual machine-locked licence for one computer only. Purchase price includes first 12 months maintenance (software upgrades and technical support) with optional annual fee payable after this time to continue to keep the licence maintained. Maintenance expiry dates are built into the licence file and can be viewed using the Help>About menu option. Clients are contacted when their maintenance is nearing the expiry date to organise licence renewals. Single Seat Licence (12 months) - Machine-locked licence for one computer valid for 12 months. Purchase price includes software upgrades and technical support. Floating Server Licence - One or more licence tokens shared over a network between multiple users. Tokens are borrowed from the server for a specified period and enable the software to be used offline (e.g. in the field) during this time. Tokens are automatically returned to the server when the offline time period expires or they can manually be returned earlier if required. Purchase the number of tokens to support the potential number of concurrent users of the software. Recommended for organisations with a number of users who will be using the iogas software at irregular intervals. Available as a renewable 12 month lease. Classic Server Licence - Original iogas Server Licence model. Licence tokens issued over a network to individual computers in the order in which they connected to the server, up to the total number of tokens purchased. Tokens are issued for a specified period (minimum 4 weeks to maximum 12 weeks) and enable the software to be used offline during this time. The token automatically becomes available to other users when it expires but there is no provision to return the token to the server early. Recommended for organisations with a number of users who will be using iogas on a regular basis and require the software on their computer for the majority of the 12 month lease period. Single Seat (12 month) licences for individual computers may be issued in lieu of server issued tokens if some users are unable to connect to the server or they require their own dedicated licence file. Available as a renewable 12 month lease. Academic Licences - Available as single seat (12 month) licence for a student/researcher single-user or as a Classic Server licence for multiple users within an academic institute or department. Proof of affiliation required. For all iogas purchases, enquires or to renew maintenance, please contact iogas@imdexlimited.com. 16 Imdex Limited December 2017

18 Single Seat Licensing When iogas is installed onto a computer for the first time the application will run for two weeks in evaluation mode*. After this time the application requires a valid licence file in order to operate. Two iogas single seat licence types are available: Single Seat (Perpetual) - the iogas software is purchased outright with an optional annual payment to keep the software in "maintenance". Maintenance includes access to software upgrades and technical support. A perpetual licence is locked to one computer. Single Seat (Timed) - commercial or academic licence that enables access to the iogas software for a fixed period of time (e.g. 12 months). The lease includes software upgrades and technical support. A timed licence is locked to one computer. See Licence Options for more information on available iogas licences. If you have purchased a single-seat (perpetual) or single seat (timed) licence then you will need to send us your Machine ID number in order for the licence file to be issued. SEND MACHINE ID NUMBER 1. Go to the Help>Send Machine ID menu option in iogas. Alternatively, if your trial period has expired, start iogas and click on the Send Machine ID button in the message window displayed. In both cases the following dialog is displayed: Send Machine ID 2. the Machine ID number to iogas.licence@imdexlimited.com. Use the Copy address and Copy Machine ID buttons to copy and paste these details into the . Please also include your name and organisation. Within 1 business day you will receive an iogas licence file (gas.single.glc) from our automated licensing system. * Note: The 2 week trial is not available in the Mac installation. Please contact us if you would a trial licence file and include your Machine ID number. 17 Imdex Limited December 2017

$INSTALL LICENCE FILE Microsoft Windows Copy the gas.single.glc file to the C:\ProgramData\ioGAS folder on your computer.$

19 INSTALL LICENCE FILE Microsoft Windows Copy the gas.single.glc file to the C:\ProgramData\ioGAS folder on your computer. If licensing a shared computer, this will enable all users who login to the computer to access the iogas software. The C:\ProgramData\ioGAS folder may be hidden from view on your computer in Windows Explorer. To find out how to show hidden folders for your operating system please see Microsoft Help or the iogas FAQ on our website for details. Windows licence location gas.single.glc file If iogas is already open then re-start for the new licence details to take effect. To check that iogas is licensed correctly select Help>About. The dialog should state that the licence is valid with the correct Machine ID and Licensed Days remaining on your machine. The licence name will also appear on the screen within the iogas application. Single seat (12 month) licences will have the same maintenance and licence expiry dates. 18 Imdex Limited December 2017

20 Single seat licence details in Help>About dialog 19 Imdex Limited December 2017

Browse to the Contents>Resources>app folder and copy the licence file to this

21 Apple Mac To install a single seat licence file on a Mac computer, right-mouse click on the iogas application in Finder and choose Show Package Contents: Browse to the Contents>Resources>app folder and copy the licence file to this location. Mac file path for iogas gas.single.glc file 20 Imdex Limited December 2017

22 If iogas is already open then re-start for the new licence details to take effect. TROUBLE-SHOOTING If you have any problems licensing the iogas application firstly check that the gas.single.glc file is located in the correct folder. If the licence file is in the correct folder but iogas is still not working then please send the log.txt file to The log.txt file can be found in the following location: Microsoft Windows C:\Users\Username\AppData\Roaming\ioGAS\log folder* * The AppData folder is a hidden folder. If the folder is not visible in Windows Explorer please see the FAQ for information about viewing hidden holders in Windows operating systems. Apple Mac Applications\ioGAS\Contents\Resources\app\log folder The Help>About dialog contains the build version and other information that may be useful when troubleshooting licence issues. If you are experiencing difficulties use the copy button to capture this information and send to us. 21 Imdex Limited December 2017

23 TRANSFER SINGLE SEAT LICENCE Although a single seat licence is locked to one computer there may be instances where it needs to be transferred to another computer for example, if you purchase a new computer, re-build your existing computer or a licence needs to be moved from a computer used by somebody who is no longer with your organisation. In all of these events we will need to issue you with a new licence file. To license the iogas software on the new computer: 1. Download and install the latest iogas desktop application (Windows or Mac OS X) from our website at 2. Start iogas and go to the Help>Send Machine ID menu option 3. Copy and paste the Machine ID number in this dialog into an and send to iogas.licence@imdexlimited.com 4. Upon receipt of your licence file copy it to the location outlined in the accompanying and re-start iogas 5. To view the licence expiry date and other details see the Help>About menu option *NOTE if you are a Mac user or the iogas trial period has expired, a message window with four uttons ill e displayed at step. Sele t the Send Ma hine ID utton and pro eed to step a o e. When requesting the new licence file please provide details about the licence to transfer (name and/or Machine ID number), the new licence holder name and address and the Machine ID of the new computer. If you require any assistance during this process please contact iogas.support@imdexlimited.com 22 Imdex Limited December 2017

24 Connect to Floating Server Licence If your organisation has purchased and installed an iogas Floating Server Licence, please see below for details on how to connect to the server, obtain a licence token and return the token back to the server when you have finished using it. Floating server licence tokens are shared over a network between multiple users. Tokens are borrowed from the server and can be returned manually by the user or automatically when the selected check out time expires. While a token is checked out the iogas software can be used offline (when the computer is not connected to the internet) during this time. Tokens are automatically returned to the server when the offline time period expires or they can be manually returned earlier if required. OBTAIN TOKEN 1. Start the iogas software. If the trial period is still valid, go to the Help>Licence Server Connection menu option. If you are running an Apple Mac or the iogas trial period has expired click on the Configure Licence Server button in the message window below: 23 Imdex Limited December 2017

25 2. The iogas Licence Server dialog is displayed. Default server licence configuration 3. Check the Connect to Licence Server box. 4. In the Host window enter the server name or IP address where the iogas server licence software is installed. You may need to contact your IT Administrator for this information. Enter the Port number if it is not the default Click on the Test button to make sure the network connection is working. If a "Successful connection to Floating server at PutHostHere:31415" message is not displayed or you receive any other error messages contact your IT Administrator. Otherwise click OK twice to exit this dialog and continue to this dialog: 8. Select an Offline Period (days) between 1 and 90 days (24 hours-12 weeks). The offline period is the duration for which the iogas software can be used while not connected to the server licence network. Please note that each time the software is started while connected to the server licence network however, the token offline period will automatically refresh so it will be valid from the current date. 7. Click Get Token to finish. 24 Imdex Limited December 2017

returned to the server when the selected offline period expires. A warning message is displayed when there are less than 2 full days remaining in the offline period.

26 8. Re-start iogas for the server licence token to take effect. The organisation name followed by [S] [Floating] is displayed on the screen when the program is running with a floating server licence as in the example below: RETURN TOKEN A token is automatically returned to the server when the selected offline period expires. A warning message is displayed when there are less than 2 full days remaining in the offline period. If the software is started while connected to the server licence network before the expiry date, the token offline period is refreshed so that it is valid for the selected period of time from the current date. To manually return a token to the licence server: 1. Select the Help>Licence Server Connection menu option. 2. The iogas Licence Server dialog is displayed. Click OK to continue. 3. Select Return Token. If you have unsaved edits in the currently open iogas file you will be prompted to save them. 25 Imdex Limited December 2017

27 4. When you click OK the iogas software is closed. If you experience any problems connecting to the server or obtaining a token please contact your IT Administrator for assistance. To view your iogas floating token details at any time see Help>About menu option. 26 Imdex Limited December 2017

28 Connect to Classic Server Licence If your organisation has purchased and installed a corporate or academic iogas Classic Server Licence, please follow the steps below to make a connection and obtain a token. Classic Server Licence tokens are issued over a network to individual computers in the order in which they connect to the server, up to the total number of licences purchased. Tokens are issued for a specified period (minimum 28 days to maximum 90 days) and are automatically returned to the server when the offline time period expires. While a token is checked out the iogas software can be used offline (when the computer is not connected to the internet) during this time. The token automatically becomes available to other users when it expires but there is no provision to return the token to the server early. OBTAIN TOKEN 1. Start the iogas software. If the trial period is still valid, go to the Help>Licence Server Connection menu option. If you are running an Apple Mac computer or the trial period has expired click on the Configure Licence Server button in the message window below: 27 Imdex Limited December 2017

29 2. The iogas Licence Server dialog is displayed. 3. Check the Connect to Licence Server box. 4. In the Host window enter the server name or IP address where the iogas server licence software is installed. You may need to contact your IT Administrator for this information. Enter the Port number if it is not the default Click on the Test button to make sure the connection is working. If you do not receive a "Successful connection to Classic server at PutHostHere:31415" message displayed or you receive any other error messages contact your IT Administrator. Otherwise click OK twice to exit this dialog and continue to this dialog: 6. Select an Offline Period (days) between 28 and 90 days (4-12 weeks). The offline period is the duration for which the iogas software can be used while not connected to the server licence network. 7. To enable continual use of the software check the Automatically Refresh box. This means that each time you start iogas while connected to the server licence network the token is refreshed so that it will be valid from the current date for the selected offline period number of days. If this box is not checked, the token will automatically be returned to the server when the offline period expiry date is reached. 8. Click Get Token to finish. 28 Imdex Limited December 2017

30 9. Re-start iogas for the server licence token to take effect. The organisation name followed by [S] is displayed on the screen when the program is running with a classic server licence as in the example below: If you experience any problems connecting to the server or obtaining a token please contact your IT Administrator for assistance. To view your token details at any time see Help>About menu option. 29 Imdex Limited December 2017

31 Support support is available for maintained clients. New single seat (perpetual) licences include 12 months technical support but ongoing maintenance must be purchased after this time in order to continue to receive technical support. Server and single seat (timed) licences automatically include technical support. Contact Details: Use this address to log any issues or enhancement requests and we always welcome client feedback to help us to continually improve our software. Where possible include a screen capture of the Help>About information and a copy of the log.txt files located in the C:\Users\Username\AppData\Roaming\ioGAS\log folder (Windows OS) or the Applications\ioGAS\Contents\Resources\app\log folder (Apple Mac). Note Username = your login name. 30 Imdex Limited December 2017

32 31 Imdex Limited December 2017

iogas Floating Server Installation Guide

iogas Floating Server Installation Guide December 2017 Table of Contents Floating Server Licence Model... 2 Server Software Technical Specifications... 3 Install Server Software... 4 Test Server Installation...