AlarmScreenNg 0.9.8
Internal DPs

This sections describes DP types, used for AS EWO, their structure and usage.

These internal DPs are used for storing different subsets of NG AS configuration. Unlike many other components, the NG AS does not use rather complex DP structures, with many DPEs, with every DPE storing particular setting. Instead, NG AS uses another approach: there is just one 'main' DPE in every DP type, containing string in JSON format. All individual settings are encoded inside this JSON string.

The names of DP types, used by NG AS, are declared as string constants AS_xxx_DP_TYPE in CTRL library AlarmScreenNg.ctl.

Automatic DP naming

For some of DP types, described in the next sections, many DPs can be created in the project. Usually these are DPs, where user may save current configuration (filter, user settings...).

In all such cases, user doesn't specify (and doesn't even see) the name of DP where settings are saved (or from where loaded). Instead, the user is required to enter own unique (and, hopefully, meaningnful) name. Later saved settings are presented to user under this name.

DP names are generated automatically, using the following rule:

<dp_type_name>_<user>_<seq_no>

For example, DPs for user settings, saved by user 'operator', will be named "_NgAsUserSetting_operator_1", "_NgAsUserSetting_operator_2", etc.

Basic configuration

The most important configuration for AS EWO, which defines all basic settings, like set of alarm properties, set of columns in table etc. See Basic configuration for more details.

The DP type, holding the basic configuration, is called _NgAsConfig. This DP type contains the only DPE ConfigJSON of type string, containing basic configuration in JSON format.

WinCC OA project may contain several DPs of this type with different basic configurations. During component installation, several DPs of this type can be created in the project: they contain some basic configurations, prepared in advance.

Note
The DP with basic configuration is not automatically created/filled during component installation if project already contains DP with such name, and content of existing DP is not empty.

Admin settings

Admin settings for AS EWO are stored in DP of type _NgAsAdmin. DP type contains the following DPEs:

  • AccessControl: string containing access control settings in JSON format. See Access Control.
  • PopupMenuJCOP: string containing description of popup menu to be shown when user clicks on alarms table. See Popup menu configuration.
    Note
    Why 'JCOP'? Because UNICOS uses another way for building/processing popup menu.
  • HelpConfig: string containing configuration for different types of help files. See Help File Types.
  • ArchiveAccess: string contatining information required for connection to ORACLE archive: database, user name and password.

WinCC OA project shall contain only one DP of this DP type, the DP is named _NgAsAdmin.

User settings

The set of user settings are stored in DPs of type _NgAsUserSetting. DP type contains the following DPEs:

  • ConfigDp: string containing the name of basic configuration DP, for which this set of user settings is saved. In many cases, user settings prepared for one basic configuration, may not work for other basic configuration (for example, because table columns may have different headers in two configurations).
  • SettingName: string containing the unique name of this setting; the name was given by user when he saved user settings. This name is presented to user when he wants to load one of previously saved user settings.
  • SettingJSON: string containing the set of user settings in JSON format. See User Settings.
  • Usage: uint value, enumerating the usage of this user settings. See Configuring the default user settings
  • DefaultFilter: uint value, enumerating the usage of default filter, contained in user settings, see User settings. The value of this DPE is used when user settings from this DP are loaded into AS EWO. Three values ape possible (see also contants AS_NG_USER_SETTINGS_DFLT_FILTER_xxx defined in CTRL lib):
    • 0: when user settings are loaded to AS EWO, the previosuly set default filter for AS EWO remains unchanged. This is the default behavior.
    • 1: when user settings are loaded to AS EWO, the default filter of AS EWO is reset to 'empty' filter. Here 'empty' means not necessary empty filter, but rather the filter resulted from default settings in filter editor. One evident example is JCOP-style filter with Warning/Error/Failure checkboxes: the 'emty' in such case means the filter with non-empty filter on alarm priority.
    • 2: when user settings are loaded to AS EWO, the default filter of AS EWO is set to the filter saved in this user settings.
    Thus, the only way to apply non-empty default filter to AS EWO is loading user settings with the value in this DPE - of course, provided that user settings were saved with non-empty filter.

WinCC OA project may contain many DPs of this DP type: one for every settings, saved by user. The names of DPs are built automatically according to general rules, see Automatic DP naming.

Filters

The structured filters are stored in DPs of type _NgAsFilter. DP type contains the following DPEs:

  • ConfigDp: string containing the name of basic configuration DP, for which this filter is saved. In many cases, filter prepared for one basic configuration, may not work for other basic configuration (for example, because set of individual filters are different in different configurations).
  • FilterName: string containing the unique name of this filter; the name was given by user when he saved filter. This name is presented to user when he wants to load one of previously saved filters.
  • FilterJSON: string containing the structured filter in JSON format. See filter JSON syntax.
  • Delete: this DPE is not used (yet?)

WinCC OA project may contain many DPs of this DP type: one for every settings, saved by user. The names of DPs are built automatically according to general rules, see Automatic DP naming.

Filter View

The configurations for FiolterView are stored in DPs of type _NgAsFilterSet. DP type contains the following DPEs:

  • ConfigDp: string containing the name of basic configuration DP, for which this filter view was sbuilt. In many cases, filter view prepared for one basic configuration, may not work for other basic configuration (for example, because set of individual filters are different in different configurations).
  • SetName: string containing the unique name of this filter view; the name was given by user when filter view was created. This name is presented to user when he wants to load one of previously saved filter views.
  • SetJSON: string containing the definition of filter view in JSON format. See Filter View editor.

WinCC OA project may contain many DPs of this DP type: one for every created filter view. The names of DPs are built automatically, but the rules for these DPs are slightly different from common Automatic DP naming, namely: the names for DPs of this type doesn't contain user name: it is expected that filter views are by default shared by many users.

Trend configuration

The trend configuration, used by NG AS, is sitting a bit aside: there is no special DP type for NG AS. Instead, the NG AS reuses existing DP type FwTrendingPlot (coming with fwTrending component) and creates/fills DP of this type called _AlarmScreenNgPlot.

The DP is created/filled either during component installation, or when the trend is being opened for the very first time.