@camunda/connectors-element-templates 1.0.6 → 1.0.8

package/src/element-templates/kafka-inbound-connector-receive.json

@@ -0,0 +1,498 @@
+[
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "Kafka Receive Task Connector",
+    "id": "io.camunda.connectors.inbound.KafkaReceive.v1",
+    "description": "Consume Kafka messages",
+    "metadata": {
+      "keywords": []
+    },
+    "documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka/?kafka=inbound",
+    "version": 7,
+    "category": {
+      "id": "connectors",
+      "name": "Connectors"
+    },
+    "appliesTo": ["bpmn:ReceiveTask"],
+    "elementType": {
+      "value": "bpmn:ReceiveTask"
+    },
+    "engines": {
+      "camunda": "^8.3"
+    },
+    "groups": [
+      {
+        "id": "authentication",
+        "label": "Authentication"
+      },
+      {
+        "id": "kafka",
+        "label": "Kafka"
+      },
+      {
+        "id": "schema",
+        "label": "Schema"
+      },
+      {
+        "id": "activation",
+        "label": "Activation"
+      },
+      {
+        "id": "correlation",
+        "label": "Correlation",
+        "tooltip": "Learn more about message correlation in the <a href=\"https://docs.camunda.io/docs/components/concepts/messages/#message-correlation-overview\">documentation</a>."
+      },
+      {
+        "id": "deduplication",
+        "label": "Deduplication",
+        "tooltip": "Deduplication allows you to configure multiple inbound connector elements to reuse the same backend (consumer/thread/endpoint) by sharing the same deduplication ID."
+      },
+      {
+        "id": "output",
+        "label": "Output mapping"
+      }
+    ],
+    "properties": [
+      {
+        "value": "io.camunda:connector-kafka-inbound:1",
+        "binding": {
+          "name": "inbound.type",
+          "type": "zeebe:property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "authenticationType",
+        "label": "Authentication type",
+        "description": "Username/password or custom",
+        "optional": false,
+        "value": "credentials",
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "authentication",
+        "binding": {
+          "name": "authenticationType",
+          "type": "zeebe:property"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "Credentials",
+            "value": "credentials"
+          },
+          {
+            "name": "Custom",
+            "value": "custom"
+          }
+        ]
+      },
+      {
+        "id": "authentication.username",
+        "label": "Username",
+        "description": "Provide the username (must have permissions to produce message to the topic)",
+        "optional": true,
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.username",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "authentication.password",
+        "label": "Password",
+        "description": "Provide a password for the user",
+        "optional": true,
+        "group": "authentication",
+        "binding": {
+          "name": "authentication.password",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "topic.bootstrapServers",
+        "label": "Bootstrap servers",
+        "description": "Provide bootstrap server(s), comma-delimited if there are multiple",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "kafka",
+        "binding": {
+          "name": "topic.bootstrapServers",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "topic.topicName",
+        "label": "Topic",
+        "description": "Provide topic name",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "kafka",
+        "binding": {
+          "name": "topic.topicName",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "groupId",
+        "label": "Consumer group ID",
+        "description": "Provide the consumer group ID used by the connector. Leave empty for an automatically generated one",
+        "optional": false,
+        "group": "kafka",
+        "binding": {
+          "name": "groupId",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "additionalProperties",
+        "label": "Additional properties",
+        "description": "Provide additional Kafka consumer properties in JSON",
+        "optional": true,
+        "feel": "required",
+        "group": "kafka",
+        "binding": {
+          "name": "additionalProperties",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "offsets",
+        "label": "Offsets",
+        "description": "List of offsets, e.g. '10' or '=[10, 23]'. If specified, it has to have the same number of values as the number of partitions",
+        "optional": true,
+        "feel": "optional",
+        "group": "kafka",
+        "binding": {
+          "name": "offsets",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "autoOffsetReset",
+        "label": "Auto offset reset",
+        "description": "What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. You should only select none if you specified the offsets",
+        "optional": false,
+        "value": "latest",
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "kafka",
+        "binding": {
+          "name": "autoOffsetReset",
+          "type": "zeebe:property"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "None",
+            "value": "none"
+          },
+          {
+            "name": "Latest",
+            "value": "latest"
+          },
+          {
+            "name": "Earliest",
+            "value": "earliest"
+          }
+        ]
+      },
+      {
+        "id": "schemaStrategy.type",
+        "label": "Schema strategy",
+        "value": "noSchema",
+        "group": "schema",
+        "binding": {
+          "name": "schemaStrategy.type",
+          "type": "zeebe:property"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "No schema",
+            "value": "noSchema"
+          },
+          {
+            "name": "Avro Inline schema",
+            "value": "inlineSchema"
+          },
+          {
+            "name": "Confluent Schema registry",
+            "value": "schemaRegistry"
+          }
+        ]
+      },
+      {
+        "id": "schemaStrategy.avro.schema",
+        "label": "Schema",
+        "description": "Avro inline schema for the message value",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "required",
+        "group": "schema",
+        "binding": {
+          "name": "schemaStrategy.schema",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "schemaStrategy.type",
+          "equals": "inlineSchema",
+          "type": "simple"
+        },
+        "type": "Text"
+      },
+      {
+        "id": "schemaStrategy.schemaType",
+        "label": "Schema type",
+        "description": "Select the schema type. For details, visit the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/kafka/?kafka=inbound\" target=\"_blank\">documentation</a>",
+        "optional": false,
+        "value": "avro",
+        "group": "schema",
+        "binding": {
+          "name": "schemaStrategy.schemaType",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "schemaStrategy.type",
+          "equals": "schemaRegistry",
+          "type": "simple"
+        },
+        "type": "Dropdown",
+        "choices": [
+          {
+            "name": "JSON",
+            "value": "json"
+          },
+          {
+            "name": "Avro",
+            "value": "avro"
+          }
+        ]
+      },
+      {
+        "id": "schemaStrategy.schemaRegistryUrl",
+        "label": "Schema registry URL",
+        "description": "Provide the schema registry URL",
+        "optional": false,
+        "constraints": {
+          "notEmpty": true
+        },
+        "group": "schema",
+        "binding": {
+          "name": "schemaStrategy.schemaRegistryUrl",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "schemaStrategy.type",
+          "equals": "schemaRegistry",
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "activationCondition",
+        "label": "Activation condition",
+        "description": "Condition under which the Connector triggers. Leave empty to catch all events",
+        "optional": true,
+        "feel": "required",
+        "group": "activation",
+        "binding": {
+          "name": "activationCondition",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "consumeUnmatchedEvents",
+        "label": "Consume unmatched events",
+        "value": true,
+        "group": "activation",
+        "binding": {
+          "name": "consumeUnmatchedEvents",
+          "type": "zeebe:property"
+        },
+        "tooltip": "Unmatched events are rejected by default, allowing the upstream service to handle the error. Check this box to consume unmatched events and return a success response",
+        "type": "Boolean"
+      },
+      {
+        "id": "correlationKeyProcess",
+        "label": "Correlation key (process)",
+        "description": "Sets up the correlation key from process variables",
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "correlationKey",
+          "type": "bpmn:Message#zeebe:subscription#property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "correlationKeyPayload",
+        "label": "Correlation key (payload)",
+        "description": "Extracts the correlation key from the incoming message payload",
+        "constraints": {
+          "notEmpty": true
+        },
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "correlationKeyExpression",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageIdExpression",
+        "label": "Message ID expression",
+        "description": "Expression to extract unique identifier of a message",
+        "optional": true,
+        "feel": "required",
+        "group": "correlation",
+        "binding": {
+          "name": "messageIdExpression",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageTtl",
+        "label": "Message TTL",
+        "description": "Time-to-live for the message in the broker (ISO-8601 duration)",
+        "optional": true,
+        "constraints": {
+          "notEmpty": false,
+          "pattern": {
+            "value": "^(PT.*|)$",
+            "message": "must be an ISO-8601 duration"
+          }
+        },
+        "feel": "optional",
+        "group": "correlation",
+        "binding": {
+          "name": "messageTtl",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "messageNameUuid",
+        "generatedValue": {
+          "type": "uuid"
+        },
+        "group": "correlation",
+        "binding": {
+          "name": "name",
+          "type": "bpmn:Message#property"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "deduplicationModeManualFlag",
+        "label": "Manual mode",
+        "description": "By default, similar connectors receive the same deduplication ID. Customize by activating manual mode",
+        "value": false,
+        "group": "deduplication",
+        "binding": {
+          "name": "deduplicationModeManualFlag",
+          "type": "zeebe:property"
+        },
+        "type": "Boolean"
+      },
+      {
+        "id": "deduplicationId",
+        "label": "Deduplication ID",
+        "constraints": {
+          "notEmpty": true,
+          "pattern": {
+            "value": "^[a-zA-Z0-9_-]+$",
+            "message": "can only contain alphanumeric characters, dashes, and underscores"
+          }
+        },
+        "group": "deduplication",
+        "binding": {
+          "name": "deduplicationId",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "deduplicationModeManualFlag",
+          "equals": true,
+          "type": "simple"
+        },
+        "type": "String"
+      },
+      {
+        "id": "deduplicationModeManual",
+        "value": "MANUAL",
+        "group": "deduplication",
+        "binding": {
+          "name": "deduplicationMode",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "deduplicationId",
+          "isActive": true,
+          "type": "simple"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "deduplicationModeAuto",
+        "value": "AUTO",
+        "group": "deduplication",
+        "binding": {
+          "name": "deduplicationMode",
+          "type": "zeebe:property"
+        },
+        "condition": {
+          "property": "deduplicationId",
+          "isActive": false,
+          "type": "simple"
+        },
+        "type": "Hidden"
+      },
+      {
+        "id": "resultVariable",
+        "label": "Result variable",
+        "description": "Name of variable to store the response in",
+        "group": "output",
+        "binding": {
+          "name": "resultVariable",
+          "type": "zeebe:property"
+        },
+        "type": "String"
+      },
+      {
+        "id": "resultExpression",
+        "label": "Result expression",
+        "description": "Expression to map the response into process variables",
+        "feel": "required",
+        "group": "output",
+        "binding": {
+          "name": "resultExpression",
+          "type": "zeebe:property"
+        },
+        "type": "Text"
+      }
+    ],
+    "icon": {
+      "contents": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0nMTgnIGhlaWdodD0nMTgnIHZpZXdCb3g9JzAgMCAyNTYgNDE2JyB4bWxucz0naHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmcnIHByZXNlcnZlQXNwZWN0UmF0aW89J3hNaWRZTWlkJz4KICAgIDxwYXRoIGQ9J00yMDEuODE2IDIzMC4yMTZjLTE2LjE4NiAwLTMwLjY5NyA3LjE3MS00MC42MzQgMTguNDYxbC0yNS40NjMtMTguMDI2YzIuNzAzLTcuNDQyIDQuMjU1LTE1LjQzMyA0LjI1NS0yMy43OTcgMC04LjIxOS0xLjQ5OC0xNi4wNzYtNC4xMTItMjMuNDA4bDI1LjQwNi0xNy44MzVjOS45MzYgMTEuMjMzIDI0LjQwOSAxOC4zNjUgNDAuNTQ4IDE4LjM2NSAyOS44NzUgMCA1NC4xODQtMjQuMzA1IDU0LjE4NC01NC4xODQgMC0yOS44NzktMjQuMzA5LTU0LjE4NC01NC4xODQtNTQuMTg0LTI5Ljg3NSAwLTU0LjE4NCAyNC4zMDUtNTQuMTg0IDU0LjE4NCAwIDUuMzQ4LjgwOCAxMC41MDUgMi4yNTggMTUuMzg5bC0yNS40MjMgMTcuODQ0Yy0xMC42Mi0xMy4xNzUtMjUuOTExLTIyLjM3NC00My4zMzMtMjUuMTgydi0zMC42NGMyNC41NDQtNS4xNTUgNDMuMDM3LTI2Ljk2MiA0My4wMzctNTMuMDE5QzEyNC4xNzEgMjQuMzA1IDk5Ljg2MiAwIDY5Ljk4NyAwIDQwLjExMiAwIDE1LjgwMyAyNC4zMDUgMTUuODAzIDU0LjE4NGMwIDI1LjcwOCAxOC4wMTQgNDcuMjQ2IDQyLjA2NyA1Mi43Njl2MzEuMDM4QzI1LjA0NCAxNDMuNzUzIDAgMTcyLjQwMSAwIDIwNi44NTRjMCAzNC42MjEgMjUuMjkyIDYzLjM3NCA1OC4zNTUgNjguOTR2MzIuNzc0Yy0yNC4yOTkgNS4zNDEtNDIuNTUyIDI3LjAxMS00Mi41NTIgNTIuODk0IDAgMjkuODc5IDI0LjMwOSA1NC4xODQgNTQuMTg0IDU0LjE4NCAyOS44NzUgMCA1NC4xODQtMjQuMzA1IDU0LjE4NC01NC4xODQgMC0yNS44ODMtMTguMjUzLTQ3LjU1My00Mi41NTItNTIuODk0di0zMi43NzVhNjkuOTY1IDY5Ljk2NSAwIDAgMCA0Mi42LTI0Ljc3NmwyNS42MzMgMTguMTQzYy0xLjQyMyA0Ljg0LTIuMjIgOS45NDYtMi4yMiAxNS4yNCAwIDI5Ljg3OSAyNC4zMDkgNTQuMTg0IDU0LjE4NCA1NC4xODQgMjkuODc1IDAgNTQuMTg0LTI0LjMwNSA1NC4xODQtNTQuMTg0IDAtMjkuODc5LTI0LjMwOS01NC4xODQtNTQuMTg0LTU0LjE4NHptMC0xMjYuNjk1YzE0LjQ4NyAwIDI2LjI3IDExLjc4OCAyNi4yNyAyNi4yNzFzLTExLjc4MyAyNi4yNy0yNi4yNyAyNi4yNy0yNi4yNy0xMS43ODctMjYuMjctMjYuMjdjMC0xNC40ODMgMTEuNzgzLTI2LjI3MSAyNi4yNy0yNi4yNzF6bS0xNTguMS00OS4zMzdjMC0xNC40ODMgMTEuNzg0LTI2LjI3IDI2LjI3MS0yNi4yN3MyNi4yNyAxMS43ODcgMjYuMjcgMjYuMjdjMCAxNC40ODMtMTEuNzgzIDI2LjI3LTI2LjI3IDI2LjI3cy0yNi4yNzEtMTEuNzg3LTI2LjI3MS0yNi4yN3ptNTIuNTQxIDMwNy4yNzhjMCAxNC40ODMtMTEuNzgzIDI2LjI3LTI2LjI3IDI2LjI3cy0yNi4yNzEtMTEuNzg3LTI2LjI3MS0yNi4yN2MwLTE0LjQ4MyAxMS43ODQtMjYuMjcgMjYuMjcxLTI2LjI3czI2LjI3IDExLjc4NyAyNi4yNyAyNi4yN3ptLTI2LjI3Mi0xMTcuOTdjLTIwLjIwNSAwLTM2LjY0Mi0xNi40MzQtMzYuNjQyLTM2LjYzOCAwLTIwLjIwNSAxNi40MzctMzYuNjQyIDM2LjY0Mi0zNi42NDIgMjAuMjA0IDAgMzYuNjQxIDE2LjQzNyAzNi42NDEgMzYuNjQyIDAgMjAuMjA0LTE2LjQzNyAzNi42MzgtMzYuNjQxIDM2LjYzOHptMTMxLjgzMSA2Ny4xNzljLTE0LjQ4NyAwLTI2LjI3LTExLjc4OC0yNi4yNy0yNi4yNzFzMTEuNzgzLTI2LjI3IDI2LjI3LTI2LjI3IDI2LjI3IDExLjc4NyAyNi4yNyAyNi4yN2MwIDE0LjQ4My0xMS43ODMgMjYuMjcxLTI2LjI3IDI2LjI3MXonCiAgICAgICAgICBzdHlsZT0nZmlsbDojMjMxZjIwJy8+Cjwvc3ZnPg=="
+    }
+  }
+]