Application Configuration Manifest - app.config.json

The app.config.json file is a JSON file that contains the definition of the settings for your app. This file is used to define the application's configuration form that the user can fill out when installing the app, as well as the application's settings.

Module Settings

Property	Type	Description
sections	ModuleSettingsSection[]	List of settings sections.

Module Settings Section

Property	Type	Description
label	string	Label for the section.
fields	ModuleSettingsField[]	List of fields in the section.

Module Settings Field

Property	Type	Description
type	MetadataTemplateFieldTypeEnum	Type of the field (e.g., "text", "number", "date", "select", "multi-select", "checkbox").
name	string	Name of the field.
label	string	Label for the field.
help_text	string	Help text for the field.
is_required	boolean	Whether the field is required.
options	ModuleSettingsOption[]	List of options for select and multi-select fields (see below).

Module Settings Option

Property	Type	Description
value	string	Value of the option.
label	string	Label for the option.

Examples

Order Submission Settings

{
  "sections": [
    {
      "label": "Order submission settings",
      "fields": [
        {
          "type": "text",
          "name": "order_submit_endpoint",
          "label": "Endpoint",
          "help_text": "The order endpoint handler",
          "is_required": true
        }
      ]
    },
    {
      "label": "Order settings",
      "fields": [
        {
          "type": "select",
          "name": "selected_currency",
          "label": "Currency",
          "help_text": "Select currency",
          "is_required": false,
          "options": [
            {
              "label": "USD",
              "value": "USD"
            },
            {
              "label": "EUR",
              "value": "EUR"
            }
          ]
        },
        {
          "type": "number",
          "name": "max_discount",
          "label": "Max discount",
          "help_text": "",
          "is_required": false
        }
      ]
    }
  ]
}

Feature Flags

{
  "sections": [
    {
      "label": "Feature flags",
      "fields": [
        {
          "type": "checkbox",
          "name": "allow_theming",
          "label": "Allow theming",
          "help_text": "Allow theming of the UI",
          "is_required": false
        }
      ]
    }
  ]
}

AI Recommendation Config

{
  "sections": [
    {
      "label": "AI Recommendation Config",
      "fields": [
        {
          "type": "text",
          "name": "prompt",
          "label": "Prompt for AI",
          "help_text": "Provide a prompt for AI for example: Generate recommended sections based on following customer description: {{customerDescription}}. Here is a JSON representation of all sections: {{sections}}",
          "is_required": false
        },
        {
          "type": "text",
          "name": "systemprompt",
          "label": "Definition for AI",
          "help_text": "Provide a definition for AI for example: You are a real estate advisor",
          "is_required": true
        },
        {
          "type": "text",
          "name": "strategy",
          "label": "Mode for Recommendation",
          "help_text": "Please choose if you'd like to force the recommendation or leave it as suggestion. Options: suggest or force. Default is suggest.",
          "is_required": true
        },
        {
          "type": "select",
          "name": "strategy",
          "label": "Mode for Recommendation",
          "help_text": "Please choose if you'd like to force the recommendation or leave it as suggestion. Default is suggest.",
          "is_required": false,
          "options": [
            {
              "value": "suggest",
              "label": "Suggest"
            },
            {
              "value": "force",
              "label": "Force"
            }
          ]
        }
      ]
    }
  ]
}

Section Manager

{
  "sections": [
    {
      "label": "Section Manager",
      "fields": [
        {
          "type": "text",
          "name": "uididentifier",
          "label": "Unique Identifier for your external ID",
          "help_text": "e.g. UID, ISBN, CustomerID etc. will be added as a tag. Default:UID.",
          "is_required": false
        },
        {
          "type": "select",
          "name": "market",
          "label": "Select Market",
          "help_text": "",
          "options": [
            {
              "value": "EU",
              "label": "EU"
            },
            {
              "value": "US",
              "label": "US"
            }
          ]
        }
      ]
    }
  ]
}

Azure Communication Services Config

```json
{
  "sections": [
    {
      "label": "Azure Communication Services Config",
      "fields": [
        {
          "type": "text",
          "name": "azure_string",
          "label": "Azure Connection String",
          "help_text": "Provide the Azure connection string",
          "is_required": true
        }
      ]
    }
  ]
}