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

const keys = useCreateNodeKey(ActionCategoryComponentEnum.LOG);

export interface LogDataType {
  someConfiguration?: Recordable;
}

export const LogConfig: NodeItemConfigType = {
  ...keys,
  clazz: 'org.thingsboard.rule.engine.action.TbLogNode',
  categoryType: RuleNodeTypeEnum.ACTION,
  name: 'log',
  configurationDescriptor: {
    nodeDefinition: {
      details:
        "Transform incoming Message with configured JS function to String and log final value into Thingsboard log file. Message payload can be accessed via <code>msg</code> property. For example <code>'temperature = ' + msg.temperature ;</code>. Message metadata can be accessed via <code>metadata</code> property. For example <code>'name = ' + metadata.customerName;</code>.",
      description: 'Log incoming messages using JS script for transformation Message into String',
      inEnabled: true,
      outEnabled: true,
      relationTypes: ['Success', 'Failure'],
      customRelations: false,
      ruleChainNode: false,
      defaultConfiguration: {
        jsScript:
          "return 'Incoming message:\\n' + JSON.stringify(msg) + '\\nIncoming metadata:\\n' + JSON.stringify(metadata);",
      },
      uiResources: ['static/rulenode/rulenode-core-config.js'],
      configDirective: 'tbActionNodeLogConfig',
      icon: 'material-symbols:menu',
      iconUrl: '',
      docUrl: '',
    },
  },
};