Adding an AppData key

The administrator can add AppData keys for all users (globally) or keys can be added by other users depending on their role and permissions.

Procedure

  1. Display the Edit AppData window:

    From Contenta Explorer, click Tools > Options > Tool Preferences.

    From Contenta Web, right click on sysadmin, and then click More. From the resulting pop-up menu, click Edit AppData.

  2. Click the key path in the configuration tree where you want to add the new key.

    The key is added at this level in the hierarchy, that is, collection_name and configuration name are keys:

  3. Click Tools > Options > Tool Preferences > {Global} Collections .
  4. Click Insert Key.
  5. Enter the name and value that you want for the key, and then press OK.
    Where required, enter AppData information for the keys described in the following table, noting the key path for each.
    KeyFunction
    AppData Key Path {Global}/Collections
    MARK_DB_FOR_INDEXThis value instructs the Contenta Portal server to queue new, modified, and deleted objects for indexing

    The database will not be indexed in Solr if this setting is not TRUE.

    The upgrade_56 executable and the newdb.pl Perl script set this value (true or false) based on user input. You run these using the command line from the Contenta_home/bin directory.

    RETRYSetting RETRY value to true or 1 instructs the Crawler to retry indexing objects that recently failed to index for this database (see Activity and Error Monitoring).

    The Crawler will change the value of this field from true to QUEUED once it has started the indexing process for the failed objects. The upgrade_56 executable and thenewdb.pl Perl script set this value (true or false) based on user input.

    You run these using the command line from the Contenta_home/bin directory.

    AppData Key Path {Global}/Collections/collection_name

    where collection_name is a unique name for a Solr collection.

    There can be only one database per Solr collection. It is named collectionSDL_Contenta_Sample; however, the administrator can change this name while running the upgrade_56 executable or the newdb.pl Perl script, or later by editing AppData.

    OBJECT_TYPESThis value lists object types that the Crawler will index. S1000D examples include: DModule, PModule.

    Object types in the list must be comma separated. If this value is empty, objects of all types, that are configurations or descendants of configurations, will be indexed.

    The upgrade_56 executable and the newdb Perl script create an empty value named OBJECT_TYPES under the collection key. The collection key is named either collectionSDL_Contenta_Sample, the default, or a name entered when running the upgrade_56 executable and the newdb Perl script. You run these using the command line from the Contenta_home/bin directory.

    URLThe URL to the Solr collection. For example: http/https://localhost:8983/ solr/#/collectionSDL_Contenta_Sample

    The name of the collection in this URL is collectionSDL_Contenta_Sample If present, the hash and slash (#/) will be removed by the Crawler.

    The upgrade_56 executable and the newdb.pl Perl script set the collection name and port number based on user input. You run these using the command line from the Contenta_home/bin directory.

    LANGUAGE_CODEThe language code for the content. During indexing, the Crawler attempts to read the language code for each object from the Language ISO Code property data field. If this fails, the Crawler attempts to read the LANGUAGE_CODE value from this AppData field. If that also fails, the Crawler uses Apache Tika to determine the language of the object. Tika is less than 100% accurate in determining foreign languages.

    The upgrade_56 executable and the newdb.pl Perl script set this value based on user input. You run these using the command line from the Contenta_home/bin directory.

    This value defaults to en if not specified.

    DEFAULTIf set to true, this collection will be used for Search; otherwise, the Contenta application developer must call the PCMSearch::SetCollection (STRING) API.

    This value is used by the Search in Contenta Web and in Contenta Explorer (it is not used by the Crawler).

    The upgrade_56 executable and the newdb.pl Perl script set this value to true. You run these using the command line from the Contenta_home/bin directory.

    AppData Key Path {Global}/Collections/collection_name/configuration_name

    where collection_name is the name of a Solr collection and configuration_name is the name of a configuration within that collection to be indexed.

    IDPATHSpecifies the exact path of the configuration that requires indexing.

    The upgrade_56 executable and the newdb.pl Perl script create the All_Configs key, but do not create the IDPATH under it; therefore, the Crawler will know to index the Contenta objects in all Contenta configurations in Solr.

    If you want specific configurations indexed, rather than all configurations, replace the All_Configs key with keys having the name of each configuration to index. Under each of these keys, insert the IDPATH value of the appropriate configuration object (see Global AppData Settings).

    You run these using the command line from the Contenta_home/bin directory.

    STATUS_REPORTINGIf set to true or 1, the Crawler will write status to the INDEXING_STATUS AppData value while performing the initial indexing of the database.

    The upgrade_56 executable and the newdb.pl Perl script set this value to true. You run these using the command line from the Contenta_home/bin directory.

    INDEXING_STATUSThe Crawler creates this value and writes status to it if STATUS_REPORTING is set to true or 1. Status is written only during initial indexing.

    The Crawler sets this value to indicate how many objects have been indexed. Example: 5172 objects indexed, 3 objects failed.

    QUEUED_FOR_INDEXINGThis will be set to true by the Crawler after it has queued this configuration for indexing.

    Once set to true, the Crawler will not index this container again if the Crawler is subsequently restarted.

    If you set it to false the Crawler will reindex this configuration.

    MAXDOCSMAXDOCS determines the maximum number of documents that can be retrieved by each search operation. The default value is 1024.

    You can create your own value to override the default value by adding the MAXDOCS AppData value. This value can be overridden in an advanced search query that includes the parameter: rows=99, where 99 is the maximum number of rows that the query will retrieve.

    This value can also be overridden programmatically by calling the API method SetSolrMaxRows.
    AppData Key Path {Global}/Collections/collection_name/All_configs

    where collection_name is a Solr collection.

    The All_configs configuration contains values to be applied to all configurations within the collection. In addition to the previously described STATUS_REPORTING and QUEUED_FOR_INDEXING values, the All_configs configuration can contain the following optional value.

    CONFIGS_ALREADY_INITIALLY_INDEXEDWhen using the All_configs option, the Crawler will skip initial indexing for any configurations specified in this field, which takes as its value a semicolon-delimited list of configuration IDs within the collection, such as the following.

    6;932;54;7319;88;397;253;841;9273

    The CONFIGS_ALREADY_INITIALLY_INDEXED field must be added under the All_configs AppData key.

    Because the Crawler skips initial indexing of configurations specified in this value, using it can reduce the time required for initial indexing with the All_configs option.