> ## Documentation Index
> Fetch the complete documentation index at: https://doc.qbilon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Managing Custom Tasks

> Manage custom task templates, parameters, versions, and removal.

## Preface

Thanks to the new **Custom Task Templates** (CTTs) feature, you can now create and manage your own task templates in Qbilon. This feature gives you the flexibility to define exactly how your custom tasks should look and behave, right down to the configuration parameters and how they’re presented when someone creates a new task.

With Custom Task Templates, you can tailor Qbilon to your unique automations. Rather than relying solely on Qbilon's default templates, you can create your own for specific use cases, such as connecting to new data sources, consolidating data, or writing data elsewhere. This results in less manual setup, fewer mistakes, and a smoother, more personalized experience when creating tasks.

## Creating CTTs

Now, let's walk through how you can create your own custom task template. You'll find all the necessary tools under the `Task Templates` page in the `Automations` section.

1. **Go to "Automations → Task Templates"**
   * You will see a list of all your custom templates. Note that you can only manage your own templates here, not the ones provided by Qbilon.
   ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/caeef129-724f-49dc-8298-0ceb7e6f8802-screenshot-2026-10-13-143302.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=618dcfdbef5228bceef0c7bab9b7e408)
2. **Click “Create New Template”**
   * This opens the template creation form.
   * ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/089c2993-35e2-47ce-9910-0e696d2e0bdf-screenshot-2026-10-13-142136.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=2db3845cd8bce9f128b41c4cf1c332e9)
3. **Basic Information**

   * **Name**: Give your template a clear, descriptive name.
   * **Task Group:** In the data section, there are three groups into which you can put your task template. Choose one of the following groups: `Data Sources`, `Data Consolidation` or `Data Writer`
   * **Container Image**: Enter the Docker image to be used for this task, including the tag. For example, enter `sanfteschorle/aws:v1`.
   * **Upload Icon**: Select an icon to represent your template. Currently, only .svg files are allowed.

   > [!WARNING]
   >
   > Do **not** use the `latest` tag for versions as this might hinder the automation engine from detecting the correct image entrypoint after an update and break your custom task. Always use explicit tags, e.g., `v1` or something similar
   >
   > * **Entrypoint:** The command that runs when the container starts is defined by the `ENTRYPOINT` and/or `CMD` directive. If both are present, Docker appends `CMD` to `ENTRYPOINT`, so `CMD` acts as default arguments. Docker file:
   >
   > ```dockerfile theme={null}
   > ENTRYPOINT ["python", "/app/my_script.py"]
   > CMD ["--default-arg"]
   > ```
   >
   >  → in Qbilon `python /app/my_script.py --default-arg` 4. (Optional) **Advanced Settings**
   >
   > * If you want to pull an image from a private registry, you have to toggle the switch `Private Registry` and provide the credentials (username and password) here.
   >
   > * The validity of the provided credentials can be tested via the `Test Image Access` button on the bottom right corner.
   >
   > * ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/cc208839-2c67-485f-8d6b-c215b99a22aa-screenshot-2026-10-13-142750.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=e20761d8de5c60ca667e5f5546307427)
   >
   > 5. **Define Configuration Parameters**
   >
   > 6. You can add as many configuration parameters as you need here. These parameters make your template dynamic. When someone creates a task from your template, they’ll be prompted to fill out these parameters. The value provided by the user for a specific parameter will then be injected as an environment variable into your Docker image at runtime.
   >
   > 7. ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/ac22f6dd-73c2-44bc-84ca-6e2336263b52-screenshot-2026-10-13-144810.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=02f37a601532c7b6288972521af5613f)
   >
   > 8. For each parameter, you’ll need to specify the following:
   >
   > * **Display Name**: How this parameter will appear in the UI.
   > * **Variable Name**: The name of the environment variable passed to the Docker container.
   >   * **Note:** There are reserved environment variable names by Qbilon that can not be used as variable name:
   >     * `QB_HOST`
   >     * `QB_ORCHESTRATOR_HOST` (deprecated)
   >     * `QB_TASK_ID`
   >   * **Note:** Variable Names have to be unique within one task template!
   > * **Required**: Decide whether this parameter must be filled out when creating a task or not.
   > * **Type**: Choose the type that best fits the parameter. The following types are currently supported:

<table>
  <colgroup>
    <col width="134" />

    <col width="194" />

    <col width="267" />

    <col width="325" />
  </colgroup>

  <thead>
    <tr>
      <th>**Type**</th>
      <th>**Task Template &**\
      **Task Visualization**</th>
      <th>**Representation**\
      **in Custom Tasks**</th>
      <th>**Additional**\
      **Information**</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>**String**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/a0164031-4a12-4550-bddf-a370235fa81b-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=bcd2d47e42c95154379a5e3f760f6942)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/4b687c56-f73c-46ee-9f84-da8078cb55a5-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=4fc6ebb6a9da8ff4e5b34542d8bbdd6c)
      </td>

      <td>`CP_TEXT=Some Text`</td>
      <td>**Default Value**: The value displayed to users by default for this configuration parameter when creating a task from this template. This field may be left empty.</td>
    </tr>

    <tr>
      <td>**String (Secret)**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/879b5b56-3f1b-452d-8af9-79c64d632f22-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=f5dfca7912b3833ec9d048205bf9a10d)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/387e617f-2b59-4efe-9e43-880f85125fa5-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=bc8945484bd4b9dbdd886db726e60c6d)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/db570e3e-cc12-40d2-834e-8ec55e4b8f3f-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=40202795f8bb7dbf3823fc6f04faaa00)
      </td>

      <td>`CP_SECRET=Some Secret`</td>
      <td>**Secret**: When set to `true`, the text value provided by the user will be both obfuscated and encrypted when stored in the database.</td>
    </tr>

    <tr>
      <td>**URL**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/92a5ad1b-1aa3-443e-8211-ee03ed021a8c-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=2eb1348006d2dfd6f8ca76badb67a7b2)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/1b74ba9d-7837-43dd-a7f2-eddc13bb56d8-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=51e32f5a7a03ccf7d2bb5d870e0e185d)
      </td>

      <td>`CP_URL=https://test.test`</td>
      <td>**Default Value**: The value displayed to the user by default for this configuration parameter when creating a task from this template. It may be left empty. If provided, it must be a valid URL.</td>
    </tr>

    <tr>
      <td>**Boolean**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/8d312a4f-572a-46f9-a418-a325c28f444c-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=c92cd78c412dc6e3e07ad317182f21d3)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/7fd502e4-4a75-4c3a-896d-a8535bade8cd-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=0cf379b2a00be8c364dd6f8e538882f5)
      </td>

      <td>`CP_BOOL=false`</td>
      <td>**Default Value**: This is the value that is displayed to the user by default for this configuration parameter when a task is created from this template. This field may be left empty.</td>
    </tr>

    <tr>
      <td>**Number**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/2875dcd8-be00-4f9e-92c9-116876dbda90-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=12f05abaaae5fe21e38ec541633c9ff3)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/aa355464-c459-4095-8a15-635423769225-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=b10115738cba8c68667933099fa34030)
      </td>

      <td>`CP_NUMBER=123`</td>
      <td>**Default Value**: The value displayed to the user by default for this configuration parameter when creating a task from this template. It may be left empty. If provided, it must be a number.</td>
    </tr>

    <tr>
      <td>**Select**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/e854ca24-a0a4-43b8-96cc-2aa22309bd99-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=e31dcddfebe3a4944c4b0a01b724512d)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/1eff4cb6-f239-4d60-a3c5-a25ada2a5434-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=96f9d57d995afd9fee8afe9e3afaf0b2)
      </td>

      <td>`CP_SELECT=as`</td>
      <td>**Options**: a list of possible values for this configuration parameter.\
      \
      **Default Value**: This is the value that is displayed to the user by default for this configuration parameter when a task is created from this template. It must be one of the available options. Users can select only one option.</td>
    </tr>

    <tr>
      <td>**Multi-Select**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/d65895db-7e0d-49ef-9622-4aa80b691e63-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=91030d7aba7b7dcdda29ad49d4b84a37)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/bd457ec7-362f-49b1-ba81-755259c28d59-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=42012912460df9f224238c09367b8e51)
      </td>

      <td>`CP_MULTI=as,df`</td>
      <td>**Options**: a list of possible values for this configuration parameter.\
      \
      **Default Value**: This is the value that is displayed to the user by default for this configuration parameter when a task is created from this template. It must be one of the available options. Users can select multiple **options**.</td>
    </tr>

    <tr>
      <td>**CSV**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/0339f28b-ad8a-4338-927e-3e59f7c67eb6-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=1e741cf36a012ccdb29571628e951fc7)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/484d9948-91d2-4eab-994d-c89f0b7d2468-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=fe48c11220dae7d98358e8b83abcedf4)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/329bba78-d04c-4354-8e24-f6831f1a625c-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=f101d1f91b767bd2d85b67605ac36eca)
      </td>

      <td>`CP_CSV=ITFA.csv`</td>
      <td>Currently, only CSV files are allowed. This will be enhanced later to support different file types.</td>
    </tr>

    <tr>
      <td>**Markdown**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/f1ec0c27-747f-49ac-ac4a-5caf5865600f-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=13ab56d79c994729099540b32c964261)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/7d7ae695-3a28-499f-906b-68146ce769d6-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=375e699dc8e95900a9970e31f73f539c)
      </td>

      <td>`CP_MD=`</td>
      <td>**Default Value**: This is the value that is displayed to the user by default for this configuration parameter when a task is created from this template. It can be left empty. If used, you can use typical Markdown for styling. Since there is no option to edit this during task creation, it is usually used for explicit explanations to the user.</td>
    </tr>

    <tr>
      <td>**CRON**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/4f9de495-6750-49e1-aae8-30d1583e9159-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=70405e43c2109617857909f4e5b0a05e)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/1e49e9b6-1e44-48d6-a66c-a12aff161aae-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=c5c48fa86b729a199abb8e1adee8b931)
      </td>

      <td>`CP_CRON=0,30 * * * *`</td>
      <td>This is a CRON expression that can be used for scheduling or similar inputs.</td>
    </tr>

    <tr>
      <td>**Type Filter**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/248bdc30-d4ed-43e3-b890-3110a6ee0687-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=4d66b64605c81ff8da252a3c79636b5d)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/5a6cef98-67ae-4efb-b0b6-ad243aea4ac2-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=5acb9d2c33581b4809b4b80b1fb503f9)
      </td>

      <td>`CP_TYPE={"attributeNames":[],"names":["AWS EC2"],"condition":{"operator":"or","condition":[{"attributeName":"aws-tag-Name","operator":"equal_to","value":"asdf","conditionType":"atomic"},{"attributeName":"Name","operator":"matches","value":"asdf","conditionType":"atomic"}],"conditionType":"nested"}}`</td>
      <td>A type filter dialog which can be used to create queries against Qbilon's read API, cf. [Reading from Qbilon](https://doc.qbilon.io/12-customizing-qbilon/rest-api/reading-from-qbilon.md).</td>
    </tr>

    <tr>
      <td>**Relation Filter**</td>

      <td>
        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/321ed9c6-14da-4002-b976-83d41d8f7a91-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=13f09438af1cc1ae54453cb5e53ec144)

        ![Managing Custom Tasks: Creating CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/930fd605-2802-4ce3-b7e9-21ea4e194660-image.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=fcdd66b36971422c56044bedb7a99f21)
      </td>

      <td>`CP_REL={"attributeNames":[],"names":["contains [AWS Virtual Private Cloud -> AWS Subnet]"],"condition":{"operator":"and","condition":[{"attributeName":"First Seen","operator":"within","value":"-P3DT","conditionType":"atomic"},{"attributeName":"Name","operator":"equal_to","value":"asdf","conditionType":"atomic"}],"conditionType":"nested"}}`</td>
      <td>A relation filter dialog which can be used to create queries against Qbilon's read API, cf. [Reading from Qbilon](https://doc.qbilon.io/12-customizing-qbilon/rest-api/reading-from-qbilon.md).</td>
    </tr>
  </tbody>
</table>

Clicking "Create and save template" will create the template, which can then be used in any automation to create new tasks.

When someone creates a new task based on your template, they’ll see a form generated from the configuration parameters that you defined. Required fields must be filled out. Values for secret fields are hidden and securely stored. File fields restrict uploads to the specified file types. Multiselect fields allow users to choose from your predefined options.

That's it! Now you're ready to build powerful, reusable task templates tailored to your needs.

## Deleting CTTs

Once you create a task template, it will appear in the templates list in the `Automations` section. You can delete each CTT by clicking on the trash icon.

![Managing Custom Tasks: Deleting CTTs](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/baa787f8-69a5-4b48-95d4-b350bd74fb09-screenshot-2026-10-13-145352.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=82e18b9207cc2674ac8ca7917286eba4)

> [!NOTE]
>
> You can only delete task templates that are not being used in any automation. Once a task template is used in an automation, the trash icon will be disabled. You will first have to remove the corresponding task from the automation before deleting the task template.

## Updating CTTs

At some point, it may be necessary to update or upgrade your custom task templates. For example, you may need to ...

* fix bugs in an older version of your task template or
* enhance the existing functionality of your task template.

To do this, select your task template and click `Upgrade Template` on the bottom toolbar to create newer versions of it. In the dialog that opens, you can change the task instance image to a newer Docker image. You can also add, remove, or change the configuration parameters that you defined for that task template.

For example, let's say you created a "My Custom Task" task template with the task instance image "mytask:v1," and now you want to upgrade it. In the "Basic Information" section, change the image to "mytask:v2" (you can choose a different image and version).

From now on, you will see an orange info icon in all tasks in your automations that use the old version of your task template. This icon alerts users that a newer version of the task template is available for one of the tasks in the automation.

As soon as you click on the upgrade task template icon for a task, Qbilon will guide you through the upgrade process. For example, you can choose which version of the template to upgrade to.

![Managing Custom Tasks: Updating CTTs](https://mintcdn.com/qbilon-docs/aJQhbcvq7mtvhV0w/.gitbook/assets/3cc10205-e471-48e6-9dfa-323a211fb4c7-image.png?fit=max\&auto=format\&n=aJQhbcvq7mtvhV0w\&q=85\&s=54b81594896b832104c01be84e062588)

It will either require you to fill out new configuration parameters or acknowledge the deletion of dismissed ones.

![Managing Custom Tasks: Updating CTTs](https://mintcdn.com/qbilon-docs/lr-P4KF_9wn8x9Vs/.gitbook/assets/c3a10003-47a3-4570-abc0-5fab66e12022-image.png?fit=max\&auto=format\&n=lr-P4KF_9wn8x9Vs\&q=85\&s=0824c916c4be7d93ca2a2e8f5878fd8c)

Once you have completed the upgrade process for that task, the new task template will be used from that point forward.

## Importing & Exporting CTTs

To make sharing and copying custom task templates across different Qbilon instances as easy as possible, we introduced the ability to export custom task templates from one instance and import them into another.

To do this, go to `Automations → Task Templates`, where you will be presented with two options:

* Export all templates at once in a ZIP folder. To do this, click on the `Import/Export Templates` button in the top right corner.
* Export a single template. Select one existing task template from the list and click `Export Selected` in the bottom toolbar.

To import these templates into another Qbilon instance, simply click on the `Import/Export Templates` button and select `Import Templates`. You can choose to upload either a single template or a batch of templates.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.