Articles in this section

See more

Configuration Files

Avatar
Jason Stevens
  • Updated
Follow

There are two groupings of configuration files.

  • The system configuration  files are found in config. These are the files for overall service configuration.  These are files whose names end in .cfg.  These files are in Java property file syntax, and define name-value pairs.

  • The more complex Endpoint and Transport Rules Configuration Files are found in launcher/config/rosapi. These are the files you need to edit to change the input parameters, transport rules, and configuration requirements of the individual endpoints.

System Configuration Files

These are the configuration files for overall service operation. The perceptive reader may notice that there are endpoint specific configuration files here as well, e.g. dedupe, rni, rnt. The architecture is still evolving.

Location: server/launcher/config

Configuration File

Purpose

com.basistech.downloadextract.cfg

Defines the pathnames for the download extractor config file and the constraints file.

com.basistech.rli.cfg

Configuration for RLI specifically the short string threshold.

com.basistech.worker.service.cfg

Configuration for worker service startup.

com.basistech.ws.cxf.cf

Configuration for CXF. Defines urlBase. Works in conjunction with org.apache.cxf.http.jetty-main.cfg.

com.basistech.ws.dedupe.cfg

Configuration for name deduplication.

com.basistech.ws.doc.cfg

Configuration for the documentation settings.

com.basistech.ws.fe.health.cfg

Configuration for frontend health check.

com.basistech.ws.frontend.cfg

Configuration for the front end RESTful services parameters.

com.basistech.ws.local.usage.tracker.cfg

Configuration file for usage tracking.

com.basistech.ws.metrics.cfg

Configuration for AWS cloudwatch metrics. 

com.basistech.ws.rni.cfg

Configuration for name indexing.

com.basistech.ws.rnt.cfg

Configuration for name translation.

com.basistech.ws.transport.http.cfg

This configures the workers' web server's asynchronous request processing, its queuing, and failure retry.

com.basistech.ws.worker.cfg

Configuration for the location of each endpoint root as well as the native code root. It also contains configuration settings for worker threads and CloudWatch metrics.

org.apache.cxf.http.jetty-main.cfg

Configuration for CXF HTTP Jetty. CXF is Rosette's webservice framework and Jetty is its embedded webserver. Works in conjunction with com.basistech.ws.cxf.cfg.

org.apache.cxf.osgi.cfg

Configuration for Apache CXF.

Endpoint and Transport Rules Configuration Files

The following files contain configuration parameters for Rosette Server, individual endpoints, and transport rules.

Location: /server/launcher/config/rosapi

Configuration File

Purpose

constraints.yaml

Defines input constraints for Rosette: maximums for document and text input sizes as well as names deduplication list size. It is referenced by com.basistech.downloadextract.cfg.

downloaderExtractor.yaml

Provides the detailed configuration of the download/text-extractor (DTE) component. It is referenced by com.basistech.downloadextract.cfg.

transport-rules.tsv

Provides a mapping to the worker REST URL.  See Understanding the Transport Rules

worker-config.yaml

Configures the pipelines. The entries contained in this file are highly dependent on the backend code. It may be useful for identifying language support for the various endpoints as well as the associated endpoint configuration file, but should be left in its shipped state unless otherwise instructed.

xxx-factory-config.yaml

Lists the individual factory configurations, as called for by worker-config.yaml. Their contents are defined by the individual endpoint requirements. These files are where you modify the configuration for individual endpoints.

Factory Configuration Files

The worker-config.yaml file details component factories and the pipelines for each endpoint. A single endpoint may use multiple factories. Use this file to determine which factories you may have to modify to set the configuration values for a task. Some factories, such as rbl-factory-config.yaml are used by multiple endpoints.

Table 3. Factory Files

File Name

Primary Endpoint

analyze-factory-config.yaml

topics

cat-factory-config.yaml

categories

dp-factory-config.yaml

syntax/dependencies

rbl-factory-config.yaml

morphology

sentences

rct-factory-config.yaml

transliteration

relax-factory-config.yaml

relationships

rex-factory-config.yaml

entities

rex-no-resolution-factory-config.yaml

topics

entities

rli-factory-config.yaml

language

rni-dedup-factory-config.yaml

name-deduplication

rni-factory-config.yaml[a]

name-similarity

rnt-factor-config.yaml

name-translation

semantic-vectors-factory-config.yaml

semantics/vector

sent-factory-config.yaml

sentiment

similar-terms-factory-config.yaml

semantics/similar

tokenization-factory-config.yaml

tokens

topics-factory-config.yaml

topics

[a] To modify the parameters of the name-similarity endpoint, see Name Similarity Configuration Files

Disabling Licensed Endpoints

Typically, all endpoints which you have active licenses for will load and run when called. Use these instructions to disable specific endpoints.

Warning

We recommend that you do not disable the /language endpoint as it is used by many endpoints to identify the language of the request.

  1. In the server/launcher/config directory, create a file named override-endpoints.yaml listing only the endpoints that you want enabled.

    endpoints:
    - /language
    - /entities
    - /categories
    - /semantics/vector
    - /morphology
    - /sentences
    - /tokens

  2. In the server/launcher/config directory, edit the file com.basistech.ws.worker.config and specify the overrideEndpointsPathname parameter. This will be the full path name of the file you created in the previous step. For example, if you installed Rosette in the directory /Users/user/rosette-1.20.3, the parameter would be:

    overrideEndpointsPathname=/Users/user/rosette-1.20.3/server/launcher/config/override-endpoints.yaml

  3. Restart Rosette Server for the changes to take effect.

If you call a disabled endpoint, you will receive an "unknownError". For example, if you are licensed for the /topics endpoint, but disable it, a call to the endpoint will return the following JSON:

{
  "code": "unknownError",
  "message": "Worker unsupported target Endpoint{path=/topics}/eng",
  "stack": null
}

The /ping and /info endpoints are always enabled. They do not have to be listed in the override-endpoints.yaml file.

Name Similarity Configuration Files

There are two .yaml files located in the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc directory to guide you in configuring the name-similarity endpoint, parameter_defs.yaml and parameter_profiles.yaml. The parameter_defs.yaml file lists the default value for all parameters, along with a short description. This file should not be modified.

To configure the name-similarity results, change the values of the parameters in the parameter_defs.yaml file. Parameter values can be for all language pairs, or for a specific language pair. If the change is for all languages, use the any: profile. If a parameter change is for a specific language pair, use the appropriate language code pair. The two language codes are always written in alphabetical order, except for eng, which always comes last.

Example 1. Add a parameter for all languages

  1. Edit the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc/parameter_defs.yaml file.

  2. Search for any:

  3. Add parameterName: parameter value

  4. Save


Example 2. Add a parameter for Spanish-English matching

  1. Edit the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc/parameter_defs.yaml file.

  2. Search for the language combination spa_eng:

  3. Add parameterName: parameter value

  4. Save


Related articles

Comments

0 comments

Article is closed for comments.





Powered by Zendesk