_NGA_Group

The _NGA_Group data point is structured as follows (default values based on standard EVENT archive group):

Element Name Type Default Description
backend dpId Reference to NGA backend internal data point represented as a string (DP name).
active bool 1 Group is active, data can be written and read.
isLicensed bool false Used for internal license monitoring and is only valid if a backend/group is active. The license information is shown in the user interface. See chapter Backend - Backend list.
archiveAll bool false Group will archive all DPEs, also without _archive config.
groupName string Name of an archive group.
isAlert bool false Group is used for alert archiving (not events).
isUserDefined bool false Not yet enabled.
encrypt bool false Not yet enabled.
groupPriority unsigned 1 Not yet enabled.
storage struct -
retentionInterval unsigned 2 = day Period for how long backed up data is saved– factor (1=hour,2=day,3=week,4=month,5=year).
retentionFactor unsigned 31 Multiplicator for retention interval
segmentDurationInterval unsigned 2 = day Duration of a single segment – factor (1=hour,2=day,3=week,4=month,5=year).
segmentDurationFactor unsigned 1 Multiplicator for segment duration interval.
segmentDurationStart time 0 Sync time for segment switch (time period from midnight).
backupAgeInterval unsigned 0 Time limit for age of a segment before backup takes place; (0=back up before deletion, 1=hour,2=day,3=week).
backupAgeFactor unsigned 0 Multiplicator for backup age interval (0=back up before deletion)
backupInterval unsigned 0 Period for backup – factor (1=hour,2=day,3=week).
backupFactor unsigned 0 Multiplicator for backup interval (0=no backup).
nextScheduledBackup time 0

Time of next scheduled backup (for sync).

Note that the daylight-saving time is not considered in the calculation of next scheduled backup.
backupDayOfMonth unsigned 0

Day of month on which the data is backuped.

The backup time is taken from _NGA_Group.storage.nextScheduledBackup
disableBackupOnDeletion bool false If a segment is deleted due to the retention period, the segment is backed up by default. To disabled the backup, set the disableBackupOnDeletion to TRUE.
segments struct -
start dyn_time - List of all segments – start time.
end dyn_time - List of all segments – end time.
id dyn_long - List of all segments – segment id.
status dyn_int - List of all segments – segment status.
commands struct -
updateSegmentList bool - Updates segment information.
deleteSegmentById long - Delete segment.
deleteSegmentResponse int - Feedback when segment is deleted.
backupSegmentById long - Backup segment.
backupSegmentResponse int - Feedback when segment is backed up.
restoreSegmentById long - Restore segment.
restoreSegmentResponse int - Feedback when segment is restored.
switchSegmentById long - Perform segment switch.
switchSegmentResponse int - Feedback when segment is switched
specificCommand string - DB / backend-specific operation.
specificCommandResponse string - Feedback when DB / backend-specific operation is performed.
triggerWrite bool - Trigger archiving of all DPEs of this group.
triggerWriteResponse int - Number of DPEs triggered (pos. value) / error code (neg. value).
statistics struct -
index int -

1 = get current DPE assignment to group

2 = get current DPE assignment from database

0 = answer received.
dpElements dyn_dpid - List of all DPEs currently assigned to this group.
displayName langString Name of an archive group in the user interface.