Configure VEE by organization/channel¶

This page explains how to define VEE configuration at the organization or channel level using veeID and the VEEConfig.yaml table.

You can define your VEE configuration from the organization level down to the channel level. You set up a channel-specific VEE configuration by means of the veeID associated with the channel. This is a primary key in the VEEConfig.yaml table, which is fully mutable via SAPI.

VEE-related parameters present in other KX entities are then gathered and merged in an effective rule set to build the effective VEE group configuration for a channel or set of channels, with these VEE parameters being cached in-memory for more efficient processing of subsequent messages.

The VEEConfig.yaml table is defined as follows:

VEEConfig:
  m-meta: schema.yaml
  type: basic
  description: This table holds information about channel-related validation, editing, and estimation rules. Because of its structure, this table is not splayed.
  groups: MD
  primaryKeys: veeID
  validationFn: verVEEConfig
  isMdqQueryable: true
  mdqTables: VEEConfig
  isMdqTraversable: true
  topic: MD
  columns:
   - name: veeID
     type: integer
     description: Unique VEE identifier
     attr: unique

   - name: orgID
     type: integer
     description: Organization associated with this VEE configuration (FK to Organization)
     foreignKey: orgID

   - name: extVeeID
     type: symbol
     description: External VEE identifier (unique within organization)

   - name: parentVeeID
     type: integer
     description: Parent VEE identifier, or null if none
     foreignKey: VEEConfig

You can define a default veeID in veeDefault.yaml for a particular channel configuration (e.g., orgID, chanType, intv, uom, dir). This default will apply to channels that have been newly created during auto-registration.

Note

This table is only created during initial loading of the database; therefore, further manipulation of this table in a live system through an API is not currently supported.

The veeDefault.yaml table is defined as follows:

VEEDefault:
  m-meta: schema.yaml
  type: basic
  description: This table holds information about default VEE configurations for new channels.
  groups: MD
  primaryKeys: [ orgID,  chanType,  intv,  uom,  dir ]
  validationFn: verVEEDefault
  isMdqTraversable: true
  topic: MD
  columns:
   - name: orgID
     type: integer
     description: Organization associated with this entry
     foreignKey: orgID
     attr: grouped
     attrOrd: p
     attrDisk: p

   - name: chanType
     type: short
     description: Enumeration of channel type

   - name: intv
     type: short
     description: Interval length in global system-defined units

   - name: uom
     type: short
     description: Enumeration of units of measure

   - name: dir
     type: byte
     description: Application-defined directional flow classification, or null

   - name: veeID
     type: integer
     description: VEE identifier
     foreignKey: VEEConfig

Configure VEE by organization/channel¶

Next steps¶