Keynetix HoleBASE SI Geotechnical Data Management system Network Installation Guide HoleBASE SI Network installation Guide The material contained within this guide is designed to help you install and licence HoleBASE SI on a network. There is a separate guide to help you install the system on a standalone machine. If you have problems installing and licencing HoleBASE SI please let us know by calling us or emailing us on support@keynetix.com and we will be pleased to help you resolve any problems. Numbered paragraphs are used to describe step by step instructions on a task or series of related tasks. Bold Italic text denotes an item on the interface such as a menu option, command button, or listed item. Within this, the pipe (|) symbol denotes options on a cascading menu – as in Licence | Manage. Other Italic text is used to refer to proper names or emphasise a phrase, word or sentence. Bold text is used to indicate the actual contents of an editable field or box, or what the reader should type into a box. Certain icons are used to indicate that the adjacent text is an aside or additional information. These are as follows:. Conventions used in this Document Numbered paragraphs are used to describe step by step instructions on a task or series of related tasks. Bold Italic text denotes an item on the interface such as a menu option, command button, or listed item. Within this, the pipe (|) symbol denotes options on a cascading menu – as in Manage | Tests. Other Italic text is used to refer to proper names or emphasise a phrase, word or sentence. Bold text is used to indicate the actual contents of an editable field or box, or what the reader should type into a box. Certain icons are used to indicate that the adjacent text is an aside or additional information. These are as follows: - This symbol indicates a section of text that discusses some aspect of the current command or function. The light bulb symbol is a tip or hint associated with the command being described. This is the See Also symbol and refers the reader to another section or chapter related to the function or command being described. This is the Video Available symbol and refers the reader to the Keynetix Knowledgebase where a video can be found related to the function or command being described. Revision 1.2 28/05/2014 2 HoleBASE SI Network installation Guide Contents Conventions used in this Document 1. 2 INTRODUCTION TO HOLEBASE SI 4 Downloading the software 2. 4 LOCATING AND INSTALLING THE LICENCE MANAGER 5 Licencing a network server 3. 5 LOCATING AND INSTALLING YOUR DATABASES 6 Determining where to install SQL Server 6 Determining what version of SQL Server to use. 7 Determining how many Databases to use 7 SQL Server Installation Guide 9 4. INSTALLING HOLEBASE SI DESKTOP SOFTWARE 10 Supported Platforms and Recommended Requirements 10 Desktop Installation 10 5. RUNNING HOLEBASE SI FOR THE FIRST TIME 12 Connecting to Licence Manager 12 Creating a new HoleBASE SI database 13 Connecting to an existing HoleBASE SI Database 14 Rolling out HoleBASE SI on large networks 16 Logging in 16 Next steps 16 6. APPENDIX 1 – IT NOTES 17 Permissions 17 Firewall and Antivirus Exceptions 17 Prerequisites 17 Windows Installer 4.5 17 Microsoft .NET Framework 3.5 SP1 and .NET Framework 4.0 17 Microsoft SQL Server Express 2008 R2 SP2 18 Microsoft® SQL Server® 2008 R2 Native Client (For XP ONLY – without SQL Server) 18 Revision 1.2 28/05/2014 3 HoleBASE SI Network installation Guide 1. Introduction to HoleBASE SI HoleBASE SI is a desktop application which connects to a database and licence manager to enable it to run. There are therefore three components to consider when installing the system. 1) Licence Manager 2) Database Server 3) Desktop Application If you are looking to install the system for evaluation purposes or you only have one person who needs to access this system then all three components can be installed on the same machine and this installation is covered in the Standalone Installation Guide However with a Network installation the database and Licence Manager must be installed on network servers and there is a choice of installers for the desktop application depending on whether you need the machine to be able to run HoleBASE SI away from the network connection. This guide covers all the steps to installing the system in the order we recommend you do them. Downloading the software The Keynetix Knowledgebase is a website dedicated to giving you online training and resources to help you get the most from your Keynetix software. You will need to login to the system to read some articles and to download the software. Keynetix will have set up an account for you with your email address, so if you are unable to login please request that a new password is sent to you by entering your email address in the top form on (http://www.keynetix.com/index.cfm?fuseaction=login.loginform) and clicking the Email me a new account password option. If you are able to gain access please fill out the details immediately below the Email me a new account password option and click Register. All the instructions on how to download each component mentioned below are detailed on the following article (http://kbs.keynetix.com/node/460) on The Keynetix Knowledgebase. There are two installers for the database component and HoleBASE SI desktop, one for 32bit and one for 64bit operating systems. It is important to download the correct installer and if you are unsure whether your machine is running a 64bit operating system then you can find out by reading this article (http://kbs.keynetix.com/node/439) on the Keynetix Knowledgebase. It is important to note that you need to download the 64bit versions of the Database installer if your Server is running a 64bit OS no matter what your local machines are running. Revision 1.2 28/05/2014 4 HoleBASE SI Network installation Guide 2. Locating and installing the Licence Manager If you have purchased a concurrent user licence of HoleBASE SI you must use the network licence manager to request and manage your licences. The network machine that you installed the Licence Manager onto must be accessible by all machines that are going to use HoleBASE SI. There is only a small amount of data traffic between HoleBASE SI and the Licence Manager so connections through to the server do not need to be as fast as they need to be for the database server. If you wish to share your HoleBASE SI licences between different sites, you must install the Licence Manager on a server that can be accessed from all the required sites. This server does not have to be the same server as the database is running from. The Licence Manager is a Sentinel SafeNet solution and will run on a Virtual or Physical machine provided the socket 1947 is open on the firewall and on local machines. Licencing a network server 1. Before you install the software ensure that the server selected to host The HoleBASE SI Licence Manager is visible to all machines that will need to use HoleBASE SI 2. Install the HoleBASE SI Licence Manager on the server by downloading the installer from the information given in the download section of this guide 3. When you run the HoleBASE SI licence program you will see a single screen like the one shown below 4. Click the Generate Code button to generate a fingerprint file. This will create a C2V file with a long name such as HoleBASE_SI_832807067132086561_2013_01_03_1556.c2v Save this file to a location without changing its name. 5. Email the file to licencing@keynetix.com email address with “Network HoleBASE SI Licence” as the subject line. 6. You can then click the Close button to shut the Licence Manager down and proceed with the installation of the other components while you wait for the licence file to be returned to you. 7. On receipt of the licence file (which will be a .V2C file) you simply navigate back to the screen above, click on the Apply Licence button and select the file that was emailed to you. You can check that the licence file has been successfully installed by selecting the Test Licence button 8. Finally the system will offer to create you a confirmation file. Save this file to a location on your network or hard disk and email it to Keynetix if requested. Revision 1.2 28/05/2014 5 HoleBASE SI Network installation Guide 3. Locating and installing your Databases HoleBASE SI Passwords Explained. When you install HoleBASE SI there are three important passwords to know about and this can be a little confusing unless you fully understand the differences between them. Once you have set up HoleBASE SI the only password you need to know about and remember is your User password. However during the setup process you will also need to know the Database User password and the SQL System Admin user password. User Password This password is assigned to each user that logins into HoleBASE SI and controls which projects they can see and what rights they have in each project. HoleBASE SI has an administrator user set up as default and the default password for this user is Qwerty123 Database User Password The Database User password is used internally by HoleBASE SI to login into your company’s SQL server account. Many different applications may be running on this SQL Server account and so it is important for IT Administrators that the login that HoleBASE SI uses can only access the HoleBASE SI data. This username and password is set up or set during the “Create new database procedure”. All users who use HoleBASE SI will access the SQL Server account using this username and password but they will never see it as it is stored internally within HoleBASE once the database has been set up and connected to. SQL System Admin (SA) Password SQL Admin User is the username and password required to create a new database on your SQL Server install and is only needed if you are not linking to an existing database. This is where most of the confusion usually occurs as it is often confused with the SQL Login Password. Again this comes down to SQL Server security management, when HoleBASE creates a database it needs high level admin access to create a new Database User (see above) and databases. The rights to do this will not usually be assigned to the SQL Login user and so the addition of the SQL Server admin user allows IT administrators to temporarily create a user with these rights and allow HoleBASE SI to set itself up. Once the HoleBASE SI databases and SQL User has been created this username and password are never used again and so the IT administrator can delete the account from SQL server and know that the HoleBASE application does not have access to create any more databases within their SQL Server account. Determining where to install SQL Server HoleBASE SI requires a connection through to a SQL Server database to function correctly and store data. A SQL Server installation can become resource intensive and can slow machines down and we would advise that any machine that SQL Server is being installed on should meet the recommend requirements below Minimum Requirements • Intel or compatible 1GHz processor • 1GB of RAM • 2.2GB of available hard drive space • Windows Server 2003 Revision 1.2 28/05/2014 6 HoleBASE SI Network installation Guide Recommended Requirements (small number of licences) • Intel or compatible 2GHz processor • 2GB of RAM • 5GB of available hard drive space • Windows Server 2008 R2 Contact Keynetix to discuss hardware recommendations for large multi-office / international or large project archive deployments The server that has been selected to host the database must be visible to all machines that will need to use HoleBASE SI. This may sound like an obvious point but there may be a number of firewalls that exist between the server and the desktop application and it is important to check that all firewalls between these two machines will allow SQL server data to pass through them. A simple test to check SQL visibility is to try to connect to a SQL server using the standard data connection tools in Microsoft Excel. If these tools cannot see the SQL server and connect then neither will HoleBASE SI. Determining what version of SQL Server to use. Currently HoleBASE SI only works on SQL Server 2008 R2 SP2 and SQL Server 2012. We do not, and will not be supporting SQL Server 2005. SQL Server is available in a free to use download called SQL Server 2008 Express. The limitations of SQL Server Express are: - Maximum 10 GB per database. - Uses no more than 1 processor. - Uses no more than 1 GB of internal memory. This makes SQL Server Express the ideal platform for companies that have up to 5 licences of HoleBASE SI and are running a system with around 250 projects in it. These are purely estimated figures and you may find that the system will work well using SQL Server Express if you have more licences or more projects. The three restrictions above act mainly as a throttle control for amount of data stored and the number of requests that can be handled at any one time by the server. The full version of SQL server allows multiple processors to be used and 64GB of memory to be allocated to the software and 524 Petabytes in database size (effectively unlimited). A petabyte (derived from the SI prefix peta- ) is a unit of information equal to one quadrillion (short scale) bytes, or 1 billiard (long scale) bytes. The unit symbol for the petabyte is PB. The prefix peta (P) indicates the fifth power to 1000: 1 PB = 1000000000000000B = 10005 B = 1015 B = 1 million gigabytes You will be able to upgrade your system and data at a later date. So if you start with SQL Server Express and then upgrade to the full SQL Server you will be able to migrate your data across to the new system easily. The majority of users simply start with this version and consider migrating once you they been able to check the performance. Determining how many Databases to use You do not need to store all your data in one place as HoleBASE SI can be set up to connect to multiple databases. This can be useful for large international organisations who require regional data centres or companies where the IT infrastructure does not support fast SQL Server access between offices. Revision 1.2 28/05/2014 7 HoleBASE SI Network installation Guide However there are a few items you need to consider before you decide on the location and number of databases to install. 1) The connection speed between the Desktop and the Database Server will determine how fast HoleBASE SI is to use. If you have a slow connection speed then the user experience and usability of the system will be greatly reduced. 2) Each database should be seen as a separate enclosed HoleBASE SI system. You will not be able to access project data, user information or templates stored in a separate system. This may work well for international companies where they wish to operate independently but may not work well for companies with regional offices in the same region who want to share project data. Our advice is therefore to install as few databases as possible, preferably one per region, as long as your IT infrastructure allows this to operate at a speed acceptable to the users. There are so many different ways to set up IT infrastructure that it is impossible for us to currently estimate how fast it will work on your systems. However we will be happy to supply you with trial desktop licences so you can conduct tests within your network and will try to work with you / your IT department to ensure HoleBASE SI is functioning to its optimum performance for the required setup . Revision 1.2 28/05/2014 8 HoleBASE SI Network installation Guide SQL Server Installation Guide We have prepared a separate guide for the installation and setup of SQL Server Express and this guide and installation files can be downloaded from the following article on The Keynetix Knowledgebase http://kbs.keynetix.com/node/577 Revision 1.2 28/05/2014 9 HoleBASE SI Network installation Guide 4. Installing HoleBASE SI desktop software If you are installing to a laptop that may need HoleBASE SI to work without a connection to the network at some point in the future we recommend that you install the standalone installation instead of the Network PC installation as this will install the database locally. Information on how to download this installer and installation guide are available in the Downloading Software section of this document Supported Platforms and Recommended Requirements HoleBASE SI is currently only supported on the following Microsoft Windows operating systems: • • • • Windows XP (x86 SP3 and x64 SP2) – Requires Additional Prerequisite (see prerequisites) Windows Vista (x86 SP1 and x64 SP1) Windows 7 (x86 SP1 and x64 SP1) Windows 8 (x86 and x64) Important Note: This release requires that the specific minimum service pack (see above) is installed for the respective Operating System before starting the HoleBASE SI installation process. Minimum Requirements - Intel or compatible 1.4GHz processor - 1GB of RAM - 2.2GB of available hard drive space - 800x600 resolution - Windows XP with Service Pack 3 (x86) or Windows XP with Service Pack 2 (x64) - Internet Connection (to enable streamed mapping data) Recommended Requirements - Intel or compatible 2GHz processor - 2GB of RAM - 5GB of available hard drive space - 1280x1024 resolution - Windows 7 with Service Pack 1 (x86 and x64) - Internet Connection (to enable streamed mapping data) Desktop Installation 1. Before running the installer please ensure that you have one of the supported operating systems (and required Service Pack installed on your machine) 2. Download the HoleBASE SI Installation for your required platform (x86 or x64) from the Keynetix Knowledgebase and extract the contents of the zip file onto your local machine 3. Run setup.exe to begin the installation process (do not run the HoleBASE-SI.msi) 4. Follow the onscreen prompts (depending on your current system configuration you may be prompted to install one or more of the Microsoft prerequisites.) 5. After the installation is complete, run HoleBASE SI by clicking the icon on the desktop or launch from the start menu Important Notes: Revision 1.2 28/05/2014 10 HoleBASE SI Network installation Guide During the installation process you may be prompted to restart your machine following the installation of each of the Microsoft prerequisites. Following a restart the installation process should automatically resume. Depending on your Windows User Account Control (UAC) settings you may also be prompted to elevate to a System Administrator and may be prompted to enter an Administrator username and password. Revision 1.2 28/05/2014 11 HoleBASE SI Network installation Guide 5. Running HoleBASE SI for the first time If you are following this guide in order you should now have your licence manager and Database installed and ready to go. The first time you run HoleBASE SI you will need to do the following operations manually:1) Connect to the Licence Manager 2) Create the Database 3) Connect to the Database Each time you subsequently add a machine to the HoleBASE SI system you will need to only do steps 1 and 3 above and these can be automated if you are rolling out HoleBASE to a large network. Connecting to Licence Manager 1. When you run HoleBASE SI for the first time you will see the login screen as shown below. 2. Click the licence button to display the licence options. Select the Networked option as shown below and then click Next 3. The Licence Type form will be displayed. You will need to type the host name of the server that you installed the HoleBASE Licence program on. You only need to type the host name and you do not need to enter any path or additional information. 4. Once you have specified a new network licence location HoleBASE SI will close so that the changes can be registered. The next time you open HoleBASE SI it will look at this new licence location Revision 1.2 28/05/2014 12 HoleBASE SI Network installation Guide Creating a new HoleBASE SI database The first time you run HoleBASE with a network SQL server installation you need to create a new database to store the data. HoleBASE SI will do this for you but you need to follow the steps below to complete the task. 1. When you run HoleBASE SI for the first time you will see the login screen as shown below. 2. Click on the Manage Connections Link to open the connections window. This will display any connections you already have configured for HoleBASE SI. The first time you open this form it will be blank. Click the Create Database button. 3. You will now see one of the largest forms in HoleBASE SI and you will need to carefully complete each section. There are two sections for username and password. The first section, labelled SA details is the username and password for the SQL server user that has rights to create new databases. This is usually different from the main users details. a. Connection Name:- This is the name for the connection, it will be shown in the HoleBASE user interface. You can use any name for this parameter. b. SA Username and Password: These are the details for the user that has permission to create a new database in the SQL server install and will have been provided to you by your IT department or recorded when you setup SQL Server. c. Server: This is the server name that the SQL server is running on. The server name should be the same as the server name you use to login into the SQL Server Management Studio. If you are unsure and your IT department has the SQL browser installed on your server you can use the Browse button to locate your server. d. Database Name:- This is the exact name for the database that you wish to setup in SQL server. It is recommended that you use HoleBASE SI as your default name. e. Database Username and Password: Select “Create New User” and then add the user name and password, or select use an existing user by adding their username and password. This will be the user who has permissions / is Revision 1.2 28/05/2014 13 HoleBASE SI Network installation Guide owner of the created database which by default will have no access permissions to any other database on the server 4) Click the Test Connection button to ensure that a connection can be made to the database and then click Save to create the database. The process of creating the database and saving the information will also set up the connection to the server in this copy of HoleBASE SI. If you wish to connect other installations of HoleBASE SI to this database server you need to follow the “Connecting to an existing HoleBASE SI database procedure below and you do not need to repeat this procedure. Once you have created the database you will need to connect to it. This is covered in the next section of this guide. If the Test Connection was not successful this is likely to be due to a number of options:• The username and password are wrong for the System Administrator. This can be checked by logging into the SQL Server Management Studio on the server. If you are unable to do this then there is a problem with the username or password you have entered • You have selected the option that forces the user to change their password the first time they login to SQL Server. HoleBASE SI does not support the changing of the password so SQL will not allow access. Logging on to Management Studio on the server will resolve this problem. • The desktop machine cannot see the SQL server. This may be due to network security restrictions of firewall settings. To test if this is the problem try to connect to the SQL Server using the username and password using the Data Connections options in Excel. Consult with your IT team if you are unable to connect with Excel or the Keynetix Support team if you can. Connecting to an existing HoleBASE SI Database If you are connecting to a network SQL server then you must follow the steps below. Revision 1.2 28/05/2014 14 HoleBASE SI Network installation Guide 1. When you run HoleBASE SI for the first time you will see the login screen as shown below. 2. Click on the Manage Connections Link to open the connections window. This will display any connections you already have configured for HoleBASE SI. The first time you open this form it will be blank. Click New Connection to link to an existing database that has been set up for HoleBASE SI. Note: If you have not yet created a HoleBASE SI database then you need to click the Create Database button and follow the steps in the section above in this guide. 3. The Connections form will be displayed as shown below and you need to enter the following information that will have been supplied to you by your IT department. a. Name:- This is the name of the connection and will be shown in the HoleBASE user interface. You can use any name for this parameter. b. Database Name:- This is the precise name for the database that has already been set up within SQL server using the “Creating a new HoleBASE SI database” procedure above c. Server: This is the server name that the SQL server is running on. The server name should be the same as the server name you use to login into the SQL Server Management Studio. If you are unsure and your IT department has the SQL browser installed on your server you can use the Browse button to locate your server. d. Username and Password: This will have been provided to you by your IT department or set up in the “create new database” procedure above. Revision 1.2 28/05/2014 15 HoleBASE SI Network installation Guide Rolling out HoleBASE SI on large networks The config file can be copied onto multiple machines to speed up deployment on multiple machines for more information on this option please contact our support team on support@keynetix.com Logging in HoleBASE SI comes with a standard Administrator User Account. The username for this account is Administrator. The default password is Qwerty123 with a capital Q. The first time you login to HoleBASE SI you will be asked if you wish to load our sample data. It is recommended that you do this as it will enable you to quickly get to grips with the system’s capabilities. The demo project is easy to delete once you have finished learning the system. Next steps Congratulations you have now reached the end of the network Installation of HoleBASE SI and should now have your data and licences being served from the network. This is the end of the installation process but the start of your tour of HoleBASE SI. We recommend that you open up the user guide and print it for reference. You may also like to follow us on Twitter @keynetix as we tweet about new content when it is uploaded to The Keynetix Knowledgebase. Revision 1.2 28/05/2014 16 HoleBASE SI Network installation Guide 6. Appendix 1 – IT notes This section contains IT specific information that your IT team may need in order to assess the best way to install the system. Most users do not need to know this level of detail to install HoleBASE SI so we have included this information in an Appendix. Permissions You will require Administrator Privileges in order to install HoleBASE SI and its prerequisites. All prerequisites are bundled into the HoleBASE SI Installer which auto detects if you have the required versions and then installs them automatically if required. You do not need to download the prerequisites manually. Please note that depending on your Windows User Account Control (UAC) settings you may also be prompted to elevate to a System Administrator and may be prompted to enter an Administrator username and password. Firewall and Antivirus Exceptions HoleBASE SI contains a mapping component within the software which may need a specific exception added to any network antivirus and firewall software running on the network. Any proxy servers that may prevent the program from accessing the internet may also need to be reviewed. Specifically the following executable may need adding to any firewall or proxy server exception list; Keynetix.HolebaseSI.WPF.exe Also, the following list of web addresses may need adding to any proxy server exception lists; BING: dev.virtualearth.net ecn.t0.tiles.virtualearth.net ecn.t1.tiles.virtualearth.net ecn.t2.tiles.virtualearth.net ecn.t3.tiles.virtualearth.net BGS: mapapps2.bgs.ac.uk/ArcGIS/services/GeoIndexLite/boreholes/MapServer/WMSServer? maps.bgs.ac.uk/ArcGIS/services/BGS_Detailed_Geology/MapServer/WMSServer? HoleBASE SI also requires a connection through to Microsoft SQL Server database. If any problems are encountered connecting through to the database then please consult the HoleBASE database installation guide or consult the Keynetix support team. Prerequisites This section describes the prerequisites for installing the HoleBASE SI release on your machine. All the application prerequisites are bundled into the HoleBASE SI Installer which will detect and automatically install the required components. Windows Installer 4.5 In order to install a number of the prerequisites version 4.5 of the Windows Installer is required. Microsoft Windows Installer is a component of the Windows operating system. Windows Installer provides a standard foundation for installing and uninstalling software. Microsoft .NET Framework 3.5 SP1 and .NET Framework 4.0 HoleBASE SI requires the Microsoft .NET Framework 4.0 which requires version 3.5 SP1 as a prerequisite. Important Note: The .NET Framework 4 works side by side with older Framework versions. Applications that are based on earlier versions of the Framework will continue to run on the version targeted by default. Revision 1.2 28/05/2014 17 HoleBASE SI Network installation Guide Microsoft SQL Server Express 2008 R2 SP2 If you run the HoleBASE SI and SQL Server installer on your machine then the installation will create a specific SQL Server instance called “HOLEBASE” and so will not affect any existing default or named instances of SQL Server Express on the machine. Important Note: To date we have only tested the installation of SQL Server 2008 R2 SP2 Express alongside an existing SQL Server 2008 Express and SQL Server 2005 Express installation. Please contact support (support@keynetix.com) prior to installation if you have any other SQL Server database versions already installed on your machine and are concerned about installing SQL Server 2008 R2 SP2 Express. Microsoft® SQL Server® 2008 R2 Native Client (For XP ONLY – without SQL Server) (This is not required if SQL server has been installed locally using the with SQL Server installer) Microsoft SQL Server 2008 R2 Native Client (SQL Server Native Client) is a single dynamiclink library (DLL) containing both the SQL OLE DB provider and SQL ODBC driver. It contains run-time support for applications using native-code APIs (ODBC, OLE DB and ADO) to connect to Microsoft SQL Server 2000, 2005, or 2008. SQL Server Native Client should be used to create new applications or enhance existing applications that need to take advantage of new SQL Server 2008 R2 features This redistributable installer for SQL Server Native Client installs the client components needed during run time to take advantage of new SQL Server 2008 R2 features, and optionally installs the header files needed to develop an application that uses the SQL Server Native Client API. Note the additional prerequisite that is only required for XP when SQL Server Express is not installed locally. This installer is available from the download page at http://www.keynetix.com/holebase/downloads. Revision 1.2 28/05/2014 18