MultiLogger Suite Installation Guide 2016

Transcription

1 MultiLogger Suite Installation Guide 2016 Disclaimer: The following document is provided to assist users with the installation, operation and training in the use of our products. This document and our products are intended to be used by technically qualified personnel. Contained herein is information that is proprietary to Canary Systems and may not be reproduced or copied in any form, nor disclosed to outside parties by any means whether directly or indirectly, without the written consent of Canary Systems. This document is subject to change without notice and Canary Systems assumes no responsibility for errors, omissions or misinterpretation. Furthermore, Canary Systems makes no warranty as to the suitability of this information and/or products for any given application or use. Copyright Canary Systems, Inc., All Rights Reserved. Canary Systems, MultiLogger, MLSuite, MLField, and MLWeb are Registered Trademarks of Canary Systems, Inc. Microsoft is a registered trademark of the Microsoft Corporation. All other trademarks are property of their respective owners, All Rights Reserved. multilogger_suite_installation_guide_2016.docx Doc Rev Gould Road, PO Box 2155 New London, NH USA Voice: (603) support@canarysystems.com Web:

2

3 Table of Contents Section 1 Introduction System Requirements Technical Support MultiLogger Suite Installation Custom Installation Modifying the Installation Updating the Installation Launching the Applications MLGateway Setup and Activation MLServer Setup and Activation Working Files Path Integration with Active Directory Section 3 Removal MLGateway License Deactivation MLServer License Deactivation MultiLogger Suite Removal How to use this guide: Notes will appear in boxes like this, with bolded text. They contain information you need to know to ensure that you use certain features correctly, minimizing any errors. Hints will appear in boxes like this, with italicized text. They indicate tips on how to use certain features more effectively, such as any shortcuts to certain functions. When you see a folder s name in square brackets ([ ]), it indicates the root folder within a directory. There are several folders to navigate before you arrive at the folder that s bound in the brackets. For example, the Public Documents folder will appear as [Public Documents] or [Shared Docs] This is a placeholder for the directory C:\Users\Public\Public Documents. When you see a keyboard key s name in bold angle brackets (< >), this Indicates a particular keystroke you must make in order to perform certain functions.

4 Section 1 Introduction Section 1 Introduction Welcome to Canary Systems MultiLogger Suite. This is a collection of powerful desktop, server, Web, and mobile applications that monitors Instruments, collects their data, and outputs that data into different types of charts and reports. MultiLogger Suite 2016 consists of a group of desktop applications, a database server (Firebird 2.5 SQL), and a web client that runs under Microsoft Internet Information Services (IIS). There are five main desktop applications, as illustrated in the diagram below: MLGateway Manages connected dataloggers including programming and data collection. MultiLogger Client software for MLGateway. MLServer Imports automatically collected data and processes it along with other data to generate alarms and other notifications. MLWeb Works with Microsoft IIS to deploy the Firebird SQL database for browser access. Insite Database client application. MLDBConsole Database management application. 2 MultiLogger Suite Installation Guide

5 Section 1 Introduction In addition, MultiLogger Suite includes several support applications: Roobrik (not shown in illustration) For processing data collected and stored in ASCII (text) data files. Roobrik can manually or automatically generate reports, charts, and spreadsheets. MLEditor (not shown in illustration, included with MultiLogger installation) A specialized editor for MultiLogger programming files. MLSetup (not shown in illustration, included with MultiLogger installation) A tool for expanding the programming capabilities of MultiLogger. Firebird (not shown in illustration, included with MultiLogger installation) Firebird SQL server. IBOConsole (not shown in illustration) Firebird database management console (not required). This Installation Guide will provide information on running the MultiLogger Suite installer, installing IIS (for MLWeb ), updating MultiLogger Suite to a new version or a service pack, configuring MLGateway and MLServer to work with a database, and how to remove MultiLogger Suite. Firebird is a registered trademark of Firebird Foundation Incorporated. MultiLogger Suite Installation Guide 3

6 Section 1 Introduction 1.1 System Requirements MultiLogger Suite is designed to run on Microsoft Windows Server 2008, Windows Server 2012, Windows Vista, Windows 7, Windows 8, and Windows 10 operating systems. MLWeb is designed to run on the.net framework, and will work with IIS 7 or newer. Please note the following requirements. They are different if you install MultiLogger Suite on a desktop computer instead of a server. Note: Performance with larger database deployments (over 1 GB), multiple users, and large GIS image sizes will be improved with additional desktop or server memory (RAM). If the server is hosting MLWeb, MLServer, and Firebird, a minimum 16 GB of RAM is recommended. If the desktop is hosting MLWeb, MLServer, and Firebird, a minimum of 8 GB of RAM is recommended Server Installation Minimum server requirements: Operating system: Microsoft Windows Server 2008 R2 (64-bit) Processor: 2 GHz per core, 4 cores Memory: 8 GB Hard drive: 100 GB, solid state or hard disk. Separate drive or partition for database storage: 100 GB, solid state or hard disk Network speed: 1 GB LAN Screen resolution: 1024x768 Web browser: Internet Explorer 11 IIS 7.NET framework Microsoft Excel 2007 Adobe Reader X Recommended server specifications: Operating system: Microsoft Windows Server 2012 R2 (64-bit) or newer Processor: 3 GHz per core, 8 cores or greater Memory: 16 GB or greater Hard drive: 500 GB or greater, solid state or hard disk Network speed: 1 GB LAN Separate drive or partition for database storage: 250 GB or greater, a mirrored redundant array of inexpensive disks, or a solid state drive formatted with a cluster size of 16 KB Screen resolution: 1920x1080 or higher Web browsers: Internet Explorer 11, Microsoft Edge, Mozilla Firefox, or Google Chrome IIS 8 or newer.net framework or newer Microsoft Excel 2016 or newer Adobe Reader XI or newer 4 MultiLogger Suite Installation Guide

7 Section 1 Introduction Desktop Installation Minimum system requirements: Operating system: Microsoft Windows Vista Processor: 2 GHz Memory: 4 GB Hard drive: 100 GB, solid state or hard disk. Screen Resolution: 1280x768 Web browser: Internet Explorer 11, Microsoft Edge, Mozilla Firefox, or Google Chrome IIS 7.NET framework Microsoft Excel 2007 Adobe Reader X Recommended system specifications: Operating System: Windows 10 (64-bit) or newer Processor: 3 GHz or greater Memory: 8 GB or greater Hard drive: 200 GB or greater, solid state or hard disk Screen Resolution: 1920x1080 or higher Web browsers: Google Chrome IIS 8 or newer.net framework or newer Microsoft Excel 2016 or newer Adobe Reader XI or newer Windows, Windows Server, Excel and Internet Explorer are registered trademarks of the Microsoft group of companies. Adobe and Reader are registered trademarks of Adobe Systems Incorporated. MultiLogger Suite Installation Guide 5

8 Section 1 Introduction 1.2 Technical Support Check the About box in MultiLogger, MLDBConsole, or Insite for contact details. You can also visit the Canary Systems website by clicking on the company s logo in MLWeb. Canary Systems may be contacted directly via phone or . Canary Systems, Inc. 5 Gould Road New London, NH Phone: (603) support@canarysystems.com Note: Support updates are available from the support area of The 2016 version is free for users of MultiLogger 2015 with an active support contract. Upgrading from older versions may be subject to upgrade fees. Contact your software vendor or Canary Systems directly for more information. Our website also provides numerous Application Notes and all the latest User s Guides. Visit the Support page at to access these resources. 6 MultiLogger Suite Installation Guide

9 The MultiLogger Suite software is available in two formats: a USB flash drive or from a downloaded installer. The current MultiLogger Suite installer is available from the support area of our website, at When installing from the download, browse to the designated download folder to find the MultiLoggerSuite2016.x32 or MultiLoggerSuite2016.x64 installation program and double-click it. This will launch the installer. When installing from a USB flash drive, launch the appropriate installer, either MultiLoggerSuite2016.x32 or MultiLoggerSuite2016.x64 Note: When installing a service pack version of the software, the number of the service pack will be included in the installer s name. For example, the installer for MultiLogger 2016 Service Pack 1 would appear as MultiLoggerSuite2016SP1.x32 or MultiLoggerSuite2016SP1.x64. If installing MultiLogger Suite on a web server, we recommend that you configure IIS and install the latest version of the NET framework on the computer or server prior to running the MultiLogger Suite installer. Note: The following example is for a new installation of MultiLogger Suite on a Windows Server 2012, 64-bit system with Admin user rights. The installation process, particularly for file locations, on your operating system may vary, especially with desktop operating systems, such as Windows 7 or Windows 8. MultiLogger Suite may be installed on any computer. However, if User Account Controls restrict the installer from making changes to it, the screenshot at right will appear. Enter the administrator s credentials on the User Account Control form, shown at right, to continue the installation. Click Cancel at any time to terminate the installer. MultiLogger Suite Installation Guide 7

10 Once the installer is ready, you will be prompted to continue. Click Next to proceed. The End-User License Agreement (EULA) will display in a viewing window. Please read the agreement entirely. It may also be printed for later review and reference purposes by clicking the Print button. Select I accept the terms in the license agreement to indicate agreement, then click Next to continue. 8 MultiLogger Suite Installation Guide

11 You will be prompted to designate the path for the program files installation. Typically, a path in the Program Files folder is used. Click the Change button to specify an alternate path. Otherwise, click Next to continue with the default path. Note: Users with Administrative rights will have the default installation path of C:\Program Files \MultiLogger\. Users without Administrative rights will have the default installation path of C:\MultiLogger. MultiLogger Suite Installation Guide 9

12 The Custom Setup form is shown next. By default, MultiLogger Suite and its subordinate applications are selected, while MLWeb and IBO Console are deselected. This is the most common installation type; see Section 2.1 for further information. Note: MLWeb will be available only when MultiLogger Suite is installed with Administrator user rights. Specific applications can be selected by clicking on the icon and changing their installation options. You can install just the main feature or install the main feature plus all of its subfeatures by selecting either of the first two options in the menu. You can also omit a feature from the installation by selecting This feature will not be available from the menu 10 MultiLogger Suite Installation Guide

13 2.1 MultiLogger Suite Installation Typically, the MultiLogger Suite option is selected. This will install all the programs required to run MultiLogger Suite on a local computer. Click Next to continue. The MultiLogger Suite program files will then be copied to the destination folder. MultiLogger Suite Installation Guide 11

14 The following screen will appear, indicating a successful installation. Click Finish to complete the installation. Also note the Desktop shortcuts that have been created: Note: MLGateway, MLServer, and Firebird servers are installed as services if the installation is performed by a user with Administrator rights. This allows the servers to automatically run without requiring a user login. Otherwise, the servers are installed as applications when a non-administrator user runs the installation; applications require a user s login to run. The installer is accessible from the Control Panel, under Programs and Features. It can be used to uninstall MultiLogger Suite, and it can be used to modify or repair an installation. See Sections 2.3 and 2.4 for more information. 12 MultiLogger Suite Installation Guide

15 2.2 Custom Installation Custom installations are used to install features that are not included with the default MultiLogger Suite setup namely MLWeb and IBOConsole. A custom installation can be performed by selecting the desired programs from the list and omitting others. Clicking Help will display the Custom Setup Tips window. A custom installation can be used to create MultiLogger Workstations. Creating a workstation means that only client programs need to be installed locally because MultiLogger servers are installed elsewhere. MultiLogger Suite Installation Guide 13

16 For example, consider a scenario where MultiLogger servers (MLGateway, MLServer, and Firebird) are installed on a networked computer, and a user wants to set up a workstation with Insite and MLDBConsole on their local computer. The user can perform the following custom installation: Follow the previous installation steps until the Custom Setup form is shown. Then select only the features that are needed for the workstation, and any subfeatures associated with them, if desired, and click Next. In the example above, the user is installing Insite and MLDBConsole on their computer. This will allow the user to connect to the database and use Insite and MLDBConsole as if they were on the server itself. After the desired programs are selected, the installation will proceed as it did in the previous section. Click Finish to complete the installation. Note: The Custom Setup dialog must be used to install IBOConsole and MLWeb. Firebird ODBC 32 and 64-bit installers can be downloaded from If Firebird server was already installed on the same machine, then it will not appear as an option in the list of programs to install. 14 MultiLogger Suite Installation Guide

17 2.2.1 MLWeb Installation When installing MLWeb, make sure IIS is configured on the server or computer, as detailed in the following sections. The server or computer that will run MLWeb must have IIS and the.net framework installed in order for MLWeb to run. The following instructions detail a new installation of IIS 8 on a server running Windows Server Open the Server Manager if it is not already open. The Dashboard will appear, showing the configured Roles and Server Groups: MultiLogger Suite Installation Guide 15

18 Click on Local Server to view the Properties, Events, Service, etc. for the local server. Scroll to the very bottom to view the already installed Roles and Features, then click on the Tasks pull-down menu. Select Add Roles and Features to add IIS as a Role: Next, the Add Roles and Features Wizard will appear. Follow these steps to install IIS: 1. Read the steps in the Before You Begin section of the wizard. Once you take note of them, click Next. 2. On the Installation Type section of the wizard, choose Role-Based or feature-based installation and click Next. 3. On the Server Selection section of the wizard, choose Select a server from the server pool. Typically, there will only be one server to select, and it will already be highlighted. Click Next to proceed. 4. On the Server Roles section of the wizard, scroll down to Web Server (IIS): 16 MultiLogger Suite Installation Guide

19 5. Check the IIS box. This will bring up a menu that asks you to add features to the server. 6. Confirm that the Include Management Tools box is checked and add the displayed features to IIS by clicking Add Features. Click Next on the following screen, which shows Web Server (IIS) checked. 7. Next, the Features section of the wizard will display, showing the installed features. Be sure to expand and install all sub features of.net Framework 3.5 Features and.net Framework 4.5 features. Click Next. 8. Read the information about Web Server Roles, then click Next and select Role Services from the list. Install the following Roles and all subcomponents: Common HTTP Features Install all subcomponents. Security Install all subcomponents. Application Development Features Install all subcomponents. Management Tools Install IIS Management Console and IIS Management Scripts and Tools only. Click Next after all selections have been made. 9. Confirm that all roles, role services, and features have been selected, then click Install. Installation may take several minutes to install. Upon the successful installation, click Close. Restart the server if prompted to do so. MultiLogger Suite Installation Guide 17

20 After IIS 8 is installed, open the Start menu and click Administrative Tools. Then select Internet Information Services (IIS) Manager. Further configuration of IIS 8 can be performed through this menu. When you install MLWeb, its files will be installed in the directory C:\inetpub\wwwroot. During the installation, you will also configure the Web Application for the website. The default Web Application is Default Web Site/, shown below. Click Next to continue the installation as detailed in Section MultiLogger Suite Installation Guide

21 2.3 Modifying the Installation After initial installation, the same installer can be run again to add or remove MultiLogger features, repair installation errors, or uninstall MultiLogger Suite. To install or uninstall specific components after the initial installation has been completed, simply re-run the installer and select Modify, Repair, or Remove from the Program Maintenance dialog. Modify Click Modify and Next to display the Custom Setup form. Here, features can be added or removed. Repair Select this option and click Next to fix installation errors in the program. Remove Select this option to uninstall MultiLogger Suite from the computer or server. You can also run the installer from the Control Panel, in the Programs and Features menu. Select MultiLogger Suite from the list and select Uninstall, Change, or Repair to perform the operations described above. MultiLogger Suite Installation Guide 19

22 2.4 Updating the Installation Updating an installation of MultiLogger Suite to a newer version requires running the installer of a newer version. There are two types of updates you can perform: a full version upgrade or a service pack upgrade. Each is described below. Note: Prior to upgrading, it is highly recommended to back up the CanarySys folder and put it in a safe place. For older versions, such as MultiLogger v4, it is recommended to back up the MultiLogger folder Full Version Update Whenever a new version of MultiLogger Suite is launched, you can download it from Canary Systems website, or obtain a copy on a flash drive. Follow the instructions detailed in Sections 2.1 through 2.3 to install and set up the new version s software Service Pack Update Service pack updates for the currently supported versions will be periodically uploaded to Canary Systems website. The installation for the upgrade can be downloaded, and when the file is opened, the following dialog box will appear: Click Yes and follow the installation s instructions to update the currently-installed version of MultiLogger Suite to the newer version. Click Next and, after a successful installation, click Finish. 20 MultiLogger Suite Installation Guide

23 2.5 Launching the Applications Once the MultiLogger Suite installer completes, shortcuts will be added to the desktop. Applications can also be launched from the \Program Files\MultiLogger folder (default), or shortcuts can be placed in the Startup folder so applications are launched when a user logs in. A MultiLogger Suite group in the Start menu will be created by the installer; this provides shortcuts to the primary applications installed. When MLWeb is installed and configured on the local computer or server, you can access it from a Web browser. Type in the browser s address bar to visit the admin page, where you can configure the websites on the server. When you log into a website, the browser brings up the MLWeb interface for that website. Double-click the desktop icons to run the applications. The MLSetup shortcut opens another application to allow you to configure a datalogger s programming library. Use the MLGateway and MLServer shortcuts in the Start menu to open each application s Control Panel when they are installed as services. If they were installed as applications, you can launch their Control Panels from the Start menu, or by clicking their icons in the desktop tray at the right end of the Taskbar. Note: If MLGateway and MLServer are already running in the background, additional instances will NOT be launched when you click on their shortcut icons. The Control Panels for the currently running instances will display. The Firebird Server Control can be accessed from the Control Panel. If MLServer and MLGateway are installed as services, then they can also be started or stopped using the Services panel. The Services panel can be accessed from the Administrative Tools group in the Start menu. See the MultiLogger User s Guide for more information on running MultiLogger. See the MLDBConsole User s Guide for more information on running MLDBConsole and MLServer. See the Insite User s Guide for more information on running Insite. See the MLWeb User s Guide for more information on running MLWeb. MultiLogger Suite Installation Guide 21

24 2.6 MLGateway Setup and Activation MLGateway is designed to operate as a server; MultiLogger is simply a client of MLGateway. MLGateway performs all the actual functions related to system management, programming, monitoring, and data collection. The following illustration depicts the interaction of the various software components included with MultiLogger Suite. These various software components may be distributed throughout a LAN/WAN connected group of computers or all the applications, including the database server, may be installed and running on the same computer. Note: When MultiLogger connects to MLGateway, make sure it is connecting to a compatible version. If the version of MultiLogger is not compatible with MLGateway, then one or both installations may need to be updated to the current versions. MLGateway performs the following functions: Multi-user access to dataloggers and other hardware. MultiLogger text and graphical monitoring functions. Automation of data collection. Automation of database data import (using MLServer). Note: If MLGateway is installed by a user with Administrative permissions, MLGateway will install as a service. If installed as a non-administrator user, MLGateway will install as an application. Running as a service provides the advantage of not requiring a user to be logged in for MLGateway to function. 22 MultiLogger Suite Installation Guide

25 2.6.1 MLGateway Control Panel Interface The MLGateway Control Panel is shown below. It provides status information as well as buttons to access the various forms and functions. The Function Buttons perform the following actions: Settings Configures the Port used for MultiLogger to MLGateway communications. License Configures the MLGateway license. Deactivate Deactivates the MLGateway license. See Section 3.1 for more information. Log File Displays the log file viewer. Help Displays the help file. About Displays the current version and support contact information, shown at right MLGateway Startup As a Service (Administrator Users) If MLGateway was installed as a Service, open the interface by clicking on the MLGateway icon in the MultiLogger Suite group in the Start menu. The Control Panel interface, shown above, functions similarly when MLGateway is run as an application. Note: Closing the Control Panel does not close MLGateway. To exit, you will need to stop the Service using the Windows Services form and then uninstall it as a service. See the following section for more information MLGateway Startup As an Application (Non-Administrator Users) After installation, MLGateway will be started automatically and also placed into the Startup group to the to launch after the computer reboots. Note the MLGateway icon, Taskbar., in the tray area to the lower right of the Double-click to display the console, shown on the previous page. Click the X in the upper right corner of the form to close the form. Note: Closing the form does not close MLGateway. To exit, right-click on the icon in the tray to display the pop-up menu, then select Exit. MultiLogger Suite Installation Guide 23

26 2.6.4 MLGateway Switching between Service and Application operation Note: You must be logged in as an Administrator, or run Command Prompt as an Administrator to switch MLGateway between service and application operations. If installed and running as a service, follow these steps to convert to application operation: 1. Go to Control Panel Administrative Tools Services. Locate the MLGateway entry, right-click it and select Stop. The Services view should update to show that the service stopped. 2. Open a Command Prompt from the Start Accessories group in Windows 7 or Windows Server 2008 (this is located in the Windows System group of the Start menu in Windows 8 and Windows Server 2012). Make sure you run the Command Prompt as an Administrator. If necessary, right-click the Command Prompt icon and select Run as Administrator from the list of options. Log in with the Administrator credentials on the User Account Control form and the Command Prompt will open with C:\Windows\system32> in the initial command line. 3. Change to the folder where MultiLogger is installed. If the default installation folder was used, then enter cd \program files\multilogger <ENTER>. A new command line with the directory will appear. 4. Unload MLGateway as a Service by typing mlgateway /uninstall <ENTER>. A message will display to indicate a successful unloading of the Service. Close the Command Prompt by typing exit <ENTER>. 24 MultiLogger Suite Installation Guide

27 5. Locate the MLGateway icon in the Programs MultiLogger group. Click it to launch the application. 6. Include a shortcut to MLGateway in the Startup folder so when the computer boots, it will automatically launch as an application. If installed and running as an application, follow these steps to convert to service operation: 1. Right-click the MLGateway icon in the system tray,, and select Exit from the pop-up menu to exit the application. For Windows 7 and Windows Server 2008, go to Start All Programs Startup and locate the MLGateway icon. Right-click it and select Delete to move the shortcut to the Recycle Bin. 2. Open a Command Prompt from the Start Accessories group in Windows 7 or Windows Server 2008 (this is located in the Windows System group of the Start menu in Windows 8 and Windows Server 2012). Make sure you run the Command Prompt as an Administrator. 3. Change to the folder where MultiLogger is installed. If the default installation folder was used, then enter cd \program files\multilogger <ENTER>. A new command line with the directory will appear. 4. Start MLGateway as a Service by typing mlgateway /install <ENTER>. MultiLogger Suite Installation Guide 25

28 A message will display indicating a successful loading of the Service. Close the Command Prompt by typing exit <ENTER>. 5. The Service must now be started. Go to Control Panel Administrative Tools Services. Locate the MLGateway entry, right-click and select Start Service. The Services view should update to show it started MLGateway Licensing and Activation MLGateway must be licensed and activated on each machine where it is running. There are two steps: 1. Enter the License Key 2. Obtain the Authorization Code (activation) Enter the License Key Click the License button on MLGateway to display the License Activation form. Alternately, open MultiLogger and select File MLGateway License to display the form. At startup, the License Key is blank, enter the key supplied with the MultiLogger Suite documentation. This is usually found on the Final QA Report form supplied by Canary Systems. Click Demo Key to obtain a 30-day demo key. Obtain the Authorization Code (activation) After entering the License Key, MLGateway must be activated. Click the Activate button on the Control Panel to begin the activation process. If registration information has not been entered on this computer, you will first be prompted to complete the Product Registration Form, shown at right. You will need to fill out First Name, Last Name, Company, Country, City, State, Postal Code and at a minimum, filling out the remaining fields is recommended. Once the form is complete, click Activate (the button shows Update if registration information has been previously entered) to attempt connecting to our Authorization Code Server to obtain your Authorization Code. Note: Your computer requires Internet connectivity for the automated Authorization Code delivery to function. If you are unable to use the electronic system, call Canary Systems Software Support at ext. 302 to authorize the software over the phone. If all fields are entered correctly, the License Key is valid, and the computer has Internet connectivity, the Authorization Code will be uploaded into the appropriate form field, and the software will be activated. 26 MultiLogger Suite Installation Guide

29 The following messages may display during the process: Authorization Granted Thank you for registering. You have succeeded in activating the software. A required field is blank. This displays because one of the required fields isn t filled in. The fields in bold are required fields. Click OK to return to the Product Registration Form, complete the form, and click Activate again. The License Key is not valid. The format is incorrect or the number is not valid. Verify that the License Key is entered correctly. The Vendor is not valid (can be blank). The Vendor field is not filled out correctly this is usually the result of incorrect spelling. If the software was provided directly by Canary Systems, then leave Vendor blank. Contact your vendor to clarify the exact entry of the field. Unable to reach the Canary Systems Authorization Server. This is usually due to lack of Internet connectivity on the computer attempting to activate the software. This may be due to Firewall configuration or network security configuration. If applicable, contact your systems administrator for assistance in resolving the issue. If you are unable to resolve the connectivity issues, the product must be registered offline. First, you will need to restart the software, and then click Register and Print on the Product Registration Form after you complete it. Fax or this form to Canary Systems or your software vendor. You will receive an Authorization Code that must be manually entered into the Software Activation form to activate the software. You may also call or Canary Systems or your software vendor to obtain your Authorization Code. Software Authorization inactive. This may be the result of incorrect configuration of the authorization server. Double-check the License Key entry. If it fails again, contact your vendor or Canary Systems directly. Demo Authorization Denied Too many requests. MLGateway can be activated with a demo Authorization Code, which lasts 30 days. This period can be extended, but by default, it expires after a single period. Contact your vendor or Canary Systems if you require a longer demo period. Authorization Failed. There was an error in the negotiation for the Authorization Code. Try clicking Activate again and if it fails again, contact your vendor or Canary Systems for further direction. MultiLogger Suite Installation Guide 27

30 2.7 MLServer Setup and Activation MLServer is the application included with the MultiLogger Suite software that is integral to managing databases and notifications. It performs the following functions: Licensing of the database. Processing data sent to it by MLGateway. Processing data collected by other systems and/or software though import folders. Processing data in the database and generation of alarms and other notifications. Processing and generation of automated outputs. Management of MultiLogger gateway lists. It can be deployed as an application or as a Windows service. If the user installing MultiLogger Suite has Administrator rights, then it will be installed as a service. Otherwise, it will install as an application. Running as a service provides the advantage of not requiring a user to be logged in for MLServer to function. Several notification methods are available including , pager, COM port (e.g. sending a command string out a serial port of the PC), and digital I/O port events (e.g. using a Keithley digital I/O card to activate a dialer or other attached notification device and running executables). See the Insite User s Guide for more information on configuring and using these notification methods MLServer Control Panel Interface The MLServer Control Panel is shown at right. It provides status information as well as buttons to access the various forms and functions. Note: The Operating Time is shown in ddd:hh:mm:ss format, where; ddd=days, hh=hours, mm=minutes, ss=seconds. The Function Buttons perform the following: Mail Displays the Configure Mail Messaging form. Databases Displays the Configure Databases form. Import Displays the Configure DB Import form. Backup Displays the Configure DB Backup Tasks form. Log File Displays the Log File viewer. Help Displays the main on-line help topic. About Displays the current version and support contact information. Keithley is a registered trademark of Keithley Instruments, Inc. 28 MultiLogger Suite Installation Guide

31 2.7.2 MLServer Startup As a Service (Admin User Default) After installation, MLServer will be started automatically. To access the Control Panel Applet, browse to the Programs MultiLogger group and click MLServer. A view of the Control Panel Applet is shown below. Click the X in the upper right corner of the form to close the form MLServer Startup As an Application After installation, MLServer will be started automatically and also placed into the Startup group in the Start menu to launch after the computer reboots. Note the MLServer icon,, in the tray area to the lower right of the Taskbar. Double-click to display the console, shown above. Click the X in the upper right corner of the form to close it. Note: Closing the Control Panel does not close MLServer. To exit, right-click on the icon in the tray to display the pop-up menu, then select Exit MLServer Startup As Service If MLServer was installed as a service, no icon will display in the tray. To manage the configuration of MLServer, run the MLServer program in the MultiLogger Programs Group. The form above functions similarly to when operated as an application. Note: Closing the form does not close MLServer. To exit, you will need to stop the Service using the Windows Services form and then uninstall it as a service. See the following section for more information MLServer Switching between Application and Service Operation Note: You must be logged in as an Administrator, or run Command Prompt as an Administrator to switch MLServer between service and application operations. If installed and running as a service, follow these steps to convert to application operation: 1. Go to Control Panel Administrative Tools Services. Locate the MLServer entry, right-click it and select Stop. The Services view should update to show it stopped. 2. Open a Command Prompt from the Start Accessories group in Windows 7 or Windows Server 2008 (this is located in the Windows System group of the Start menu in Windows 8 and Windows Server 2012). Make sure you run the Command Prompt as an Administrator. If necessary, right-click the Command Prompt icon and select Run as Administrator from the list of options. Log in with the Administrator credentials on the User Account Control form and the Command Prompt will open with C:\Windows\system32> in the initial command line. MultiLogger Suite Installation Guide 29

32 3. Change to the folder where MultiLogger is installed. If the default installation folder was used, enter cd \program files\multilogger <ENTER>. 4. Unload MLServer as a Service by typing mlserver /uninstall <ENTER>. A message should display indicating successful unloading of the service. Close the command prompt by typing exit <ENTER>. 5. Locate the MLServer icon in the MultiLogger group in the Start menu. Click it to launch the application. 6. Include a shortcut to MLServer in the Startup folder so when the computer boots, MLServer will automatically launch as an application. If installed and running as an application, follow these steps to convert to service operation: 1. Right-click the MLServer icon in the system tray,, and select Exit from the pop-up menu to exit the application. For Windows 7 and Windows Server 2008, go to Start All Programs Startup and locate the MLServer icon. Right-click it and select Delete to move the shortcut to the Recycle Bin. 30 MultiLogger Suite Installation Guide

33 2. Open a Command Prompt from the Start Accessories group in Windows 7 or Windows Server 2008 (this is located in the Windows System group of the Start menu in Windows 8 and Windows Server 2012). Make sure you run the Command Prompt as an Administrator. 3. Change to the folder where MultiLogger is installed. If the default installation folder was used, enter cd \program files\multilogger <ENTER>. A new command line with the directory will appear. 4. Start MLServer as a service by typing mlserver /install <ENTER>. A message should display indicating successful loading of the service. Close the Command Prompt by typing exit <ENTER>. 5. The service now must be started. Go to Control Panel Administrative Tools Services. Locate the MLServer entry, right-click and select Start Service. The Services view should update to show it started. MultiLogger Suite Installation Guide 31

34 2.7.6 Configure Mail Messaging The Configure Mail Messaging form in MLServer configures how MLServer will send s and notifications, i.e. how to connect to the mail server and how to use it. Note: This example assumes you have SMTP service available on your LAN. Contact your System Administrator to verify availability and access to the SMTP services based on your login. TCP/IP Connection Select LAN Connection from the Connection drop-down list to select a LAN Connection for sending , or select from available dial-up or other network connections that are available. An example configuration is shown at right. Server - This is the domain name for the SMTP server, alternately an IP may be specified. Verify with your System Administrator the correct setting. Port The default SMTP port is 25, verify with your System Administrator the correct setting. User Name This is your SMTP account name, verify with your System Administrator the correct setting. Password Enter the password required to use the SMTP server, leave blank if no password is required. Note: When using dial-up networking, the Port, User Name and Password fields are usually left blank. From Generally this is your User Name followed by the domain originating the . It usually does not matter what name is entered here, however some SPAM filtering software may reject mail which does not have a valid From recipient identified. From Name This is usually your proper name, minus convention. Attach Data File Check to attach the notification information as a file instead of including the contents of the message within the body. Test Click to send a test to verify the mail server connection and configuration. A dialog will display, prompting for the to send the test message to, shown at right. Enter a valid address and click OK, or click Cancel to abort. Some common errors are shown below: Host Not Found Check the Server entry for correct server name. Connection Timed Out Check the Port setting or check for proper firewall configuration. Incorrect Authentication Data Check the User Name and Password. Modem Select the Modem to be used for dial-up networking connections. The list of available modems is supplied by the operating system, if the list is blank check the installed modems. 32 MultiLogger Suite Installation Guide

35 The form buttons have the following functions: Click to display the help file. Click to accept all changes to the Configure Mail Messaging form. Click to cancel all changes to the Configure Mail Messaging form Configure Databases Use the Configure Databases form to configure which databases will be processed for alarms and other notifications. It also manages the database licensing. The form is a grid view of currently configured databases. Hint: The column widths can be adjusted and are saved automatically. Usually, the database entries are already configured on the system and retrieved by MLServer. MLDBConsole or Insite. These applications will configure the database entries during the Database Configuration step. Alternately, MLServer may be used to configure the database entries directly. Active Indicates whether the database will be actively polled for new alarms and output events. Databases may be configured but not polled for Alarm or Output Events. Alias This field is read-only and is populated from the name of the database file as found at the configured Path. Licensed Shows the status of the licensing for the selected database, including an option to configure the licensing. Server Enter the server name or IP address of the database server that is managing the database. Enter localhost for the database server on the same machine running MLServer. Path Enter the path to the database, whether on the local or remote machine. Clicking in the edit displays the file browse button in the edit, this may be used to browse to the database file. Username Enter the Username to be used for logging in to the database. The default administrator account name is sysdba. Password Enter the Password to be used for logging in to the database. The default administrator password is masterkey. MultiLogger Suite Installation Guide 33

36 The form buttons have the following functions: Display the Configure Databases help topic. Click to accept all changes to the Configure Databases form. Click to cancel all changes to the Configure Databases form. The grid control at the lower left of the view manages the grid contents: The buttons have the following functions: Advance to the first record in the grid. Advance to the previous record in the grid. Advance to the next record in the grid. Advance to the last record in the grid. Create a new record. Delete the currently selected record. Save the current record s contents. Cancel the changes made to the current record. To add a database and license it, follow these steps: First, click to a new record. The grid will update with the non-configured entry: 34 MultiLogger Suite Installation Guide

37 Click in the Path edit to display the file browse button and field. Browse to the database file and click Open, the grid should update with the new database. Now complete the Username, Password and Active options. The administrator account, sysdba should be used for MLServer. Enter the default sysdba password, masterkey; if it was changed (recommended), then enter the correct password. Selecting Active will also check whether the database is licensed. If it is correctly licensed, then the grid view will update with the number of licensed elements, as shown below: MultiLogger Suite Installation Guide 35

38 Hint: If the database was already configured using MLDBConsole or Insite, the Username and Password fields, along with the Active option, will still need to be completed. If the database is not licensed correctly, an error message will display, shown at right: Each database can accommodate up to 50 elements without the need for additional licensing. However, support obtained from Canary Systems will require a Support Contract. You can purchase license keys to increase the amount of available elements in the database. Please contact Canary Systems for more information. A database becomes unlicensed when the number of elements exceeds the license s limit, such as 51/50. In that case, the database needs additional licenses, click the ellipsis button ( ) to display the Database Licensing form, shown below. The Database Licensing form manages the licenses for each database. The form is a grid view of currently added License Keys and corresponding Authorization Codes, along with the number of Elements that the License Key provides. Database licensing is based on the number of active Data Elements. The grid control at the lower left manages the grid contents. The buttons have the following functions: Advance to the first record in the grid. Advance to the previous record in the grid. Advance to the next record in the grid. Advance to the last record in the grid. Create a new record. Delete the currently selected record. Note: If the server has Internet access, clicking the delete button will delete the database License Key record from the Canary Systems licensing database, which allows the database License Key to be used for another database or on another server. To add a database license, follow these steps: First, click to add a new record. The License Key form will then display. License Keys are 16-character hexadecimal keys that provide for adding Data Elements to the database license, they are obtained from Canary Systems directly. 36 MultiLogger Suite Installation Guide

39 Enter the database s License Key, then click Activate to obtain an Authorization Code to activate the license. The License Key also encodes information regarding the vendor. If registration information has not been previously submitted, it may also be necessary to fill out a Registration Form. Click Register to launch the form. Note: An Internet connection is required to use the electronic activation system. Contact Canary Systems directly if the License Key must be activated manually. If activation is successful, a message will display; clicking OK will return to the Licensing Form. Contact Canary Systems for assistance with any error messages that display. The Licensing Form will update with the License Key entered, the Authorization Code obtained, and number of Data Elements licensed. Multiple licenses can be added to each database to increase the number of available licensed Data Elements. Click Close to return to Configure Databases form, it should update to show proper Licensed status. MultiLogger Suite Installation Guide 37

40 2.8 Working Files Path MultiLogger Suite 2016 uses the Public Documents folder, available in the directory C:\Users\Public, to store user-customized or user-created files. This path is known as the [Public Documents] or [Shared Docs] folder. The [Shared Docs] path is used for all user-customized or user-created files. These include additions or modifications to the MultiLogger programming options, units configuration, datalogger configuration files, and collected data files, among others. Only program files and other non-customizable files are now stored in Program Files\MultiLogger (or an alternate installation path, if it was changed). Hint: The MultiLogger Suite installation will add a CanarySys shortcut to the desktop. To find the user-created files for each application on Windows Server 2008 or Windows Server 2012, open My Computer, and open the Local Disk (C:) drive. Next, browse to Users Public Public Documents CanarySys. Notice the subfolders in CanarySys for each application. To find the user-created files for each application on Windows 7 or Windows 8, open My Documents and browse to Public Documents CanarySys. Notice the same subfolders for each application. 38 MultiLogger Suite Installation Guide

41 2.9 Integration with Active Directory MLSuite allows to use Active Directory user accounts to log into a project s database in MLWeb, Insite, and MLDBConsole. This section describes additional steps needed for integration with Active Directory Configuring MLServer Open Services (available from Start > Administrative Controls) and right-click on the MLServer entry. In the Log On tab, ensure that MLServer is logged in via the Local System account. 2,9,2 Configuring IIS Make sure Windows Authentication is enabled under Security settings of the IIS Roles and Features Wizard. MultiLogger Suite Installation Guide 39

42 2.9.3 Configuring MLWeb First, open the IIS Manager and expand the local server s entry in the tree view on the left. Click on Application Pools and ensure MLWeb has LocalSystem as its Identity. Then, open the admin page ( in a Web browser to let MLWeb complete one-time initialization of User Authentication. If it does not complete the initialization, the following error message will display at the bottom of the admin page: Cannot configure windows authentication. Filename: redirection.config. Error: Cannot read configuration file due to insufficient permissions If this happens, the security permissions for the folder with IIS s configuration files must be modified. Browse to the following directory: C:\Windows\System32\inetsrv\config. Open the config folder and right-click on a blank part of the folder to view its Properties. In the Security tab, click on the SYSTEM account in the Groups or user names list. Ensure that SYSTEM has Full Control in the Permissions list at the bottom of the form. If it does not, click the Edit button and check the Allow box for Full Control. 40 MultiLogger Suite Installation Guide

43 2.9.4 Configuring Active Directory Open the Active Directory Users and Computers application from the Start menu and browse to the Computers group under the local domain. Double-click on the server where MLWeb is installed (TEST- SP in this example) to bring up its properties. Click on the Delegation tab and select the option Trust this computer for delegation to any service (Kerberos only). The same is required for the server where MLServer is installed. MultiLogger Suite Installation Guide 41

44 2.9.5 Configuring browsers Now you must configure the browser settings to trust MLWeb as part of the local intranet, to allow Active Directory to be used for user authentication. The configuration procedure depends on the browser you will use. Internet Explorer 10 In Internet Explorer 10, the automatic logon should be enabled for the server s Local intranet, and the name of the server should be part of the intranet. For Windows Server 2012, Windows 10, and Windows 8, open the Control Panel and double-click on Internet Options. In the Internet Properties window, select the Security tab and choose Local intranet. Then, adjust the security level for the Local Intranet by clicking the Custom level button. The Security Settings form will display, shown at right. Scroll down to the User Authentication settings, and in the Logon options group, click on Automatic logon only in Intranet zone. This will allow users in Active Directory to log into MLWeb automatically. Next, the server where MLWeb is running must be added to a list of sites on the Local intranet. In the Internet Properties window, with the Local intranet still selected, click on the Sites button. The Local intranet form will display. Add the following website to the Local intranet: of the server with MLWeb). In the example below, the website will be added to the zone. Click Add to add the site to the Websites list below. This will allow you to access the host server from a Web browser on any computer in the Local intranet. 42 MultiLogger Suite Installation Guide

45 For Windows 7, the form that appears when you click the Sites button in the Internet Properties window is slightly different. By default, you can automatically detect the Local intranet by checking the Automatically detect intranet network box in the form and all websites in the intranet will be available to view in a Web browser. You can also manually add the host server to the Local intranet by clicking on Advanced in the form. This brings up the same Local intranet form from the Windows Server 2012 example. Add the host server to the list by typing the following URL into the field: of the host server), and click Add. Now the server s website can be accessed as part of the Local intranet. MultiLogger Suite Installation Guide 43

46 Mozilla Firefox In Mozilla Firefox, the host server must be defined in some of the browser s preferences, so Active Directory can be used in MLWeb. Open up a browser window and type about:config in the address bar. The following warning message will display: Click I ll be careful, I promise! to proceed to the list of preferences. In the Search field, type in network.negotiate and a list of preferences with the prefix network.negotiate will appear. To change the value for each preference. Right-click the Value field and select the appropriate option from the menu Toggle or Modify, depending on the preference type. Make the following changes to the following preferences, as described in the table below: Preference Name network.negotiate-auth.allow-non-fqdn network.negotiate-auth.delegation-uris network.negotiate-auth.trusted-uris Action Toggle the Value to true. Modify the string to the name of the host server. Modify the string to the name of the host server. 44 MultiLogger Suite Installation Guide

47 Now, Firefox can use Active Directory when logging into MLWeb. Google Chrome Note: Make sure Google Chrome is closed before authorizing the host server in it. In order to authorize the host server in Google Chrome, you must edit the browser s registry files in the Registry Editor. In the Start menu, type regedit.exe in the Search field. Click on the result to open the Registry Editor. In the Registry Editor, expand the HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE group and browse to the SOFTWARE\POLICIES subgroup. Right-click the Policies subgroup and select New>Key from the popup menu. Then, rename the New Key #1 to Google. In the Google key, add a subordinate key and rename the New Key #1 Chrome. Open the Chrome key subgroup and right-click the grid view. MultiLogger Suite Installation Guide 45

48 Select New>String Value from the popup menu and rename the New Value #1 string AuthServerWhitelist. The Type for this string will be REG_SZ. Double-click the string and an Edit String form will appear. Add the name of the host server to the Value data field, shown below. The Value data must match the name of the site binding set in IIS. In this example, the data for the string will be test-sp. Click OK to confirm the new value data for the string. Add another new string to the Chrome subgroup. Rename the New Value #1 AuthNegotiateDelegateWhitelist. Double-click the string and add the name of the host server to the Value data. In this example, the data for the string will be test-sp. When finished, the Chrome key should contain the following strings, described in the table below. String Name Type Data (Default) REG_SZ (value not set) AuthServerWhitelist REG-SZ The name of the host server. AuthNegotiateDelegateWhitelist REG-SZ The name of the host server. Now, Google Chrome can use Active Directory when logging into MLWeb. 46 MultiLogger Suite Installation Guide

49 Section 3 Removal Section 3 Removal 3.1 MLGateway License Deactivation Before removing MultiLogger Suite, the license for MLGateway must be deactivated on the current computer to allow it to be reactivated on another computer. First, open MLGateway as an application, and click the Deactivate button on the interface to display a confirmation dialog. Alternately, open MultiLogger and click File Deactivate MLGateway to display the confirmation dialog. Click OK on the dialog to confirm your decision and deactivate the license. A successful deactivation will display the information dialog shown at right. Click OK to close it. Now that the license for MLGateway is deactivated, the licensed databases in MLServer must also be deactivated, as described in the next section. MultiLogger Suite Installation Guide 47

50 Section 3 Removal 3.2 MLServer License Deactivation In addition to deactivating the license on MLGateway, all licensed databases on MLServer must also be deactivated and removed so they can be reactivated on another computer. Open MLServer as an application and click the Databases button on the interface to bring up the Configure Databases form. Select a database and click the ellipsis button (highlighted in red below) next to the counter in the Licensed column to bring up the Configure Database Licensing form (shown below right) and check if the selected database has additional license keys. If the database has additional licenses associated with it, select one of them in the form and click on the red minus button (highlighted in red) to delete the record. A confirmation dialog will display; click OK to confirm your decision. Repeat this process as needed for any additional license keys. Close the Configure Database Licensing form when all license keys have been removed to return to the Configure Databases form. With any additional licenses removed, highlight the database in the grid and click the red minus button in the grid control (highlighted in orange above) to remove the database record from the form. A confirmation dialog will display (shown at bottom right); click OK to confirm your decision. Repeat this process as needed for the other databases in the record. After all databases have been unlicensed and deactivated, MultiLogger Suite can now be removed from your computer as described in the next section. 48 MultiLogger Suite Installation Guide

51 Section 3 Removal 3.3 MultiLogger Suite Removal Note: The following example is for a removal of MultiLogger Suite on a Windows Server 2012, 64- bit system with Admin user rights. The removal process for your operating system may vary, especially with desktop operating systems, such as Windows 10. Removal of MultiLogger Suite is straightforward. First, load the Control Panel, then click Uninstall a program under Programs. Scroll down the list and locate the MultiLogger Suite listing. Click Uninstall to begin the process. You will be asked to confirm removal of MultiLogger Suite. Click to Yes to continue. MultiLogger Suite will be uninstalled. Once the process is complete, the Programs and Features form will reappear. MultiLogger Suite Installation Guide 49

52 Section 3 Removal An alternative way to uninstall the software is to run the installation program again. This will display the Program Maintenance form. Select Remove, then Next to continue. Note: This does NOT delete any user created or modified files including Network Configurations, datalogger configuration files, collected data files, or user customized programming options. You will be asked to confirm the removal at the next dialog. Click Remove to continue with the removal. 50 MultiLogger Suite Installation Guide