3.3. User groups

This chapter describes how PxM user groups are created and managed within the Web Management Interface, covering the following:

3.3.1. What are user groups?

A user group is a collection of users who require the same access levels to devices and tasks.

By creating user groups allows you to simplify the process of giving members of a group, organisation, team, department etc the same privilege levels required to do their job. It minimises the risk of missing people off the access list as well as making it easier to quickly remove a users access from the group rather than individually removing them from each profile.

manage user groups table

3.3.2. Process of creating a user group and associate users and profiles

The process of creating a user group and then associating users who require the same access privileges is as follows:

  1. Create your user group container with a preferred user source and a name applicable to the users that will be added to the group.

    The source selected will determine the user list presented for association:

    • Local source will allow you to select and add users from the PxM users list with any auth type.

    • Active Directory source will only present a synchronised list of Active Directory users that belong to the named security group.

      Note

      If the name of the user group does not exactly match the name of the security group on the Active Directory then the user list will be empty.

  2. Associate users (local or Active Directory): For local source user groups, select the users from the list presented. For an Active Directory source user group use the synchronise button to pull in the users listed in the Active Directory security user group with the same name. Active Directory users that are currently not listed within the Manage users page will be created. Active Directory users can’t be updated or deleted from within PxM. Updates to user groups at the Active Directory level need to be synchronised with PxM in order for the changes to be pickup and reflected in PxM.

  3. Associate profiles: Either select from the profiles that already exist or create a new profile with the access privileges required for the user group. Adding a profile to the user group will give all the users in the user group access to the devices and device tasks listed in the profile with the access level stated. User groups can be added to multiple profiles.

3.3.3. How to create a new user group

Creating a user group creates a container that can then be used to

  1. Either click on the plus icon icon next to User groups in the left-hand menu or click on the plus icon New user group button on the Manage user groups page. Either way a New user group window will open.

    new user group window

  2. Fill in the following details:

    Heading Description
    Source

    Select one of the following options:

    • Local: Allows you to create a user group to which you can add PxM users.
    • Active Directory: Allows you to add a user group that will be synchronised against an existing security group in Active Directory.

    Note

    The Active Directory currently configured as the User Authentication Service will be used for all Active Directory user group operations.

    Name

    This is the display name of the user group.

    Using an Active Directory source: When using an Active Directory source, the name must match that of a Global Security Group that exists in Active Directory.

    If the user group name is found in Active Directory, the user group will be successfully created. The PxM Platform will then proceed to synchronise the user data using the sAMAccountName from the Active Directory.

    Note

    Synchronising of user data is done with diacritic (accents added to words) insensitivity and case insensitivity.

    If a discovered Active Directory user already exists in PxM, they will be added to the user group.

    If a discovered Active Directory user doesn’t already exist in PxM, it will be created automatically and added to the user group.

    Notes Additional information can be added which may be relevant to the user group and managing it.
    check box icon Enabled

    If the checkbox is check box icon checked then the user group is enabled. When added to a profile, the users within the group will be given permission to the devices.

    Note

    If an Active Directory user group is created in a disabled state, the users will not be synchronised until the group is enabled.

  3. Click Save.


3.3.4. How to associate users and profiles to a user group

The User group detail page allows you to view and configure the users and profiles that will be associated with the named user group.

Note

The associated users in an Active Directory user group cannot be modified directly. The user groups are synchronised with Active Directory. The associated users will only get updated if the user group in Active Directory changes.

To add users to a local source user group:

  1. On the Named user group detail page, click the Manage button to the right of ASSOCIATED USERS.

  2. The Manager: users window opens, select the checkboxes for the users to be added to the group.

    associate users

  3. Click Save changes. The users are added to the user group and will now be listed in the Associated users section.

To synchronise users for an Active Directory source user group:

  1. On the Named user group detail page, click the Synchronise button to the right of ASSOCIATED USERS.
  2. Wait while the users are synchronised. PxM Platform communicates with the Active Directory listed on the Manage Active Directory and if the named user group matches the name of a user group on the Active Directory the users are added to the user group list. Any users within the Active Directory user group that don’t already exist within the PxM users will be automatically created.

To add profiles to user groups:

  1. On the Named user group detail page, click the Manage button to the right of ASSOCIATED PROFILES.

  2. The Manager: profiles window, select the checkboxes for the profiles to be added to the group.

    associate profiles

  3. Click Save changes. Profile user update task will be executed.

    The profile will be updated to include the user group. All users listed in the user group will be given the same privileged access levels configured within the profile.

    user group configured

    Example of the user group added to the profile:

    user group added to profile

3.3.5. Bulk importing

Rather than creating user groups manually and one at a time, you can create many user groups in a bulk import. To do this, you need to download and populate the appropriate CSV (comma separated values) file.

Bulk import can be used to create new user groups or update existing user group memberships (associated users and associated profiles).

user group bulk import options

3.3.5.1. Populating the new user group bulk import csv template file

To create new user groups download and populate the Bulk import > Import user groups csv template.

The csv template contains the required fields and provides examples as a guideline for filling in the fields correctly.

Example user group CSV template

user group csv template

Example of a user group csv template filled in

user group csv populated template

Required fields

Column heading Description
Is Active Directory group?

Enter TRUE if the user group created is an Active Directory user group that you want to synchronise the associated user from.

Enter FALSE to select from the PxM list of users.

Name

Enter the display for the user group.

If adding an Active Directory user group the name must exactly match the name of the user group that exists on the Active Directory, otherwise the user synchronisation will fail.

Notes Add any additional information that may be useful.
Enabled

Enter TRUE to enable the user group when created. Enter FALSE to disable the user group when created.

Note

Disabling a user groups will dynamically revoke any permissions allocated through profiles.

3.3.5.2. Importing the completed new user group csv file

Once you have populated and saved the user group CSV file with all the new user groups you want to create, you can import the data into PxM to create your user group containers.

  1. Within the Manage user groups page, click Bulk Import > Import user groups.

    import user group from csv window

  2. Within the Web Management Interface Import from CSV window, click Choose File. Locate the saved user groups CSV file.

  3. Click Import. The CSV entries will be listed in the Review import data window. Review the entries and update if necessary, using the Edit pencil icon.

  4. Click Import.

  5. Within the Action queue window, click Done. The new new group containers are created and can be seen on the Manage user groups page.

    manage user groups table

    At this stage, the Local source user groups will be empty. You will need to manually add users to associate them with the user group.

    Active Directory source groups will be synchronised with the existing Active Directory user group. Any users within the Active Directory user group that don’t already exist within the PxM users will be automatically created.

    To keep the Active Directory user group up to date you can do one of the following:

    • Manually synchronise using the Synchronise button on the Named user group page.
    • Set a user group synchronisation interval (see User Group Synchronisation interval (minutes)) to automatically trigger an update on all Active Directory user groups.

3.3.5.3. Amending the user group membership bulk import csv template file

Bulk importing user group memberships only applies to associating users to a local source user group.

Limitations of bulk importing user group memberships are:

  • Can not associate profiles within the user group membership CSV file.
  • No Bulk import > Import user user groups membership > Download CSV template available for download.
  • Can not be used to add users to a user group with a source of Active Directory.

Once a user group container has been created you can:

  • Bulk import new user membership to single or multiple user groups.
  • Update existing user memberships within single or multiple user groups.
  • Remove user membership from single or multiple user groups.

3.3.5.4. Exporting and updating the user group membership CSV file

Before exporting the user group membership CSV file, decide whether you want to download the user group membership for every user group in the list or only a selection.

Selecting one or more user groups will only export the user group membership for those selected.

To export the user group membership for all your user groups listed do not select any user groups in the list.

Within the Manage user groups page, click the Export button and select Export user groups membership. A user groups membership CSV file will be created with the exported data.

user group bulk export options

  1. Within the Manage user groups page, click the Export button and select Export user groups membership. A user groups membership CSV file will be created with the exported data.

  2. Open the exported data CSV file in your preferred editor. The CSV file will contain the following:

    user groups membership csv export

    Heading Description
    User group Name of the user group as it appears on the Manage user groups page.
    User The name of the PxM user as stated on the Manage users page within the Name column which has been added to the user group.
  3. Update the CSV file. Only update the changes you want to make and leave the rest as is.

    • Add the names of the users you want to add to a single or multiple user groups. Each additional user to each user group should be on a separate line.
    • Delete the row containing the user within a specific user group you want removed from a single or multiple user groups.
  4. Save the CSV file with the changes.

3.3.5.5. Importing the amended user group memberships CSV file

  1. Within the Manage user groups page, click Bulk Import > Import user groups memberships.

    user group bulk import options

  2. Within the Import from CSV window, click Choose file. Locate and select the saved user groups memberships CSV file that was updated.

    import user group memberships from csv window

  3. Click Import. The CSV entries will be listed in the Review import data window. Review the entries and make amendments if required.

  4. Click Import. The actions are queued.

  5. Within the Action queue window, click Done. The necessary updates are made.

3.3.6. Editing a user group

See the General usage section for inline editing.

3.3.7. Deleting a user group

Deleting a user group will:

  • The user group will be permanently removed from the PxM Platform database.
  • User group will be removed from all profiles listed in the user group.
  • Users access levels will be revoked for all devices and device tasks within the profiles associated with the deleted user group.