Get group

Description

This step is run against a group to return details of the group.

It can return more or less data, driven by config or data parameters.

key

Identifies the group to return, relative to this group. Default is this group. Same syntax as the key portion of the WorkerScript runtime placeholder for groupReference.

If trustedConnection is true and the step has been called from a connection, the additional syntax of 'ref:nodeVersionReference' is permitted, allowing a trusted connection to look up a group by node version reference. This will not work unless called from a trusted connection.

trustedConnection

If set to true, and the step has been called from a connection, then the connection's connection group must be trusted, i.e. have the trusted indicator set.

trustedConnection can only be set in config (otherwise an untrusted connection could simply turn off the option).

trustedFolder

If set to true, then the group must be in a folder identified by the binding "groups", evaluated from the connection group.

If set to a binding reference, then the group must be in a folder identified by the binding reference, evaluated from the connection group.

Has no effect if trustedConnection is not also set.

trustedGroup If set to true, then the group must itself be trusted.
listGroups Indicates that a list of sub groups should be returned.
listWorkers Indicates that a list of workers should be returned.
listConnections

Add to each group or worker a "connections" array which lists the connections for the group or worker. Each connection is an object with role, name and path (where path is the path of the connection's connection group), e.g.

"connections": [
{
"role": "owner",
"name": "Supplier management",
"path": "modules/supplier_management",
"config": { .. connection group config .. }
},
{
"role": "supplier",
"name": "Bill's Bolts",
"path": "suppliers/billsbolts",
"config": { .. connection group config .. }
}
]
processIdentifierWorker

When used with listWorkers, returns only details of that worker. This can be used to check that the worker is an immediate child of the group, and to get information about that worker.

It returns:

{
"processIdentifier": "group process identifier",
"name": "groupName",
"path": "group/path",
"processTypeReference": "processTypeReference",
"config": { .. group config .. },
  "groups": [
{
"processIdentifier": "Sub-group process identifier",
"name": "Sub-group name",
"path": "group/path/sub",
"processTypeReference": "processTypeReference",
"config": { .. group config .. }
}, ...
],
"workers": [
{
"processIdentifier": "worker process identifier",
"name": "Worker name",
"processTypeReference": "processTypeReference",
"config": { .. worker config .. }
}, ...
],
}

The groups array is only returned if listGroups is true. The workers array is only returned if listWorkers is true.

Groups and workers are identified by their "processIdentifier" properties, and have names.

Group and worker objects will also have a connections array if this has been requested.

(We could add processIdentifier to connection, also, if required, i.e. the processIdentifier of the connection group.)

The trust options are used in the standard control worker, to allow a process module to query information about the groups but to detect groups that cannot be fully trusted. This is used by modules that need to securely identify data from the groups.

Member Type List

Tab/SequenceWeightMember Type
Basic/
0
Basic/
0
Basic/description
0
Basic/tagList
0
Config/
0
Flow rules/flowRules
0

Set Tags

Tag List