index.ts 5.68 KB
/**
 *规则链 属性集 英文配置文件
  目前共有10个,分类按名称进行配置
 */
export default {
  title: 'Enrichment',
  description: 'Add additional information to message metadata',
  calculateDelta: {
    name: 'calculate delta',
    details: `Calculates delta and period based on the previous time-series reading and current data. Delta calculation is done in scope of the message originator, e.g. device, asset or customer. If there is input key, the output relation will be 'Success' unless delta is negative and corresponding configuration parameter is set. If there is no input value key in the incoming message, the output relation will be 'Other'.`,
    description: `Calculates and adds 'delta' value into message based on the incoming and previous value`,
  },
  customerAttributes: {
    name: 'customer attributes',
    details: `If Attributes enrichment configured, server scope attributes are added into Message metadata. If Latest Telemetry enrichment configured, latest telemetry added into metadata. To access those attributes in other nodes this template can be used <code>metadata.temperature</code>.`,
    description: 'Add Originators Customer Attributes or Latest Telemetry into Message Metadata',
  },
  customerDetails: {
    name: 'customer details',
    details: `If checkbox: <b>Add selected details to the message metadata</b> is selected, existing fields will be added to the message metadata instead of message data.<br><br><b>Note:</b> only Device, Asset, and Entity View type are allowed.<br><br>If the originator of the message is not assigned to Customer, or originator type is not supported - Message will be forwarded to <b>Failure</b> chain, otherwise, <b>Success</b> chain will be used.`,
    description: 'Adds fields from Customer details to the message body or metadata',
  },
  originatorAttributes: {
    name: 'originator attributes',
    details: `If Attributes enrichment configured, <b>CLIENT/SHARED/SERVER</b> attributes are added into Message metadata with specific prefix: <i>cs/shared/ss</i>. Latest telemetry value added into metadata without prefix. To access those attributes in other nodes this template can be used <code>metadata.cs_temperature</code> or <code>metadata.shared_limit</code> `,
    description: 'Add Message Originator Attributes or Latest Telemetry into Message Metadata',
  },
  originatorFields: {
    name: 'originator fields',
    details: `Will fetch fields values specified in mapping. If specified field is not part of originator fields it will be ignored.`,
    description: 'Add Message Originator fields values into Message Metadata',
  },
  originatorTelemetry: {
    name: 'originator telemetry',
    details: `The node allows you to select fetch mode: <b>FIRST/LAST/ALL</b> to fetch telemetry of certain time range that are added into Message metadata without any prefix. If selected fetch mode <b>ALL</b> Telemetry will be added like array into Message Metadata where <b>key</b> is Timestamp and <b>value</b> is value of Telemetry.</br>If selected fetch mode <b>FIRST</b> or <b>LAST</b> Telemetry will be added like string without Timestamp.</br>Also, the rule node allows you to select telemetry sampling order: <b>ASC</b> or <b>DESC</b>. </br>Aggregation feature allows you to fetch aggregated telemetry as a single value by <b>AVG, COUNT, SUM, MIN, MAX, NONE</b>. </br><b>Note</b>: The maximum size of the fetched array is 1000 records.\n `,
    description: 'Add Message Originator Telemetry for selected time range into Message Metadata\n',
  },
  relatedAttributes: {
    name: 'related attributes',
    details: `Related Entity found using configured relation direction and Relation Type. If multiple Related Entities are found, only first Entity is used for attributes enrichment, other entities are discarded. If Attributes enrichment configured, server scope attributes are added into Message metadata. If Latest Telemetry enrichment configured, latest telemetry added into metadata. To access those attributes in other nodes this template can be used <code>metadata.temperature</code>.`,
    description:
      'Add Originators Related Entity Attributes or Latest Telemetry into Message Metadata',
  },
  relatedDeviceAttributes: {
    name: 'related device attributes',
    details: `If Attributes enrichment configured, <b>CLIENT/SHARED/SERVER</b> attributes are added into Message metadata with specific prefix: <i>cs/shared/ss</i>. Latest telemetry value added into metadata without prefix. To access those attributes in other nodes this template can be used <code>metadata.cs_temperature</code> or <code>metadata.shared_limit</code>`,
    description:
      'Add Originators Related Device Attributes and Latest Telemetry value into Message Metadata',
  },
  tenantAttributes: {
    name: 'tenant attributes',
    details: `If Attributes enrichment configured, server scope attributes are added into Message metadata. If Latest Telemetry enrichment configured, latest telemetry added into metadata. To access those attributes in other nodes this template can be used <code>metadata.temperature</code>.`,
    description: 'Add Originators Tenant Attributes or Latest Telemetry into Message Metadata',
  },
  tenantDetails: {
    name: 'tenant details',
    details: `If checkbox: <b>Add selected details to the message metadata</b> is selected, existing fields will be added to the message metadata instead of message data.<br><br><b>Note:</b> only Device, Asset, and Entity View type are allowed.<br><br>If the originator of the message is not assigned to Tenant, or originator type is not supported - Message will be forwarded to <b>Failure</b> chain, otherwise, <b>Success</b> chain will be used.`,
    description: 'Adds fields from Tenant details to the message body or metadata',
  },
};