Catalogs

A catalog is a type of entity that can be related to another entity and it defines a set of options. When a catalog is displayed in an edit-view it uses a drop-down list control. Sometimes catalogs are called picklists by developers.

Catalogs are used as data inputs in varying places across the platform. Catalogs can be displayed as a dropdown list or a seach enabled list depending on configuration. For more details about the visual representation of a catalog see the catalogs page in the User Interface chapter.

How to use

To open the Catalogs view, navigate to Develop ➔ Catalogs.

Designer

Fields in the sidebar:

1. Name - Is the name of the catalog. If the name starts with "." (dot) then when if used as a dynamic list the filter operator is StartsWith otherwise it is Contains.
2. Extended - Specify if the catalog is extended. For extended catalogs the FETCH EXTENDED tab is mandatory.
3. Module - Specify if the entity is contained in a module.
4. UUID - Is the unique identifier of the row in the table (read-only).

Entity diagram:

FETCH tab

The FETCH tab represents the code that queries what is needed for the catalog. The value that should appear in the catalog is marked by the AS value alias. The entire fetch syntax can be used here.

Here is an example of what a FETCH for a catalog might be:

FETCH supplier (key, name AS value)

FETCH EXTENDED tab

Mandatory for extended catalogs, optional for simple catalogs.

The FETCH EXTENDED tab represents the code that queries what is needed for the catalog, but used only if the bool Extended is true. This tab is used as it says in it's name, to extend the query with more information.

Here is an example of what a FETCH for an extended catalog might be:

FETCH supplier (key, name AS value, address) FILTER AND (${name}, ${address})

See the visual representation of extended catalogs here.

FILTERS tab

Mandatory for extended catalogs, optional for simple catalogs.

Filters need to match the placeholders defined in the FETCH EXTENDED tab.

Fields in the filters table:

1. Title - Tite of the filter.
2. Input type - Type of the filter field.
3. Catalog - Specify if the filter has a catalog (works only with fixed list and dynamic list).
4. Argument name - The name of the argument in the FETCH.

Tab entity diagram: