index.ts
4.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/**
*规则链 外部的 英文配置文件
目前共有11个，分类按名称进行配置
*/
export default {
title: 'External',
description: 'Interacting with external systems',
alarmNotice: {
name: 'alarm notice',
details: `notice method include sms,email and so on.`,
description: 'while device alarm, notice some people.',
},
awsSns: {
name: 'aws sns',
details: `Will publish message payload to the AWS SNS topic. Outbound message will contain response fields (<code>messageId</code>, <code>requestId</code>) in the Message Metadata from the AWS SNS. For example <b>requestId</b> field can be accessed with <code>metadata.requestId</code>.`,
description: 'Publish message to the AWS SNS',
},
awsSqs: {
name: 'aws sqs',
details: `Will publish message payload and metadata attributes to the AWS SQS queue. Outbound message will contain response fields (<code>messageId</code>, <code>requestId</code>, <code>messageBodyMd5</code>, <code>messageAttributesMd5</code>, <code>sequenceNumber</code>) in the Message Metadata from the AWS SQS. For example <b>requestId</b> field can be accessed with <code>metadata.requestId</code>.`,
description: 'Publish messages to the AWS SQS',
},
azureIotHub: {
name: 'azure iot hub',
details: `Will publish message payload to the Azure IoT Hub with QoS <b>AT_LEAST_ONCE</b>.`,
description: 'Publish messages to the Azure IoT Hub',
},
gcpPubsub: {
name: 'gcp pubsub',
details: `Will publish message payload to the Google Cloud Platform PubSub topic. Outbound message will contain response fields (<code>messageId</code> in the Message Metadata from the GCP PubSub. <b>messageId</b> field can be accessed with <code>metadata.messageId</code>.`,
description: 'Publish message to the Google Cloud PubSub',
},
kafka: {
name: 'kafka',
details: `Will send record via Kafka producer to Kafka server. Outbound message will contain response fields (<code>offset</code>, <code>partition</code>, <code>topic</code>) from the Kafka in the Message Metadata. For example <b>partition</b> field can be accessed with <code>metadata.partition</code>.`,
description: 'Publish messages to Kafka server',
},
mqtt: {
name: 'mqtt',
details: `Will publish message payload to the MQTT broker with QoS <b>AT_LEAST_ONCE</b>.`,
description: 'Publish messages to the MQTT broker',
},
rabbitmq: {
name: 'rabbitmq',
details: `Will publish message payload to RabbitMQ queue.`,
description: 'Publish messages to the RabbitMQ',
},
restApiCall: {
name: 'rest api call',
details: `Will invoke REST API call <code>GET | POST | PUT | DELETE</code> to external REST server. Message payload added into Request body. Configured attributes can be added into Headers from Message Metadata. Outbound message will contain response fields (<code>status</code>, <code>statusCode</code>, <code>statusReason</code> and response <code>headers</code>) in the Message Metadata. Response body saved in outbound Message payload. For example <b>statusCode</b> field can be accessed with <code>metadata.statusCode</code>.<br/><b>Note-</b> if you use system proxy properties, the next system proxy properties should be added: "http.proxyHost" and "http.proxyPort" or "https.proxyHost" and "https.proxyPort" or "socksProxyHost" and "socksProxyPort",and if your proxy with auth, the next ones should be added: "tb.proxy.user" and "tb.proxy.password" to the thingsboard.conf file.`,
description: 'Invoke REST API calls to external REST server',
},
sendEmail: {
name: 'send email',
details: `Expects messages with <b>SEND_EMAIL</b> type. Node works only with messages that where created using <code>to Email</code> transformation Node, please connect this Node with <code>to Email</code> Node using <code>Successful</code> chain.`,
description: 'Sends email message via SMTP server.',
},
sendSms: {
name: 'send sms',
details: `Will send SMS message by populating target phone numbers and sms message fields using values derived from message metadata.`,
description: 'Sends SMS message via SMS provider.',
},
};