Configuration files to remove during an upgrade

When importing configuration into the DXP certain configuration files can be removed.

The following configuration files are created by the system during updates and can be removed. If you attempt to import any of these files via WebDAV you will receive an error.

  • crawl_scheduler.cfg

  • collection.state

  • secondary-collection.cfg

  • secondary-start-urls.cfg

The following old configuration files should be converted / removed:

  • Any file with a .form extension

  • any graphics/css/html file that is not included in the profiles web resources folder. If a profile has a service.thumbnail key set to a image file this should be removed, the image file located and uploaded as the result page’s thumbnail from the administration dashboard.

  • Any .groovy, .sh, .pl, .php, .py file. The custom logic within these files must be replaced if used.

  • any auto completion CSV file that is generated by the update.

  • Any backup file - with a .bak extension, or containing a datestamp -XXXXXXXXXXX.cfg e.g. kill_exact-201806231010.cfg

  • best_bets.cfg - this is an old format best bets configuration file. Any rules contained within the file should be set up using the best bets UI in the administration dashboard, or converted into curator.json rules using the converter tool.

  • collection.cfg.start_urls - if empty remove this file.

  • contextual_navigation.cfg - this file was removed in v16. Configuration contained within the file should be merged into collection.cfg/profile.cfg (should be automatically done by the upgrade utility).

  • extra_search.*.cfg - this file was removed in v16. Configuration contained within the file should be merged into collection.cfg/profile.cfg (should be automatically done by the upgrade utility).

  • form_interaction.cfg - this file was removed in v16. Configuration contained within the file should be merged into collection.cfg/profile.cfg (should be automatically done by the upgrade utility).

  • meta.cfg - this file was removed in v16. Configuration contained within the file should be merged into collection.cfg/profile.cfg (should be automatically done by the upgrade utility).

  • quicklinks.cfg - this file was removed in v16. Configuration contained within the file should be merged into collection.cfg/profile.cfg if it contains a key quicklinks=enabled (should be automatically done by the upgrade utility).

  • metamap.cfg - this file contains legacy metadata mappings. Can be deleted if there is a metadata-mappings.cfg file. Upgrade utility should automatically convert this if there isn’t an updated metadata-mappings.cfg

  • xml.cfg - this file contains legacy metadata mappings. Can be deleted if there is a xml-index.cfg file. Upgrade utility should automatically convert this if there isn’t an updated xml-index.cfg

  • faceted_navigation.cfg if contained in a collection level configuration folder. This file should exist in profile/results page folders.

  • padre_opts.cfg - this should only exist in profile folders. Remove this file if the profile includes a profile.cfg with a query_processor_options key. If there is no profile.cfg or the profile.cfg doesn’t contain a query_processor_options key then you need to copy any query_processor_options from the parent search package’s collection.cfg into the profile.cfg, and then merge the values from padre_opts.cfg. Any option that is set in both padre_opts.cfg and collection.cfg should set the value from the padre_opts.cfg.

Other configuration files you might come across that can be deleted:

  • query-spike-word-list.cfg, query-word-list.cfg and query-zero-word-list.cfg - these files can be deleted.