Metadata File Configuration

Once you have set up your index mapping, the next step is to configure the metadata files in Arranger Server. These metadata files specify which fields from your index mapping will be accessible to end users and define how data will be displayed in Arranger's UI components.

Setting up the Arranger Metadata Files

Arranger metadata files are JSON files that describe the available fields in the index mapping and control the UI behavior. You need to provide four metadata files to Arranger:

You can refer to the sample JSON files created for the default file_centric_1.0 index mapping.

Aggs-state.json

The aggs-state.json file allows you to configure the search filters and aggregations that will be available in the facet panel of the data portal. Aggregations provide insights into the distribution of data based on specified criteria, enabling users to filter and refine their search results.

Columns-state.json

The columns-state.json file is used to configure the data columns that will be displayed in the search results table of the data portal. You can specify the fields from your index mapping that you want to include as columns in the table.

Extended.json

The extended.json file provides additional configurations for your Elasticsearch index mapping. It allows you to define custom behaviors and settings specific to your data model.

Matchbox-state.json

The matchbox-state.json file is used to configure the quick search settings for specified fields in the data portal. It defines which fields will be considered for quick search queries and how the search results will be displayed.

These metadata files play a crucial role in defining the functionality and output of Arranger. Customize them according to your requirements to provide a tailored search experience for your users.