Recommended Reads

Deprecated Settings

Introduction

This section describes the settings which have been deprecated from the Gateway schema.

Authentication

authentication > allowPaoLogin

This setting has been deprecated as PAO is no longer supported.

authentication > groups

The (optional) groups section contains any number of uniquely named user-group definitions.

Mandatory: No
Default: No groups defined

authentication > users > user > email

Deprecated: Use authentication > users > user > information instead, which allows the inclusion of generic information. Use the value type "Email".

Mandatory: No

Database Suspend Command

The command Database > Suspend (available on Gateway in the Gateways view in Active Console) where you had to tick/untick the "Suspend database" checkbox to suspend /unsuspend logging of database item values has been deprecated.

You should now use the commands DatabaseLogging > Itemvalues > DiscardandDatabaseLogging > Itemvalues > Log. The old command can still be scheduled through scheduled commands / tasks for backward compatibility.

Database Suspend On Error Setting

This setting has been deprecated and you should now use discardItemValuesOnError setting.

In this setting, you can configure multiple error codes. When any of these error codes are returned from the database, it triggers discarding of database item values and these updates are not be logged to the database (or saved to disk if the database isn't available).

This setting takes a text input and a wildcard search (pattern) is used to match the error against the error string returned from the database.

For example, the database may throw back error like:

[2003] Can't connect to MySQL server on 'ITRSPC000.ldn.itrs' (110)

Any substring of this error message such as "2003" or "[2003]" or "Can't connect to MySQL server on 'ITRSPC000.ldn.itrs'" will match this error message.

To start logging of database item values again, you need to issue command DatabaseLogging > Itemvalues > Log.

Please refer Database logging errors for a list of possible error codes returned from different database vendors.

Scheduled Commands

scheduledCommands > scheduledCommand > recurrence > pattern > hourly

This setting has been deprecated. Please use hours recurrence pattern.

scheduledCommands > scheduledCommand > recurrence > pattern > daily

This setting has been deprecated. Please use days recurrence pattern.

scheduledCommands > scheduledCommand > recurrence > pattern > weekly

This setting has been deprecated. Please use weeks recurrence pattern.

scheduledCommands > scheduledCommand > recurrence > pattern > monthly

This setting has been deprecated. Please use months recurrence pattern.

Self-announcing Netprobes

Filters

selfAnnouncingProbes > filters

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

Filters are used to control which Self-announcing Netprobes can connect to the Gateway, based on the managed entity attributes specified in the Netprobe setup. There are three types of conditionals configurable for filters:

Filters are checked in the order they are defined in the setup. The first filter that matches the probe determines whether to allow or deny the connection.

If a probe does not match any filters in the list, the catch-all filter action determines whether the probe is allowed to connect or denied.

Caution: The condition defined by a filter must be true for all managed entities defined on a Self-announcing Netprobe or the probe will be rejected.

Mandatory: No
Default: None, catch-all filter determines behaviour in this case

selfAnnouncingProbes > catch-allFilter

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The value of this setting determines whether to allow or deny the connection from a Self-announcing Netprobe that does not match any of the filters configured in filter .

Setting Description
ALLOW Allow the probe connection
DENY Deny the probe connection
Mandatory: Yes
Default: ALLOW

selfAnnouncingProbes > filters > filter > name

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

This setting specifies the name of the filter. Several filters can have the same name. There is no requirement at the time being for the name to be unique.

Mandatory: Yes

selfAnnouncingProbes > filters > filter > allow

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

When specified, any probe that matches this filter will be allowed to connect to the gateway.

Mandatory: One of allow or deny must be specified.

selfAnnouncingProbes > filters > filter > deny

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

When specified, any probe that matches this filter will be denied from connecting to the gateway.

Mandatory: One of allow or deny must be specified.

Filter Types

selfAnnouncingProbes > filters > filter > and

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The and filter combines the results from all sub-filters to form the logical conjunction result.

That is, this filter will only match the probe if all sub-filters match the probe, or if there are no sub-filters.

Mandatory: No
Default: When no sub-filters are configured, the filter will match the probe.

selfAnnouncingProbes > filters > filter > or

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The or filter combines the results from all sub-filters to form the logical disjunction result.

That is, this filter match the probe if at least one sub-filter matches the probe, or if there are no sub-filters.

Mandatory: No
Default: When no sub-filters are configured, the filter will match the probe.

selfAnnouncingProbes > filters > filter > entityAttributeComparison

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The entity attribute comparison filter allows you to specify an attribute in the Managed Entity (of the self-announce probe) to perform a comparison against.

As a contrived example, you can use this to filter all probes in London by specifying the name setting as "City" and the value setting as "London".

Note: This assumes that there are managed entity attributes called "City" that have been configured correctly.

Mandatory: No

selfAnnouncingProbes > filters > filter > entityAttributeComparison > name

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The name of the managed entity attribute which will be compared.

If the attribute does not exist on the entity, the filter will behave as if the attribute has an empty string value.

Mandatory: Yes

selfAnnouncingProbes > filters > filter > entityAttributeComparison > comparison

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

Setting Description
EQUALS The comparison will pass the probe, if the attribute matches the specified value (case-sensitive comparison).
NOT_EQUALS The comparison will pass the probe, if the attribute does not match the specified value (case-sensitive).
Mandatory: Yes

selfAnnouncingProbes > filters > filter > entityAttributeComparison > value

Deprecated. Gateway can accept Self-announcing Netprobes with multiple managed entities.

The value to compare the managed entity attribute against.

Mandatory: Yes