Field mappings provider module

Purpose of this module

The field mappings provider module allows apps to add field mappings into a search index.

Configuration

The root element for the field mappings provider module is field-mappings-provider. It accepts the following attributes for configuration:

• key: The unique identifier of the plugin module.
• class: The fully qualified field mappings provider class name.
• index: The system index to which the field mappings will be added. Either CONTENT or CHANGE. Mutually exclusive with custom-index.
• custom-index: The custom index to which the field mappings will be added. Mutually exclusive with index.

You can add multiple field mappings providers as long as they have distinct keys.

Configuration example

This is how you would register the StatusFields field mappings provider that adds field mappings to the CONTENT system index:

1
2
<field-mappings-provider
    key="statusFieldMappings"
    index="CONTENT"
    class="com.atlassian.confluence.plugins.cql.tutorial.impl.StatusFields" />

This is how you would register the QuestionsEdgeIndexFieldMappings field mappings provider that adds field mappings to the questions-edge custom index:

1
2
<field-mappings-provider
    key="questionsEdgeMappings"
    custom-index="questions-edge"
    class="com.atlassian.confluence.plugins.questions.edgeindex.custom.QuestionsEdgeIndexFieldMappings" />

See also

• Extractor2 module
• Add a field to CQL