Configuring Framework Settings

Because the Framework Settings component does not display as an independent portlet, it is not configured in the same way as most Endeca standard components. Instead, you modify these settings in the Control Panel.

Note: If you do not see the Discovery Framework Settings in the Control Panel, it probably means you did not install the endeca-framework-settings-portlet-<version>.war file. Please review your installation settings.

The Framework Settings page looks like this:

The Framework Settings component contains the following settings:
Framework Setting Meaning
df.cordaImageAuthEnabled: Controls whether Corda chart image URLs are secured.
df.cordaServerExternalUrl and df.cordaServerInternalUrl: The externally- and internally-accessible URLs of the Corda Server, which is used by the Chart component.
df.cordaServerRedirectorUrl: The URL of the Corda Redirector, which can be used by the Chart component.
df.dataSourceDirectory: The directory on disk from which to load data source definition files.
df.deepLinkPortletName: The name of the deep link component.
df.defaultDataSource: The name of the data source to use as the default.
df.defaultExporter: The default exporter class.
df.exportPortletName: The default name of the export portlet.
df.healthCheckTimeout: The time (in milliseconds) for query timeout when checking data source availability on initialization.
df.maxExportAnalyticsRecords: The maximum allowable number of Analytics records that can be exported.
df.maxExportBaseErrors: The maximum allowable number of non-Analytics records that can be exported.
df.mdexCacheManager: The fully-qualified class name to use for the MDEX Cache Manager. Changing this setting is currently experimental and unsupported, and should be used only for research purposes. This interface will change in upcoming releases.
df.mdexStateManager: The fully-qualified class name to use for the MDEX State Manager.
df.mdexSecurityManager: The fully-qualified class name to use for the MDEX Security Manager.
df.metadataCacheEnabled: If set to false, retrieves this metadata directly from the data source whenever required (this will be slow). This setting will take effect for new sessions. Note that the use of this setting in a production environment is not supported.

To change a Framework setting:

  1. On the Framework Settings page, change a setting by providing a new value in its configuration field.
    Note: Take care when modifying these settings, as incorrect values can cause problems with your Discovery Framework application.
  2. Click Update Settings.
  3. For the changes to be applied, restart Discovery Framework.