Developer Home / Data Feeds / Data Feed Types / Group

Group

Use this data feed type to define new employee groups and/or assign and revoke user managements of groups. This is also the only data set that allows removal--particularly, the revocation of a user's management of a group.

In Guardian, one is able to define a hierarchy which represents the organizational structure of a company, allowing management responsibilities to be distributed among regional managers, branch managers, human resources specialists, etc.—in fact, a company’s hierarchy can be defined to any level of specificity required for a given organization.

Employee groups represent individual nodes within the organization’s hierarchical structure and are used to categorize a collection of employees. The hierarchy is comprised of between one and five levels as defined by the organization. The organization may create levels for the following types of data stored in Guardian: locations, legal entities, and custom fields.

Values and relationships of attributes are represented in a hierarchical fashion within Guardian such that an employee group at a higher level in the hierarchy represents a larger set of employees than a group appearing lower in the structure (i.e. an employee group defined by more attributes).

Group creation assumes the attributes used to define the new employee group already exist (i.e. a specific location, legal entity, and/or custom field choice). The file must include all parent attributes that define the employee group.

A management enables additional user permissions by extending user scope. Specifically, assigning a user to an employee group defines a management, associating a set of employees with a user, and allowing him or her to view and modify the employees’ cases.

This data feed type can be used to create management relationships between a user and an employee group. Management groups logically describe a tree structure, mirroring the organization of the company. A group is identified by a unique path from the root of the hierarchy to the desired node. Multiple management relationships can exist for the same group node.

The file must include the attribute values that define the employee group. Root is used to distinguish the top of the hierarchical tree. A user may be assigned to this node which means the user has access to all employees within the organization.

Set userId.profileId to assign that user management of the specified group, unless revokeOwnership is set, which revokes the management of the specified group for the user identified by userId.profileId. The directive ‘revokeOwnership’ is only valid if userId.profileId is also specified. Set the root field to "yes" and leave all of the other hierarchy fields empty when you want to assign/revoke the management of the entire company to/from the user identified by userId.profileId. Do not identify a row with both a root ‘yes’ value and values for other hierarchical fields as it will result in an error. If the user is to be assigned to a group other than the company group, leave the root field empty. When creating a new employee group, leave the root field empty.