Configure HighQ Appliance
note
HighQ Appliance is deployed remotely by HighQ Professional Services. Talk to your HighQ account manager if you have specific deployment requirements.
Configuring Appliance after deployment
HighQ Appliance is first configured and deployed by HighQ support. However, for the security of your data, once Appliance is deployed HighQ has no access to the application.
Normally, when HighQ Appliance is first deployed, it is pre-configured as specified with your HighQ Account Manager and purchased modules will be enabled. Further configuration, such as the addition of new modules, or to match updates to your system, can only be performed by your administrators. Access to HighQ Appliance configuration and how to make changes are described below.
Examples
Should your database structure change, or should you change the configuration of a Collaborate or Publisher instance, you may need to access HighQ Appliance to reconfigure a connector or security settings.
Possible reasons include:
- Install a new connector, e.g. you wish to use a new source of data
- New security setup, e.g. you need to change security keys
- Changes to personnel, e.g. a new admin hire requires access to HighQ Appliance
- Changes to your data structure, e.g. additional Active Directory fields
- Changes to iSheet structure, e.g. new or deleted iSheet columns, or changes to your SQL database
- Changes to sites, e.g. a new type of site requires access to your data
- New features, e.g. an update to Appliance opens new options
In most cases, Appliance is configured for your entire instance, not for individual sites created on that instance. You do not need to change access HighQ Appliance for the creation of a new site based on an existing site or template.
In certain circumstances, your HighQ representative can provide support if you open remote access to your system.
Upgrading HighQ Appliance
To upgrade HighQ Appliance to a new version, please follow the instructions provided here.
Access HighQ Appliance in a browser
Open a browser on the server that hosts HighQ Appliance. Enter the provided URL to open the
Sign in
screen.- For example: 'http://localhost:8080/HighQAppliance/LoginRequiredPage.action'
Enter your credentials and select
Sign in
.If you can't access your account, you can verify your username, or reset your password. Select
Can't access your account?
.Select
Username
or Password
, then enter the requested information. An email is sent to reset the password or provide a reminder of the account details.An Appliance administrator can also unlock account access in
User management
. Select a 'locked' user in the list, then select Unlock User
and OK
.Module Management (Home page)
The HighQ Appliance home page provides a list of categories for navigation on the left, when it is first opened, the
Module Management
category is selected.
A list of enabled modules is shown on the right. These modules are already set up to communicate with Collaborate and Publisher and can be further configured in HighQ Appliance.
Add new module
If you need to add a new module, open the
Module Management
screen, then select Add module
to add a new module.A new module uses an existing module type to connect to a new site or database.
If you require a new type of module, first contact your HighQ account manager.
Click the
Module type name
drop-down list to see all available modules (as listed in System Configuration
).
Only purchased module types can be configured. If you require a new type of module, first contact your HighQ account manager.
Give the module a unique name description. Set the
Status
to Active
or Archived
. Select Save
to create the module.An
Archived
module cannot be used. Edit
the module and change the Status to Active
to use the module.User management
Select
User Management
, to add new users, adjust user permissions, email addresses.The User Management section shows users that have access to the HighQ Appliance environment. These are not Collaborate or Publisher users.
To create a new user, select
Add user
on this screen.Date of birth
can be set as a mandatory field during registration, and can be used to check identity if the user requests a password reset.If you have Appliance Admin rights, you can reset a password for a user on this screen.
Select
Save
to create the user.
Permissions
There are three types of users:
- System admin- These users can add, edit or delete any module and any permission
- Module admin- These users can update any module permission that they have permission to see
- Internal admin- These users can view the permissions of a particular permission
In the
User Management
screen, select Permission
in a user record to show which modules they have permission to access and if they have Internal User
or Module admin
rights.
A Module or System admin can change permissions for each user, module by module:
- Internal User- Internal Users can only view settings for the modules they can access, they cannot make changes
- Module Admin- Module Admins can make changes in the modules that have permission to access.
Internal Users
or Module Admins
can only see the Module Management
and Download Logs
sections in HighQ Appliance.In the
Module Management
section, users can only see modules they have permission to access.Select
Save
to change the user permissions.By default, an Appliance System Admin has full access to all modules, therefore the selection boxes cannot be changed.
Configuring connectors
If you have purchased access to a connector, it will be pre-configured. If you need to verify or change the configuration of the connector, open the
Module Management
section.See Connectors in HighQ Appliance for more information.
Active Directory / LDAP
Sync users and groups from AD or LDAP servers to streamline your user management and leverage security groups to reduce administration and minimize risk.
See Active Directory connector for more information, including how to configure the connector.