script-connector.json

{
  "$schema" : "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
  "name" : "Script Connector",
  "id" : "io.camunda.community:script-connector",
  "description" : "A connector to execute a script",
  "version" : 1,
  "category" : {
    "id" : "connectors",
    "name" : "Connectors"
  },
  "appliesTo" : [ "bpmn:Task" ],
  "elementType" : {
    "value" : "bpmn:ServiceTask"
  },
  "groups" : [ {
    "id" : "default",
    "label" : "Properties"
  }, {
    "id" : "output",
    "label" : "Output mapping"
  }, {
    "id" : "error",
    "label" : "Error handling"
  }, {
    "id" : "retries",
    "label" : "Retries"
  } ],
  "properties" : [ {
    "value" : "io.camunda.community:script-connector",
    "binding" : {
      "type" : "zeebe:taskDefinition:type"
    },
    "type" : "Hidden"
  }, {
    "id" : "script.type",
    "label" : "Type",
    "group" : "default",
    "binding" : {
      "name" : "script.type",
      "type" : "zeebe:input"
    },
    "type" : "Dropdown",
    "choices" : [ {
      "name" : "Embedded",
      "value" : "embedded"
    }, {
      "name" : "Resource",
      "value" : "resource"
    } ]
  }, {
    "id" : "script.embedded",
    "label" : "Script",
    "description" : "The script to be executed",
    "optional" : false,
    "constraints" : {
      "notEmpty" : true
    },
    "feel" : "optional",
    "group" : "default",
    "binding" : {
      "name" : "script.embedded",
      "type" : "zeebe:input"
    },
    "condition" : {
      "property" : "script.type",
      "equals" : "embedded"
    },
    "type" : "String"
  }, {
    "id" : "script.language",
    "label" : "Script Language",
    "description" : "The language the script uses. By default, the ones available are: javascript, groovy, kotlin, mustache",
    "optional" : false,
    "constraints" : {
      "notEmpty" : true
    },
    "feel" : "optional",
    "group" : "default",
    "binding" : {
      "name" : "script.language",
      "type" : "zeebe:input"
    },
    "condition" : {
      "property" : "script.type",
      "equals" : "embedded"
    },
    "type" : "String"
  }, {
    "id" : "script.resource",
    "label" : "Script resource",
    "description" : "The resource that should be executed. Should be prefixed with 'classpath:' for a classpath resource, 'file:' for a file system resource. If none of these prefixes matches, it will attempt to load the provided resource as URL.",
    "optional" : false,
    "constraints" : {
      "notEmpty" : true
    },
    "feel" : "optional",
    "group" : "default",
    "binding" : {
      "name" : "script.resource",
      "type" : "zeebe:input"
    },
    "condition" : {
      "property" : "script.type",
      "equals" : "resource"
    },
    "type" : "String"
  }, {
    "id" : "context",
    "label" : "Script context",
    "description" : "The context that is available to the script",
    "optional" : false,
    "feel" : "required",
    "group" : "default",
    "binding" : {
      "name" : "context",
      "type" : "zeebe:input"
    },
    "type" : "String"
  }, {
    "id" : "resultVariable",
    "label" : "Result variable",
    "description" : "Name of variable to store the response in",
    "group" : "output",
    "binding" : {
      "key" : "resultVariable",
      "type" : "zeebe:taskHeader"
    },
    "type" : "String"
  }, {
    "id" : "resultExpression",
    "label" : "Result expression",
    "description" : "Expression to map the response into process variables",
    "feel" : "required",
    "group" : "output",
    "binding" : {
      "key" : "resultExpression",
      "type" : "zeebe:taskHeader"
    },
    "type" : "Text"
  }, {
    "id" : "errorExpression",
    "label" : "Error expression",
    "description" : "Expression to handle errors. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/\" target=\"_blank\">documentation</a>.",
    "feel" : "required",
    "group" : "error",
    "binding" : {
      "key" : "errorExpression",
      "type" : "zeebe:taskHeader"
    },
    "type" : "Text"
  }, {
    "id" : "retryBackoff",
    "label" : "Retry backoff",
    "description" : "ISO-8601 duration to wait between retries",
    "value" : "PT0S",
    "group" : "retries",
    "binding" : {
      "key" : "retryBackoff",
      "type" : "zeebe:taskHeader"
    },
    "type" : "Hidden"
  } ]
}