CfgFilter

Description

Use Filters to specify conditions for data selection from a data repository (for example, from a database table).

Filter Keys

Filter Name	Type	Description
dbid	int	A unique identifier of the filter. If specified, configuration server will return information only about this filter.
tenant_dbid	int	A unique identifier of the tenant. If specified, Configuration server will return information only about the filter(s) that belong to this tenant.
name	string	Name of a filter. Shall be specified as a character string. If specified, Configuration Server will return information only about the filter(s) with that name.
format_dbid	int	A unique identifier of format this filter relates to. If specified, Configuration Server will return information only about the filter(s) with that format.
state	int	Current state of the filter (See CfgObjectState). If specified, Configuration Server will return information only about the filter(s) that are currently in this state.

Attributes

• DBID — An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.
• tenantDBID — A unique identifier of the CfgTenant to which this filter is allocated. Mandatory. Once specified, cannot be changed.
• name — A pointer to filter name. Must be unique within tenant environment.Mandatory.
• description — A pointer to filter description.
• formatDBID — A unique identifier of CfgFormat to which this filter is dedicated. Once specified cannot be changed. Mandatory.
• state — Current object state. Mandatory. Refer to CfgObjectState.
• userProperties — A pointer to the list of user-defined properties. Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section. Among other properties must include kv-pair that specifies the filter sequence which application can use to read information from data table having specified format.

Comments

Filter used by Outbound applications is defined by two kv-pairs that must be present in userProperties under default section:

Two ways of editing are provided:

• Automated. The user has a list of fields and is able to create expressions using GUI-like any SQL wizard. The only simple expressions are created i.e., list of <field>, <sign>, and <value> separated by AND and OR
• Manual (Advanced). The user types the statement manually and is totally responsible for the correct syntax.

If value of kv-pair exceeds character string limit ( >255 symbols) the string has to be separated into two or more strings. Two or more kv-pairs with same names have to be used to locate such string in userProperties.

The order of kv-pairs in userProperties is defined by application the filter is intended to. String concatenation is application responsibility.

Deletion of Filter X will cause the following events set out in the order of arrival:

• Modification of filterDBID of all calling lists that refer on the Filter X
• Deletion of Filter X

XML Representation

Tip

This XML was created using the Configuration Server 7.5 schema.

  <CfgFilter>
    <DBID value="101" />
    <tenantDBID value="101" />
    <name value="Test_Filter" />
    <formatDBID value="104" />
    <state value="1" />
  </CfgFilter>

See Also

CfgDeltaFilter

CfgTableAccess

CfgFormat