Documentation Center

Configuring which metadata-bound fields are searchable in Dynamic Delivery outputs

In the configurations for publish plug-ins and for background tasks, you can configure which metadata fields you would like to see indexed for searching in a Dynamic Delivery output.

Procedure

  1. In Organize Space, go to Settings > XML Settings > Background Tasks.
  2. Find the handler section whose eventType attribute has the value DITADELIVERYUPDATEPUBLICATIONMETADATA.
  3. Within this section, find the parameter element whose name attribute has the value SearchableFields.
  4. In the ishfields subsection, do one of the following:
    • If you want the name of the metadata field (the element name) to be indexed, insert a subelement of the format <ishfield name="NAME" level="LEVEL" ishvaluetype="element" />
    • If you want the values of the metadata field to be indexed, insert a subelement of the format <ishfield name="NAME" level="LEVEL" ishvaluetype="value" /> or <ishfield name="NAME" level="LEVEL" /> (the ishvaluetype attribute defaults to the value value, so you can omit it).
    where:
    • NAME is the name of the metadata field
    • LEVEL is the level (logical, version or lng) at which this metadata field exists
    .
  5. Select Save to apply your changes.
  6. Go to Settings > XML Settings > Publish Plug-ins.
  7. Find the plugindefinition section whose name attribute has the value ISHDITADELIVERYPREPAREMETADATA.
  8. Within this section, find the parameter element whose name attribute has the value SearchableFields.
  9. Insert the same subelements you inserted in the Background Tasks screen.
  10. Select Save to apply your changes.
  11. Publish to a Dynamic Delivery output and confirm that the package being sent contains content such as this (in this example, the values of the FISHMBPRODUCT metadata field, which exists on the logical level, have been added to the package for indexing):
    "FISHMBPRODUCT.logical.value": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "searchable": "yes"
    },

What to do next

The field or fields you configured are now indexed and stored in the Dynamic Delivery database. Your next step is to actually implement the search for these fields in your documentation website.