index.ts 1.96 KB
import { EnrichmentCategoryComponentEnum } from '../../../enum/category';
import { useCreateNodeKey } from '../../../hook/useCreateNodeKey';
import type { NodeItemConfigType } from '../../../types/node';
import { RuleNodeTypeEnum } from '../../index.type';

const keys = useCreateNodeKey(EnrichmentCategoryComponentEnum.RELATED_DEVICE_ATTRIBUTES);

export interface RelatedDeviceAttributesDataType {
  someConfiguration?: Recordable;
}

export const RelatedDeviceAttributesConfig: NodeItemConfigType = {
  ...keys,
  clazz: 'org.thingsboard.rule.engine.metadata.TbGetDeviceAttrNode',
  categoryType: RuleNodeTypeEnum.ENRICHMENT,
  name: 'related device attributes',
  configurationDescriptor: {
    nodeDefinition: {
      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',
      inEnabled: true,
      outEnabled: true,
      relationTypes: ['Success', 'Failure'],
      customRelations: false,
      ruleChainNode: false,
      defaultConfiguration: {
        clientAttributeNames: [],
        sharedAttributeNames: [],
        serverAttributeNames: [],
        latestTsKeyNames: [],
        tellFailureIfAbsent: true,
        getLatestValueWithTs: false,
        deviceRelationsQuery: {
          direction: 'FROM',
          maxLevel: 1,
          relationType: 'Contains',
          deviceTypes: ['default'],
          fetchLastLevelOnly: false,
        },
      },
      uiResources: ['static/rulenode/rulenode-core-config.js'],
      configDirective: 'tbEnrichmentNodeDeviceAttributesConfig',
      icon: '',
      iconUrl: '',
      docUrl: '',
    },
  },
};