Configure Fields to Export

You can control the fields that Find exports when a user exports the results to CSV.

By default, Find exports all document fields. You can exclude particular fields from the export, in which case Find exports all field except for the excluded ones. You can also specify particular fields to explicitly include, in which case Find exports only the allowed fields.

You configure CSV export fields by modifying the fieldsInfo section of the Find configuration file.

TIP: You can also set a limit on the number of documents that Find exports in the CSV. See Change the Maximum Number of Documents to Export.

To configure the fields to export

  1. Go to the Find home directory.
  2. Open config.json in a text editor.
  3. Find or add the fieldsInfo section.

  4. Create a property and definition object for each field that you want to modify. You can use the following properties:

    names

    (Array, strings) An array of raw field names that you want to apply the settings to.

    csvExport (Boolean) A Boolean value that specifies whether to export this field in the CSV export.

    Set csvExport to false to exclude the field from CSV export. By default, Find includes all fields. You can use this option to exclude some fields.

    Set csvExport to true to explicitly include the field in the CSV export. If any fields in your configuration have csvExport set to true, Find exports only those fields.
    displayName (String) The user-friendly display name to use in the Find user interface. For more information, see Configure User-Friendly Names for Fields and Values.
    values (Object) A JSON object to specify a field value and the display value to use for that value. For more information, see Configure User-Friendly Names for Fields and Values.
    advanced (Boolean) A Boolean value that specifies whether to display this field in document previews. For more information, see Configure Fields to Show or Hide in Document Previews.

    For example:

    "fieldsInfo": {
       "country": {
          "names": [ "COUNTRY_ORIGIN" ],
          "displayName": "Country",
          "values": [ { "value": "UK", "displayValue": "United Kingdom of Great Britain and Northern Ireland" } ]
       },
       "elevation": {
          "names": [ "PLACE_ELEVATION" ],
          "csvExport": false
       }
    }

    When a user exports a document, the CSV export does not include the PLACE_ELEVATION field.

  5. Save the file, and then restart Find to apply your configuration changes.