Skip to main content
Version: 10.3.2

Package AI Agent Variation Asset Bundle

note

The article describes an AI Agent Variation Asset Bundle. For details on the structure of an AI Agent Asset Bundle, refer to Package assets into AI Agent Asset Bundle.

You can generate an AI Agent Variation Asset Bundle in one of the two ways:

info

An AI Agent Variation Asset Bundle depends on an AI Agent it relates to. It does not have its own BCBs, models, and so on.

Control Tower starts generation asynchronously and prepares an AI Agent Variation Asset Bundle with the following structure:

├── business-process
├── configuration_payload.json
├── meta-info.json
├── variation.json

A sample AI Agent Variation Asset Bundle can look as follows:

business-process​

The directory contains all Business Process packages linked to the variation and available as zip files.

configuration_payload.json​

The file contains exported settings.

A sample configuration_payload.json file looks as follows:

{
    "default_configuration":
    {
        "select":"factiva",
        "countries":[],
        "factivaSearchServiceUrl":"httpsApiBetaDowjonesCom",
        "factivaUsernameNamespaceUserId":"FactivaUser1",
        "numberOfArticlesToExtract":"15"
    }
}

meta-info.json​

The meta-info.json file is required and must be a valid JSON file. The structure is as follows:

{
    "WF_VERSION":"10.2.5.23-SNAPSHOT",
    "DATA_MODEL_VERSION":"0.1.0",
    "USE_CASE_CODE":"UCDEMO3",
    "INSTANCE":"example.workfusion.com",
    "MULTI_CONFIGURATION":true,
    "AUTHOR":"User1",
    "USE_CASE_VERSION":"0.1.0",
    "PACKAGE_DATE":"2022-07-18 09:48:55",
    "NAME":"odf-install"
}

USE_CASE_CODE and USE_CASE_VERSION should contain the code and any of the versions of the AI Agent the variation relates to. Restrictions that apply to the USE_CASE_CODE and USE_CASE_VERSION parameters are the same as for the AI Agent Asset Bundle | meta-info.json.

variation.json​

The variation.json file is required as it allows to distinguish between an AI Agent Asset Bundle and an AI Agent Variation Asset Bundle.

The file can be empty or can contain the VARIATION_NAME attribute, for example:

{ "VARIATION_NAME" : "MyVariation" }

The import behavior depends on whether variation.json is empty or not:

  • The file is empty: a new variation is created, and its name is generated automatically. The VariationX postfix is added right after the AI Agent name and version, for example, Version 0.1.0-Variation1.
  • The file contains a variation name:
    • If there is no variation with such a name, a new variation with the name specified in variation.json is created.
    • If a variation with the same name already exists, Business Processes (/business-process) and configuration settings (configuration_payload.json) are replaced with data from a newly imported variation.
info

Unlike for the AI Agent Asset Bundle import, there are no special import strategies for an AI Agent Variation Asset Bundle.