Supervisor Insight Installation Guide www.monitorbm.com
Supervisor Insight Installation Guide Copyright 2014 Monitor Business Machines Ltd The software contains proprietary information of Monitor Business Machines Ltd. It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Monitor Business Machines Ltd. All rights reserved. No part of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Monitor Business Machines Ltd. 31a Normanby Road, Mt Eden, Auckland 1024, NEW ZEALAND Printed: May 2014 The Monitor Logo and Supervisor are registered trademarks of Monitor Business Machines Ltd. Any other products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks.
Contents Introduction Typographical Conventions 1... 1 Product Overview 2 System Requirements 3 Prerequisites 4 Single Server System Network Server System... 4... 4 Installation Installing Supervisor Insight 5... 5 Single Server... 8 Netw ork Server... 9 With SQL Access Rights... 12 Without SQL Access... Rights 13 Install Wizard at a Later... Time 14 17 Overview... 17 SQL Database Access... 17 Internet Information Services Configuration... 23 Internet Information Services... 6 24 Internet Information Services... 7 29 Internet Information Services... 7.5 31 Configure Application... Pools 31 SupervisorNet Website... 31 SQL Connection Strings... 33 Configuring ASP.NET... 36 Register.Net and IIS... 36 ASP.NET Access for Window... s XP 37 Configuring the ASP.NET... account. Window s 2003 and 2008 40 Registry Settings... 40 Regional Settings... 41 Contents i
Introduction Typographical Conventions Before you start using this guide, it is important to understand the terms and typographical conventions used in the documentation. The following kinds of formatting in the text identify special information. Formatting convention Type of Information Emphasis Use to indicate a reference to an object or idea. For example 'Click the Undo key'. CAPITALS Names of keys on the keyboard. for example, SHIFT, CTRL, or ALT. KEY+KEY Key combinations for which the user must press and hold down one key and then press another, for example, CTRL+P, or ALT+F4. Faded edge screen captures are used when the entire screen is not necessary for the explanation being presented. A Monitor Terminal display capture. These captures are taken using the Operate function in the IP Terminal Utility. Terminal 1 Introduction Refers to a Monitor Terminal.
Product Overview Supervisor Insight is a web-based reporting system for Supervisor Net. With Supervisor Insight, a web browser can be used to report on the following: Transactions Primary database status Secondary database status Autoloader cash and card status Autoloader cash pickup receipts Supervisor Insight reports can be saved in PDF, MS Word, Rich Text (RTF), Crystal Reports (RPT) and MS Excel formats Supervisor Insight uses the following three main components: Supervisor Net version 5 software RTE database using SQL Server Internet Information Services (IIS) Web server These three components may all be installed on the same computer, or they can be split across two or three computers depending on a particular site's requirements. Product Overview 2
System Requirements Windows XP, 2003 Server, Vista, 7 or 2008 (x86 and X64 platforms) with the latest service packs installed Supervisor Net version 5 or later Internet Information Server (IIS) version 5 or later SQL Server 2000, 2005 or 2008 with the latest service packs Internet Explorer 5.5 or greater, on client computers Microsoft.Net framework v2.0 3 System Requirements
Prerequisites Single Server System A Single Server System has all of the Supervisor Components and requirements installed on the same computer Supervisor Net is installed and working correctly Internet Information Server (IIS) is installed as the default web server on port 80 and working correctly IIS has ASP.NET components installed and working correctly SQL Server 2000, 2005 or 2008 is installed and working correctly Internet Explorer is working correctly on the server The Real-Time Export database is installed and configured correctly Network Server System A Network Server System has Supervisor software running on separate computers to Insight within a Microsoft Windows Domain. A Windows Active Directory domain is configured on the network Supervisor Net is installed on the network IIS is installed as the default web server on port 80 on the same machine as Insight is to be installed IIS has ASP.NET installed and working SQL Server is installed on the network SQL Server Management Studio (or Enterprise Manager) is installed on the SQL Server Computer All participating computers belong to the same domain If necessary, a domain account has been created to run ASP.NET. A domain account is required if ASP.NET is running under Windows XP and is on a different machine from SQL Server Prerequisites 4
Installation Installing Supervisor Insight Version 5 of Supervisor Insight differs from previous versions in the following respects: It uses version 2.0 of the.net framework, rather than version 1.1 It uses a newer version of the Crystal Reports runtime It is installed using a different installation package Because of these differences, it is recommended that any previous installation of Supervisor Insight be removed from the server before installing version 5 for the first time. It is also strongly recommended that any versions of the Crystal Reports runtime other than "Crystal Reports Basic Runtime for Visual Studio 2008" be removed. The Supervisor Insight installation package must be run on the computer hosting the IIS web server. It carries out the following functions: Install the reports and supporting files Configure an IIS virtual directory containing the reports. The virtual directory is always called SupervisorNet, but the physical Windows directory may be in any location on the machine If necessary, install the.net framework version 2 If necessary, install the Crystal Reports runtime Run the framework configuration wizard Run the Insight install package, setup.exe 5 Installation
Choose the install location, then click Next Verify the install settings, click Back to change settings, click Install to install Installation 6
Setup will then install the required files and registry settings If necessary the installation wizard install the Crystal Reports runtime Next, the framework wizard will run. The framework configuration wizard s function is to ensure that the various Windows and SQL Server accounts and permissions are configured so that Insight can operate correctly. You must run the wizard on the Supervisor Insight machine to configure required registry settings, and to configure the ASP.Net user under specific circumstances (i.e. on a pre-windows 2003 system with SQL Server on a different machine). In order to configure SQL Server accounts and permissions, you must run the wizard under an account that has Security Admin rights to the SQL Server. You can do this from the Supervisor Insight machine, or from another machine by running the wizard as a stand-alone program. Note that if Supervisor Insight, Supervisor Net and SQL Server are installed on different machines, it is not necessary to run the Insight Setup Wizard on each machine. Configuration can be completed on the Supervisor Insight machine provided you have Security Admin privileges on SQL Server. If that is not the case, the wizard can be run by another user that has these privileges. When the wizard is run, it displays a sequence of screens depending on where it is run. 7 Installation
Single Server When Supervisor Insight is installed on the same machine as Supervisor Net, Insight will import the settings of the Supervisor Net installation. The wizard will display details of the local system. By default, the checkbox to configure SQL database access rights will be set. If you do not have security admin privileges to the SQL Server system, then you can clear this checkbox. In that case, only the registry settings will be saved. You will still have to run the wizard at a later time either under a different user account or from a different machine to configure database access rights. When you click Apply, the settings will be applied to the system. Installation 8
This will finish the Insight installation. Network Server In this case, the actions taken depend on the operating system on which IIS and ASP.NET are installed. If this is on Windows XP (IIS version 5) then by default ASP.NET will run under a local machine account called ASPNET which cannot access remote SQL servers. In order to allow such access, the wizard needs to modify ASP.NET to run under a domain account which is granted access to the SQL Server database. You should create this account before running the wizard. Under Windows 2003 and later, the ASP.NET process runs under the account NT AUTHORITY\NETWORK SERVICE. This is accessible on other machines as domain\machine$, and so in this case no special domain account need be set up. 9 Installation
You are prompted to enter the name of the Supervisor Net server, and the port on which the Supervisor Net database server is listening: You are then prompted for the location of the SQL Server machine, and the database name of the RTE database: In the case of SQL Server 2005 or 2008, the machine name and instance must be specified, in the form server\instance. SQL Server 2000 doesn't have instances so just the server name will be specified. Installation 10
If the ASP.NET machine (web server) is running Windows XP and the SQL Server database is not on the local machine, you are then prompted for the name and password for the ASP.NET domain account, using the following screen: The user name must be specified in the form domain\user. If the machine is running Windows 2003 or later, this step is skipped. The next steps depend on your SQL Server access. 11 Installation
With SQL Access Rights At this point you will configure database access rights, then Supervisor Insight will be ready to run. You do not need to run the wizard on any other machine. Click Apply to configure the machine using the settings you have entered. This will finish the Insight installation. Installation 12
Without SQL Access Rights At this point clear the checkbox so not to configure database access rights. In that case, only the registry settings will be saved. You will still have to run the wizard at a later time either under a different user account or from a different machine to configure database access rights. If you do configure database access rights, then Supervisor Insight will be ready to run. You do not need to run the wizard on any other machine. Click Apply to configure the machine using the settings you have entered. This will finish the Insight installation. 13 Installation
Install Wizard at a Later Time If you have run the wizard as part of the Supervisor Insight installation with the requisite SQL rights, you do not need to run it anywhere else. If for some reason, you did not have the required SQL access rights on that machine, you can run the wizard as a stand-alone program from another location. If that machine has Supervisor Net installed, the wizard will use the local settings and not display the first two screens below. If Supervisor Net is not installed on the machine, you will be prompted to enter the name of the Supervisor net server: This information is required so that the Supervisor Net machine can be granted appropriate access to the database. Installation 14
Next, you will be prompted to select the Real-Time Export SQL server, instance, and database names: Next, you must enter the name of the account under which ASP.NET is running, so that the account may be given the appropriate permissions in the RTE database. On pre-windows 2003, this account needs to a domain user account. On Windows 2003 and later, the account is the network service account. This is visible on the network in the form domain\machine$, and should be specified in this form in the dialog box: 15 Installation
Next you will see the Apply Settings screen. The checkbox to configure SQL access rights will be checked and disabled at this time. It is assumed that if you are running the wizard on other than the Supervisor Insight machine, then you have the required privileges to configure SQL security. The Supervisor Net configuration may or may not contain the port number, depending on the operating system it is configured on. If it does, this will be Port Number: 16000. Click Apply to configure the machine using the settings you have entered. This will finish the Insight installation. Installation 16
Overview The previous sections have described the use of the the framework wizard to install and configure the components required for Insight. There are some additional configuration required with the SQL Server. Alternatively it may happen that the wizard fails to complete its tasks successfully and extra manual configuration is required, this configuration is also in the next sections. It is assumed that the following components have been successfully installed: Internet Information Services ASP.NET SQL Server Supervisor Net Crystal Reports run time Supported operating systems are Windows XP, Windows 2003 Server and Windows 2008 Server. If ASP.NET, SQL Server and Supervisor Net are not all running on a single machine, then the machines involved must all be members of a single domain. SQL Database Access The Supervisor Net RTE database may be installed on either full or free version of SQL Server 2000, 2005, or 2008. When installing SQL Server 2005 or 2008 access from remote computers is not enabled by default. If SQL Server 2005 or 2008 is running on a different machine than Supervisor Net or ASP.NET, remote access must be enabled. This may either be done at install time or by running the SQL Server Configuration Manager. Open the SQL Server Configuration Manager, expand SQL Server Network Configuration, and select Protocols for SQLEXPRESS Select TCP/IP right click and select Enable 17
Then navigate to SQL Server Services, select the SQL Server service from the right hand side which is running, then select the blue arrow from the top to restart the service. SQL Server 2005 and 2008 allows multiple database instances to run on the same machine. The Supervisor Net database may be installed on any instance. The database should have already been created when Supervisor Net 5.x or above was installed. If for some reason the database is not yet installed, it may be created using the database setup tool DatabaseSetup. exe in the Supervisor install folder. If the ASP.NET account is not running on the SQL Server, then the ASP.NET account must be configured to have read/write access to the database. This is configured using the db_datareader and db_datawriter roles in the database. To grant this access Open the Microsoft SQL Server Management Studio, and navigate to Database -> Security -> Logins on the left hand pane. Right click in an empty area (if viewing Object Explorer Details) in the right pane, or right click Logins in the left pane, then choose New Login... 18
The account to use will depend on whether the remote ASP.NET machine is running Windows XP, or Server 2003/2008. In the case of Server 2003/2008 on the remote server ASP.NET should be running under the 'NT AUTHORITY\NETWORK SERVICE' account. This is accessible on the SQL Server machine as Domain\Machine$, where 'Machine' is the name of the ASP.NET machine, and must be granted read/write access. Server 2008 R2 uses a different model for the ASP.NET account. For server 2008 R2 the application pool identity must be configured to have the below access. The identity can't be searched for but will be in the form of: 'IIS APPPOOL\app pool name' where 'app pool name' is the name of the application pool that Insight is configured to run under. For example; If Insight is using the default application pool, this will be: IIS APPPOOL\DefaultAppPool, or if Insight is using an application pool called, SupervisorNet, then the login name for SQL will be: IIS APPPOOL\SupervisorNet. In the screen below, the remote server is running Windows Server 2008. The machine name is S2008-32-1, and the domain is MBMNZ. Note the default database down the bottom is SupervisorNet. 19
In the case of Windows XP as the ASP.NET machine, the remote account will be the ASPNET domain account created. This is the same domain account used when installing Insight when asked for the 'Supervisor Insight's Windows login', and must be configured in IIS and SQL Server. The screen below shows this domain account called Insight. Note the default database down the bottom is SupervisorNet. 20
Next, click on User Mapping on the left hand side of the new login screen. For both types of account the security user mapping is the same. The database, and access required are ticked as below. When you have done this click on OK to add the security 21
Next, navigate to the Database -> Databases -> SupervisorNet -> Security -> Users and make sure your user has been added. Check the security has also been added by right clicking the username and selecting Properties... 22
At the bottom under 'Database role membership' you should see the access groups as below, if not add them manually. Click on OK to exit this. You may need to restart the SQL Server to propagate the access privileges, this is done the same way as restarting the service mentioned at the beginning if the SQL Database Access section. Even if Supervisor Net and ASP.NET are running on the same machine as SQL Server, they will still need access rights to the database. For Supervisor Net, this should happen automatically for the Local system account under which the services run. Internet Information Services Configuration When Supervisor Insight in installed, it creates a virtual IIS directory to hold the files needed for the reports. It attempts to configure this directory for use with ASP.NET. If you are running IIS from Windows XP as a network server, you will need to configure IIS to use your Domain ASP.NET account. It is also possible one or more parts of this process may fail. This section describes how to compete the process manually, if necessary. 23
Internet Information Services 6 Open the Internet Information Services (IIS) Manager, in Windows XP this is in the Control Panel -> Administrative Tools. Navigate to the 'supervisornet' folder. Right click on supervisornet, and select Properties A Default Web Site Properties windows will now appear Select the 'Directory Security' tab as shown below, and under 'Anonymous access and authentication control' click Edit... 24
In the 'Authentication Methods' window, you should see something similar to below. This needs to be changed to allow ASP.NET to authenticate against the SQL Server Check the box Digest authentication for Windows domain server, select Yes to the popup, then configure the Anonymous access to your domain ASP.NET account configured for SQL Server 25
Re-enter the password as required. Click OK twice to get back to the Properties window Click on the Documents tab, if Default.aspx isn't in the list then click Add... otherwise skip the next two steps. Enter in the default document name, then click OK 26
To load the page faster, you can use the arrows to the left to change the order of the default documents. Click on the ASP.NET tab and then Edit Configuration 27
On the General tab, under Connection string manager, select LocalSqlServer and click Edit... Change the data source from.\sqlexpress to point to your SQL Server as below, then click OK Click OK until you have closed all the properties windows, and exit IIS Manager Open the Windows services, and select IIS Admin Service, restart this service. 28
You should receive the confirmation box below, click on Yes to restart IIS Once IIS has restarted, close the Windows services utility. Internet Information Services 7 Open the Internet Information Services (IIS) Manager. In Windows Server this is in Administrative Tools. Navigate to Default Web Site (this could also be done directly on the supervisornet site which is below Default Web Site) and double click in Connection Strings from the middle pane. 29
Select LocalSqlServer from the middle pane, and click Edit... In the window that pops up, change the SQL Server and Credentials to reference your SQL Server, database and user details, then click OK. 30
Select Default Web Site, and in the right pane there should be an Actions list. Under Manage Web Site, click Restart to restart the web server. The web server may also be restarted from Windows services by restarting World Wide Web Publishing Service. Internet Information Services 7.5 When Supervisor Insight and the SQL database are on the same machine, no configuration changes are required to IIS. When the SQL database is on a different machine, then configure IIS 7.5 as below and restart. Configure Application Pools SupervisorNet Website 1. Navigate to Application Pools. 2. Click Add Application Pool... 3. Choose a name e.g. Supervisor Insight Leave the rest as defaults. 31
4. Select the Application Pool, and in the right hand pane under Edit Application Pool, select Advanced Settings... 5. Under General, change Enable 32-Bit Applications to True. 6. Click OK to close. 7. Navigate to Sites -> Default Web Site -> SupervisorNet. 8. Right click, and select Add Application... 32
9. Choose and Alias, then click Select... and choose the Application pool just created. 10.Enter a Physical path, this is the install path to Supervisor Insight. 11.Click OK to add. 12.Navigate to the SupervisorNet application and double-click the Authentication icon on the middle display. 13.In the list of Authentication types, right-click on Anonymous Authentication and select Edit. 14.Change the user to the Application Pool Identity option. 15.Save settings and restart the web server. SQL Connection Strings Navigate to Default Web Site (this could also be done directly on the supervisornet site which is below Default Web Site) and double click in Connection Strings from the middle pane. 33
Select LocalSqlServer from the middle pane, and click Edit... 34
In the window that pops up, change the SQL Server and Credentials to reference your SQL Server, database and user details, then click OK. Select Default Web Site, and in the right pane there should be an Actions list. Under Manage Web Site, click Restart to restart the web server. The web server may also be restarted from Windows services by restarting World Wide Web 35
Publishing Service. Configuring ASP.NET If ASP.NET is running on the same machine as SQL Server and Supervisor Net, then configuration should be straightforward. Under Windows 2003 and 2008, the ASP.NET process runs under the account 'NT AUTHORITY\NETWORK SERVICE'. This account should be a member of the local users group. The ASP.NET account may need to have registry settings configured, to tell it where to find Supervisor Net and SQL Server - these settings are described in the section Registry Settings. In addition, the ASP.NET account may need to be configured as an authorised user in the RTE database. This is described in the section SQL Database Access. If ASP.NET in running on a different machine from SQL Server or Supervisor Net then it may need to be configured for remote access. This procedure is described in the following sections. Permissions will need to be configured for access to SQL Server and Supervisor Net as in the single machine case. Register.Net and IIS If the Microsoft.Net framework was installed before IIS and ASP.NET, you will need to register the.net framework with IIS. The following process will create the ASPNET user and make IIS aware of the.net framework. Open a command prompt and navigate to: C:\Windows\Microsoft.NET\Framework\v2.0.50727 If your operating system is 64-bit, the path will be: C:\Windows\Microsoft.NET\Framework64\v2.0.50727 Next, run the command: aspnet_regiis -i 36
ASP.NET Access for Windows XP If the ASP.NET user cannot access the required files in Insight, the following security access will need to be added. Open Windows Explorer and navigate to the Insight install folder (C:\mbm\ in this example) right click on the insight folder and select Properties In the Properties window, click the Security tab, if your user isn't in the list, select Add... 37
Enter in the name of the ASP.NET user and select Check Names to verify it, then click OK Select your user, and give them Read & Execute, List Folder Contents and Read access. Some special permissions will also have to be setup, so click Advanced down the bottom 38
Select your user from the list, and click Edit... Check 'Create Files / Write Data' and 'Create Folders / Append Data' then click OK 39
You will now see the Special Permissions permission to be grey and ticked, click OK to close the Security Properties Your ASP.NET user will now have access to run Insight. Configuring the ASP.NET account. Windows 2003 and 2008 Under Windows Server 2003 and 2008, the default account for ASP.NET is a local machine called 'NT AUTHORITY\NETWORK SERVICE'. On Windows Server 2008 R2, the default account is 'IIS APPPOOL\DefaultAppPool'. This account is accessible on other machines as domain\machine$. You should not change the password of this account. Registry Settings ASP.NET needs to be told where to find the SQL Server database and Supervisor Net. This must be done even if they are both running on the same machine as ASP.NET. The information must be entered in the following registry keys: 40
Key: HKLM\SOFTWARE\Monitor Business Machines\superVISorinsightFramework The following string values must be set up: String Value Data ASPNetLocal 1 for local, value of 0 for remote DatabaseName SQL database name for Supervisor Net Port Port to contact Supervisor on, typically 16000 SQLServerComputer Name of the PC that SQL resides on, format is Machine\Instance SupervisorNetServer Name of the PC that Supervisor Net resides on Key: HKLM\SOFTWARE\Monitor Business Machines\SupervisorNet The following string value must be set up: String Value InsightLogPath Data Insight Install log path e.g. C:\mbm\insight\Bin\log\ Example of Registry settings for Supervisor Insight Framework key: Regional Settings In the filter pages and reports, dates and currencies are formatted according to the regional settings of the account under which the ASP.NET process runs. This is one of: NETWORK SERVICE (Windows 2003, single server) Domain account (More than one server) In the latter case, the password for the account is known, and the regional settings can be set using the regional settings control panel. In the first case, the regional settings for the account are taken from the default system locale at the time when the account is created (eg when the.net framework is installed). 41
If these settings were incorrectly configured when the account was first created, they can be changed by an administrator. If your account has the correct settings, then in the Regional and Language option in the control panel. In Windows Vista, Windows 7 or Server 2008 select the Administrative tab then select Copy Settings... This will allow you to copy your regional settings to the system accounts. This cannot be done in Windows XP or Server 2003. 42
Monitor Business Machines Ltd 31a Normanby Road, Mt Eden, Auckland 1024, New Zealand. Phone: +64 9 623 5000 Web: www.monitorbm.com