You are currently viewing an older version of the documentation. You can find the latest documentation here.

RMC Interface Table Option

Overview

The table option constructs a table in the view. Use this when the full variable names are not known at the time the template is created.

For example, when monitoring Sink Distributor User Mounts it is not possible to fully specify the variable names, as new mounts may come and go. Instead, a pattern that the variable names fall into is specified.

Table option configuration

RMC Interface data template table option

When you opt a data template and choose the table option, here are the ways you can configure the table:

Record seed

This option is used to retrieve data from recurring variable strings, such as user, mounts, services, and so on.

The record seed replaces the recurring variables followed by the various fields to be retrieved.

For more information, see $HOST and $INSTANCE substitutions in RMC Interface Plug-in Technical Reference.

Mandatory: Yes

Key like

The key in the variable name must map to a text string that is unique across all the records in the RMC data stream.

Sometimes it is necessary to only pick the records that have the key that match a specific pattern. For example, when monitoring Service instances, the key must have a text followed by a number. If this pattern restriction is not specified, the Service summary records (text without number) will also be displayed.

The key forms the changeable part of the record seed. This can be the username, serverId, service name, and so on. The key can be several variable parts.

Key pattern can be specified using combinations of matchElements in any order.

Match Element Description
Number Matches any combination of 0-9 up to a '.'
Text Matches any combination of characters up to a '.' or a number.
Any Matches any combination of characters up to a '.'

Mandatory: Yes

Fields

Define the fields that will be shown in the table.

Field Description
Name

Name of the column that shows this field.

Mandatory: Yes

options (second column)

Denotes the field content type:

  • value — RMC name identifying the source managed variable. For example, attributes or consumer name.
  • Key element — If the <key> pattern is composed of multiple elements, this setting adds a column to display a corresponding element, denoted by its position in the <key> pattern. For a <key> pattern matching "route.2209.dataStreams", key element 1 would show "route", element 2 "2209", and element 3 "dataStreams".
  • Key template — Displays the matched <key> pattern in the format specified by the template. The key template can be any combination of the key elements and string literals. For a <key> pattern matching "route.2209.dataStreams", the following key template will display the key as "route-2209-dataStreams":
  • Show as percentage — Allows for the creation of new columns which are based on existing field data. These are a percentage representation of two data items. Indicate a Numerator and a Denominator.
Strip

Some RMC variables contain additional information that may not be desired, this command can be used to truncate the contents of a variable at a predefined position.

You have the option to truncate after or before a specified string.

options (right column)

Provides the option to show the variable as a rate.

When Show as rate is enabled, then you can configure the following options:

  • Options — Signed wrap or Unsigned wrap.
  • Calculation method — Change between samples or Change between syncs.

Mandatory: No

For more information on the Show as rate options, see Rate calculation in RMC Interface Plug-in Technical Reference.

Unified strings

This is an optional parameter that indicates that the specified unified strings are to be considered as a single element that matches a single element in the pattern specified with Key like.

For example, if a.b.c is specified as a unified string, then the record 'a.b.c.1.d' will match the pattern Text + Number + Text.

Wildcards can be used in unified strings. Each * will match a single dot-separated element in the key.

For example, *.a.b will match 'xxx.a.b' but not 'xxx.yyy.a.b'.

Mandatory: No

Show key

This parameter may be specified to produce a field in the display which will indicate how the key has been constructed. This can be useful for initial setting up of the template, or debugging.

Mandatory: No

Default: False