Search...

Out of support

Search...

Out of support

Introduction

This chapter explores how to manage taxonomical and classification tools in the Platform. The main available tools for the purpose are Tags and Categories. The chapter also describes the tools that define the shape of the entities of your installation: Digital Product Types (with their templates) and Integration Patterns.

Tags and Categories can be used to create a taxonomical hierarchy of entities (digital products, Apps, Organizations, etc.) as well as to facilitate discoverability for entities. A clear taxonomy within the Platform helps maintaining clear ownership, improves discoverability, and strengthens compliance, lifecycle management and audit readiness.

There are other important uses of Tags and Categories which can impact important aspects of visibility, user profiling, and security. More details are available in the dedicated chapters for Tags and Categories.

These configurations can be found from the sidebar menu, under Administration > Classification & Taxonomy.

Tags

Having tags allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to:

  • digital products (including API Products) and API Assets;

  • Applications;

  • Documentation.

It is possible to associate one or more tags to the same entity.

NOTE: Tags will be visible to all users who can view a particular entity. Use Categories if you want to decorate your entities for taxonomical purposes with information that should stay private for certain users.

Creating a tag

You can create a new Tag at any moment. Once a Tag is created, it can be added or removed from any entity at any point of its lifecycle (unless the entity is retired).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Click Add to create a new tag.

  3. Complete the following fields:

    • Name (required, up to 255 characters);

    • Description (optional).

  4. Click Save.

Editing a tag

You can edit a tag at any time, and it will change on all linked entities without further impacts.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Modify the details.

  4. Click Save.

  5. The tag updates immediately across the Platform.

Deleting a tag

You can delete a tag at any time, and it will disappear from all linked entities.

POSSIBLE IMPACTS: Tags can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API (see chapter Security governance). Removing a tag will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting tags that are not mentioned either in any API, or in any Keyset Policy Template.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Check in Used by which products, assets, apps and documentation use the tag.

  4. Click Delete and confirm.

  5. The tag is permanently removed from all associated entities.

Categories

Having categories allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to. There are four kinds of categories, each managed in its own tab:

  • API categories, for digital products (including API Products) and API Assets;

  • App categories, for Applications;

  • Organization categories, for Organizations;

  • Documentation categories, for Documentation.

It is possible to assign one or more Categories to each entity.

NOTE: Unlike Tags, Categories can also be given limited visibility from certain users. You can choose whether a category is visible in the Catalogs to the users who can view a certain entity. This is useful in case a Category may reveal private information that should not be available to external users of the Catalog.

NOTE2: Organization categories are also used to extend the default visibility of digital products and the automatic approval of subscriptions to whole groups of organizations (see chapters Default entity visibility and Security governance).

Creating a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Choose the API, App, Organization or Documentation tab.

  3. Click Add to create a new category.

  4. Complete the following fields:

    • Name (required);

    • Description (optional);

    • Visibility (required): Full access (visible to all users who can see the entity), Custom access (restricted, for example to some types of organization) or Tenant Owner Only (visible only to the Owner).

  5. Click Save.

Editing a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Update the details.

  4. Click Save.

  5. The category is updated and immediately reflected in the Platform.

Deleting a category

POSSIBLE IMPACTS: Categories can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API. Removing a Category will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting Categories that are not mentioned either in any API, or in any Keyset Policy Template. Removing an Organization category can also change the visibility and automatic approval rules based on it.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Check in Used by which entities use the category.

  4. Click Delete and confirm.

  5. The category is permanently removed from all associated entities.

Integration Patterns (or Messaging Patterns)

NOTE: API Assets are available only if enabled for your installation.

Manage Integration Patterns (or Messaging Patterns) to define the data structure of your tenant's Assets.

This feature is useful when you want to govern any non-standard assets in the Platform, for example a particular kind of database interface or particular type of API which may not fit in with how default APIs are defined in the Platform.

Aside from the Overview information (like Name, Organization, Group, Relevant Users, Tags and Categories) which cannot be changed, you can freely structure each Asset's shape by deciding which data will be collected to define it. This will determine what the form will be like for users inserting the data of the Asset.

Each Pattern will thus have one or more custom parameters, and for each parameter you can choose different aspects that determine how the information is validated. Some examples are whether the field is mandatory, if it's to be chosen from a set of options (which you can list), or if it's a file to upload, and so on.

NOTE: Once an Asset with a particular Pattern is created, the Pattern can no longer be deleted unless all Assets using it are deleted. Also, if a Pattern is updated by the administrator, the change will not be immediately reflected in the Assets that have been generated before the change; in this case the Assets will need to be created from scratch.

Creating an integration pattern

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Integration Patterns.

  2. Click Add to create a new integration pattern.

  3. Enter the integration pattern metadata:

    • Name (required);

    • Description (optional);

    • Is productizable?: if checked the new integration pattern grants the ability to productize the asset, that is to turn it into an API Product. This is to be chosen if you expect the asset to be eventually exposed on the API gateway. Make sure the gateway integration of your installation supports this type of Asset.

  4. Click Save.

  5. Create all the Parameters for this Pattern (see Creating a parameter).

Editing an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Update the details.

  3. Click Save.

Deleting an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Delete and confirm.

Cloning an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Clone.

  3. Enter the new name and description.

  4. Click Save.

Creating a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Add to create a new parameter.

  3. Fill in the parameter metadata. For each parameter you must choose the following:

    • Label (required): enter the name or label for this parameter.

    • Placeholder (required): brief text to assist the end user in filling in this parameter.

    • Info (required): additional information to help the end user in filling out the field.

    • Description (required): briefly describe the purpose of this parameter.

    • Insertion Mode (required): defines the input type for the information. Each option brings its own choices, listed in the table below.

  4. Click Save.

Insertion mode

Choices

Text input

Cardinality (required): whether the parameter is mandatory or optional, with its minimum and maximum. Regex: the regex with which to validate the text. Regex explanation: if a regex has been inserted, additional information to inform the end user about the validation rules for the input.

Text box

Same as Text input.

Single select

Cardinality (required); Available values (required); Default values.

Multi select

To let users select one or more options from a list of provided values. Cardinality (required); Available values (required); Default values (their number depends on the cardinality).

Single-file upload

Cardinality (required); Extension (required): the extension of the file that users can upload, without the dot (for example txt).

Editing a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click on the edit button of the parameter.

  3. Modify the desired fields.

  4. Click Save.

Deleting a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Delete and confirm.

Digital Product Types

NOTE: Digital products other than APIs are available only if enabled for your installation.

Manage Digital Product Types to define the types of your digital products, besides APIs.

This feature is useful when you want to expand the portfolio of digital product types on your tenant beyond the default options (MCP Servers, AI Agents). Default types are marked as Default and are read-only; the types you create are marked as Custom.

You can freely define each Digital Product Type's templates by deciding which schema must be followed and which specifications can be added. This will determine what the form will be like for users inserting the data of the Digital Product. Each type can have one or more templates.

Creating a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Click Add to create a new digital product type.

  3. Enter the digital product type metadata:

    • Name (required);

    • Description (required);

    • Featured: if checked the Digital Product Type is featured. In the New Digital Product wizard it appears as a selectable card (otherwise it's only in the Other product type dropdown), and in the Catalog and Workspace it appears as its own tab (otherwise it's grouped under the More menu). It does not affect the products themselves, only where the type is surfaced.

  4. Click Save.

NOTE: A new type can be chosen in the New Digital Product wizard once it has at least one template.

Editing a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Use View usage to check which digital products use the type.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the digital product type is used by a digital product, it cannot be edited.

Deleting a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Delete and confirm.

NOTE: Only a custom digital product type can be deleted.

Creating a digital product type template

A template has three tabs: Info, Schema (the form that users will fill in) and Specifications (the technical files that can be attached to the digital products).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Info tab enter the template metadata:

    • Name (required);

    • Description (required);

    • Featured: a featured template is marked as Featured in the template selection of the New Digital Product page and in the Template filter of the Catalog and Workspace.

  5. In the Schema tab:

    • click Add section, and rename the section as you prefer;

    • click Add field and set the properties of the field (see the table below);

    • for fields of type object or list, click Add sub-field to define the fields they contain;

    • use the up and down arrows to change the order of the fields within the section.

  6. In the Specifications tab, define the specifications (see Defining specifications).

  7. Click Save.

The properties of each field are the following:

Group

Property

Description

GENERAL

Key (required)

Unique machine-readable key, in camelCase and without spaces (for example firstName).

GENERAL

Section

The section of the form where the field is shown.

GENERAL

Type

The type of data of the field (for example string).

GENERAL

Compilation Mode

How the user fills in the field (see below). If left empty, it is inferred from the type.

GENERAL

Label

The label shown in the form.

GENERAL

Description

Help text shown as a tooltip next to the field.

GENERAL

Default value

The value the field starts from. On an editable field it is a suggestion that the user can change.

GENERAL

Required

If checked the field is marked as mandatory.

GENERAL

Read only

If checked the field is always disabled. Combined with a default value, it makes the field a constant.

GENERAL

Visibility

Everywhere (editable in the form and shown read-only in the catalog), Form only (hidden in the catalog, for internal data) or Hidden (kept in the schema but never shown).

GENERAL

Disable if

The condition under which the field has to be disabled.

VALIDATION

Min Length, Max Length

The minimum and maximum number of characters.

VALIDATION

Minimum, Maximum

The smallest and largest numeric values.

VALIDATION

Pattern

The regex that validates the value.

VALIDATION

Pattern Explanation

An explanation of the pattern for the user.

VALIDATION

Format

A string format used for validation (for example email, date or URI).

UI OPTIONS

Placeholder

The example text shown in the empty field.

UI OPTIONS

Input Type

The type of input (for example text, number, email or password).

UI OPTIONS

Enum Values

The values the user can choose from (switches the field to a single selection).

UI OPTIONS

Item Enum Values

For lists, the values that can be chosen for each item (switches the field to a multiple selection).

UI OPTIONS

Accepted Extensions, Supported Files Label

For file uploads, the accepted extensions (for example .json, .yaml) and the label describing them.

UI OPTIONS

Add Button Label

For repeatable lists, the text of the button that adds an item.

LAYOUT & POSITIONING

Row

Fields sharing the same Row number are placed side by side.

LAYOUT & POSITIONING

Col Span

The width of the field in a 12-column grid (1 – 12).

The available compilation modes are: Text Input, Textarea, Number Input, Checkbox, Toggle, Single Select (requires enum values), Multi Select (requires item enum values), Tags / Chips, Date Picker (requires the date format), Password / Secret, JSON Editor (for data without a fixed schema), Subsection Card (for objects with their own fields), Repeat Section (for lists of objects) and file upload.

NOTE: It's also possible to upload a JSON file with all the information:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Schema tab click on the Options menu (3 dots).

  5. Click Import JSON.

  6. Open your file from your device.

  7. Click Save.

HINT: The same Options menu offers Copy JSON, Download and Clear all. Use Full screen to work on large schemas, Show form preview to see how the form will appear to users, and the JSON Schema view to see the read-only schema generated from the fields. Fields not assigned to a section are shown in the Custom Fields section, whose title can be changed with Custom Fields section title.

Defining specifications

A specification is a schema-based description of a technical file that can be attached to the digital products created with the template (for example the configuration file of an MCP server or the card of an AI Agent). It is defined by a label, a JSON schema and, optionally, mapping expressions between the specification and the fields of the template.

Steps:

  1. Open the template and go to the Specifications tab.

  2. Click Add specification.

  3. Enter the Label and, optionally, the Description of the specification.

  4. Define the Schema of the file, in the tree view or in the code view: add properties, choosing their name and type (or create them as a Reference to a reusable schema), and set their attributes (Basic Properties, Validation, String, Number, Array and Object Properties, Values, Discriminator, XML, External Documentation).

  5. Click Save.

NOTE: When a specification has mapping expressions, uploading its file to a digital product can copy some values into the data of the digital product. The Platform asks for confirmation before replacing the values already saved.

NOTE2: Schemas that use advanced JSON Schema features not supported by the visual editor are edited as raw JSON and saved exactly as written. Use Remove specification to delete a specification from the template.

Editing a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Select a template from the list.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the template is used by a digital product, it cannot be edited. To change a template in use, create a new one (for example by cloning the existing one): the digital products already created keep the template they were created with.

Deleting a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click on the Bin icon on the template you want to delete, and confirm.

Menu della documentazione

Introduction

Table of Contents

This chapter explores how to manage taxonomical and classification tools in the Platform. The main available tools for the purpose are Tags and Categories. The chapter also describes the tools that define the shape of the entities of your installation: Digital Product Types (with their templates) and Integration Patterns.

Tags and Categories can be used to create a taxonomical hierarchy of entities (digital products, Apps, Organizations, etc.) as well as to facilitate discoverability for entities. A clear taxonomy within the Platform helps maintaining clear ownership, improves discoverability, and strengthens compliance, lifecycle management and audit readiness.

There are other important uses of Tags and Categories which can impact important aspects of visibility, user profiling, and security. More details are available in the dedicated chapters for Tags and Categories.

These configurations can be found from the sidebar menu, under Administration > Classification & Taxonomy.

Tags

Having tags allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to:

  • digital products (including API Products) and API Assets;

  • Applications;

  • Documentation.

It is possible to associate one or more tags to the same entity.

NOTE: Tags will be visible to all users who can view a particular entity. Use Categories if you want to decorate your entities for taxonomical purposes with information that should stay private for certain users.

Creating a tag

You can create a new Tag at any moment. Once a Tag is created, it can be added or removed from any entity at any point of its lifecycle (unless the entity is retired).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Click Add to create a new tag.

  3. Complete the following fields:

    • Name (required, up to 255 characters);

    • Description (optional).

  4. Click Save.

Editing a tag

You can edit a tag at any time, and it will change on all linked entities without further impacts.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Modify the details.

  4. Click Save.

  5. The tag updates immediately across the Platform.

Deleting a tag

You can delete a tag at any time, and it will disappear from all linked entities.

POSSIBLE IMPACTS: Tags can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API (see chapter Security governance). Removing a tag will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting tags that are not mentioned either in any API, or in any Keyset Policy Template.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Check in Used by which products, assets, apps and documentation use the tag.

  4. Click Delete and confirm.

  5. The tag is permanently removed from all associated entities.

Categories

Having categories allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to. There are four kinds of categories, each managed in its own tab:

  • API categories, for digital products (including API Products) and API Assets;

  • App categories, for Applications;

  • Organization categories, for Organizations;

  • Documentation categories, for Documentation.

It is possible to assign one or more Categories to each entity.

NOTE: Unlike Tags, Categories can also be given limited visibility from certain users. You can choose whether a category is visible in the Catalogs to the users who can view a certain entity. This is useful in case a Category may reveal private information that should not be available to external users of the Catalog.

NOTE2: Organization categories are also used to extend the default visibility of digital products and the automatic approval of subscriptions to whole groups of organizations (see chapters Default entity visibility and Security governance).

Creating a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Choose the API, App, Organization or Documentation tab.

  3. Click Add to create a new category.

  4. Complete the following fields:

    • Name (required);

    • Description (optional);

    • Visibility (required): Full access (visible to all users who can see the entity), Custom access (restricted, for example to some types of organization) or Tenant Owner Only (visible only to the Owner).

  5. Click Save.

Editing a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Update the details.

  4. Click Save.

  5. The category is updated and immediately reflected in the Platform.

Deleting a category

POSSIBLE IMPACTS: Categories can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API. Removing a Category will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting Categories that are not mentioned either in any API, or in any Keyset Policy Template. Removing an Organization category can also change the visibility and automatic approval rules based on it.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Check in Used by which entities use the category.

  4. Click Delete and confirm.

  5. The category is permanently removed from all associated entities.

Integration Patterns (or Messaging Patterns)

NOTE: API Assets are available only if enabled for your installation.

Manage Integration Patterns (or Messaging Patterns) to define the data structure of your tenant's Assets.

This feature is useful when you want to govern any non-standard assets in the Platform, for example a particular kind of database interface or particular type of API which may not fit in with how default APIs are defined in the Platform.

Aside from the Overview information (like Name, Organization, Group, Relevant Users, Tags and Categories) which cannot be changed, you can freely structure each Asset's shape by deciding which data will be collected to define it. This will determine what the form will be like for users inserting the data of the Asset.

Each Pattern will thus have one or more custom parameters, and for each parameter you can choose different aspects that determine how the information is validated. Some examples are whether the field is mandatory, if it's to be chosen from a set of options (which you can list), or if it's a file to upload, and so on.

NOTE: Once an Asset with a particular Pattern is created, the Pattern can no longer be deleted unless all Assets using it are deleted. Also, if a Pattern is updated by the administrator, the change will not be immediately reflected in the Assets that have been generated before the change; in this case the Assets will need to be created from scratch.

Creating an integration pattern

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Integration Patterns.

  2. Click Add to create a new integration pattern.

  3. Enter the integration pattern metadata:

    • Name (required);

    • Description (optional);

    • Is productizable?: if checked the new integration pattern grants the ability to productize the asset, that is to turn it into an API Product. This is to be chosen if you expect the asset to be eventually exposed on the API gateway. Make sure the gateway integration of your installation supports this type of Asset.

  4. Click Save.

  5. Create all the Parameters for this Pattern (see Creating a parameter).

Editing an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Update the details.

  3. Click Save.

Deleting an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Delete and confirm.

Cloning an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Clone.

  3. Enter the new name and description.

  4. Click Save.

Creating a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Add to create a new parameter.

  3. Fill in the parameter metadata. For each parameter you must choose the following:

    • Label (required): enter the name or label for this parameter.

    • Placeholder (required): brief text to assist the end user in filling in this parameter.

    • Info (required): additional information to help the end user in filling out the field.

    • Description (required): briefly describe the purpose of this parameter.

    • Insertion Mode (required): defines the input type for the information. Each option brings its own choices, listed in the table below.

  4. Click Save.

Insertion mode

Choices

Text input

Cardinality (required): whether the parameter is mandatory or optional, with its minimum and maximum. Regex: the regex with which to validate the text. Regex explanation: if a regex has been inserted, additional information to inform the end user about the validation rules for the input.

Text box

Same as Text input.

Single select

Cardinality (required); Available values (required); Default values.

Multi select

To let users select one or more options from a list of provided values. Cardinality (required); Available values (required); Default values (their number depends on the cardinality).

Single-file upload

Cardinality (required); Extension (required): the extension of the file that users can upload, without the dot (for example txt).

Editing a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click on the edit button of the parameter.

  3. Modify the desired fields.

  4. Click Save.

Deleting a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Delete and confirm.

Digital Product Types

NOTE: Digital products other than APIs are available only if enabled for your installation.

Manage Digital Product Types to define the types of your digital products, besides APIs.

This feature is useful when you want to expand the portfolio of digital product types on your tenant beyond the default options (MCP Servers, AI Agents). Default types are marked as Default and are read-only; the types you create are marked as Custom.

You can freely define each Digital Product Type's templates by deciding which schema must be followed and which specifications can be added. This will determine what the form will be like for users inserting the data of the Digital Product. Each type can have one or more templates.

Creating a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Click Add to create a new digital product type.

  3. Enter the digital product type metadata:

    • Name (required);

    • Description (required);

    • Featured: if checked the Digital Product Type is featured. In the New Digital Product wizard it appears as a selectable card (otherwise it's only in the Other product type dropdown), and in the Catalog and Workspace it appears as its own tab (otherwise it's grouped under the More menu). It does not affect the products themselves, only where the type is surfaced.

  4. Click Save.

NOTE: A new type can be chosen in the New Digital Product wizard once it has at least one template.

Editing a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Use View usage to check which digital products use the type.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the digital product type is used by a digital product, it cannot be edited.

Deleting a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Delete and confirm.

NOTE: Only a custom digital product type can be deleted.

Creating a digital product type template

A template has three tabs: Info, Schema (the form that users will fill in) and Specifications (the technical files that can be attached to the digital products).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Info tab enter the template metadata:

    • Name (required);

    • Description (required);

    • Featured: a featured template is marked as Featured in the template selection of the New Digital Product page and in the Template filter of the Catalog and Workspace.

  5. In the Schema tab:

    • click Add section, and rename the section as you prefer;

    • click Add field and set the properties of the field (see the table below);

    • for fields of type object or list, click Add sub-field to define the fields they contain;

    • use the up and down arrows to change the order of the fields within the section.

  6. In the Specifications tab, define the specifications (see Defining specifications).

  7. Click Save.

The properties of each field are the following:

Group

Property

Description

GENERAL

Key (required)

Unique machine-readable key, in camelCase and without spaces (for example firstName).

GENERAL

Section

The section of the form where the field is shown.

GENERAL

Type

The type of data of the field (for example string).

GENERAL

Compilation Mode

How the user fills in the field (see below). If left empty, it is inferred from the type.

GENERAL

Label

The label shown in the form.

GENERAL

Description

Help text shown as a tooltip next to the field.

GENERAL

Default value

The value the field starts from. On an editable field it is a suggestion that the user can change.

GENERAL

Required

If checked the field is marked as mandatory.

GENERAL

Read only

If checked the field is always disabled. Combined with a default value, it makes the field a constant.

GENERAL

Visibility

Everywhere (editable in the form and shown read-only in the catalog), Form only (hidden in the catalog, for internal data) or Hidden (kept in the schema but never shown).

GENERAL

Disable if

The condition under which the field has to be disabled.

VALIDATION

Min Length, Max Length

The minimum and maximum number of characters.

VALIDATION

Minimum, Maximum

The smallest and largest numeric values.

VALIDATION

Pattern

The regex that validates the value.

VALIDATION

Pattern Explanation

An explanation of the pattern for the user.

VALIDATION

Format

A string format used for validation (for example email, date or URI).

UI OPTIONS

Placeholder

The example text shown in the empty field.

UI OPTIONS

Input Type

The type of input (for example text, number, email or password).

UI OPTIONS

Enum Values

The values the user can choose from (switches the field to a single selection).

UI OPTIONS

Item Enum Values

For lists, the values that can be chosen for each item (switches the field to a multiple selection).

UI OPTIONS

Accepted Extensions, Supported Files Label

For file uploads, the accepted extensions (for example .json, .yaml) and the label describing them.

UI OPTIONS

Add Button Label

For repeatable lists, the text of the button that adds an item.

LAYOUT & POSITIONING

Row

Fields sharing the same Row number are placed side by side.

LAYOUT & POSITIONING

Col Span

The width of the field in a 12-column grid (1 – 12).

The available compilation modes are: Text Input, Textarea, Number Input, Checkbox, Toggle, Single Select (requires enum values), Multi Select (requires item enum values), Tags / Chips, Date Picker (requires the date format), Password / Secret, JSON Editor (for data without a fixed schema), Subsection Card (for objects with their own fields), Repeat Section (for lists of objects) and file upload.

NOTE: It's also possible to upload a JSON file with all the information:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Schema tab click on the Options menu (3 dots).

  5. Click Import JSON.

  6. Open your file from your device.

  7. Click Save.

HINT: The same Options menu offers Copy JSON, Download and Clear all. Use Full screen to work on large schemas, Show form preview to see how the form will appear to users, and the JSON Schema view to see the read-only schema generated from the fields. Fields not assigned to a section are shown in the Custom Fields section, whose title can be changed with Custom Fields section title.

Defining specifications

A specification is a schema-based description of a technical file that can be attached to the digital products created with the template (for example the configuration file of an MCP server or the card of an AI Agent). It is defined by a label, a JSON schema and, optionally, mapping expressions between the specification and the fields of the template.

Steps:

  1. Open the template and go to the Specifications tab.

  2. Click Add specification.

  3. Enter the Label and, optionally, the Description of the specification.

  4. Define the Schema of the file, in the tree view or in the code view: add properties, choosing their name and type (or create them as a Reference to a reusable schema), and set their attributes (Basic Properties, Validation, String, Number, Array and Object Properties, Values, Discriminator, XML, External Documentation).

  5. Click Save.

NOTE: When a specification has mapping expressions, uploading its file to a digital product can copy some values into the data of the digital product. The Platform asks for confirmation before replacing the values already saved.

NOTE2: Schemas that use advanced JSON Schema features not supported by the visual editor are edited as raw JSON and saved exactly as written. Use Remove specification to delete a specification from the template.

Editing a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Select a template from the list.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the template is used by a digital product, it cannot be edited. To change a template in use, create a new one (for example by cloning the existing one): the digital products already created keep the template they were created with.

Deleting a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click on the Bin icon on the template you want to delete, and confirm.

Menu della documentazione

Introduction

Table of Contents

This chapter explores how to manage taxonomical and classification tools in the Platform. The main available tools for the purpose are Tags and Categories. The chapter also describes the tools that define the shape of the entities of your installation: Digital Product Types (with their templates) and Integration Patterns.

Tags and Categories can be used to create a taxonomical hierarchy of entities (digital products, Apps, Organizations, etc.) as well as to facilitate discoverability for entities. A clear taxonomy within the Platform helps maintaining clear ownership, improves discoverability, and strengthens compliance, lifecycle management and audit readiness.

There are other important uses of Tags and Categories which can impact important aspects of visibility, user profiling, and security. More details are available in the dedicated chapters for Tags and Categories.

These configurations can be found from the sidebar menu, under Administration > Classification & Taxonomy.

Tags

Having tags allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to:

  • digital products (including API Products) and API Assets;

  • Applications;

  • Documentation.

It is possible to associate one or more tags to the same entity.

NOTE: Tags will be visible to all users who can view a particular entity. Use Categories if you want to decorate your entities for taxonomical purposes with information that should stay private for certain users.

Creating a tag

You can create a new Tag at any moment. Once a Tag is created, it can be added or removed from any entity at any point of its lifecycle (unless the entity is retired).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Click Add to create a new tag.

  3. Complete the following fields:

    • Name (required, up to 255 characters);

    • Description (optional).

  4. Click Save.

Editing a tag

You can edit a tag at any time, and it will change on all linked entities without further impacts.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Modify the details.

  4. Click Save.

  5. The tag updates immediately across the Platform.

Deleting a tag

You can delete a tag at any time, and it will disappear from all linked entities.

POSSIBLE IMPACTS: Tags can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API (see chapter Security governance). Removing a tag will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting tags that are not mentioned either in any API, or in any Keyset Policy Template.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Tags.

  2. Select a tag from the list.

  3. Check in Used by which products, assets, apps and documentation use the tag.

  4. Click Delete and confirm.

  5. The tag is permanently removed from all associated entities.

Categories

Having categories allows for better discovery and an intuitive understanding of the areas of belonging and impact on the entities to which they can be assigned to. There are four kinds of categories, each managed in its own tab:

  • API categories, for digital products (including API Products) and API Assets;

  • App categories, for Applications;

  • Organization categories, for Organizations;

  • Documentation categories, for Documentation.

It is possible to assign one or more Categories to each entity.

NOTE: Unlike Tags, Categories can also be given limited visibility from certain users. You can choose whether a category is visible in the Catalogs to the users who can view a certain entity. This is useful in case a Category may reveal private information that should not be available to external users of the Catalog.

NOTE2: Organization categories are also used to extend the default visibility of digital products and the automatic approval of subscriptions to whole groups of organizations (see chapters Default entity visibility and Security governance).

Creating a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Choose the API, App, Organization or Documentation tab.

  3. Click Add to create a new category.

  4. Complete the following fields:

    • Name (required);

    • Description (optional);

    • Visibility (required): Full access (visible to all users who can see the entity), Custom access (restricted, for example to some types of organization) or Tenant Owner Only (visible only to the Owner).

  5. Click Save.

Editing a category

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Update the details.

  4. Click Save.

  5. The category is updated and immediately reflected in the Platform.

Deleting a category

POSSIBLE IMPACTS: Categories can be used in Keyset Policy Templates to define rules for when a Keyset Policy should apply to Subscriptions to an API. Removing a Category will thus have effects on those policies, and may therefore extend the policy inadvertently. Make sure you are deleting Categories that are not mentioned either in any API, or in any Keyset Policy Template. Removing an Organization category can also change the visibility and automatic approval rules based on it.

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Categories.

  2. Select a category from the list.

  3. Check in Used by which entities use the category.

  4. Click Delete and confirm.

  5. The category is permanently removed from all associated entities.

Integration Patterns (or Messaging Patterns)

NOTE: API Assets are available only if enabled for your installation.

Manage Integration Patterns (or Messaging Patterns) to define the data structure of your tenant's Assets.

This feature is useful when you want to govern any non-standard assets in the Platform, for example a particular kind of database interface or particular type of API which may not fit in with how default APIs are defined in the Platform.

Aside from the Overview information (like Name, Organization, Group, Relevant Users, Tags and Categories) which cannot be changed, you can freely structure each Asset's shape by deciding which data will be collected to define it. This will determine what the form will be like for users inserting the data of the Asset.

Each Pattern will thus have one or more custom parameters, and for each parameter you can choose different aspects that determine how the information is validated. Some examples are whether the field is mandatory, if it's to be chosen from a set of options (which you can list), or if it's a file to upload, and so on.

NOTE: Once an Asset with a particular Pattern is created, the Pattern can no longer be deleted unless all Assets using it are deleted. Also, if a Pattern is updated by the administrator, the change will not be immediately reflected in the Assets that have been generated before the change; in this case the Assets will need to be created from scratch.

Creating an integration pattern

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Integration Patterns.

  2. Click Add to create a new integration pattern.

  3. Enter the integration pattern metadata:

    • Name (required);

    • Description (optional);

    • Is productizable?: if checked the new integration pattern grants the ability to productize the asset, that is to turn it into an API Product. This is to be chosen if you expect the asset to be eventually exposed on the API gateway. Make sure the gateway integration of your installation supports this type of Asset.

  4. Click Save.

  5. Create all the Parameters for this Pattern (see Creating a parameter).

Editing an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Update the details.

  3. Click Save.

Deleting an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Delete and confirm.

Cloning an integration pattern

Steps:

  1. Select an integration pattern from the list.

  2. Click Clone.

  3. Enter the new name and description.

  4. Click Save.

Creating a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Add to create a new parameter.

  3. Fill in the parameter metadata. For each parameter you must choose the following:

    • Label (required): enter the name or label for this parameter.

    • Placeholder (required): brief text to assist the end user in filling in this parameter.

    • Info (required): additional information to help the end user in filling out the field.

    • Description (required): briefly describe the purpose of this parameter.

    • Insertion Mode (required): defines the input type for the information. Each option brings its own choices, listed in the table below.

  4. Click Save.

Insertion mode

Choices

Text input

Cardinality (required): whether the parameter is mandatory or optional, with its minimum and maximum. Regex: the regex with which to validate the text. Regex explanation: if a regex has been inserted, additional information to inform the end user about the validation rules for the input.

Text box

Same as Text input.

Single select

Cardinality (required); Available values (required); Default values.

Multi select

To let users select one or more options from a list of provided values. Cardinality (required); Available values (required); Default values (their number depends on the cardinality).

Single-file upload

Cardinality (required); Extension (required): the extension of the file that users can upload, without the dot (for example txt).

Editing a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click on the edit button of the parameter.

  3. Modify the desired fields.

  4. Click Save.

Deleting a parameter

Steps:

  1. Select an integration pattern from the list. A list of parameters should be visible.

  2. Click Delete and confirm.

Digital Product Types

NOTE: Digital products other than APIs are available only if enabled for your installation.

Manage Digital Product Types to define the types of your digital products, besides APIs.

This feature is useful when you want to expand the portfolio of digital product types on your tenant beyond the default options (MCP Servers, AI Agents). Default types are marked as Default and are read-only; the types you create are marked as Custom.

You can freely define each Digital Product Type's templates by deciding which schema must be followed and which specifications can be added. This will determine what the form will be like for users inserting the data of the Digital Product. Each type can have one or more templates.

Creating a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Click Add to create a new digital product type.

  3. Enter the digital product type metadata:

    • Name (required);

    • Description (required);

    • Featured: if checked the Digital Product Type is featured. In the New Digital Product wizard it appears as a selectable card (otherwise it's only in the Other product type dropdown), and in the Catalog and Workspace it appears as its own tab (otherwise it's grouped under the More menu). It does not affect the products themselves, only where the type is surfaced.

  4. Click Save.

NOTE: A new type can be chosen in the New Digital Product wizard once it has at least one template.

Editing a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Use View usage to check which digital products use the type.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the digital product type is used by a digital product, it cannot be edited.

Deleting a digital product type

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Delete and confirm.

NOTE: Only a custom digital product type can be deleted.

Creating a digital product type template

A template has three tabs: Info, Schema (the form that users will fill in) and Specifications (the technical files that can be attached to the digital products).

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Info tab enter the template metadata:

    • Name (required);

    • Description (required);

    • Featured: a featured template is marked as Featured in the template selection of the New Digital Product page and in the Template filter of the Catalog and Workspace.

  5. In the Schema tab:

    • click Add section, and rename the section as you prefer;

    • click Add field and set the properties of the field (see the table below);

    • for fields of type object or list, click Add sub-field to define the fields they contain;

    • use the up and down arrows to change the order of the fields within the section.

  6. In the Specifications tab, define the specifications (see Defining specifications).

  7. Click Save.

The properties of each field are the following:

Group

Property

Description

GENERAL

Key (required)

Unique machine-readable key, in camelCase and without spaces (for example firstName).

GENERAL

Section

The section of the form where the field is shown.

GENERAL

Type

The type of data of the field (for example string).

GENERAL

Compilation Mode

How the user fills in the field (see below). If left empty, it is inferred from the type.

GENERAL

Label

The label shown in the form.

GENERAL

Description

Help text shown as a tooltip next to the field.

GENERAL

Default value

The value the field starts from. On an editable field it is a suggestion that the user can change.

GENERAL

Required

If checked the field is marked as mandatory.

GENERAL

Read only

If checked the field is always disabled. Combined with a default value, it makes the field a constant.

GENERAL

Visibility

Everywhere (editable in the form and shown read-only in the catalog), Form only (hidden in the catalog, for internal data) or Hidden (kept in the schema but never shown).

GENERAL

Disable if

The condition under which the field has to be disabled.

VALIDATION

Min Length, Max Length

The minimum and maximum number of characters.

VALIDATION

Minimum, Maximum

The smallest and largest numeric values.

VALIDATION

Pattern

The regex that validates the value.

VALIDATION

Pattern Explanation

An explanation of the pattern for the user.

VALIDATION

Format

A string format used for validation (for example email, date or URI).

UI OPTIONS

Placeholder

The example text shown in the empty field.

UI OPTIONS

Input Type

The type of input (for example text, number, email or password).

UI OPTIONS

Enum Values

The values the user can choose from (switches the field to a single selection).

UI OPTIONS

Item Enum Values

For lists, the values that can be chosen for each item (switches the field to a multiple selection).

UI OPTIONS

Accepted Extensions, Supported Files Label

For file uploads, the accepted extensions (for example .json, .yaml) and the label describing them.

UI OPTIONS

Add Button Label

For repeatable lists, the text of the button that adds an item.

LAYOUT & POSITIONING

Row

Fields sharing the same Row number are placed side by side.

LAYOUT & POSITIONING

Col Span

The width of the field in a 12-column grid (1 – 12).

The available compilation modes are: Text Input, Textarea, Number Input, Checkbox, Toggle, Single Select (requires enum values), Multi Select (requires item enum values), Tags / Chips, Date Picker (requires the date format), Password / Secret, JSON Editor (for data without a fixed schema), Subsection Card (for objects with their own fields), Repeat Section (for lists of objects) and file upload.

NOTE: It's also possible to upload a JSON file with all the information:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click Add Template.

  4. In the Schema tab click on the Options menu (3 dots).

  5. Click Import JSON.

  6. Open your file from your device.

  7. Click Save.

HINT: The same Options menu offers Copy JSON, Download and Clear all. Use Full screen to work on large schemas, Show form preview to see how the form will appear to users, and the JSON Schema view to see the read-only schema generated from the fields. Fields not assigned to a section are shown in the Custom Fields section, whose title can be changed with Custom Fields section title.

Defining specifications

A specification is a schema-based description of a technical file that can be attached to the digital products created with the template (for example the configuration file of an MCP server or the card of an AI Agent). It is defined by a label, a JSON schema and, optionally, mapping expressions between the specification and the fields of the template.

Steps:

  1. Open the template and go to the Specifications tab.

  2. Click Add specification.

  3. Enter the Label and, optionally, the Description of the specification.

  4. Define the Schema of the file, in the tree view or in the code view: add properties, choosing their name and type (or create them as a Reference to a reusable schema), and set their attributes (Basic Properties, Validation, String, Number, Array and Object Properties, Values, Discriminator, XML, External Documentation).

  5. Click Save.

NOTE: When a specification has mapping expressions, uploading its file to a digital product can copy some values into the data of the digital product. The Platform asks for confirmation before replacing the values already saved.

NOTE2: Schemas that use advanced JSON Schema features not supported by the visual editor are edited as raw JSON and saved exactly as written. Use Remove specification to delete a specification from the template.

Editing a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Select a template from the list.

  4. Update the details (only for custom types).

  5. Click Save.

NOTE: If the template is used by a digital product, it cannot be edited. To change a template in use, create a new one (for example by cloning the existing one): the digital products already created keep the template they were created with.

Deleting a digital product type template

Steps:

  1. Navigate to Administration > Classification & Taxonomy > Digital Product Types.

  2. Select a Digital Product Type from the list.

  3. Click on the Bin icon on the template you want to delete, and confirm.