Data Market Configuration

Data markets are a type of dashboards that provide users with a curated catalog of data assets to support data discovery. You can configure personalized recommendations, search capabilities, and customizable filtering. In this tutorial, we will create a data market for our Recipe Manager created in Writing a Data Ingestion Application Package.

A data market allows us to:

• Search functionality with customizable queries and indexes
• Recommendation system that suggests relevant objects to users
• Search forms with faceted filters for refined searching
• Custom page with a marketplace-style interface

The example packages used in the tutorial are the following:

Base Package Example	Download the full examples we used in this tutorial to follow along: - Recipe Manager (version data ingestion): Recipe Manager (Metadata Application).json - SQL script with the example database: Recipe SQL Script.sql
Data Market Package Example	Recipe Manager (Data Market).json

Package Settings

First, let’s configure the package to enable the creation of a data market by adding global settings and dependencies:

"settings": {
    "createAssetMappingsForExistingAssets": false,
    "search": [
        {
            "isSearchable": true,
            "description": "Data Market for Recipes",
            "applicationKey": "cust_recipe_metadata_app_app",
            "objectTypeKey": "cust_recipe_metadata_app_recipe",
            "functionKey": "mr_object_import_func",
            "indexKey": "search_index"
        }
    ]
},
"dependsOn": [
    { "packageKey": "core" },
    { "packageKey": "cust_recipe_metadata_app" }
],

Search Query and Index

We will go through the configuration of search queries and index briefly. For more information, see the tutorial on Search Area Configuration.

You can also skip this part and use queries and indexes defined in other packages or use the ones provided in the example package.

Search Queries

Search queries define how search terms are processed and matched against indexed data. Queries are defined using the following template:

"searchQueries": [
    {
        "key": "",
        "searchQueryTypeKey": "",
        "description": "",
        "searchQuery": ""
    }
],

• empty: Used when no search term is provided or when showing all results.
• basic: Standard text search with fuzzy matching and basic ranking.
• advanced: Advanced search with operator support (AND, OR) and precise matching.

The data market package uses predefined ElasticSearch QueryDSL queries. We recommend using these standard queries as provided in the example package unless you have specific search requirements.

Search Index

The search index is a reference to the ElasticSearch index that stores searchable object data. It acts as a pointer to where the search queries will look for data.

A new search index is created using this template:

"searchIndexes": [
    {
        "key": "search_index",
        "indexName": "search_index"
    }
],

Search Form

While the search query and index can be referenced from other packages, the search form must be configured specifically for the data market.

Search forms define the search function and facets (filters) that will be selectable on the data market dashboard. Let’s start with a blank template:

"searchForms": [
    {
        "key": "",
        "state": "",
        "searchIndexKey": "",
        "orderNumber": 0,
        "iconKey": "",
        "searchQueryKeys": [],
        "template": {
            "formId": "",
            "title": "",
            "defaultFacets": [],
            "sort": []
        }
    }
],

Template Properties

Default Facets

Facets are filters that allow users to narrow down search results based on various criteria. For all  available types, see Default Facets.

Each facet configuration follows this structure:

"defaultFacets": [
    {
        "type": "faceted-element",
        "enumKeyType": "",
        "enumKey": "",
        "title": "",
        "elementType": "",
        "valueType": "",
        "orderBucketsType": "",
        "iconKey": "",
        "values": [ "" ]
    }
]

The Recipe Manager data market demonstrates four common facet patterns that work together to create a complete filtering experience. Let’s examine each one:

Facet 1: Object Type Filter (Base Filter)

This facet defines which object types are shown in the data market. It acts as the foundation and all subsequent facets are based on the objects selected by this facet.

It restricts the entire data market to only show Recipe objects. Users never see this filter as it works behind the scenes to scope the search.

{
    "type": "faceted-element",
    "enumKeyType": "objectType",
    "enumKey": "#_nameKey",
    "title": "facet.object.objectTypeNameKey.name",
    "elementType": "hidden",
    "valueType": "isTranslationKey",
    "orderBucketsType": "value",
    "iconKey": "core_default_object_type",
    "values": [ "object.type.cust_recipe_metadata_app_recipe.name" ]
}

Here are the facet’s defining properties:

Facet 2: User Relations (Dropdown Filter)

This facet creates a selectable dropdown list based on user relationships to the objects from Facet 1.

The facet allows users to filter recipes by their owner. The dropdown shows all users who own at least one recipe, enabling queries like “Show me recipes owned by John” or “Show me my recipes”.

{
    "type": "faceted-element",
    "enumKeyType": "userRelation",
    "enumKey": "cust_recipe_metadata_app_recipe_owner",
    "title": "facet.cust_recipe_metadata_app_recipe_owner",
    "elementType": "selectBox",
    "orderBucketsType": "value",
    "valueType": "isText",
    "iconKey": "core_job"
}

Facet 3: Object Relations

This facet displays as selectable tabs when there are values available, based on object-to-object relationships. It shows dietary categories (Vegan, Gluten-Free, Vegetarian, etc.) as clickable buttons. The options appear when there are recipes with those categories in the current result set. Users can select multiple categories to filter.

{
    "type": "faceted-element",
    "enumKeyType": "relation",
    "enumKey": "cust_recipe_metadata_app_has_dietary_category",
    "title": "facet.cust_recipe_metadata_app_has_dietary_category",
    "elementType": "listedValues",
    "valueType": "isText",
    "orderBucketsType": "value",
    "iconKey": "core_parameter"
}

Facet 4: Attribute Search (Full-Text Search)

This facet enables keyword and phrase searches within object attributes without showing a visible filter control. This facet enables full-text search within recipe descriptions. When users type search terms, the search engine matches against description content. This facet works invisibly, meaning that users don’t see it as a filter, but it powers the main search functionality to find keywords and phrases in descriptions.

{
    "type": "faceted-element",
    "enumKeyType": "attribute",
    "enumKey": "core_description_scanned",
    "title": "facet.core_description_scanned",
    "elementType": "none",
    "valueType": "isText",
    "orderBucketsType": "value",
    "iconKey": "core_measure"
}

How the Facets Work Together

The four facets create a layered filtering experience:

1. Facet 1 (Object Type) establishes the base: “Show only Recipe objects”
2. Facets 2 and 3provide user-visible filters on top of that base: “Among these recipes, show me…”
   • Recipes owned by a specific user (Facet 2)
   • Recipes with certain dietary categories (Facet 3)
3. Facet 4 enables searching through recipe descriptions without cluttering the UI with another filter control

Sort Configuration

The sort array defines sorting options available to users in the search results:

"sort": [
    {
        "key": "",
        "title": "",
        "reverse": false
    }
]

”sort”: [

{ "key": "name", "title": "search.sort.name", "reverse": false },
{ "key": "name", "title": "search.sort.name_reversed", "reverse": true },
{ "key": "visited", "title": "search.sort.most_popular", "reverse": false },
{ "key": "created", "title": "search.sort.most_recent", "reverse": false },
{ "key": "modified", "title": "search.sort.recently_modified", "reverse": false }

]

Data Market Page

The page asset defines the visual layout and functionality of the data market interface. It consists of multiple components that work together to provide search, recommendations, and results display.

Page Template

"pages": [
    {
        "key": "",
        "name": "",
        "url": "",
        "orderNumber": 0,
        "iconKey": "",
        "locationKey": "",
        "template": {
            "centerArea": [],
            "settings": {}
        }
    }
],

Page Components

The Data Market page uses three key components in the centerArea: search component, inline API cards, and normal API cards. In this tutorial, we will show you the configuration usually used for data markets. For the full configuration options, see the dedicated articles.

1. Search Component

Provides the main search input for users to search the data market. For more information, see Search (component).

{
    "componentId": "search#recipe_datamarket",
    "type": "search",
    "title": "template.object.market.title",
    "placeholder": "template.object.market.placeholder",
    "searchFormKey": "search_form",
    "targetDataComponentId": "api-card#recipe_target"
},

2. API Card Inline Component (Recommendations)

Displays personalized recommendations to users in an inline horizontal layout. For more information, see API Card Inline.

{
    "componentId": "api_card_inline#recipe_datamarket",
    "type": "api-card-inline",
    "api": "api/mr-object/recommendations/customizable-overview-filter",
    "headerTitle": "template.recommendation-api-card.header",
    "headerClaim": "template.recommendation-api-card.claim",
    "noDataText": "no_data",
    "targetComponentId": "api-card#recipe_target",
    "onClickOpens": "rightPanelDetail",
    "nameAttribute": "objectName",
    "leftData": {
        "type": "relationTypeKey",
        "value": "cust_recipe_metadata_app_has_dietary_category"
    },
    "rightData": {
        "type": "userRelationTypeKey",
        "value": "cust_recipe_metadata_app_recipe_owner"
    },
    "filter": {
        "objectTypeKeys": {
            "value": [
                "cust_recipe_metadata_app_recipe"
            ]
        }
    }
},

3. API Card Component (Search Results)

Displays search results in a card-based layout with multiple view options. For more information, see API Card.

{
    "componentId": "api-card#recipe_target",
    "type": "api-card",
    "api": "api/dashboard/search-object",
    "headerTitle": "template.object.api-card.header",
    "noDataText": "template.object.api-card.no_data",
    "noDataIconKey": "core_recently_viewed",
    "onClickOpens": "rightPanelDetail",
    "sortTypes": [ "name",  "created", "modified", "popularity" ],
    "nameAttribute": "name",
    "secondaryNameAttribute": "48",
    "userRelationTypeKey": "cust_recipe_metadata_app_best_cook",
    "objectPathKey": "objectPath",
    "middleSectionAttributeTypeKey": "core_description_scanned",
    "searchFormKey": "search_form",
    "additionalRelationTypes": [ { "key": "cust_recipe_metadata_app_has_dietary_category" } ],
    "additionalUserRelationTypes": [
        { "key": "cust_recipe_metadata_app_recipe_owner" },
        { "key": "cust_recipe_metadata_app_best_cook" }
    ],
    "favouriteObjectTypes": [
        { "key": "cust_recipe_metadata_app_recipe" }
    ],
    "layouts": [ { "type": "cards" } ]
}

Template Settings

Finally, using the template settings, we can hide UI elements that are displayed by default. For the data market, we don’t want any elements except for our components:

"settings": {
    "componentId": "template-settings#app_overview_settings",
    "type": "template-settings",
    "hide": {
        "attachments": true,
        "changes": true,
        "commentSection": true,
        "concepts": true,
        "editButton": true,
        "favouriteButton": true,
        "hideEmptyAttributesButton": true,
        "shareObject": true,
        "watchingButton": true,
        "workflowStatus": true,
        "likeButton": true,
        "anchors": true,
        "moveObject": true,
        "renameObject": true,
        "removeObject": true
    }
}