icms Version 2.5 icms Installation Guide

Transcription

1 icms Version 2.5 icms Installation Guide IGiCMS/R15, Mar 2014

2 All rights reserved Copyright 2014, Speakerbus Technology Printed in the UK Speakerbus Technology Limited reserves the right to make changes to the information in this document at any time without notice. Information published in this document is believed to be reliable. However, Speakerbus Technology Limited assumes no liabilities for inaccuracies or omissions in this document, or liability arising from the use of such information. Speakerbus Technology Limited assumes no liability for the infringement of patents or other intellectual property rights owned by third parties which may result from the application of this information. No part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical, for any purposes, without the written permission of Speakerbus Technology Limited. Trademarks Speakerbus Technology company logo is a registered trademark of Speakerbus Technology Limited. Speakerbus is a trademark of Speakerbus Technology Limited. Statement of Conditions Speakerbus reserves the right to make changes to the products described in this document without notice. Speakerbus Technology Limited does not assume any liability that may occur due to the use or application of the product(s) describes herein. Previous Revisions Document Name Sales Code Version Revision IGiCMS Version 2.5 Revision 14 IGiCMS Version 2.3 Revision 13 IGiCMS Version 2.2 Revision 12 IGiCMS Version 2.1 Revision 11 IGiCMS Version 2.0 Revision 10 IGiCMS Version 2.0 Revision 9 IGiCMS Version 1.5 Revision 8 IGiCMS Version 1.4 Revision 7 IGiCMS Version 1.4 Revision 6 IGiCMS Version 1.3 Revision 5 IGiCMS Version 1.2 Revision 4 IGiCMS Version 1.1 Revision 3 IGiCMS Version 1.1 Revision 2 IGiCMS Version 1.0 Revision 1 IGiCMS Version 1.01 Candidate Release 1

3 Contents About this Guide...6 Using this Guide... 6 Software Version... 6 Related Manuals... 6 Further Help... 6 Getting Help with Speakerbus System... 6 In All Cases... 6 icms Diagnostics... 7 System Requirements...8 Single Server Configuration... 8 Hardware Requirements... 8 Physical Requirements... 8 Additional Virtualisation Requirements... 8 Operating System... 8 Software Requirements... 8 Accounts... 9 Dual Server Configuration... 9 Database Server Requirements... 9 Hardware Requirements... 9 Software Requirements... 9 Additional Virtualisation Requirements IIS Server Requirements Hardware Requirements Software Requirements Accounts Web Client Compatibility...12 Before the Installation of icms Software Windows Server 2003 R Install IIS Microsoft.NET Framework 2.0 (SP2) IIS Web Service Extensions (for IIS 6) on Windows Server 2003 R Windows Firewall Install Microsoft SQL Install icms Software

4 Windows Server 2008 R Install IIS Microsoft.NET Framework 2.0 (SP2) IIS 6 Metabase Compatibility (for IIS 7) on Windows Server 2008 R Windows Authentication (for IIS 7) on Windows Server 2008 R IIS ASP.NET Application Development Role Service (for IIS 7) on Windows Server 2008 R ISAPI Restrictions (for IIS 7) on Windows Server 2008 R Windows Firewall Install Microsoft SQL Install icms Software Windows 2012 Server Install Web Server (IIS) Microsoft.NET Framework IIS 6 Metabase Compatibility (for IIS 8) on Windows Server Windows Authentication (for IIS 8) on Windows Server ASP.Net Application Development ISAPI Restrictions (for IIS 8) on Windows Server Windows Firewall Install Microsoft SQL Install icms Software General Guidance...19 Windows Authentication Issues Using Internet Explorer Application Pool Identity Microsoft SQL Installation and Configuration SQL Server Security Microsoft SQL 2005 / 2008 R2 / 2012 Installation SQL Server Configuration Manager Software Installation...23 Single (Web and Database) Server Installation Database Server Only Installation Web Server Only Installation The Upgrade Installation...40 Single (Web and Database) Server Upgrade Database Server Only Upgrade Web Server Only Upgrade

5 After the Installation...53 Using Client Release Documentation Log Files Installation Log Personal Directory Data Corporate Directory Data Installing Security Certificates Removing Security Certificates Internet Explorer Compatibility Mode Not Supported Uninstallation...61 Appendix A: Database Schedule

6 Using this Guide About this Guide This guide describes how to install the icms software. Software Version This document is written for icms Server software version 2.5. Related Manuals This document needs to be used in association with the following documents: imanager Administrator s Guide imanager Communications Solutions Overview Document Further Help In all instances, first seek help from your System Administrator. If necessary, your System Administrator can the Speakerbus Global Helpdesk at customer.support@speakerbus.co.uk. Getting Help with Speakerbus System Please find detailed below information we would like to receive when you are reporting problems to us. This will enable us to better respond to you. In All Cases Please supply a detailed description of the problem and all symptoms. Remember that a System Crash is not a detailed description. Please include the following: Timeline of events including any remedial action taken. Please also detail which time zone is being referenced in your timeline. Any relevant background information. For instance: What was happening when the problem occurred? How did the problem manifest itself? Does it effect one or all users; what were the symptoms, e.g. Remote call failure between X and Y? Has there been any work on the solution recently locally or remotely (Hardware/Software upgrades, etc.)? Which other locations are affected? (Please list sites.) 6

7 How serious is the problem? Has the problem been resolved? When submitting this information please ensure all files are clearly labelled as to which device they relate to. Please read any description that you submit and ask yourself the question what information would I need to solve this problem? icms Diagnostics Please supply the following from the icms server: Speakerbus log files for the time period around the problem. File location C:\Program Files\Speakerbus Technology Ltd\iCMS\ LogFiles. Please include the Comms.log, Install.log, Integration.log (if applicable), Maintenance.log and the Web.log. Full SQL Database Backup from the icms server experiencing the problem. Microsoft Windows Event Logs Application Log Security Log (if available) System Log System Information Host name and IP Information (LmHost/Hosts file). Speakerbus Software levels If it is a performance related issue please take a number of screen shots of the CMSCommsService processe in Task Manager. If possible a description of any Firewall configuration. Any other pertinent information. 7

8 Single Server Configuration Hardware Requirements Physical Requirements Processor: 1Ghz Intel Pentium 4 Processor or faster RAM: 1Gb minimum, 4Gb RAM recommended Additional Virtualisation Requirements System Requirements icms can be supported on both VMWare or Microsoft Hypervisor virtualised environments. Speakerbus supports VMWare Server ESXi V5 along with Microsoft Hyper V 2008 R2. The minimum host server specification is: Processor: Intel XEON (E5520 8Mb Cache 2.26Ghz) RAM: 2Gb Hard Disk: 135Gb The recommended minimum Guest configuration for icms is: CPU Cores: 1 RAM: 1Gb Network: Directly connected to the physical network using auto detect (switch port connected to should be a minimum of 100/Full). Hard Disk: Minimum 20Gb avaliable. This can be thin provisioned. Operating System Microsoft Windows Server 2012 (only available as 64-Bit Operating System) Microsoft Windows 2008 R2 (only available as 64-Bit Operating System) Microsoft Windows Server 2003 R2 32 Bit (SP2 recommended) Software Requirements Microsoft.NET Framework 2.0 (x64 version required on 64-bit Windows) (SP2) Microsoft SQL Server 2005, 2008 R2 and 2012; All Editions, x86 or x64 IIS 8

9 IIS 8 (for Microsoft Windows Server 2012) IIS 7 (for Microsoft Windows Server 2008 R2) OR IIS 6 (for Microsoft Windows Server 2003 R2, 32-Bit) NTFS file system (FAT file system is not supported) Accounts The icms software must not be installed on a domain controller. SQL Express Editions are suitable for small deployments for no more than twenty users. When using SQL Express Editions, SQL Server Management Studio Express is required for database management (E.g. database backups and restores). Use the defaults when installing SQL Server Management Studio Express. Windows: The Windows account used to install the icms needs to be a member of the Administrators group. The Windows account used to install the icms needs to have sysadmin privileges in SQL. Dual Server Configuration Database Server Requirements Hardware Requirements Processor: 1Ghz Intel Pentium 4 Processor or faster RAM: 1Gb RAM Software Requirements Microsoft.NET Framework 2.0 (x64 version required on 64-bit Windows) (SP2) Microsoft SQL Server 2005, 2008 R2 and 2012; All Editions, x86 or x64 NTFS file system (FAT file system is not supported) The icms software must not be installed on a domain controller. SQL Express Editions are suitable for small deployments for no more than twenty users. When using SQL Express Editions, SQL Server Management Studio Express is required for database management (E.g. database backups and restores). Use the defaults when installing SQL Server Management Studio Express. 9

10 Additional Virtualisation Requirements icms can be supported on both VMWare or Microsoft Hypervisor virtualised environments. Speakerbus supports VMWare Server ESXi V5 along with Microsoft Hyper V 2008 R2. The minimum host server specification is: Processor: Intel XEON (E5520 8MB Cache 2.26Ghz) RAM: 2Gb Hard Disk: 135Gb The recommended minimum Guest configuration for icms is: CPU Cores: 1 RAM: 1Gb Network: Directly connected to the physical network using auto detect (switch port connected to should be a minimum of 100/Full). Hard Disk: Minimum 20Gb avaliable. This can be thin provisioned. IIS Server Requirements Hardware Requirements Processor: 1Ghz Intel Pentium 4 Processor or faster RAM: 512Mb RAM Software Requirements Microsoft.NET Framework 2.0 (x64 version required on 64-bit Windows) (SP2) IIS IIS 8 (for Microsoft Windows Server 2012), IIS 7 (for Microsoft Windows Server 2008 R2) OR IIS 6 (for Microsoft Windows Server 2003 R2, 32-Bit) NTFS file system (FAT file system is not supported) The icms software must not be installed on a domain controller. Accounts Windows: The Windows account used to install the icms needs to be a member of the Administrators group. 10

11 SQL Server: The Windows account used to install the icms needs to have System Administrators permissions. Web Client The icms web browser front end will support: Microsoft Internet Explorer (except version 6 and below). Mozilla Firefox (except versions 1, 2, 4 and 5). Microsoft Windows operating systems only. Resolution: 1024 x 768 display (1280x1024 recommended). The icms web browser will not support Linux and Apple OS X operating systems. 11

12 Compatibility Please refer to the Compatibility Matrix for information on icms compatibility with iseries software. 12

13 Before the Installation of icms Software This section describes how needs to be completed before the installation of icms on: Windows Server 2003 R2 (see the section below) Windows Server 2008 R2 (see page 14) Windows Server 2012 (see page 16). Windows Server 2003 R2 1 Install IIS 6 Install IIS 6 (for Windows Server 2003 R2). 2 Microsoft.NET Framework 2.0 (SP2) Ensure Microsoft.NET Framework 2.0 Service Park 2 is installed. x64 versions are required on 64-bit Windows. 3 IIS Web Service Extensions (for IIS 6) on Windows Server 2003 R2 Where the icms software is being installed on operating systems that have IIS Web Service Extension configurability, the following Web Service Extensions must be set to be Allowed: ASP.Net v To allow the extensions listed above follow these steps: 1. Open the Windows Server 2003 R2 IIS management console. 2. Expand the Web Service Extensions folder (located underneath the Web Sites folder). 3. Select each of the extensions listed above press the Allow button (if it is not already Allowed). When the icms is installed, the hostname of the target PC is set within the icms configuration and so changing the hostname of the PC that the icms is installed on after installation will damage the working of the icms, and may well cause a breakdown in communication between the devices and the icms. Before installing the icms software make sure the Readme, located on the CD in the Docs folder is read. 13

14 4 Windows Firewall For information on the ports required for the icms server, please see the iseries Network Requirements document. 5 Install Microsoft SQL Install Microsoft SQL. For more information, see Microsoft SQL Installation and Configuration section on page Install icms Software Install icms software. For more information, see the Software Installation section, on page 23. Windows Server 2008 R2 1 Install IIS 7 Install IIS 7 (for Windows Server 2008 R2). 2 Microsoft.NET Framework 2.0 (SP2) Ensure Microsoft.NET Framework 2.0 Service Park 2 is installed. x64 versions are required on 64-bit Windows. 3 IIS 6 Metabase Compatibility (for IIS 7) on Windows Server 2008 R2 The icms web server requires that the IIS 6 Metabase Compatibility role service is installed with the Web Server (IIS) role. Windows does not install this component by default. To check whether or not the IIS 6 Metabase Compatibility role service is installed: 1. Open Programs Files > Administrative Tools > Server Manager. 2. Expand the Roles folder and select the Web Server (IIS) role. 3. Review the Role Services section to check that the IIS 6 Metabase Compatibility component (listed under Management Tools>IIS 6 Management Compatibility) is Installed. 4 Windows Authentication (for IIS 7) on Windows Server 2008 R2 If the icms web server is to be configured for Windows authentication then the icms web server requires that the IIS Windows Authenitcation role service is installed with the Web Server (IIS) role. Windows does not install this component by default. To check whether or not the Windows Authenitcation role service is installed: 14

15 1. Open Programs Files > Administrative Tools > Server Manager. 2. Expand the Roles folder and select the Web Server (IIS) role. 3. Review the Role Services section to check that the Windows Authentication component (listed under Security) is Installed. 5 IIS ASP.NET Application Development Role Service (for IIS 7) on Windows Server 2008 R2 The icms web server requires that the ASP.NET application development role service is installed with the Web Server (IIS) role. Windows does not install this component by default. To check whether or not the ASP.NET application development role service is installed: 1. Open Programs Files > Administrative Tools > Server Manager. 2. Expand the Roles folder and select the Web Server (IIS) role. 3. Review the Role Services section to check that the ASP.NET component (listed under Application Development) is Installed. 6 ISAPI Restrictions (for IIS 7) on Windows Server 2008 R2 1. Open Programs Files > Administrative Tools > IIS Manager. 2. Select the server from the Recent connections section. 3. In the IIS section select ISAPI and CGI Restrictions. 4. Review the the status of the ASP.NET v extension, and ensure it is set to Allowed. On 64-bit systems both the 32-bit and 64-bit versions of the extension should be Allowed 7 Windows Firewall Please note that when Windows 2008 is installed, Windows Firewall closes network ports that are needed by the icms server. Please ensure these ports are re-opened. For more information on the ports required for the icms server, please see the icms Network Requirements document. 8 Install Microsoft SQL Install Microsoft SQL. For more information, see Microsoft SQL Installation and Configuration on page Install icms Software Install icms software. For more information, see the Software Installation 15

16 section, on page 23. Windows 2012 Server 1 Install Web Server (IIS) 8 Install Web Server (IIS) 8 (for Windows Server 2012). 2 Microsoft.NET Framework 3.5 Ensure Microsoft.NET Framework 3.5 is installed..net Framework 3.5 includes.net Framework 2.0 and IIS 6 Metabase Compatibility (for IIS 8) on Windows Server 2012 The icms web server requires that the IIS 6 Metabase Compatibility role service is installed with the Web Server (IIS) role. Windows does not install this component by default. To check whether or not the IIS 6 Metabase Compatibility role service is installed: 1. Open the Server Manager console. 2. In the ROLES AND SERVER GROUPS section select IIS. The console screen changes and displays two sections: SERVERS and EVENTS. 3. In the SERVERS section select TASKS>Add roles and features. This displays the Add Roles and Features Wizard. 4. Click Next. 5. On the next page ensure Role-based or feature-based installation is selected and click Next. 6. On the next page ensure Select a server from the server pool is selected and choose the required server. 7. Click Next. 8. On the roles page expand Web Server (IIS)>Management Tools. 9. Within Management Tools ensure IIS Management Console and IIS 6 Management Compatibility are selected. 10. Select Install. 4 Windows Authentication (for IIS 8) on Windows Server 2012 If the icms web server is to be configured for Windows authentication then 16

17 the icms web server requires that the IIS Windows Authenitcation role service is installed with the Web Server (IIS) role. Windows does not install this component by default. To check whether or not the Windows Authenitcation role service is installed: 1. Open the Server Manager console. 2. In the ROLES AND SERVER GROUPS section select IIS. The console screen changes and displays two sections: SERVERS and EVENTS. 3. In the SERVERS section select TASKS>Add roles and features. This displays the Add Roles and Features Wizard. 4. Click Next. 5. On the next page ensure Role-based or feature-based installation is selected and click Next. 6. On the next page ensure Select a server from the server pool is selected and choose the required server. 7. Click Next. 8. On the roles page expand Web Server (IIS)>Web Server>Security. 9. Within Security ensure Windows Authentication is selected. 10. If the Install button is active select it to start the installation. 5 ASP.Net Application Development 1. Open the Server Manager console. 2. In the ROLES AND SERVER GROUPS section select IIS. The console screen changes and displays two sections: SERVERS and EVENTS. 3. In the SERVERS section select TASKS>Add roles and features. This displays the Add Roles and Features Wizard. 4. Click Next. 5. On the next page ensure Role-based or feature-based installation is selected and click Next. 6. On the next page ensure Select a server from the server pool is selected and choose the required server. 7. Click Next. 8. On the roles page expand Web Server (IIS)>Web Server>Application 17

18 Development. 9. Within Application Development ensure ASP.NET 3.5 is selected. 10. If the Install button is active select it to start the installation. 6 ISAPI Restrictions (for IIS 8) on Windows Server Open IIS Manager. 2. Select the server from the Connections section. 3. Locate the ISAPI and CGI Restrictions icon and double click it to open it. 4. Review the the status of the ASP.NET v extension, and ensure it is set to Allowed. 6 Windows Firewall Please note that when Windows 2008 is installed, Windows Firewall closes network ports that are needed by the icms server. Please ensure these ports are re-opened. For more information on the ports required for the icms server, please see the icms Network Requirements document. 7 Install Microsoft SQL Install Microsoft SQL. For more information, see Microsoft SQL Installation and Configuration on page Install icms Software Install icms software. For more information, see the Software Installation section, on page

19 General Guidance Windows Authentication Issues Using Internet Explorer There are some known Microsoft issues in Internet Explorer when connecting to a web site that is using a custom identity on it s application pool and trying to authentication on that web site using Windows autentication (not Forms authentication). The issues are explained in the following articles support.microsoft.com/kb/215383/en-us/ and kb/911149/. A typical symptom of these issues is for Internet Explorer users connecting to the website (expecting to be authentication using their Windows logon details) to be rejected access and continually prompted for their username and password. In order to rectify this issue, should it occur, the administrator will need to force IIS to authentication using NTLM instead of the default Kerberos authentication. Further details of the fix can be seen in the following article A batch file has been provided with the web server component of the icms software. The batch file alters the authentication setting of IIS to use NTLM. It should be noted that this will affect all virtual directories running under the Default Web Site, so should only be used where necessary. The batch file, called EnableNTLMAuthenticationOverride.bat, can be found in <INSTALLDIR>\Resources\IIS. Application Pool Identity It is recommended that the default, installed icms web server application pool identity is not changed. If, however, the administrator wishes to use a new identity (user account) the new identity must be: 1. Added to the Windows IIS_WPG user group on the web server machine. 2. Added as a login within SQL Server on the database server machine with permissions to read/write from/to the icms SQL database. 3. Given read/write permissions to <INSTALLDIR>\LogFiles and <INSTALLDIR>\iManager\Downloads. 4. Given full control permissions to all existing Web.log files in the <INSTALLDIR>\LogFiles folder. 19

20 SQL Server Security Microsoft SQL Installation and Configuration SQL Server Security Level - The icms SQL database is installed / upgraded and uninstalled via the icms InstallShield setup. When performing these SQL Server administrative tasks the user account used to connect to SQL Server must have Administrative rights within SQL Server. This means when using Windows Authentication the user running the icms InstallShield setup must have Administrative rights. SQL Server Authentication can be selected during the installation as a means of installing or upgrading the icms SQL database. If Microsoft SQL Server is already installed (for instance, a GA Server), please ensure it meets the following requirement. Microsoft SQL 2005 / 2008 R2 / 2012 Installation Although icms supports Microsoft SQL 2005, 2008 R2 and 2012 Standard, Workgroup and Express editions, this document will only explain how to install Microsoft SQL Installing Microsoft SQL 2008 and SQL 2008 R2 are practically identical to installing Microsoft SQL When installing Microsoft SQL Server 2005, ensure the following components are selected when prompted: Please note that some of components in the Microsoft SQL Server 2005 illustration have been renamed in version The table below shows component names in Microsoft SQL Server 2005 and its equivalent name in version

21 Component Name Microsoft SQL Server 2005 Microsoft SQL Server 2008 R2 / 2012 Database Services Connectivity Components Management Tools Database Engine Services Client Tools Connectivity Management Tools + Complete SQL Books Online (optional) For Microsoft SQL Express 2008 R2 / 2012 installations please ensure the SQL Server Database service is set using the default settings and to use NT AUTHORITY/SYSTEM as the account name. SQL Server Configuration Manager In Microsoft SQL 2008 R2, Microsoft SQL 2008 Express Edition, Microsoft SQL 2005 or SQL Server Management Studio Express (for SQL Server 2005 Express Edition SP2 installations), ensure TCP/IP is set to Enabled. 21

22 22

23 Software Installation Please ensure the installation requirements are met before completig the upgrade. For more information, see System Requirements on page 8. Single (Web and Database) Server Installation Before installing the icms software make sure the icms_readme, located on the CD in the Docs folder is read. Please note that the machine the icms is being installed on may require a system restart after the installation process. This is normally the case when the installation is completed remotely. If the User Account Control feature of Windows is being used the user may be prompted to allow the icms installation program to run and make changes on the system. The icms installation program must be run using an Administrator account, or using the Run as administrator feature of Windows. To install icms: 1. Insert the CD into the CDROM drive. The Main Menu is displayed. If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 23

24 2. Select Install icms. The InstallShield setup wizard is executed and a welcome page is displayed. 3. Select Next. The Customer Information page of the wizard is displayed. 4. Type a User name and Company name to register the icms installation, and select Next. The Choose Destination Location page of the wizard is displayed. This page allows you to choose a location to install the icms software. 5. If required, change the default installation location and select Next. OR Leave the default installation location unchanged and select Next. 24

25 The Select Features page of the wizard is displayed. 6. Ensure Database Server and Web Server are selected. 7. Ensure Integration Server is selected if you require the icms database to be integrated with an SB 534N global administration database. If not, deselect the option. 8. Click Next. A license agreement for using the Speakerbus icms software is displayed. 9. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using the Apache software is displayed. 10. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using Telerik software is displayed. 25

26 11. Please read and accept the terms of the license agreement and select Next to continue. The Database Server Login page of the wizard is displayed. The icms InstallShield setup wizard needs to connect to the SQL Server upon which the icms is to be installed. This is so that it can install and configure the icms SQL database for use with the icms software. Please note, for SQL Server 2005 Express Edition SP2 / SQL Server 2008 Express Edition SP1 installations the Database Server will need to be set to (hostname)\sqlexpress. 12. In order for the icms InstallShield setup wizard to login to the specified SQL Server the login credentials used to do this are required. Select either Windows authentication or SQL Server authentication. Selecting Windows authentication tells the wizard to log in to SQL Server using the same Windows user account that the installation is being run with. Please note that the login specified must have System Administrator permissions within the SQL Server being used to log on to. 13. Select Next. The system will attempt to detect if an icms SQL database exists. If one does not exsit on the server, the Install new database option page of the icms InstallShield setup wizard is displayed. If one does exist you may be prompted to upgrade the database. The Create Windows scheduled task for icms database page may be displayed instead. If the latter page is displayed please go to step Ensure Yes (Recommended) is selected to install a new SQL database 26

27 maintenance and select Next. The Create Windows scheduled task for icms database page of the icms InstallShield setup wizard is displayed. For more information on the default schedule, see Appendix A Database Schedule on page Ensure Yes (Recommended) is selected to create a Windows scheduled task for icms database maintenance and select Next. The Authentication mode page of the icms InstallShield setup wizard is displayed. 16. Select icms Integral Authentication to use the icms software s inbuilt security system or Windows Authentication to use Windows user account security. 17. Select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page 27

28 wizard. 18. Select Install. The installation will now begin copying files and configuring the system. This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 19. Ensure the Start the icms Communications Service is selected, and select Finish. OR Ensure both the Start the icms Communications Service and Start the icms Integration Server check boxes are selected. The Start the icms Integration Server check box is displayed if the Integration Server was installed as part of the installation. 28

29 20. Select Finish. 21. Now click the imanager desktop icon to start the application. Please refer to the imanager Administrator s Guide for information on how to use imanager. imanager is the web management tool used to manage icms. 22. An icms product key needs to be applied before imanager can be used. For more information, see the Product Key section in the imanager Administrator s Guide. Database Server Only Installation Before installing the icms software make sure the icms_readme, located on the CD in the Docs folder is read. Please note that the machine that the icms is being installed on may require a system restart after the installation process. This is normally the case when the installation is completed remotely. If the User Account Control feature of Windows is being used the user may be prompted to allow the icms installation program to run and make changes on the system. The icms installation program must be run using an Administrator account, or using the Run as administrator feature of Windows. To install icms: 1. Insert the CD into the CDROM drive. The Main Menu is displayed. If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 29

30 2. Select Install icms. The InstallShield setup wizard is executed and a welcome page is displayed. 3. Select Next. The Customer Information page of the wizard is displayed. 4. Type a User name and Company name to register the icms installation, and select Next. The Choose Destination Location page of the wizard is displayed. This page allows you to choose a location to install the icms software. 5. If required, change the default installation location and select Next. OR Leave the default installation location unchanged and select Next. 30

31 The Select Features page of the wizard is displayed. 6. Ensure Database Server is selected and Web Server deselected. 7. Ensure Integration Server is selected if you require the icms database to be integrated with an SB 534N global administration database. If not, deselect the option. 8. Click Next. A license agreement for using the Speakerbus icms software is displayed. 9. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using the Apache software is displayed. 10. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using Telerik software is displayed. 31

32 11. Please read and accept the terms of the license agreement and select Next to continue. The Database Server Login page of the wizard is displayed. The icms InstallShield setup wizard needs to connect to the SQL Server upon which the icms is to be installed. This is so that it can install and configure the icms SQL database for use with the icms software. Please note, for SQL Server 2005 Express Edition SP2 / SQL Server 2008 Express Edition SP1 installations the Database Server will need to be set to (hostname)\sqlexpress. 12. In order for the icms InstallShield setup wizard to login to the specified SQL Server the login credentials used to do this are required. Select either Windows authentication or SQL Server authentication. Selecting Windows authentication tells the wizard to log in to SQL Server using the same Windows user account that the installation is being run with. Please note that the login specified must have System Administrators permissions within the SQL Server being used to log on to. 13. Select Next. The system will attempt to detect if an icms SQL database exists. If one does not exsit on the server, the Install new database option page of the icms InstallShield setup wizard is displayed. If one does exist you may be prompted to upgrade the database. The Create Windows scheduled task for icms database page is displayed instead. If the latter page is displayed please go to step Ensure Yes (Recommended) is selected to install a new SQL database 32

33 maintenance and select Next. The Create Windows scheduled task for icms database page of the icms InstallShield setup wizard is displayed. For more information on the default schedule, see Appendix A Database Schedule on page Ensure Yes (Recommended) is selected to create a Windows scheduled task for icms database maintenance and select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page wizard. 16. Select Install. The installation will now begin copying files and configuring the system. This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 33

34 17. Ensure the Start the icms Communications Service is selected, and select Finish. OR Ensure both the Start the icms Communications Service and Start the icms Integration Server check boxes are selected. The Start the icms Integration Server check box is displayed if the Integration Server was installed as part of the installation. 18. Select Finish. Web Server Only Installation Before installing the icms software make sure the icms_readme, located on the CD in the Docs folder is read. Please note that the machine that the icms is being installed on may require a system restart after the installation process. This is normally the case when the installation is completed remotely. If the User Account Control feature of Windows is being used the user may be prompted to allow the icms installation program to run and make changes on the system. The icms installation program must be run using an Administrator account, or using the Run as administrator feature of Windows. 1. Insert the CD into the CDROM drive. The Main Menu is displayed. 34

35 If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 2. Select Install icms. The InstallShield setup wizard is executed and a welcome page is displayed. 3. Select Next. The Customer Information page of the wizard is displayed. 4. Type a User name and Company name to register the icms installation, and select Next. The Choose Destination Location page of the wizard is displayed. This page allows you to choose a location to install the icms software. 35

36 5. If required, change the default installation location and select Next. OR Leave the default installation location unchanged and select Next. The Select Features page of the wizard is displayed. 6. Ensure Web Server is selected. 7. Ensure Database and Integration Server are deselected. 8. Click Next. A license agreement for using the Speakerbus icms software is displayed. 9. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using the Apache software is displayed. 36

37 10. Please read and accept the terms of the license agreement and select Next to continue. A license agreement for using Telerik software is displayed. 11. Please read and accept the terms of the license agreement and select Next to continue. The Database Server Selection page of the wizard is displayed. 12. Type the name of the SQL Server in SQL Server to which the Web Server component will connect to and click Next. The Authentication mode page of the icms InstallShield setup wizard is displayed. 37

38 13. Select icms Integral Authentication to use the icms software s inbuilt security system or Windows Authentication to use Windows user account security. 14. Select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page wizard. 15. Select Install. The installation will now begin copying files and configuring the system. This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 16. Select Finish. 38

39 17. Now click the imanager desktop icon to start the application. Please refer to the imanager Administrator s Guide for information on how to use imanager. imanager is the web management tool used to manage icms. 18. An icms product key needs to be applied before imanager can be used. For more information, see the Product Key section in the imanager Administrator s Guide. 39

40 The Upgrade Installation Before upgrading the icms software make sure the Readme, located on the CD in the Docs folder, is read. Please ensure the installation requirements are met before completig the upgrade. For more information, see System Requirements on page 8 When upgrading from icms software version 2.2 to a higher version, please uninstall Database Push software. Database Push is no longer required and has been replaced with a Synchronisation feature within imanager. imanager is the web management tool used to manage icms. Single (Web and Database) Server Upgrade Please note that the machine that the icms is being upgraded on may require a system restart after the installation process. This is normally the case when the upgrade is completed remotely. To upgrade an existing icms installation with both database and web server: 1. Insert the CD into the CDROM drive. The Main Menu is displayed. If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 2. Select Install icms. The InstallShield setup wizard is executed and a welcome page is displayed. 40

41 The welcome page displays the current installed software version and the version number that will be installed. Please note that the version numbers displayed on the above illustration are used for illustration purposes only, and may differ to what is displayed on your screen. 3. Select Next. The Select Features page of the wizard is displayed. 4. Ensure Database Server and Web Server are selected. 5. Select the Integration Server check box if you require the icms database to be integrated with an SB 534N global administration database. If not, ensure it is deselect. 6. Click Next. A license agreement for using the Speakerbus icms software is displayed. 7. You need to read and accept the terms of the license agreement and 41

42 select Next to continue. A license agreement for using the Apache software is displayed. 8. You need to read and accept the terms of the license agreement and select Next to continue. A license agreement for using Telerik software is displayed. 9. You need to read and accept the terms of the license agreement and select Next to continue. The Database Server Login page of the wizard is displayed. The icms InstallShield setup wizard needs to connect to the SQL Server upon which the icms is to be installed. This is so that it can install and configure the icms SQL database for use with the icms software. Please note, for SQL Server 2005 Express Edition SP2 / SQL Server 2008 Express Edition SP1 installations the Database Server will need to be set to (hostname)\sqlexpress. 42

43 10. In order for the icms InstallShield setup wizard to login to the specified SQL Server the login credentials used to do this are required. Select either Windows authentication or SQL Server authentication. Selecting Windows authentication tells the wizard to log in to SQL Server using the same Windows user account that the installation is being run with. Please note that the login specified must have System Administrators permissions within the SQL Server being used to log on to. 11. Select Next. The Upgrade database option page of the icms InstallShield wizard is displayed. 12. Ensure Yes (Recommended) is selected to update the SQL database and select Next. The Authentication mode page of the icms InstallShield setup wizard is displayed. 13. Select icms Integral Authentication to use the icms software s inbuilt security system or Windows Authentication to use Windows user account security. The current mode will be selected automatically. 14. Select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page wizard. 43

44 15. Select Install. The installation will now begin. This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 16. Ensure the Start the icms Communications Service is selected, and select Finish. OR Ensure both the Start the icms Communications Service and Start the icms Integration Server check boxes are selected. 17. Select Finish. 44

45 Database Server Only Upgrade Please note that the machine that the icms is being upgraded on may require a system restart after the installation process. This is normally the case when the installation is completed remotely. To upgrade an existing icms installation with database server only: 1. Insert the CD into the CDROM drive. The Main Menu is displayed. If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 2. Select Install icms. The welcome page displays the current installed software version and the version number that will be installed. Please note that the version numbers displayed on the above illustration are used for illustration purposes only, and may differ to what is displayed on your screen. 3. Select Next. The Select Features page of the wizard is displayed. 45

46 4. Ensure Database Server is selected and Web Server deselected. 5. Ensure Integration Server is selected if you require the icms database to be integrated with an SB 534N global administration database. If not, deselect the option. 6. Click Next. A license agreement for using the Speakerbus icms software is displayed. 7. You need to read and accept the terms of the license agreement and select Next to continue. A license agreement for using the Apache software is displayed. 8. You need to read and accept the terms of the license agreement and select Next to continue. The Database Server Login page of the wizard is displayed. The icms InstallShield setup wizard needs to connect to the SQL Server upon which 46

47 the icms is to be installed. This is so that it can install and configure the icms SQL database for use with the icms software. Please note, for SQL Server 2005 Express Edition SP2 / SQL Server 2008 Express Edition SP1 installations the Database Server will need to be set to (hostname)\sqlexpress. 9. In order for the icms InstallShield setup wizard to login to the specified SQL Server the login credentials used to do this are required. Select either Windows authentication or SQL Server authentication. Selecting Windows authentication tells the wizard to log in to SQL Server using the same Windows user account that the installation is being run with. Please note that the login specified must have System Administrators permissions within the SQL Server being used to log on to. 10. Select Next. The Upgrade database option page of the icms InstallShield wizard is displayed. 11. Ensure Yes (Recommended) is selected to update the SQL database and select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page wizard. 47

48 12. Select Install. The installation will now begin copying files and configuring the system. This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 13. Ensure the Start the icms Communications Service is selected, and select Finish. OR Ensure both the Start the icms Communications Service and Start the icms Integration Server check boxes are selected. 14. Select Finish. 48

49 Web Server Only Upgrade Please note that the machine that the icms is being upgraded on may require a system restart after the installation process. This is normally the case when the installation is completed remotely. To upgrade an existing icms installation with database server only: 1. Insert the CD into the CDROM drive. The Main Menu is displayed. If Main menu is not displayed, navigate to the CD using Windows Explorer and double click the Launch.exe on the root of the CD. 2. Select Install icms. The InstallShield setup wizard is executed and a welcome page is displayed. The welcome page displays the current installed software version and the version number that will be installed. Please note that the version numbers displayed on the above illustration are used for illustration purposes only, and may differ to what is displayed on your screen. 3. Select Next. The Select Features page of the wizard is displayed. 4. Ensure Web Server is selected. 49

50 5. Ensure Database and Integration Server are deselected. 6. Click Next. A license agreement for using the Speakerbus icms software is displayed. 7. You need to read and accept the terms of the license agreement and select Next to continue. A license agreement for using the Apache software is displayed. 8. You need to read and accept the terms of the license agreement and select Next to continue. A license agreement for using Telerik software is displayed. 9. You need to read and accept the terms of the license agreement and select Next to continue. The Database Server Selection page of the wizard is displayed. 50

51 10. Type the name of the SQL Server in SQL Server to which the Web Server component will connect to and click Next. The Authentication mode page of the icms InstallShield setup wizard is displayed. 11. Select icms Integral Authentication to use the icms software s inbuilt security system or Windows Authentication to use Windows user account security. 12. Select Next. The icms InstallShield setup wizard is now ready to begin installing the icms software, and displays the Ready to Install the Program page wizard. 13. Select Install. The installation will now begin copying files and configuring the system. 51

52 This should take no more than five minutes to complete. When the installation is complete the Finish page of the wizard is displayed. 14. Select Finish. 52

53 Using Client After the Installation Navigate to the appropriate web address. In order to use imanager correctly, Java Script must be enabled on the client web browser. For Microsoft Internet Explorer it is recommended that the icms server is added to the Trusted Sites zone. For Mozilla Firefox, the Enable JavaScript option must be selected. If an insufficient access to perform any activities message is displayed on the imanager home screen in Microsoft Internet Explorer, you will need to change the access level to Run as administrator. This can be achieved by selecting Start, right clicking Internet Explorer and selecting Run as administrator. Client machines that have previously been used to access imanager, need to be manually refreshed (Firefox Mozilla: <SHIFT>+<F5> and Internet Explorer: <CNTRL>+<F5>), when icms is upgraded. imanager, the web application used to managed icms does not support Internet Explorer s compatibility mode (which is turned on by default for intranet sites). Compatibility mode is effectively the rendering engine for Internet Explorer 7. imanager does not support Internet Explorer 7. To turn off compatibility mode, select Tools > Compatibility View. Release Documentation It is recommended that the administrator reads the release documentation provided with the icms. This can be accessed via the CD Browser or from the Start Menu using the Speakerbus->iCMS->iCMS Release Docs shortcut. Log Files For the purpose of diagnosing issues with the software or the installation, log files are written to the LogFiles folder, located underneath the installation target folder: CMSComms.log - Logging information from the icms Communications System. CMSWeb.log - Logging information from the icms Web Server. CMSIntegration - Logging information when the icms is integrated with a SB 534N System. Install.log - Logging information from the icms InstallShield setup. 53

54 When reporting issues back to Speakerbus Technology Limited, please include the above mentioned log files. In certain circumstances it may also be necessary to return additional information to aid the diagnostic process. You may also be asked to include the Windows System and Application Event Logs, and a backup of the SQL Server icms database. Installation Log The icms InstallShield setup wizard writes a log of it s actions. This log can be used to diagnose problems with the installation or as a record of the icms software installations performed. The installation log file is located in the LogFiles sub-directory of the icms installation path. The log file is called Install.log and is written in plain text so can be read by any text reader, e.g. Notepad. Personal Directory Data The Microsoft Excel spreadsheet used when importing personal directory data is located in the <TARGETDIR>\Resources\PersonalDirectory folder. For information on how to export the personal directory to an excel spreadsheet please refer to the imanager Administrator s Guide. Corporate Directory Data The Microsoft Excel spreadsheet used when importing corporate directory data is located in the <TARGETDIR>\Resources\CorporateDirectory folder. For information on how to export the corporate directory to an excel spreadsheet please refer to the imanager Administrator s Guide. Installing Security Certificates Speakerbus do not supply the security certificate. This needs to be obtained from an authorised source. Before installing the security certificate: 1. Ensure you are logged onto the icms system controller as Administrator or have administrative rights. 2. Ensure you know the security certificate file name and location. To install a security certificate on the icms system controller: 1. Open the Internet Information Service (IIS) Manager. 54

55 2. In the directory tree structure right-click Default Web Site and select Properties. This opens the Default Web Site Properties dialog. 3. Select the Directory Security tab. 4. In Secure communications select Server Certificate. This opens the Welcome Web Server Certificate Wizard. 55

56 5. Select Next. This opens the Sever Certificate page. 6. Select Import a certificate from a.pfx file. This opens the Import Certificate page. 7. Locate the security certificate file using the Browse button and click Next. This opens the Import Certificate Password page. 56

57 8. Enter the security certificate in Password and click Next. If you do not know the password, contact your system administrator. Do not change the default SSL port number Click Next. This opens the Imported Certificate Summary page. 10. Select Next. The Finish page appears. 11. Select Finish. 12. Select the OK on the Default Web Site Properties dialog. 13. Open the imanager web page typing, at the beginning of the address. 57

58 Removing Security Certificates To remove a security certificate: 1. Open the Internet Information Service (IIS) Manager. 2. In the directory tree structure right-click Default Web Site and select Properties. This opens the Default Web Site Properties dialog. 3. Select the Directory Security tab. 4. In Secure communications select Server Certificate. This opens the Welcome Web Server Certificate Wizard. 58

59 5. Select Next. This opens the Modify the Current Certificate Assignment page. 6. Select Remove the current certificate and select Next. This opens the Remove Certificate page. 7. Select Next. This opens the Finish page. 8. Select Finish. 9. Select the OK on the Default Web Site Properties dialog. 59

60 Internet Explorer Compatibility Mode Not Supported imanager, the web application used to managed icms does not support Internet Explorer s compatibility mode (which is turned on by default for intranet sites). Compatibility mode is effectively the rendering engine for Internet Explorer 7. imanager does not support Internet Explorer 7. To turn off compatibility mode, select Tools > Compatibility View. 60

61 Uninstallation The Windows and SQL Users CMSCommsService and CMSWebService are not removed by the uninstallation on standalone installations. Additionally, the Windows and SQL Users CMSIntegration and CMSMaintenance are not removed by the uninstallation on integrated installations. These will need to be manually removed from both Windows and Microsoft SQL to complete the uninstallation. To uninstall icms: 1. Open Add / Remove Programs via the Windows Control Panel. 2. Select icms from the list of currently installed programs. 3. Select Remove. 4. Confirm that you wish to remove icms. The InstallShield setup wizard is executed and a welcome page is displayed. 5. Select Next. 61