Sunteți pe pagina 1din 31

acQuire GIM Suite Server

Installation Guide
Document information
Authorised use © acQuire Software Pty Ltd
Document name acQuire GIM Suite Server - Installation Guide
Date March 2018
Table of contents

Table of contents 1
1 About this document 3
1.1 Purpose 3
1.2 About acQuire GIM Suite Server 3
1.2.1 acQuire Neo Web 3
1.2.2 acQuire Licence Administrator 3
1.2.3 acQuire Support Application 3
1.2.4 Sentinel RMS License Server 3
1.2.5 acQuire Information Manager 3
1.2.6 acQuire Neo Security 3
2 System requirements 5
2.1 Hardware 5
2.1.1 Server machine 5
2.2 Software 5
2.2.1 Operating Systems (OS) 5
2.2.2 .NET Framework version 6
2.2.3 Databases 6
2.2.4 Internet Information Services (IIS) Manager 7
2.2.5 Web browser (server and client machines) 7
3 Prerequisites for acQuire Neo Web 8
3.1 Add the Web Server (IIS) role 8
3.2 Test the Web Server (IIS) configuration 9
4 Installation 10
4.1 Migrate existing connection strings from the acQuire Information Manager.exe.config file 13
5 Getting started with acQuire Licence Administrator 15
5.1 Set up floating licences 16
5.1.1 Manage acQuire entitlements 16
5.1.2 Activate or install floating licences for your site 16
6 Getting started with acQuire Neo Web 19
6.1 Enable database access for acQuire Neo Web 20
6.1.1 Use a dedicated SQL Server login 20
6.1.2 Use a trusted authentication login 20

Installation Guide - acQuire GIM Suite Server 1


6.2 Set up acQuire Neo Web 21
6.2.1 Add a security administrator 22
6.2.2 Configure licence settings 22
6.2.3 Import users using Active Directory 22
6.2.4 Connect to a data source 23
6.2.5 Create roles, and assign permissions and users to roles 24
6.3 Test the acQuire Neo Web installation 25
6.4 Authenticate proxy servers 25
7 Change or remove an installation 27
7.1 Change an installation 27
7.2 Remove an installation 27
8 acQuire Support 28

Installation Guide - acQuire GIM Suite Server 2


1 About this document
1.1 Purpose
This document explains how to install acQuire GIM Suite Server on your computer.

1.2 About acQuire GIM Suite Server


acQuire GIM Suite Server consists of:
acQuire Neo Web
acQuire Licence Administrator
acQuire Support Application
Sentinel RMS License Server
acQuire Information Manager
acQuire Neo Security.

1.2.1 acQuire Neo Web


acQuire Neo Web is the web extension of acQuire Neo. Preconfigured datasets (called views) can be designed
and web-enabled in acQuire Neo, so that acQuire Neo Web users can access them using a web browser.

1.2.2 acQuire Licence Administrator


acQuire Licence Administrator is an application designed for the management of licences for acQuire GIM Suite
and is packaged with the acQuire GIM Suite installer.
It is intended to be used primarily by the system/server administrator or the acQuire Key Technical Contact to
perform their administrative tasks, i.e. to set up and manage floating licences for a company. However, it can
also be used to manage node-locked licences by individual users.
No special privileges are needed to access acQuire Licence Administrator once it is installed. However, the tasks
you can perform using the application may depend on your role (permissions assigned) within your company.
For example, only system/server administrators or the acQuire Key Technical Contact (not individual acQuire
users) are likely to have permissions to manage floating licences on a server.

1.2.3 acQuire Support Application


The acQuire Support Application is a single application that gives the user access to important system and
product details that can help the acQuire Support team when troubleshooting support incidents.

1.2.4 Sentinel RMS License Server


The Sentinel RMS License Server is a service that coordinates the use of floating acQuire licences by multiple
users and computers. Floating licences are installed and managed with the acQuire Licence Administrator.

1.2.5 acQuire Information Manager


The acQuire Information Manager is a service to run scheduled tasks, such as Active Directory synchronisation
and data caching.

1.2.6 acQuire Neo Security


acQuire Neo Security allows a security administrator to configure a user's permissions to perform tasks on the
acQuire Neo platform. Hence, data is protected by controlling a user’s access to it and their ability to modify it.

Installation Guide - acQuire GIM Suite Server 3


The system is modelled on Role Based Access Control. In this model, roles are created with defined permissions
and users inherit the permissions by being assigned to roles.
The system is centralised to allow the management of security for a collection of acQuire databases from a
single, central location. The benefits of a centralised system include:
Minimal replication of security configuration in each data source.
Easy management of users and roles who have access to multiple data sources.

Installation Guide - acQuire GIM Suite Server 4


2 System requirements
2.1 Hardware
2.1.1 Server machine
Below are the hardware requirements for your server to run acQuire GIM Suite Server components.
Server requirements are dependent on the database size, number of users and level of usage. It is
recommended that a customer work with their IT department to determine the server requirements for their
installation.

Database server Web and licence servers


Minimum Recommended Minimum Recommended
Processor 2Ghz Multi Core - 2Ghz or greater 2Ghz Multi Core - 2Ghz or greater
Memory (RAM) 4GB 16GB or greater 4GB 16GB or greater

2.2 Software
2.2.1 Operating Systems (OS)
Client machine

Version acQuire Licence Administrator


Windows 10 Recommended

Windows 8.1

Windows 8

Windows 7 Service Pack 1

Windows Vista Service Pack 2

Windows XP

Windows XP Tablet Edition

Server machine

Version Database server Web and licence servers


Windows Server 2016 Recommended Recommended

Windows Server 2012 R2

Windows Server 2012

Windows Server 2008 R2 Service Pack 1

Windows Server 2008 Service Pack 2

Installation Guide - acQuire GIM Suite Server 5


2.2.2 .NET Framework version
Microsoft .NET Framework must be installed on the target device. The application installer will inform you
during the installation process in case you do not have the appropriate Microsoft .NET Framework version
installed.

.NET Framework acQuire Licence Licence server Web server


Administrator
Microsoft .NET Framework 4.6.2

Microsoft .NET Framework 4.6.1


(Recommended)
Microsoft .NET Framework 4.6
(Minimum)

Note: Some operating systems are only compatible with specific .NET Framework versions. Refer to the
documentation of the operating system you are using to check for compatible .NET Framework versions.
If you require .NET Framework 4.6.1, it can be downloaded from the following links:
Offline installer: https://www.microsoft.com/en-us/download/details.aspx?id=49982
Web installer: https://www.microsoft.com/en-us/download/details.aspx?id=49981
If you require .NET Framework 4.6, it can be downloaded from the following link:
https://www.microsoft.com/en-us/download/details.aspx?id=48130

Note: These downloads have not been included with this installer so that you can get the latest versions from
Microsoft.
Contact the acQuire Support team at support@acquire.com.au if you need assistance.

2.2.3 Databases
acQuire recommends a dedicated server to host the SQL Server instance for the acQuire 4 databases.

Database acQuire Neo


SQL Server 2017 Recommended

SQL Server 2016 Service Pack 1

SQL Server 2014

SQL Server 2012

SQL Server 2008 R2

SQL Server 2008

SQL Server 2012 Express Supported as of 2.0

SQL Server 2008 R2 Express

SQL Server 2008 Express

Installation Guide - acQuire GIM Suite Server 6


2.2.4 Internet Information Services (IIS) Manager
IIS Manager version Web server
Microsoft IIS10

Microsoft IIS8.5 Recommended

Microsoft IIS8

Microsoft IIS7 Minimum

2.2.5 Web browser (server and client machines)


Web browser version acQuire Neo Web
Microsoft Edge 38 and above

Microsoft Internet Explorer 11

Mozilla Firefox 30 and above

Google Chrome 40 and above

Note: To allow system configuration of acQuire Neo Web, one of the supported browsers must be installed on
the web server machine.

Installation Guide - acQuire GIM Suite Server 7


3 Prerequisites for acQuire Neo Web
As an administrator, you must complete the following tasks on the web server before installing acQuire Neo
Web only if you have a new or unconfigured web server.

3.1 Add the Web Server (IIS) role


Note: This section is relevant only if you are installing acQuire Neo Web on a new/unconfigured web server. If
you are installing acQuire Neo Web on an existing web server, you can proceed to the Installation section as you
would already have the Web Server (IIS) role added.
To add the Web Server (IIS) role on the web server:
1. Log on to the web server machine as an administrator.
2. Open the Server Manager.
3. Right-click on Roles and select Add Roles. The Add Roles wizard opens.
4. Verify that you have completed/adhered to the instructions listed in the Before You Begin dialog and click
Next.
5. Select the Web Server (IIS) checkbox and click Next.
6. Read the information in the Web Server (IIS) dialog and click Next.
7. Select the following role services:

Section Feature
Application Development Features .NET Extensibility 4.6
ASP.NET 4.6
ISAPI Extensions
ISAPI Filters
Common HTTP Features Default Document
Static Content
Performance Features Static Content Compression
Security Request Filtering
Windows Authentication

8. Click Next.
9. Click the Print, e-mail, or save this information hyperlink. The Installation Report displays.
10. Read through your installation selections to see if they are correct.
11. Click Install. When the installation finishes, the message Installation succeeded displays.
12. Click Close. The Add Roles Wizard closes.

Installation Guide - acQuire GIM Suite Server 8


3.2 Test the Web Server (IIS) configuration
Note: This section is relevant only if you are installing acQuire Neo Web on a new/unconfigured web server. If
you are installing acQuire Neo Web on an existing web server, you can proceed to the Installation section as you
would already have the Web Server (IIS) role added.
To test the Web Server (IIS) configuration:
1. Log on to the web server machine as an administrator.
2. Open the Server Manager.
3. Select Internet Information Services (IIS) Manager from the Roles node in the Server Manager tree.
4. In the Connections tree, expand the server name, then expand the Sites folder.
5. Click the Default Web Site node.
6. Click Browse*:80 (http) from the Browse Web Site section of the Actions panel. The default home page of
Microsoft Windows IIS opens. This confirms that IIS has been configured correctly.

Installation Guide - acQuire GIM Suite Server 9


4 Installation
To install acQuire GIM Suite Server, use the acQuire GIM Suite Server.exe file that can be downloaded from the
acQuire website (existing customers only).

Note: Multiple acQuire GIM Suite versions cannot be installed on the same machine. If you have a previous
version of acQuire GIM Suite Server installed, it will automatically be uninstalled when the latest version is
installed. Before upgrading to new versions of acQuire GIM Suite Server, it is strongly recommended that the
latest version is tested in a test environment before deploying it in a production environment.
If you need to install the latest versions of any acQuire GIM Suite Server components on the same machine as a
previous version, contact support@acquire.com.au for standalone versions of the relevant installers.

To install the application:


1. Download and save the acQuire GIM Suite Server.exe file to your local hard disk.
2. Run the acQuire GIM Suite Server.exe file. The acQuire GIM Suite dialog opens.
3. Click next. The eula page displays.
4. Read the licence agreement. If you agree to the licence terms, select the I have read and I accept the
terms in the licence agreement checkbox.
5. Click next. The destination page displays.
6. If required, use the Browse button to specify a different location for acQuire GIM Suite Server to reside than
the default that will apply. The default installation path is:
For a Windows 32-bit operating system, C:\Program Files\acQuire\
For a Windows 64-bit operating system, C:\Program Files (x86)\acQuire\
7. Click next. The acQuire Licence Administrator page displays.
8. If you want to install acQuire Licence Administrator, click install.
9. Click next. The Sentinel RMS page displays.
10. If you want to install Sentinel RMS License Server, click install.
Note: The Sentinel RMS License Server is a service that coordinates the use of floating acQuire licences by
multiple users and computers. Floating licences are installed and managed with the acQuire Licence
Administrator.
11. Click next. The acQuire Neo Web page displays.
12. If you want to install acQuire Neo Web:
a. Click install. The fields on this page become active.
b. Select the website that you want to install to.
c. Specify the name of the virtual directory that you want to create, for example, Neo.
Note: The virtual directory name is a user-friendly name or alias that users see in the URL for acQuire
Neo Web.
13. Click next. The acQuire Information Manager page displays.

Installation Guide - acQuire GIM Suite Server 10


14. If you want to install acQuire Information Manager:
a. Click install. The fields on this page become active.
b. Select the account that the service should run as. If you want to use your default account, click use
default.
Note: The Network Service account is the default account that acQuire Information Manager uses; any
file locations used by acQuire automation will need to be accessible to this account. If a dedicated
service account is created, the same rules apply.
c. If required, specify the password for the account.
15. Either:
a. Click next.
- or -
b. Click verify and continue.
Note: If the Credentials are invalid! dialog opens, click ok and specify the correct account details.
The configuration page displays.
16. Configure the configuration database.
Note: The configuration database (formerly known as the Security database) is the database that the
acQuire GIM Suite software will use to ensure that your site has common configuration settings. This is
required if you are installing acQuire Neo Web or acQuire Information Manager. See section 2.2 Deploy the
acQuire Configuration Database in the Automation User Guide for more information about the
configuration database.

If you ... Then go to ...


Have an existing configuration database that is on the same server that you are running the Step 17
acQuire GIM Suite Server installer on
Have an existing configuration database that is on a different server than the one you are Step 18
running the acQuire GIM Suite Server installer on
Need to set up and populate an existing empty configuration database Step 18
Need to set up, deploy and populate a new configuration database Step 19

17. Complete the following steps to use cached credentials:


a. Leave use cached credentials selected.
b. Click verify and continue. A verification dialog opens.
c. Go to step 20.
18. Complete the following steps to use an existing database:
a. Deselect use cached credentials to make the fields available.
b. Specify the Server Instance where the configuration database is located.

Installation Guide - acQuire GIM Suite Server 11


c. Specify the authentication details. Either:
o Select trusted.
- or -
o Specify the User Name and Password.
Note: The permissions needed when deploying to an existing configuration database are db_
owner on the existing database.
d. Click connect to connect to the database server. The connect button changes to refresh, which you can
click to refresh the list of configuration databases available for your current settings.
e. Select the name of the configuration database.
f. Leave use existing selected.
g. Click verify and continue. A verification dialog opens.
h. Go to step 20.
19. Complete the following steps to create a new database:
a. Deselect use cached credentials to make the fields available.
b. Specify the Server Instance where the configuration database is located.
c. Specify the authentication details. Either:
o Select trusted.
- or -
o Specify the User Name and Password.
Note: The permissions needed to create a new configuration database are db_creator or higher.
d. Click connect to connect to the database server. The connect button changes to refresh, which you can
click to refresh the list of configuration databases available for your current settings.
e. Select create new.
f. Click deploy and continue. The Elevate Permissions? dialog opens.
g. Either:
o Select the Use Trusted Authentication checkbox.
- or -
o Clear the Use Trusted Authentication checkbox and specify the User Name and Password.
Note: The permissions needed to create a new configuration database are db_creator or higher.
h. Click ok. A verification dialog opens.
i. Go to step 20.

Installation Guide - acQuire GIM Suite Server 12


20. Click ok. Either:
a. The confirm page displays with details of the components to be installed.
- or -
b. The Create SQL logins? dialog opens. Either:
Note: SQL logins are required for the acQuire GIM Suite to function correctly.
o Click yes to automatically create the required SQL logins.
o Click no to manually create the required SQL logins after you have completed the installation.
The confirm page displays with details of the components to be installed.
- or -
c. The Migrate information manager settings dialog opens.
If you have a previous acQuire Information Manager installation that used connection strings defined in
the acQuire Information Manager.exe.config file to run data caching jobs, this dialog opens asking if you
want to migrate these connection strings to the configuration database. It is recommended that you do
this if you see this dialog. See Migrate existing connection strings from the acQuire Information
Manager.exe.config file for more information.
The confirm page displays with details of the components to be installed.
21. Click install gim suite. After the installation is complete, the confirm page displays the details of the changes
made.
22. Click close installer. The acQuire GIM Suite dialog closes.

4.1 Migrate existing connection strings from the acQuire Information


Manager.exe.config file
If you have a previous acQuire Information Manager installation that used connection strings stored in the
acQuire Information Manager.exe.config file to run data caching jobs, the following prompt displays when you
move from the configuration page to the confirm page:

If you click yes, the installer checks the existing connection strings defined in the acQuire Information
Manager.exe.config file and automatically creates corresponding entries for these data sources in the
configuration database, if they do not already exist.
It also ensures that the acQuire Information Manager's Windows user account has been included as an acQuire
Neo Security user that is mapped to these data sources - this will ensure that any data caching jobs that were
running before the upgrade will continue to run after the installation is complete.

Installation Guide - acQuire GIM Suite Server 13


Note: The reason you are prompted to migrate any existing connections defined in the acQuire Information
Manager.exe.config file is that this method of defining data sources for acQuire Information Manager to scan
has been deprecated and will no longer be supported from GIM Suite 3.0 onwards.
If you choose not to migrate your existing data sources to the configuration database at this point, you need to
add them manually later to run data caching or task automation jobs - see section 3.2 Set Up acQuire 4
Automation in the Automation User Guide for more information on how to do this.

Installation Guide - acQuire GIM Suite Server 14


5 Getting started with acQuire Licence Administrator
Note: acQuire Licence Administrator is only available if you selected acQuire Licence Administrator during
installation of acQuire GIM Suite Server.
When the installation is completed, launch acQuire Licence Administrator. You can now set up the licences you
need to use acQuire products.
As this is an installation guide, it only provides instructions on setting up and activating floating licences. For
details on:
Setting up and activating node-locked licences, refer to the acQuire GIM Suite Desktop Installation Guide. You
can also refer to the Install GIM Suite Server and Activate Licences video on the acQuire Knowledgebase for
more information.
Managing licences for your site (including reserving, deactivating, etc.), refer to the Online Help, which can
be accessed from the acQuire Licence Administrator interface. You can also refer to the acQuire
Knowledgebase to troubleshoot licensing issues and watch videos on licensing.
Your organisation may have purchased one or both of the following types of licences that acQuire provides:
A node-locked licence is attached to a single computer and is usable only by the users running the licensed
software (e.g. an acQuire application) on that computer. Connection to a server or a network is not required
in order to use this type of licence.
A floating licence is usable by multiple users who have access to the licence server on which it is hosted.
However, multiple users cannot use the same floating licence simultaneously, i.e. one user has to close their
licensed software (e.g. an acQuire application) and release the floating licence back into the server before
another user can use the same licence. Floating licences can also be checked out so that they can be used in
an offline environment, i.e. when the user does not have access to the licence server.
If you are unsure which type of licence you are meant to use, please contact your acQuire Key Technical
Contact.

Licence activation

When your organisation purchases an acQuire licence, acQuire Technology Solutions Pty Ltd. provides an
Entitlement ID (EID). An EID is not exactly a licence string. It is a 32-character key that holds all the information
needed to create individual licence strings for the purchased software components of acQuire products (a
single EID may be provided for multiple software components, depending on the nature of the purchase). This
key needs to be used during the activation process to create the licence strings before they can be used to work
with an acQuire software component (such as acQuire Neo).
The method of activation and the person responsible for activating a licence will depend on the type of licence
used:
Node-locked licence: Any user can activate a node-locked licence on their computer. A node-locked licence
generally only needs to be activated once, i.e. before its first use (unless the licence has been deactivated on
the computer for some reason).
Floating licence: A system/server administrator or the acQuire Key Technical Contact will activate floating
licences. After activation, users can select a floating licence from the appropriate server to start using the
acQuire application.
After selecting a valid/activated licence, users can start using the acQuire application.

Installation Guide - acQuire GIM Suite Server 15


Purchase licence and maintenance agreement

To purchase a licence and maintenance agreement, contact acQuire at sales@acquire.com.au. This agreement
entitles you to access software updates and support from acQuire.

5.1 Set up floating licences


The system/server administrator or the acQuire Key Technical Contact is likely to be responsible for setting up
and managing floating licences for acQuire products at a site.
Administrators:
Need to activate floating licences on the licence server before users can access these licences to use an
acQuire product
Are responsible for managing the EIDs provided by acQuire.

5.1.1 Manage acQuire entitlements


Entitlements represent the products you are entitled to use for a given licence purchase. Your entitlements are
provided in the form of EIDs. With an EID, you can activate and deactivate floating licences on a server, or you
can provide an EID to users to activate node-locked licences.
An example EID looks like this: 74105E30-42D6-4946-A0E6-BC407D34937D
When you receive your EIDs from acQuire, store them in a safe and central location so they may be retrieved
or distributed when required (e.g. for support or deactivation purposes).

5.1.2 Activate or install floating licences for your site


Activation is the process that generates a licence string, then locks and installs it onto a target device (computer
or server). When a licence is activated, it is node-locked to the device it is activated on. This means that the
licence cannot be simultaneously hosted on any other device. If the licence needs to be hosted on a different
device (e.g. when you replace your old computer with a new one), you need to deactivate it to unlock it from
the current node.
An example licence string stored on a computer or server looks like this:
*E9V,dIIREomwp3Y9qZaK,f3WQX6vfrzTB:CUROzeKwJVhDYxTBVAeqJjzneoatLwmVddf6:ssZrz4DINDo0ujZHLm9b
Yr,52jonA3yQEuxtXBf6UKuOoYbhZ1RGh6E1JF:WEYCw4WRKr2Fzxn3l4uWTHyDD# "PRODUCT" version
"VERSION", no expiration date, exclusive##AID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
You generally need to activate a licence only once, i.e. before its first use (unless you have deactivated the
licence on your computer and want to activate it again for some reason).
If you are unable to activate a licence yourself, it may be because you have:
No access to the internet
Problems connecting to the acQuire EMS server during the activation process.
You can try activating the licence using another computer that has internet access, before requesting a pre-
activated licence string (from acQuire) that you can then install.
However, in most situations, you should be able to complete the activation on your own.

Installation Guide - acQuire GIM Suite Server 16


Activate floating licences for your site

Note: The computer must have internet access and you must have the EID supplied by acQuire.
To activate floating licences for your site:
1. Open acQuire Licence Administrator.
2. From the server list, select the licence server you want to activate the licence on.
Note: If the server does not display on the server list, either click the server drop-down list and click
discover servers, or you will need to add it. See Add a licence server to acQuire Licence Administrator for
more information.
3. From the available tasks panel, click activate a licence. The activate a licence dialog opens.
4. Enter the EID that you received from acQuire in the entitlement id field.
5. Click Login. The licence details display under products.
6. Select the licence(s) you want to activate.
Note: You can select multiple licences by clicking each available licence that you want to activate.
7. Click Activate. The acQuire Licence Administrator refreshes and the activated licences display.
If you encounter any issues during the activation, contact your acQuire Key Technical Contact or acQuire at
licence@acquire.com.au. If you are unable to activate a licence, you can install an activated floating licence
for your site.
The licence is now ready to be used by users who connect to the licence server.

Install activated floating licences for your site

Installing an activated licence is a two-part process.


Part 1: Request an activated licence
1. Open acQuire Licence Administrator.
2. From the server list, select the licence server on which you want to install the activated licence string.
Note: If the server does not display on the server list, either click the server drop-down list and click
discover servers, or you will need to add it. See Add a licence server to acQuire Licence Administrator for
more information.
3. From the available tasks panel, click request an activated licence. An email is created for acQuire. It
contains all the details required to request an activated licence string.
4. Send the email.
Note: Do not change the pre-populated email address (i.e. licence@acquire.com.au).
When acQuire receives your locking code, they generate an activated licence string. This activated licence
string is then sent to you via email.
Note: If you do not have access to the internet, other modes of communication can be arranged. Call your
local office for more options.
Part 2: Install an activated licence
1. Open acQuire Licence Administrator.
2. From the server list, select the licence server on which you want to install the activated licence string.

Installation Guide - acQuire GIM Suite Server 17


3. From the available tasks panel, click install an activated licence. The install an activated licence dialog
opens.
4. Enter the activated licence string that you received from acQuire in the field provided.
5. Click OK. The install an activated licence dialog closes and the licence information is displayed.

Add a licence server to acQuire Licence Administrator

To add a licence server to acQuire Licence Administrator:


1. Open acQuire Licence Administrator.
2. Click the browse servers drop-down list.
3. Click the floating servers + button. The add server dialog opens.
4. Enter the name or IP address of the server you want to add, in the field provided.
5. Click OK. The server you specified displays in the server list. The changes are saved automatically.

Installation Guide - acQuire GIM Suite Server 18


6 Getting started with acQuire Neo Web
Before setting up acQuire Neo Web, acQuire recommends you confirm the following tasks have been
completed:
The acQuire GIM Suite Server has been installed on your web server. See the Installation section for more
information.
The floating Neo Report licences for your site have been activated on your web server. See the Set up
floating licences section for more information.

About acQuire Neo Security

acQuire Neo Security has been designed to allow sites to control the access that users have to data. The system
is modelled on Role Based Access Control (RBAC) and integrates with Active Directory. You have the option to
activate acQuire Neo Security when you first set up acQuire Neo Web. Once activated, user access to views and
dashboards in acQuire Neo Web is secured via permissions.
About permissions
Permissions are assigned to roles. You can create as many roles as you require to effectively manage security
for acQuire Neo Web. acQuire recommends you create acQuire Neo Web roles to align with the roles
undertaken by people at your site (such as Manager, Sampler, etc.).
You must create an administrator role if you want to provide users with more than read-only access to
dashboards. See Create roles, and assign permissions and users to roles for more information.
Roles are tied to a specific data source.
acQuire Neo Security manages data source permissions through roles. Roles are created on data sources to
allow groups of users and individual users to be placed into a role and have the relevant permissions assigned.
About security administrators
acQuire Neo Security has the concept of a security administrator. When a system administrator sets up acQuire
Neo Web and activates acQuire Neo Security, they are automatically added as a security administrator. After
importing user details they can then add other users as security administrators. This is useful if your site wants
to share the responsibility for managing security between multiple people.
Adding a user as a security administrator enables them to:
Create and remove connections to data sources
Create and synchronise Active Directory sources
Create, update and delete the roles that will be used to manage permissions
Manually create, update and delete groups of users
Manage the groups and roles that individual users are assigned to.
However, being added as a security administrator does not automatically grant the user access to any of the
views or dashboards in acQuire Neo Web. Nor does it allow them to create or configure dashboards. Like any
other user, this access is managed by permissions.

Installation Guide - acQuire GIM Suite Server 19


6.1 Enable database access for acQuire Neo Web
You may need to enable access to one or more acQuire databases after installing acQuire Neo Web.
In this section, we use the Microsoft SQL Server Management Studio application to grant acQuire Neo Web
access to one or more acQuire databases. A separate login must be created for each database server that will
be used by acQuire Neo Web.

6.1.1 Use a dedicated SQL Server login


The recommended approach is to create a dedicated SQL Server login that will be used by acQuire GIM Suite
services, like acQuire Neo Web.

Create a dedicated SQL Server login

To create a dedicated SQL Server login:


1. Log on to the database server machine as an administrator.
2. Open the Microsoft SQL Server Management Studio application. The Connect to Server dialog opens.
3. Select Database Engine from the Server type drop-down list.
4. Select the relevant Server name and Authentication method.
5. Click Connect.
6. Expand the Security folder in the Object Explorer panel.
7. Right-click on the Logins folder and select New Login. The Login - New dialog opens.
8. Specify the login name.
9. Select the SQL Server authentication option and specify a password.
10. Click User Mapping in the Select a page panel.
11. Select the databases to be made accessible to acQuire Neo Web.
12. Select the database role membership of ACQ_READ.
13. Click OK. The Login - New dialog closes.

6.1.2 Use a trusted authentication login


Enable network access using IIS Network Service

Note: This section is relevant only if the web server and database server are on different hosts.
To enable network access:
1. Log on to the web server machine as an administrator.
2. Open the Internet Information Services (IIS) Manager.
3. In the Connections tree, expand the server name and click Application Pools.
4. Click acQuire in the Application Pools panel.
5. Click Advanced Settings in the Actions panel. The Advanced Settings dialog opens.
6. Click Identity in the Process Model section.

7. Click the button next to the value for the identity parameter. The Application Pool Identity dialog opens.

Installation Guide - acQuire GIM Suite Server 20


8. Select NetworkService from the Built-in account drop-down list.
Note: NetworkService is also needed for accessing Active Directory sources. Active Directory sources can
be used to add users and roles in the acQuire Neo Security system.
9. Click OK. The Application Pool Identity dialog closes.
10. Click OK. The Advanced Settings dialog closes.

Create a trusted authentication login

A login is created on each acQuire database for use by acQuire Neo Web. The login name has two naming
conventions:
One for when the acQuire database resides on the same server that runs the Microsoft Internet Information
Services (IIS)
One for when the acQuire database is on a separate server.
To grant access to an acQuire database:
1. Log on to the database server machine as an administrator.
2. Open the Microsoft SQL Server Management Studio application. The Connect to Server dialog opens.
3. Select Database Engine from the Server type drop-down list.
4. Select the relevant Server name and Authentication method.
5. Click Connect.
6. Expand the Security folder in the Object Explorer panel.
7. Right-click on the Logins folder and select New Login. The Login - New dialog opens.
8. Specify the login name using one of the following naming conventions:
If the acQuire database resides on the same server that runs the IIS, the naming convention is IIS
APPPOOL\acQuire; or
If the acQuire database is on a separate server, the naming convention is <domain>\<webserver
name>$. For example, you have a company domain name of ACME and IIS is running on a machine
called web, the login name would be ACME\web$.
Note: The naming convention for the login name depends on where the acQuire database resides.
9. Click User Mapping in the Select a page panel.
10. Select the databases to be made accessible to acQuire Neo Web.
11. Select the database role membership of ACQ_READ.
12. Click OK. The Login - New dialog closes.

6.2 Set up acQuire Neo Web


When the installation is completed, launch acQuire Neo Web. As an administrator, you must complete the
following tasks on the web server or database server before you can start using the application.
When these administrative tasks have been completed, an acQuire Neo Web user can launch a browser and
enter the acQuire Neo Web URL (for example http://localhost/neo).

Installation Guide - acQuire GIM Suite Server 21


A system administrator is required to:
Configure the licence settings for acQuire Neo Web
Import user details using Active Directory.
At this point, the system administrator may complete the remaining tasks themselves, or add specific users as
security administrators and delegate the remaining tasks to them:
Create a connection to the acQuire 4 data source that contains the data that users will be able to see and
work with in acQuire Neo Web
Create the roles you require to manage permissions for various groups of users
Assign permissions to each role
Assign users or groups of users to each role so they inherit the associated permissions.

6.2.1 Add a security administrator


1. Log on to the web server machine as an administrator.
2. Launch a supported browser on the server machine (see the System requirements section for a list of the
supported browsers).
3. Enter the URL for acQuire Neo Web. The URL will be of the form http://<webserver machine name>/neo,
for example, http://localhost/neo. acQuire Neo Web opens and the no access to security administration
message displays.

4. Click . The settings page opens.

5. Click . The system settings page opens.


6. Click Make <domain\user name> a security administrator. A message confirming that you have been
successfully added as a security administrator displays and the security option is now available in the menu.

6.2.2 Configure licence settings


To configure the licence you want to use for acQuire Neo Web:
1. Specify the Licence Source you want to use. This will be the server where your Neo Report licences are
stored.
2. Click Save. Your licence setting is saved and acQuire Neo Web will continue to use this setting until you
change it.

6.2.3 Import users using Active Directory


The details for acQuire Neo Web users are imported using a connection to an Active Directory source. Any
groups that users belong to in Active Directory is reflected in the groups section of acQuire Neo Web.
1. Navigate to the configuration area. Either:
a. Click the logo in the top left corner of the acQuire Neo Web interface.
- or -
b. Open the home page.

Click .
2. Click the active directory tab.

Installation Guide - acQuire GIM Suite Server 22


3. Click add source. A dialog opens.
a. Specify an Active Directory hostname. This could be the name of the server or domain that hosts the
Active Directory group.
b. Specify a container to restrict the user details that will be imported. For example, you may specify the
name of an Active Directory group to import only the details of the users in that group.
c. Click ok. The new Active Directory source displays.
4. Click sync. A message displays to confirm that the synchronisation was completed successfully. This means
that the users and groups they belong to have been imported from the newly added Active Directory
source into acQuire Neo Web.

Note: This step is only required if:


You do not want to wait 30 minutes until the acQuire Information Manager automatically completes the
synchronisation.
The acQuire Information Manager was not installed at the time the acQuire GIM Suite Server was
installed (see the Installation section for more information).

5. (If required) Review the list of acQuire Neo Web users to confirm their details were imported correctly
from the Active Directory source.

6.2.4 Connect to a data source


1. Navigate to the configuration area. Either:
a. Click the logo in the top left corner of the acQuire Neo Web interface.
- or -
b. Open the home page.

Click .
2. Click the data sources tab.
3. Click add data source. A dialog opens.
4. Specify a meaningful Name and Description.
5. Specify the Server that holds the data source you want to connect acQuire Neo Web to.
6. Enter the name of the appropriate database in the Database field. The name that you enter here should
match exactly with the name of the database in SQL Server.
7. Specify the authentication details to use. Either:
Note: This authentication is the user you set up in Enable database access for acQuire Neo Web.
a. Select the Trusted Authentication checkbox.
- or -
b. Specify the system administrator Username and Password to connect to the specified database.
8. Click ok. The dialog closes and the newly added data source displays in the list.

Installation Guide - acQuire GIM Suite Server 23


6.2.5 Create roles, and assign permissions and users to roles
To create a role:
1. Navigate to the configuration area. Either:
a. Click the logo in the top left corner of the acQuire Neo Web interface.
- or -
b. Open the home page.

Click .
2. Click the roles tab.
3. Select the data source you want to create roles in.
4. Click add role. A dialog opens.
5. Specify a meaningful Name and Description for the role.
6. If required, select the Is administrator checkbox. This will create a role for those users who need more
than read-only access to dashboards. Any users assigned to this role will have create, edit and delete
permissions for dashboards.
7. Click ok. The dialog closes and your newly created role displays.
To assign permissions to a role:
1. Select the role that you want to assign permissions to.
2. Use the options on the right side of the page to work with permissions for this role.

none read all

Dashboards Prevents users from seeing the Allows users to access the Note: This permission is only
dashboard. It will not display dashboard and see the data in available for the administrator
in the list when they select the the views associated with it. role.
dashboards menu option.
However, the associated views Provides the same access as the
will not display in lists when read permission but users will
they select one of the also be able to configure the
corresponding menu options layout or delete this dashboard,
(shared, grid, log, map or and create other dashboards.
chart).
Views Prevents users from seeing the Allows users to access and This permission does not apply
view. It will not display in lists interact with data in the view. to views.
when they select the
corresponding menu option
(shared, grid, log, map or
chart).

Any users you subsequently assign to the role will inherit the permissions you set.

Installation Guide - acQuire GIM Suite Server 24


To assign a user to a role:
1. Select the role that you want to assign users to.
2. Using the options on the right side of the page, assign the required groups or individual users to the selected
role. The users you selected are now assigned to the role. They automatically inherit the permissions
assigned to the role. These permissions control the access they have to acQuire Neo Web views and
dashboards.
3. Click Save.

6.3 Test the acQuire Neo Web installation


The acQuire Neo Web installation is ready to be tested when the previous installations/configurations have
been successfully completed.
To test the acQuire Neo Web installation:
1. Launch a supported browser on a client machine on your network (see the System requirements section
for a list of the supported browsers).
2. Enter the URL for acQuire Neo Web to display the acQuire Neo Web home page.
The URL will be of the form http://<webserver machine name>/neo, for example, http://localhost/neo.

6.4 Authenticate proxy servers


When using an internet proxy server that requires authentication, errors may be encountered when trying to
connect to the internet (for example, Bing Maps layer in map view). In the map view case, the error will result
in a white background displaying when a Bing map layer is expected.
The authenticated proxy server needs a user name and password to access the internet, these details need to
be added to the acQuire Neo Web web.config file.
To add the proxy settings and authentication details to acQuire Neo Web:
1. Browse to the installation folder for acQuire Neo Web.
The default folder location is: C:\Program Files (x86)\acQuire Neo Web.
2. Copy the web.config file and save it to another directory.
Note: Read-only permissions will prevent you from editing the file in the installation folder.
3. Open the copy of the web.config file using a text editor.
4. Add the following under <configSections> in the <configuration> section:
<system.net>
<defaultProxy>
<proxy proxyaddress="http://proxyserver:port" bypassonlocal="False"/>
</defaultProxy>
</system.net>

Note: You must insert <system.net> under <configSections>.


See http://msdn.microsoft.com/en-us/library/ms228256%28v=vs.85%29.aspx for more information.

5. Add the following under <appSettings>:


<add key="proxyUserName" value="User"/>
<add key="proxyPassword" value="Password"/>

Installation Guide - acQuire GIM Suite Server 25


6. Save the web.config file.
7. Copy the web.config file and save it in the acQuire Neo Web installation folder to over-write the original file.
The web.config file should have the same format as displayed in the following example:

Installation Guide - acQuire GIM Suite Server 26


7 Change or remove an installation
Note: You need to be logged onto your machine with administrator privileges.
You can change or remove your installation of acQuire GIM Suite Server.

7.1 Change an installation


Add new components or remove currently installed components. For example, you now want to install acQuire
Licence Administrator.
To change an installation:
1. Run the acQuire GIM Suite Server.exe file. The acQuire GIM Suite dialog opens.
2. Click next. The eula page displays.
3. Read the licence agreement. If you agree to the licence terms, select the I have read and I accept the
terms in the licence agreement checkbox.
4. Click next. The destination page displays.
5. If required, use the Browse button to specify a different location for acQuire GIM Suite Server to reside than
the default that will apply. The default installation path is:
For a Windows 32-bit operating system, C:\Program Files\acQuire\
For a Windows 64-bit operating system, C:\Program Files (x86)\acQuire\.
6. On the acQuire Licence Administrator, Sentinel RMS, acQuire Neo Web, acQuire Information Manager
and configuration pages, select the features that you want to install, upgrade or uninstall.
7. Click next. The confirm page displays with details of what will be changed.
8. Click install gim suite. After the changes are complete, the confirm page displays the details of the changes
made..
9. Click close installer. The acQuire GIM Suite dialog closes.

7.2 Remove an installation


Remove all currently installed components. For example, you no longer want the acQuire GIM Suite Server
software on the computer.
Note: Great care should be taken using Uninstall. All the currently installed acQuire GIM Suite Server
components will be removed.
To remove an installation:
1. In the Control Panel, open the Uninstall or change a program window.
2. Select acQuire GIM Suite Server and click Uninstall. The acQuire GIM Suite dialog opens with a list of
components that will be uninstalled.
3. Click uninstall gim suite. After acQuire GIM Suite Server is uninstalled, the close installer button displays.
4. Click close installer. The acQuire GIM Suite dialog closes.

Installation Guide - acQuire GIM Suite Server 27


8 acQuire Support
For any support requests, you can email acQuire Support at support@acquire.com.au. Alternatively, you can
phone one of our offices. Visit our website for the contact details.

Installation Guide - acQuire GIM Suite Server 28


Contact
Offices Australia, Canada, Chile, South Africa
Street address 26 Kintail Road, Applecross, Western Australia, 6153
Postal address PO Box 933, Canning Bridge, Western Australia, 6153
Telephone +61 8 9316 6600
Fax +61 8 9316 6699
Email acQuire@acQuire.com.au
Website www.acQuire.com.au

Official information
acQuire Software Pty Ltd is the owner of the software and all icons and logos within the software, together with
all soft and hardcopy documentation.
This document is copyright. No part of this document may be reproduced by any process, or in any form,
without prior written consent from acQuire Technology Solutions Pty Ltd.

Disclaimer
acQuire Software Pty Ltd will not accept any liability arising from the use of the software or any other software
product mentioned in this document; nor for any technical or editorial errors or omissions made in this
document. The mention of any other computer software product in this document does not imply the
endorsement of such product by acQuire Software Pty Ltd.

Installation Guide - acQuire GIM Suite Server 29

S-ar putea să vă placă și