carbon-reductor-c8-connector.json

{
    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
    "name": "Carbon Reductor Connector",
    "id": "de.envite.greenbpm.carbonreductorconnector.carbonreductortask.v1",
    "description": "Reduces the carbon emissions caused by the process instance by shifting the work to a greener time window",
    "documentationRef": "https://github.com/envite-consulting/camunda-carbon-reductor",
    "icon": {
        "contents": "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'%3E%3Ctext y='.9em' font-size='90'%3E\uD83C\uDF31%3C/text%3E%3C/svg%3E"
    },
    "category": {
        "id": "connectors",
        "name": "Connectors"
    },
    "appliesTo": [
        "bpmn:Task"
    ],
    "elementType": {
        "value": "bpmn:ServiceTask"
    },
    "groups": [
        {
            "id": "commonConfiguration",
            "label": "Common Configuration"
        },
        {
            "id": "slaBasedConfiguration",
            "label": "SLA based configuration"
        },
        {
            "id": "outputMapping",
            "label": "Output Mapping"
        }
    ],
    "properties": [
        {
            "type": "Hidden",
            "value": "de.envite.greenbpm.carbonreductorconnector.carbonreductortask:1",
            "binding": {
                "type": "zeebe:taskDefinition",
                "property": "type"
            }
        },
        {
            "label": "Carbon Reductor Mode",
            "group": "commonConfiguration",
            "id": "carbonReductorMode",
            "description": "Choice whether to time shift the execution or just measuring the potential of time shifting",
            "type": "Dropdown",
            "choices": [
                {
                    "name": "Timeshifting Mode",
                    "value": "false"
                },
                {
                    "name": "Measurement Only Mode",
                    "value": "true"
                }
            ],
            "value": "false",
            "binding": {
                "type": "zeebe:input",
                "name": "measurementOnly"
            }
        },
        {
            "label": "Location",
            "group": "commonConfiguration",
            "id": "location",
            "description": "The location where the process is running",
            "type": "Dropdown",
            "choices": [
                {
                    "name": "Europe North",
                    "value": "northeurope"
                },
                {
                    "name": "Europe West",
                    "value": "westeurope"
                },
                {
                    "name": "France Central",
                    "value": "francecentral"
                },
                {
                    "name": "France South",
                    "value": "francesouth"
                },
                {
                    "name": "Germany North",
                    "value": "germanynorth"
                },
                {
                    "name": "Germany West Central",
                    "value": "germanywestcentral"
                },
                {
                    "name": "UK South",
                    "value": "uksouth"
                },
                {
                    "name": "UK West",
                    "value": "ukwest"
                },
                {
                    "name": "Switzerland North",
                    "value": "switzerlandnorth"
                },
                {
                    "name": "Switzerland West",
                    "value": "switzerlandwest"
                },
                {
                    "name": "Sweden Central",
                    "value": "swedencentral"
                },
                {
                    "name": "Norway East",
                    "value": "norwayeast"
                },
                {
                    "name": "West US",
                    "value": "westus"
                }
            ],
            "binding": {
                "type": "zeebe:input",
                "name": "location"
            }
        },
        {
            "label": "Duration of remaining process tasks",
            "group": "commonConfiguration",
            "id": "remainingProcessDuration",
            "description": "The duration of the remaining tasks after the Carbon Reductor as ISO 8601 duration",
            "value": "PT6H",
            "type": "String",
            "feel": "optional",
            "binding": {
                "type": "zeebe:input",
                "name": "remainingProcessDuration"
            }
        },
        {
            "label": "Maximum process duration from milestone to finish",
            "group": "slaBasedConfiguration",
            "id": "maximumProcessDuration",
            "description": "The maximum duration the process is allowed to run as ISO 8601 duration",
            "value": "PT12H",
            "type": "String",
            "feel": "optional",
            "binding": {
                "type": "zeebe:input",
                "name": "maximumProcessDuration"
            }
        },
        {
            "label": "Milestone",
            "group": "commonConfiguration",
            "id": "milestone",
            "description": "Timestamp of the chosen milestone. The milestone builds the starting point for the SLA based duration calculation: milestone + max. process duration = latest process completion date",
            "value": "=now()",
            "type": "String",
            "feel": "optional",
            "binding": {
                "type": "zeebe:input",
                "name": "milestone"
            }
        },
        {
            "label": "Minimum Threshold Enabling",
            "group": "commonConfiguration",
            "id": "thresholdEnabled",
            "description": "Enable setting a minimal amount of g/CO2 per kWh which should be saved at least",
            "type": "Dropdown",
            "choices": [
                {
                    "name": "enable",
                    "value": "true"
                },
                {
                    "name": "disable",
                    "value": "false"
                }
            ],
            "binding": {
                "type": "zeebe:input",
                "name": "thresholdEnabled"
            }
        },
        {
            "label": "Minimum Threshold Value",
            "group": "commonConfiguration",
            "id": "thresholdValue",
            "description": "Enable setting a minimal amount of g/CO2 per kWh which should be saved at least",
            "type": "String",
            "condition": {
                "property": "thresholdEnabled",
                "equals": "true"
            },
            "binding": {
                "type": "zeebe:input",
                "name": "thresholdValue"
            }
        },
        {
            "label": "Error handling behavior",
            "group": "commonConfiguration",
            "id": "errorHandling",
            "description": "Defines how to handle eror during fetching and calculating the time window for the timeshift",
            "type": "Dropdown",
            "choices": [
                {
                    "name": "Continue on failure",
                    "value": "CONTINUE_ON_EXCEPTION"
                },
                {
                    "name": "Throw BPMN Error",
                    "value": "THROW_BPMN_ERROR"
                }
            ],
            "binding": {
                "type": "zeebe:input",
                "name": "errorHandling"
            }
        },
        {
            "label": "Result Expression",
            "description": "Expression to map the response into process variables",
            "type": "Text",
            "group": "outputMapping",
            "feel": "required",
            "value": "put all()",
            "binding": {
                "type": "zeebe:taskHeader",
                "key": "resultExpression"
            }
        }
    ]
}