7.2. User groups

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

7.2.1. Manage user groups

User groups are an easy way of managing a set of PxM users who require the same device access and privileges. Once created they can easily be added to profiles to ensure all users in the group gain the same access levels to device connections and executing tasks.

The Manage user groups page allows you to create and manage these local user groups. Click User groups in the left-hand menu to view the page.

Webui Manage User Groups table

The information presented in the table includes:

Heading Description
Name This is the display name of the user group.
Checked box icon Enabled If the checkbox is checked then the user group is enabled. When added to a profile, the users within the group will be given permission to the devices.
Source

States where the user group is sourced from:

  • Local: a local user group that will have its associated users configured manually.
  • Active Directory: a user group that will be synchronised against an existing security group in Active Directory.
Notes Additional information can be added which may be relevant to the user group and managing it.
# Users Number of users that are in the group.
# Profiles Number of profiles the user group is in.

Note

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

7.2.2. Creating a user group

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

    Webui 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 exists in Active Directory.
    Name

    This is the display name of the user group.

    If 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 from the Active Directory user group.

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

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

    Notes Add any additional information that may be useful.
    Checked box icon Enabled

    If the checkbox is Checked 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.

    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 Create.


7.2.3. Configuring a user group

The User group detail page allows you to manage the user groups associated users and profiles.

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 group in Active Directory has been updated.

To view the user group detail page:

  1. Within the Manage user groups page, click on a user group Name. The User group detail page will open in a separate tab.

    The following is a view for a user group with a source of local.

    Webui User Group Detail page

    The following is a view for a user group with a source of Active Directory.

    Webui User Group Ad Group Detail page

To add users to a local user group:

  1. Within the User group detail page, click the Manage button to the right of ASSOCIATED USERS.

  2. Within the Manager: users window, select the checkboxes to the left of each user to be included in the user group.

    Alternatively, hold down the SHIFT key and click multiple users, then right-click and select Include.

    Webui Profile user manager window

  3. Click Save changes to add the users to the user group.

    Webui User groups Associated users

To add profiles to a user group:

  1. To add a profile, click the Manage button to the right of ASSOCIATED PROFILES.

  2. Within the Manager: profiles window, select the checkboxes to the left of each user to be included in the user group.

    Webui User groups Manage Profiles window

  3. Click Save changes.

    Webui User groups Associated Profiles

    The user group will now be added to the profiles and the UserDeviceAccountUpdateTask will be run to create any user accounts on the devices within the profiles.

7.2.4. Bulk importing

Bulk imports allow you to import multiple user groups and user group memberships using CSV templates.

The Import user groups CSV template is used to create a new user group.

The Import user groups membership is used to update existing and configure user group memberships.

7.2.4.1. Import user groups

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

    WebUI User Groups Bulk Import

  2. Within the Import from CSV window, click Download csv template.

    Webui User Groups Bulk Import User Groups window

  3. Save the CSV file to a preferred location. Leave the Import from CSV window open.

  4. Open up the CSV file in your preferred editor. An example entry has been give for reference. Enter the required information.

    Webui User Group Bulk Import csv

    Heading Description
    Name Enter the display for the user group. Active Directory user group names must match the name of the group on Active Directory.
    Enabled

    If this column is left blank, the group will be disabled by default when created.

    To enable the user group type TRUE.

    Active Directory Group

    If this column is left blank, the group will default to an Active Directory source.

    To use a local source group type FALSE.

    Notes Add any additional information that may be useful.

    Webui User Group Bulk Import csv example

  5. Save the CSV file with the changes.

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

  7. 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.

    Webui User Group Bulk Import Review

  8. Click Import. The actions are queued.

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

    Webui User Group Bulk Import entries

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

    Active Directory source groups will be synchronised with the Active Directory and the users in the group added. If the users don’t exist in PxM then they will be created.

7.2.4.2. Import user groups members

Once a user group has been created you can bulk import users or update existing users.

  1. Within the Manage user groups page, select one or more user groups to import members from or, to import members from all user groups, leave all deselected.

    Note

    To select a more than one user group, hold the CTRL key while clicking required user groups.

  2. Click the Export button. A drop-down appears.

  3. From the drop-down, click Export user groups membership. The user_groups_members CSV file downloads.

  4. Open the CSV file in your preferred editor.

    Webui User Groups Bulk Import Members CSV

    Heading Description
    User group Name of the user group that has been created.
    User

    Name of the PxM user added to the user group.

    Note

    User names must match the names on the Manage Users page.

  5. Update the CSV file with the names of the users you want to add to the user groups.

    For example:

    Adding additional users

    Webui User Groups Bulk Import Members CSV example

    Adding additional users and removing an existing user

    Webui User Groups Bulk Import Members CSV Removed user example


  6. Save the CSV file with the changes.

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

    WebUI User Groups Bulk Import

  8. Within the Import from CSV window, click Chooe file. Locate and select the saved user groups membership CSV file.

  9. Click Import. The CSV entries will be listed in the Review import data window. Review the entries and make amendments as necessary.

    Webui User Groups Membership Bulk Import Review

  10. Click Import. The actions are queued.

  11. Within the Action queue window, click Done. The new entries are created and can be seen on the Users groups detail page.

    Webui User Group Membership Bulk Import entries

Note

The user groups membership CSV template can be used to bulk import members for all user groups created.

For example:

Webui User Groups Bulk Import Multiple Group Memberships

7.2.5. Editing a user group

See the General usage section for inline editing.

7.2.6. Deleting a user group

Deleting a user group permanently removes the group from PxM and from all associated profiles.

To delete a user group from the Manage user groups page, right-click on an individual user group and then click Delete iconDelete.