Modules and permission profiles

A module is a permission profile. It decides two things for every user it is assigned to: which menu they see, and which parts of LogisticaHQ they are allowed to use. You create one module per role, for example Receiver, Picker, Office or Handheld, and assign each user the module that fits their job.

Administrators are not limited by modules. A user whose type is Administrator always sees the full menu and may use every screen. Modules apply to every other office and handheld user. Client portal users and LogisticaHQ Field users have fixed permissions of their own and do not use modules.

The module list

Open Setup > System > Modules. The list shows every module with its description. Click a module's name to open it, New to create one, or Delete on a row to remove one.

Create or edit a module

1. Click New, or click an existing module's name.
2. On the Details tab, fill in the module:
   • Name: the role, as users and administrators will recognise it.
   • Access Tier: how the access control paths below are read. See Access tiers.
   • Description: what the module is for.
   • Enforce password policy (shown to administrators only): when ticked, users of this module must follow the password rules set in Configuration > Setup - Password Policy: minimum and maximum length, upper-case letters, numbers, special characters and the number of days before a password expires.
3. Build the module's menu on the Menu builder tab. See Build the menu.
4. Click Update to save the details and the menu together.

Access tiers and access control paths

Under the details, a list of access control paths limits which parts of the system the module's users may reach, over and above what their menu shows. A path names a part of the LogisticaHQ server, for example /api/PickTicketApi/% for everything to do with pick tickets. The Access Tier decides how the list is read:

Paths are matched the same way as lot patterns: % stands for any number of characters and _ for exactly one, and several paths can be separated with commas. When a user reaches a path their module does not allow, LogisticaHQ refuses the request with a message naming the path.

• Click New above the list to add one path.
• Click Import to add many paths from a spreadsheet: choose the file, confirm, and LogisticaHQ reports how many were imported.
• Tick paths and click Delete to remove them.

Paths are saved as soon as you add, import or delete them: they do not wait for Update.

Test a Restrictive module before you assign it. A Restrictive module refuses everything that is not listed, including screens its users need behind the scenes, such as looking up products or printing. Sign in as a test user with the module and run through the user's daily tasks before rolling it out.

Build the menu

The Menu builder tab has two trees. Available menu on the left is the full LogisticaHQ menu. Module menu on the right is the menu this module's users will see.

• Add: drag an entry, or a whole folder, from the Available menu and drop it into the Module menu. It is copied: the Available menu never changes.
• Arrange: drag an entry by its handle (the four-way arrow) to move it up, down, into or out of a folder.
• Fold: click the arrow beside a folder to open or close it.
• Remove: click the × at the end of a row. Removing a folder removes everything in it.
• Keyboard: the arrow keys walk the tree and fold folders. Ctrl with an arrow key moves the selected entry: up and down among its neighbours, left out of its folder, right into the folder above it.

Click Update to save. Users see their new menu the next time they sign in.

The menu decides what users see. The access control paths decide what they may use. Hiding a screen from the menu does not stop someone who knows its address, so protect sensitive areas with paths as well.

Assign a module to a user

Open the user in Setup > System > Users and switch on the module in the user's Modules list. See Users.