Group

Top Previous Next

This context lets you access and manage a single group.

Unique Actions [?]

•	Create Group Status Tracker

Other unique actions:

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

Replicate of 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: Observer

Public Variables (Properties) [?]

Common Variables: groupMembership (Group Membership)

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

Public Functions [?]

ADD MEMBER

Adds new member context to the group.

Function Name:

add

Permissions:

Accessible at Operator permission level

Input Records:

Input Format:

Name	Type	Description
context	String	Path of context to add.

Output Records:

Output Format:

None

REMOVE MEMBER

Removes member context from the group.

Function Name:

remove

Permissions:

Accessible at Operator permission level

Input Records:

Input Format:

Name	Type	Description
context	String	Path of context to remove.

Output Records:

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:

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)