General Admin Manual

Document: 258.01E — Qmatic

Copyright Notice

The information in this document is subject to change without prior notice and does not represent a commitment on the part of Q-MATIC AB. All efforts have been made to ensure the accuracy of this manual, but Q-MATIC AB cannot assume any responsibility for any errors and their consequences. This manual is copyrighted and all rights are reserved. Reproduction is not allowed without written permission from Q-MATIC AB.

COPYRIGHT © Q-MATIC AB, 2025. Feedback and questions: documentation@qmatic.com.

1. What’s New

2. Installation

2.1 Overview

General Admin is an extension that centralises configuration shared across multiple applications. Service, branch, and language settings — used throughout many applications — are configured once in General Admin rather than individually per module.

2.2 Installation

1. Copy generaladmin.war to <Orchestra_install_dir>\system\custdeploy.
2. Add generalAdminMessages.properties to <Orchestra_install_dir>\system\conf\lang.
3. Add the following lines to commonMessages.properties in <Orchestra_install_dir>\system\conf\lang:

   application.generaladmin = General Admin
   application.generaladmin.description = Administration for Global Applications
   module.application.generaladmin = General Admin
   
   application.generaladmin-m-lang.description = General Admin Languages
   module.generaladmin-m-lang = General Admin Languages
   
   application.generaladmin-m-g-trans = General Admin Group Translations
   application.generaladmin-m-g-trans.description = General Admin Group Translations
   module.generaladmin-m-g-trans = General Admin Group Translations
   
   application.generaladmin-m-g-temp = General Admin Group Templates
   application.generaladmin-m-g-temp.description = General Admin Group Templates
   module.generaladmin-m-g-temp = General Admin Group Templates
   
   application.generaladmin-m-s-groups = General Admin Service Groups
   application.generaladmin-m-s-groups.description = General Admin Service Groups
   module.generaladmin-m-s-groups = General Admin Service Groups
   
   application.generaladmin-m-u-mapping = General Admin User Mapping
   application.generaladmin-m-u-mapping.description = General Admin User Mapping
   module.generaladmin-m-u-mapping = General Admin User Mapping

4. Execute the required database queries against the qp_central database. See section 4 for Oracle, PostgreSQL, and SQL Server scripts.
5. Restart Orchestra Central.
6. Create users and roles with the required access rights. See section 2.3.

2.3 Access Rights

Full access to General Admin requires a role with all of the following modules:

• Appointment
• Calendar Admin
• General Admin
• Connector Administration
• Connector EntryPoint
• Connector ServicePoint

To restrict access to specific sections, use these granular modules instead:

3. Using General Admin

3.1 Introduction

General Admin provides centralised configuration for: Languages, Branch Translations, Service Translations, Service Templates, Branch Templates, Service Groups, Region Translations, and User Mapping.

3.2 Languages

Add all languages that should be available for translation throughout the system.

3.2.1 Add a New Language

1. Click Add language.
2. Fill in the form:
   • Language code — ISO 639-1 code used for language-specific names for branches, services, and other translated elements.
   • Name — Any display name to help users navigate between languages.
   • Country code — ISO 3166-1 code.
   • Direction of text — Left to right or right to left.
   • Date format — E.g. DD/MM/YYYY. A hint shows the current date in the entered format.
   • Time format — Choose from: 24h with 2 digits, 12h with 2 digits, 24h with 1 digit, 12h with 1 digit.
   • Branches — Select the branches that will use this language configuration.

3.2.2 Manage Languages

• Click the radio button in the Default column to set a language as the default.
• Click Edit to edit a language.
• Click Delete to remove a language.
• Click Refresh to refresh the list.
• Click Save into branch variables to publish language configuration to branch level (creates a branch variable for every branch the language is assigned to). Required for distributed environments.

3.3 Branch Translations

Translate the name and address information of all branches into the configured languages. The list shows all branches with their default name and a column per configured language.

3.3.1 Add Branch Translations

1. Click Edit for the branch to translate.
2. Select the language for the translation.
3. Enter the name, address, city, and country for the selected language.
4. Click Save. To add translations for multiple languages in one step, switch languages and fill in fields before saving — all translations across all languages are saved together.

Click Refresh to refresh the branch list.

3.4 Service Translations

Translate the name of all Calendar services (appointment services) into the configured languages. The list shows all services with their default name and a column per configured language.

3.4.1 Add Service Translations

1. Click Edit for the service to translate.
2. Select the language.
3. Enter the translated service name.
4. Click Save. Switch languages and fill in names before saving to update all languages at once.

Click Refresh to refresh the service list.

3.5 Service Templates

Service templates provide customers with additional information about a service, such as required documents or preparation instructions. They are used in:

• Qmatic Web Booking service list — customers click an information icon to view the service template.
• Qmatic Web Booking booking confirmation page.
• Appointment notification messages — add the parameter {{serviceTemplate}} to include the template in any notification message.

3.5.1 Create Service Template

1. Click Edit for the service.
2. Choose the language for the template.
3. Add content in the text area using the editor (supports item lists, font size changes, and other formatting). The template is saved in HTML format.
4. Save. Then restart Qmatic Web Booking to apply the changes.

3.6 Branch Templates

Branch templates provide customers with additional information about a branch, such as arrival directions. Up to three templates per branch can be created, each corresponding to a different position. Use the following parameters in notification messages to include them:

• Position 1: {{branch.template.1}}
• Position 2: {{branch.template.2}}
• Position 3: {{branch.template.3}}

3.6.1 Create Branch Template

1. Click Edit for the branch.
2. Select the Language for the template.
3. Select the Position (1, 2, or 3).
4. Add the information in the text area. The template is saved in HTML format.
5. Click Save.

3.7 Service Groups

Services can be arranged in groups to make them easier for customers to find — especially useful for organisations offering many services. Service groups are configured at global level. The same service can appear in multiple service groups.

3.7.1 Create Service Group

1. Click Create service group.
2. Fill in the form:
   • Name — Latin characters and numbers only, no spaces. Must be unique. Used in the URL for service group preselection. Cannot be changed after saving.
   • Name in [language] — Translated name for each language defined in General Admin > Languages.
   • Application type — Choose which application will use the group: Appointment Booking, Servicepoint, Mobile App, or Entrypoint. For Mobile Ticket, select Mobile App.
   • Services — Select the services to include.
3. Click Save.

3.7.2 Manage Service Groups

• Click the up/down arrows to reorder groups.
• Click Edit to edit a service group.
• Click Delete to delete a service group.
• Click Refresh to refresh the list.
• Click Save into branch variables to publish service groups to branch level (required for distributed environments).

3.8 Region Translations

Translate the names of all branch regions (sub-groups) into the configured languages. The list shows default region names and a column per configured language.

3.8.1 Add Region Translations

1. Click Edit for the region to translate.
2. Select the language.
3. Enter the translated name.
4. Click Save. Switch languages and fill in translations before saving to update all languages at once.

Click Refresh to refresh the region list.

3.9 User Mapping

User mapping allows Counter users to log in without having to select a branch, service point, and work profile each time. Key rules:

• All users to be mapped must belong to a user mapping group.
• A user mapping group can only be mapped to one branch, but a user can belong to several groups, and multiple groups can share the same branch.
• If a user has access to 2 branches in User Management but is only mapped to 1 group/branch in General Admin, they still have access to the unmapped branch — but without pre-configured service point and work profile.
• A preselected service point/work profile can be made optional (user can still change it) or mandatory (Lock SP / Lock WP) so it cannot be changed.

3.9.1 Requirements

Counter version 5.8.0 or later is required to use user mapping features in General Admin version 2.1.0 and later.

3.9.2 Map a Group of Users to a Branch, Service Point and/or Work Profile

1. Click Create user mapping.
2. Enter a descriptive name for the group.
3. Select a branch.
4. Select the service points and work profiles for the group. Select All to include all current and future service points/work profiles.
5. Click Add users. Only users with access to the selected branch are shown.
6. Configure settings for each user:
   • Default service point — Preselected service point for the user.
   • Lock SP — If enabled, the user cannot change to a different service point.
   • Default work profile — Preselected work profile for the user.
   • Lock WP — If enabled, the user cannot change to a different work profile.
   • Default group — If enabled, this group’s settings are preselected for the user. Users can still change to another branch and receive that branch’s mapping settings.
   All settings are optional unless Auto Login is enabled, in which case Default service point and Default work profile are mandatory.
7. Click Save.

3.9.3 Manage Groups

Changes to user mapping settings are applied the next time the user logs in to Counter.

• Click Edit to modify a group’s mappings. Note: group name and branch cannot be changed — create a new group if these need to change.
• Click Delete to delete a group.
• To remove a user from a group, click Edit on the group, find the user, and click Delete.

3.9.4 Skip Profile Settings Dialog (Auto Login)

Enable Auto Login to bypass the user profile settings dialog when opening Counter, allowing staff to start immediately.

• Turn on Enable Auto Login. This is a global setting applied system-wide.

4. Database Queries

4.1 Oracle

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin', 1, 1, 0, 'generaladmin', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin', 0, 0, NULL, 20, NULL, 0, 'generaladmin');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-lang', 1, 0, 0, 'generaladmin-m-lang', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-lang', 0, 0, NULL, 0, NULL, 0, 'generaladmin-m-lang');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-g-trans', 1, 0, 0, 'generaladmin-m-g-trans', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-g-trans', 0, 0, NULL, 0, NULL, 0, 'generaladmin-m-g-trans');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-g-temp', 1, 0, 0, 'generaladmin-m-g-temp', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-g-temp', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-g-temp');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-s-groups', 1, 0, 0, 'generaladmin-m-s-groups', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-s-groups', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-s-groups');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-u-mapping', 1, 0, 0, 'generaladmin-m-u-mapping', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-u-mapping', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-u-mapping');

commit;

4.2 PostgreSQL

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin', true, false, 1, 'generaladmin', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin', 0, 0, NULL, 20, NULL, 20, 'generaladmin');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-lang', true, false, 0, 'generaladmin-m-lang', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-lang', 0, 0, NULL, 20, NULL, 20, 'generaladmin-m-lang');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-g-trans', true, false, 0, 'generaladmin-m-g-trans', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-g-trans', 0, 0, NULL, 20, NULL, 20, 'generaladmin-m-g-trans');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-g-temp', true, false, 0, 'generaladmin-m-g-temp', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-g-temp', 0, 0, NULL, 20, NULL, 20, 'generaladmin-m-g-temp');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-s-groups', true, false, 0, 'generaladmin-m-s-groups', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-s-groups', 0, 0, NULL, 20, NULL, 20, 'generaladmin-m-s-groups');

INSERT INTO applications (id,branch_app,is_distributed,enabled,url,version,view_index)
VALUES ('generaladmin-m-u-mapping', true, false, 0, 'generaladmin-m-u-mapping', 1, 110);
INSERT INTO application_modules (id,is_distributed,enabled,icon_url,privilege_level,url,view_index,application_id)
VALUES ('generaladmin-m-u-mapping', 0, 0, NULL, 20, NULL, 20, 'generaladmin-m-u-mapping');

commit;

4.3 SQL Server

USE [qp_central]
GO
INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin', 1, 1, 0, 'generaladmin', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin', 0, 0, NULL, 20, NULL, 0, 'generaladmin')
GO

INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin-m-lang', 1, 0, 0, 'generaladmin-m-lang', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin-m-lang', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-lang')
GO

INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin-m-g-trans', 1, 0, 0, 'generaladmin-m-g-trans', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin-m-g-trans', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-g-trans')
GO

INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin-m-g-temp', 1, 0, 0, 'generaladmin-m-g-temp', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin-m-g-temp', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-g-temp')
GO

INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin-m-s-groups', 1, 0, 0, 'generaladmin-m-s-groups', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin-m-s-groups', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-s-groups')
GO

INSERT INTO [qp_central].[applications] ([id],[branch_app],[is_distributed],[enabled],[url],[version],[view_index])
VALUES ('generaladmin-m-u-mapping', 1, 0, 0, 'generaladmin-m-u-mapping', 1, 110)
GO
INSERT INTO [qp_central].[application_modules] ([id],[is_distributed],[enabled],[icon_url],[privilege_level],[url],[view_index],[application_id])
VALUES ('generaladmin-m-u-mapping', 0, 0, NULL, 20, NULL, 0, 'generaladmin-m-u-mapping')
GO

Q-MATIC AB, Box 198, SE-431 23 Mölndal, Sweden. Phone: +46 31 756 46 00. Email: info@qmatic.com. Web: www.qmatic.com