Group

This context lets you access and manage a single group.

Unique Actions

[?]

Create Group Status Tracker

This action lets you create a tracker that will indicate the group's status, i.e. the aggregated status of all group members. Group status is calculated using two parameters: Expression and Initial Value.

The group status Expression is evaluated for every group member context. It should involve two references:

  • {env/previous}, a reference that refers to the result of previous calculation

  • A reference to the data in current context, such as {.:status$connectionStatus}

During the first evaluation, {env/previous} will resolve to the Initial Value.

Action Flow:

  1. The user is prompted to enter the expression to be calculated for every group member, and an initial value for a group status.

  2. Group status expression is constructed based on the above data and a new tracker is created.

  3. A notification indicating the name of the new tracker is shown.

Action Name:

createStatusTracker

Action Icon:

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Configure Group

(Default Action)

This action is used to edit Group properties.

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

Action Type:

Configure

Create in Group

This action is used to create new object and add it to group immediately after creation. Object type matches group type, e.g. Alert for Alert Group, etc.

Action flow:

1. Start Create action from "container" context matching the group, e.g. Admin's Alerts context for Admin's Alert Group.

2. Add newly created object to the group.

Action Name:

create

Action Icon:

Non-Interactive Mode:

Not supported

Permissions:

Accessible at Observer permission level

Create Nested Group

This action is used to create a nested group inside a current group.

Action Name:

createNestedGroup

Action Icon:

Permissions:

Accessible at Manager permission level

Replicate or Add to Group

This is a Drag-and-Drop action that accepts contexts of the same type as group members, i.e. User contexts for the User groups etc. The Logic of this action is completely different in two cases:

  • When accepted context is not member of this group

  • When accepted context is already member of the group

In the first case accepted context is just added to the list of group members. No interaction of the used it performed in this case.

In the second case this action behaves as the Replicate action, i.e. performs replication of a group member's configuration to all other group members.

This action is very convenient to add new members to the group. New members are added by just dragging them and dropping on the Group context.

Action Type:

Drag and Drop

Action Name:

replicateOrAdd

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Operator permission level

Convert Dynamic Group to Static

This action adds every child of a dynamic group as a static child to the same group so that it can be later removed individually. When done, group's validity expression is emptied so that it has no more dynamic children.

It's easy to create a group of objects matching specific criteria:

  • Create new group and specify its validity expression to auto-add objects that match it;

  • Convert group to static;

  • Add or remove certain objects to fine-tune your group.

Action Name:

convertToStatic

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Engineer permission level

Common Actions

[?]

Delete, Edit Context Permissions, Monitor Related Events, Search/Filter, View Status

Context States and Icons

Icon

Code

State

0

Normal group

1

Group that performs automatic replication

Advanced Information

Context Information

Context Type: group

Context Name: provided by user

Context Description: provided by user

Context Path: "usergroups.GROUP_NAME" for user group, "users.USER_NAME.devgroups.GROUP_NAME" for Device group

Context Mask: "usergroups.*" for user groups, "users.*.devgroups.*" for Device groups

Context Permissions

[?]

Level

Description

None

No access allowed.

Observer

Group member list browsing.

Basic event monitoring.

Status browsing.

Access to group member list does not mean access to the group members themselves. See Group Member Permissions for details.

Operator

Configuration browsing.

Group member management.

Manager

Group configuration and removal.

Engineer

Same as Manager.

Administrator

Same as Manager.

Public Variables (Properties)

[?]

Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)

Group

Properties

See description of the variable and its fields here.

Variable Name:

childInfo

Records:

1

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

name

String

1 - 50 characters

description

String

1 - 50 characters

autoReplication

Boolean


hideMembers

Boolean

validityExpression

String

validityListeners

Data Table

Group Status

See description of the variable and its fields here.

Variable Name:

groupStatus

Records:

1

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

enabled

Boolean


variable

String


expression

String


statuses

Data Table

Replication Options

See description of the variable and its fields here.

Variable Name:

replication

Records:

0...unlimited

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

variable

String

description

String

replicate

Boolean

useMaster

Boolean

master

String

Location

Contains current location of the device group. This variable is available only for device groups.

Variable Name:

location

Records:

1

Permissions:

Readable at Observer permission level

Record Format:

Field Name

Field Type

Notes

latitude

Float

Current device group latitude.

longitude

Float

Current device group longitude.

Static Members

This variable lists group members that were manually added by devices operators. The list includes only members that are accessible to the party that reads this variable.

Note that certain static group members can also appear in the Validity list (e.g. match dynamic group's validity expression).

Variable Name:

staticMembers

Records:

0...unlimited

Permissions:

Readable at None permission level

Record Format:

Field Name

Field Type

Notes

context

String

The path of static member context.

Member Status

This variable lists individual status of all group members. Those individual statuses are used to calculate aggregated group status.

Variable Name:

memberStatus

Records:

0...unlimited

Permissions:

Readable at Observer permission level

Record Format:

Field Name

Field Type

Notes

context

String

Member context path.

status

String

Member status string.

Public Functions

[?]

Add Member

Adds new member context to the group.

Function Name:

add

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

Name

Type

Description

context

String

Path of context to add.

Output Records:

0

Output Format:

None

Remove Member

Removes member context from the group.

Function Name:

remove

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

Name

Type

Description

context

String

Path of context to remove.

Output Records:

0

Output Format:

None

Call Function for Group Members

Calls the same context function from every member context.

Function Name:

call

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

Name

Type

Description

function

String

Name of function to call.

parameters

String

Function input parameters.

Output Records:

0...unlimited

Output Format:

Name

Type

Description

context

String

Context path.

successful

Boolean

Indicates whither execution was successful.

error

String

Text of error message, if execution has failed.

return

Data Table

Function output, if execution was successful.

Public Events

[?]

Common Events: info (Information), contextStatusChanged (Status Changed)

Was this page helpful?