aqd portal v7.2 installation guide
DESCRIPTION
AQD Portal v7.2 Installation GuideTRANSCRIPT
For further information
Email: [email protected]
Website: www.superstructuregroup.com
Head Office
Superstructure Group Limited
Ash House, Fairfield Avenue
Staines, Middlesex TW18 4AB
United Kingdom
Ph +44 870 803 2579
Fax +44 1784 224 245
Regional Office
Superstructure Group (AP) Limited
Level 1, 19 Tory Street
P O Box 19127, Courtenay Place
Wellington, New Zealand
Ph +64 4 385 0001
Fax +64 4 381 3934
Safety & Risk Management
AQD PORTAL V7.2
Installation Guide
Release 1.6
Date: October 2010
AQD Portal Installation Guide
Release: 1.6 October 2010
AQD Portal v7.2 Installation Guide.doc
Copyright 2010 Superstructure Group Limited
All rights reserved
No part of this publication may be reproduced, stored in a retrieval system, or
transmitted in any form or by any means, electronic, mechanical, photocopying,
recording or otherwise without the prior written permission of Superstructure Group
Limited, the copyright holder.
This document is the property of Superstructure Group Limited and may not be
disclosed to any third party or copied without consent.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Contents i
AQD Portal v7.2 Installation Guide.doc
Table of Contents
Introduction ........................................................................................................................ 1
Installation Overview ........................................................................................................................... 1
Installation Steps ................................................................................................................................. 1
Installation Steps (continued) .............................................................................................................. 2
Step 1 – IIS installed and correct .Net Framework version ................................................................. 2
Step 2 – Database Version ................................................................................................................. 2
Step 3 – Obtain the Database Source and Catalog ............................................................................ 3
Step 4 – Reading Configuration Guide ............................................................................................... 4
Step 5 – Application Folder ................................................................................................................. 4
Step 6 – Unzip Archive ........................................................................................................................ 4
Step 7 – Log Folder ............................................................................................................................. 4
Step 8 – Edit Web.Config .................................................................................................................... 5
Step 9 – Disable Security .................................................................................................................... 5
Step 10 – Open IIS Manager............................................................................................................... 5
Step 11 – Create Application Pool ...................................................................................................... 5
Step 12 – Create the AQD Portal Web Application ............................................................................. 5
Step 13 – Enable Default Content Page ............................................................................................. 5
Step 14 – Configure URL for accessing the AQD Portal .................................................................... 6
Step 15 – Open AQD Portal Site ......................................................................................................... 7
Step 16 – License the AQD Portal ...................................................................................................... 7
Step 17 – Create Administration User(s) ............................................................................................ 7
Step 18 – Close the Browser............................................................................................................... 8
Step 19 – Enable Security ................................................................................................................... 8
Step 20 – Validate Access .................................................................................................................. 8
Step 21 – Set up Other Users ............................................................................................................. 8
Step 22 – Custom Logo ....................................................................................................................... 8
Step 23 – Custom Text ........................................................................................................................ 8
SSL Certificates ................................................................................................................................... 8
Windows Server 2003 IIS Installation ................................................................................ 9
Create Application Pool ....................................................................................................................... 9
Create Web Application ..................................................................................................................... 11
Multiple File Upload ........................................................................................................................... 12
64 Bit Settings ................................................................................................................................... 13
Windows Server 2008 IIS Installation .............................................................................. 14
Create Application Pool ..................................................................................................................... 14
Create Web Application ..................................................................................................................... 16
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 1
AQD Portal v7.2 Installation Guide.doc
Introduction
The AQD Portal is currently supported on:
Windows 2003 Server
Windows 2008 Server
The AQD Portal will run on 64 bit environment but has to be run in 32 bit mode.
Requires .NET Framework 3.5 SP1 on the web server and ASP.NET 2.0 configured
and functioning.
Prior to Installation of the AQD Portal you need an AQD 7 SQL Server database. If
you are currently running a previous version of AQD you will need to upgrade to
version 7 before installing and configuring this application.
Installation
Overview
The installation process in general is similar on 2K3 and 2K8 apart from some of the
IIS Settings and where they are located. The basic process and sequence will be
covered first then the IIS Configuration separately for each of the two environments.
Installation
Steps
1. The .NET framework 3.5sp1 needs to be installed before IIS is installed.
2. Confirm that the database to connect to has been created or upgraded to AQD
Version 7.
3. Check the name of the SQL Server Instance and the name of the database.
4. Pre-read the AQD Portal Configuration guide and determine the configuration
options to be used.
a. Authentication.
b. Authorisation.
c. Directory User.
d. Obtain or create a company logo to also appear in the portal.
e. Consider what custom static text is to appear on the landing and home pages.
5. Create a folder on the server to contain the web application that you will later
point to from the Web Application (virtual directory).
6. Copy the contents from the distribution ZIP archive into the new folder (as per
step 5).
7. Set up Log folder.
8. Make your required changes to the “Web.Config” file as outlined in the AQD
Portal configuration Guide based on the decisions made in step 4 above. If you
are going to use Database Authentication you may have to temporarily configure
windows authentication until you have created an administration user.
9. Set securityEnabled attribute in the portalAuthorisationService tag to false
allowing total access to the application (you need to do this to allow you to set up
an administration user).
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 2
AQD Portal v7.2 Installation Guide.doc
Installation
Steps
(continued)
10. Open the Internet Information Services Manager (IIS Manager).
11. Create an AQD Application Pool.
12. Create an AQD Portal Application pointing to the folder created in step 5 adding
it to the AQD Application Pool.
13. Enable Default Content Page
14. Configure URL for accessing the AQD Portal.
15. Open a browser and navigate to the site.
16. Licence the AQD Portal
17. Create the Administration User(s)
18. Close the Browser
19. Enable Security on the portal Authorisation Providers in the “Web.Config” file
and reset the Authentication options if required.
20. Open the portal in a browser again and confirm it is working.
21. Set up other users as required.
22. Load up custom logo.
23. Load up custom text.
Step 1 – IIS
installed and
correct .Net
Framework
version
The .NET framework 3.5sp1 needs to be installed before IIS is installed. This is to
ensure that the correct .Net version extension is installed within IIS. If IIS has already
been installed please refer to the following knowledgebase article regarding .Net
versions and installation http://support.microsoft.com/kb/909642.
To check, if the .NET Framework has been installed already, please review the “Web
Service Extensions” in IIS. The framework has been installed and configured
correctly if there are two entries:
ASP.NET v1.1.4322 ALLOWED
ASP.NET v2.0.50727 ALLOWED
Step 2 –
Database
Version
Check that you have an AQD V7 database to connect to. You can run the following
query against the database (“PAQD” in the example below) to check the status of the
database schema.
SELECT TOP 1000 [ID]
,[Script_name]
,[Load_User]
,[Version]
,[Success]
FROM [PAQD].[AQD].[Admin_ScriptControl]
The query result should be: “AQDV72_Upgrade.sql”.
The creation or updating of the AQD Database is not covered in this document.
Please refer to the AQD Installation documentation for database installation or
upgrade prerequisites and instructions.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 3
AQD Portal v7.2 Installation Guide.doc
Step 3 –
Obtain the
Database
Source and
Catalog
The Database Source is generally a machine name, but may be a machine and
instance name – e.g. SQL-PROD\SQLEXPRESS – Ensure the database source and
catalogue that contains the AQD 7 database is known and that a connection is
possible from the Web Server, particularly if the web server is in a DMZ and pin
holes or special routes are required for the connection. Remember Superstructure
Client Services does not support the configuration of your infrastructure.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 4
AQD Portal v7.2 Installation Guide.doc
Step 4 –
Reading
Configuration
Guide
When reading the guide remember if you are going to be using Database
Authentication for the AQD Portal that you will initially have to choose another form
of authentication initially, say windows or LDAP, while you set up the initial
Administration Users in the system.
Step 5 –
Application
Folder
The naming and location of this folder is really governed by your standards for Web
Applications. When locating and naming this folder and the folder hierarchy that you
are going to use, consider whether there is to be a single instance of the AQD Portal
or whether there are to be multiple with different configurations. It is also possible
that you may be installing onto two different web servers, one in the DMZ and one on
the intranet. If you don’t have any standards then consider – “C:\Program
Files\Superstructure Group\AQDPortal”
Step 6 – Unzip
Archive
Extract the contents of the zip archive, AQDPortalV72.zip into the folder(s) created in
step 6.
Locate a batch file called “PackScripts.bat” in the folder (the one from step 6). Please
run this file to compress the most widely used Javascript files to optimize
performance.
Step 7 – Log
Folder
Create a folder that Log4Net can write any logging to. The “Web.Config” file is
configured to write to a folder called “Logs”. The identity for the ASP.NET Worker
process, typically “Network Service” and set in the Application Pool Settings, needs
to have write access to this folder.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 5
AQD Portal v7.2 Installation Guide.doc
Step 8 – Edit
Web.Config
Set up the configuration for the portal as outlined in the AQD Portal Configuration
Guide. Remember if you are going to be using database authentication then initially
you will have to use either windows or LDAP until you have set up the administration
users in the database.
Step 9 –
Disable
Security
Until the administration users have been set up in the AQD Portal the portal will need
to operate with its security disabled. This is done by setting the securityEnabled
Attribute on the portalAuthorisationService in the web.config file to false. See the
configuration guide for more details.
Step 10 –
Open IIS
Manager
The Internet Information Services manager is located in the Administrative Tools.
Step 11 –
Create
Application
Pool
Create an application pool called “AQD”. See Windows 2003 or 2008 sections as
appropriate for further details.
Step 12 –
Create the
AQD Portal
Web
Application
Use the IIS Manager to create the AQD Portal Web Application pointing it to the
folder that was created in step 6. The web application can be named according to
your organisation’s requirements.
See the Windows 2003 or 2008 sections in this document as appropriate for further
details.
Step 13 –
Enable
Default
Content Page
Default.aspx needs to be included in the “Enable default content page” list under
Document tab on the AQD Portal Website properties. Add this file to the list, if it is
missing.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 6
AQD Portal v7.2 Installation Guide.doc
Step 14 –
Configure
URL for
accessing the
AQD Portal
A URL will need to be configured by adding a Host Header for access to the AQD
Portal. This will be dependent on whether the AQD Portal is configured for use
internally or externally. Example URL: www.aqd.airline.com
Headers allow multiple sites to run from one IP address and through one port (eg 80). The advantage of using "Host Headers" is that a large number of sites can be hosted through just one external IP address. The request is interpreted by the server and the visitor is directed to the correct site based upon the URL they entered and NOT just the IP address it was translated to by the DNS server.
This means that you need to add the URL (excluding http://) in the "Host Header" box as shown above. In the case of an Intranet, entering "intranet.aqd.airline.com" so visitors will type http://intranet.aqd.airline.com to access the site. In the case of an Extranet, entering "www.aqd.airline.com" so visitors will type http://www.aqd.airline.com to access the site. However, this will mean that a DNS entry must exist for "intranet.aqd.airline.com" or “www.aqd.airline.com” to be translated to the correct IP address and route to your web server. This will therefore mean that you must also make this change to your DNS server if you plan to use this method.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 7
AQD Portal v7.2 Installation Guide.doc
Step 15 –
Open AQD
Portal Site
Open a browser and navigate to the AQD Portal.
Step 16 –
License the
AQD Portal
See AQD Portal Configuration Guide.
Step 17 –
Create
Administration
User(s)
With the portal licensed, the AQD Portal administration user(s) can be created and
setup in readiness for enabling security.
Click on the Admin module navigating to the following screen. Use the “Maintain
Staff” section to add the Administration User(s).
Now use the Administer Security Groups to add the Administration Users to the
Admin Group. Clicking on the staff link for the Admin group row will provide a dialog
to add members to this group.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 8
AQD Portal v7.2 Installation Guide.doc
Step 18 –
Close the
Browser
Close the browser
Step 19 –
Enable
Security
Edit the Web.Config and enable security and if Database authentication is required
set this up now – see the AQD Portal Configuration Guide for more details.
Step 20 –
Validate
Access
Open up the browser and navigate to the site logging on as one of the newly created
administration users and confirm the access to the Admin module and functions.
Step 21 – Set
up Other
Users
Set up other users as required.
Step 22 –
Custom Logo
Load up the custom logo – see AQD Portal Configuration Guide for more details.
Step 23 –
Custom Text
Load up the custom text – see AQD Portal Configuration Guide for more details.
SSL
Certificates
The Web Application can be run under SSL and this is highly recommended when
being used in an unsecured environment like the internet.
Consult Microsoft IIS documentation and your certificate supplier’s documentation on
configuring a Web Application to require and use SSL.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 9
AQD Portal v7.2 Installation Guide.doc
Windows Server 2003 IIS Installation
Create
Application
Pool
Right click on Application Pools and select “New – Application Pool” from the popup
menu.
With the new pool added open the properties dialog and check change Identity as
require – Network Service is usually the default.
Also to assist with performance it is recommended that you disable the idle worker
process shutdown
Worker Process Recycling settings:
The AQDPortal should recycle the worker process for the Application Pool at least
every time the Change Password Stored Procedure is run (ie daily). By default the
App Pool will be recycled every 1740 minutes (29 hours). This can cause the
password to have changed, but user sessions might still be based on the old
password. To prevent this, the following steps need to be performed.
1) Switch to the Recycling tab.
2) Change the value of the “Recycle worker processes (in minutes)” setting to:
“1440” (represents 24 hours).
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 10
AQD Portal v7.2 Installation Guide.doc
3) Tick the “Recycle worker processes at the following times:” checkbox. Click
“Add…” to bring up the “Select Time” dialog:
4) Your settings should now look similar to the image below.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 11
AQD Portal v7.2 Installation Guide.doc
Create Web
Application
Right click on “Default Web Site” on the left of the IIS Manager and select “New-
Virtual Directory” from the popup menu. Used the displayed wizard to set the alias
and point it to the application folder.
Now right click on the created virtual directory in the IIS Manager and select
properties from the popup menu.
Use the “Create”-button provided to convert it into an Application. Make sure execute
Permissions have been set to “Scripts only”.
Now change to the ASP.NET tab and check/set the .NET Version.
In the Documents tab check for – “Default.aspx” – if missing add it.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 12
AQD Portal v7.2 Installation Guide.doc
Multiple File
Upload
Attachments: Enabling multiple file upload
To enable multiple file upload in the AQD Portal, your organisation needs to roll out
the Microsoft Silverlight plug-in to all the clients using the AQD Portal. In addition to
that, IIS 6 on Windows Server needs to be configured to serve the Silverlight Mime
type. This is done in the “Http Headers” tab of the Properties window in the IIS
Management Console.
Follow these steps to add the required Mime type:
1) Open IIS6 Manager, right click on the web site you want to configure and select
“Properties”
2) Switch to the “Http Headers” tab.
3) In the MIME type section, click on the “MIME types...”-button
4) Add new MIME type:
Extension: .xap
MIME type: application/x-silverlight-app
5) Restart IIS
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 13
AQD Portal v7.2 Installation Guide.doc
64 Bit
Settings
The AQD Portal Web application has to be run in 32 bit mode. If you are installing
on a 64 bit Windows 2003 Server then you need to also make the following
changes:
Open a command prompt and navigate to the InetPub/AdminScripts directory
typically “C:\Inetpub\AdminScripts”.
Now in the command window execute the following:
cscript.exe adsutil.vbs set W3SVC/AppPools/Enable32BitAppOnWin64 1
(see
http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/0aaf
b9a0-1b1c-4a39-ac9a-994adc902485.mspx?mfr=true).
Now reregister ASP.NET in IIS for 32 bit.
In the command window navigate to
“C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727” – note not the 64 directory!
In the command window execute aspnet_regiis –i
This will register the 32 bit ASP.NET into IIS.
Finally in the Internet Services Manage under Web Extensions enable ASP.NET 32
bit applications.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 14
AQD Portal v7.2 Installation Guide.doc
Windows Server 2008 IIS Installation
Create
Application
Pool
Right click on Application Pools and select “Add Application Pool...” from the popup
menu.
Enter AQD as the pool name, the correct .NET framework and Managed Pipeline
mode as “Integrated” as shown above. Open Advance settings, check network
identity and if on a 64 bit version of 2k8 enable 32 bit applications.
Worker Process Recycling settings:
The AQDPortal should recycle the worker process for the Application Pool at least
every time the Change Password Stored Procedure is run (ie daily). By default the
App Pool will be recycled every 1740 minutes (29 hours). This can cause the
password to have changed, but user sessions might still be based on the old
password. To prevent this, the following steps need to be performed.
1) Find the Recycling link on the Application Pool window (right hand side)
2) Change the “Regular Time Interval (minutes) setting to: “1440” (represents
24 hours).
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 15
AQD Portal v7.2 Installation Guide.doc
3) Click “Add” and enter the time (24 hour clock) when the worker process
should be recycled. This should be set to a time after the Change Password
Stored Procedure had run, eg “00:10:00”, which is ten minutes past midnight
if the Stored Procedure is set to run at “00:05:00” (five minutes past
midnight).
4) Click Next to confirm your settings and then “Finish”.
5) Open the Advanced Settings dialog. The settings should now look similar to
the image below.
AQD Portal Installation Guide
Release: 1.6 October 2010 CONFIDENTIAL Page 16
AQD Portal v7.2 Installation Guide.doc
Create Web
Application
Right click the web site in the left hand side of the IIS Manager and select “Add
Application”.
Enter the Alias name for the AQD Portal, select the AQD pool then navigate to the
application folder.