# Groups

## Groups screen

In the left menu on the Administration Module home page, click ![](https://content.gitbook.com/content/KjZcMxkzmJaMCI7tSLjB/blobs/yR7Trrx2SM5yJM9QL4Ta/left_menu_groups_small.png) to display the **Groups** screen.

<figure><img src="https://content.gitbook.com/content/KjZcMxkzmJaMCI7tSLjB/blobs/bx6YxXw41VMd0DrXiFey/groups%20list.png" alt=""><figcaption></figcaption></figure>

## Menu banner

| **Buttons** | **Remarks**                              |
| ----------- | ---------------------------------------- |
| Refresh     | Refreshes the group list displayed       |
| New group   | Displays a blank form to add a new group |

## Filters

| **External filters**     | **Remarks**                                                                                                                                                                                                                                                                                                                |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Filter drop-down list    | Filters by specified criteria (e.g. name, description, email address, etc.); see next table                                                                                                                                                                                                                                |
| Search                   | Searches for groups by name, description, etc.                                                                                                                                                                                                                                                                             |
| Directory drop-down list | Displays the specified group directory                                                                                                                                                                                                                                                                                     |
| Type drop-down list      | <ul><li><strong>All</strong></li><li><strong>Directory</strong>: A group of users from a single directory (created by a synchronization or defined within WorkflowGen)</li><li><strong>Virtual group</strong>: A virtual group of users from a single directory filtered by an SQL-like query (directory filter)</li></ul> |

| **Filter drop-down list \*** | **Remarks**                                |
| ---------------------------- | ------------------------------------------ |
| ADS Path                     | Filters by group's ADS Path                |
| Common name                  | Filters by group's common name             |
| Description                  | Filters by group’s description             |
| Disintguished name           | Filters by group's distinguished name      |
| Email                        | Filters by group's email address           |
| Group code                   | Filters by group's group code              |
| Name                         | Filters by group's name                    |
| Query                        | Filters by group's query                   |
| System identifier            | Filters by group's system identifier (SID) |

\* A filter can be applied to part of a field.

## Groups list

| **Columns**             | **Remarks**                                                                                                                                                                                                                 |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Multi-select checkboxes | <p>Clicking one or more checkboxes will display buttons to:</p><ul><li>Delete the selected group(s)</li><li>Activate the members of the selected group(s)</li><li>Deactivate the members of the selected group(s)</li></ul> |
| Name                    | Name of the group (click to open the group form in edit mode)                                                                                                                                                               |
| Description             | Description of the group                                                                                                                                                                                                    |
| Users                   | Number of users associated to the group (a link displays the corresponding users)                                                                                                                                           |
| Directory               | Group directory                                                                                                                                                                                                             |

## Group form

Click a group name to open its form, which contains the following sections and fields.

| **Sections / Fields**                                                                                                                         | **Remarks**                                                                                                                                             |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **General**                                                                                                                                   |                                                                                                                                                         |
| Directory                                                                                                                                     | Group directory                                                                                                                                         |
| Name                                                                                                                                          | Unique identifier for the group in the directory (required field)                                                                                       |
| Description                                                                                                                                   | Group description (required field)                                                                                                                      |
| Synchronized                                                                                                                                  | If checked, the group is managed by the directory synchronization                                                                                       |
| **Associations**                                                                                                                              |                                                                                                                                                         |
| Virtual group query                                                                                                                           | Statement allowing a group definition based on query parameters (directory filter); see below for [query examples](#query-examples)                     |
| <img src="https://content.gitbook.com/content/KjZcMxkzmJaMCI7tSLjB/blobs/KbcOLi1lnltytMhaVNwk/question_mark.png" alt="" data-size="original"> | Help on query syntax (field name list)                                                                                                                  |
| Test                                                                                                                                          | Query syntax test and query result                                                                                                                      |
| Users                                                                                                                                         | Number of users associated to the group (a link displays the corresponding users); see [Associated users](#associated-users) below for more information |
| **Properties**                                                                                                                                |                                                                                                                                                         |
| Email                                                                                                                                         | Group's email address                                                                                                                                   |
| Group code                                                                                                                                    | Group's code                                                                                                                                            |
| LDAP ADsPath                                                                                                                                  | Group's LDAP ADsPath string                                                                                                                             |
| Common name                                                                                                                                   | Group's common name                                                                                                                                     |
| Distinguished name                                                                                                                            | Group's distinguished name                                                                                                                              |
| System identifier                                                                                                                             | Group's SID                                                                                                                                             |

### Associated users

Users are associated with a group only when the group is saved (at creation or when manually re-saved). If synchronized, the user list is refreshed at the time of the synchronization. If no synchronization has been defined for that directory, users in the virtual groups of that directory will not be updated automatically.

### Query examples

* User of a group: `{ISMEMBER(FINANCE)}`
* Users from a defined city: `CITY = 'LOS ANGELES'`
* Combinations, such as: `Country='USA'` and `{ISMEMBER(FINANCE)}`

## Deleting a group

Deleting a group does not delete the associated users.