Smile CDR v2022.11.PRE
On this page:
   38.80    LDAP Authentication 38.82    MDM   

38.81Lucene FullText Indexing

 

The Lucene FullText Indexing configuration category includes the following configurable options:

  • Lucene Index Directory

  • Elasticsearch/OpenSearch AWS Region.

  • Elasticsearch Index Prefix

  • ElasticSearch Password

  • ElasticSearch URL protocol. Either http or https

  • ElasticSearch Host URLs.

  • ElasticSearch Username

  • Enable FullText Content Index

  • Enable Indexing of Search Parameters (experimental)

  • Store resource bodies in Lucene (experimental)

  • Enable Terminology Index

  • Lucene Indexing Provider

  • Lucene Indexing Enabled

38.81.1Property: Lucene Index Directory

 
Property Name Lucene Index Directory
Property Key
Property Type LOCAL_FILEDIR
Description This is the local directory where Lucene will put its index files when operating in LUCENE_DISK mode. This can be an absolute path, or a relative path (treated as relative to the base of the Smile CDR installation).
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.hibernate_search.directory = 

38.81.2Property: Elasticsearch/OpenSearch AWS Region.

 
Property Name Elasticsearch/OpenSearch AWS Region.
Property Key
Property Type STRING
Description The AWS Region if using AWS-managed Elasticsearch/OpenSearch. If this is set, authentication will be attempted via the DefaultCredentialsProviderChain using the AWS SDK. However, you can force static credentials of Access Key and Secret Key by putting them into the username and password fields, respectively.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.aws_region = 

38.81.3Property: Elasticsearch Index Prefix

 
Property Name Elasticsearch Index Prefix
Property Key
Property Type STRING
Description If set, all indexes created by elasticsearch will be prefixed with the provided value, followed by a hyphen."
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.index_prefix = 

38.81.4Property: ElasticSearch Password

 
Property Name ElasticSearch Password
Property Key
Property Type PASSWORD
Description The password to use for connections to the ElasticSearch cluster.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.password = 

38.81.5Property: ElasticSearch URL protocol. Either http or https

 
Property Name ElasticSearch URL protocol. Either http or https
Property Key
Property Type STRING
Description Whether the server to be connected to uses http or https.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value http
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.protocol = http

38.81.6Property: ElasticSearch Host URLs.

 
Property Name ElasticSearch Host URLs.
Property Key
Property Type STRING
Description A comma-delimited list of the connection URLs to use for connections to the ElasticSearch cluster.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value localhost:9090
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.url = localhost:9090

38.81.7Property: ElasticSearch Username

 
Property Name ElasticSearch Username
Property Key
Property Type STRING
Description The username to use for connections to the ElasticSearch cluster.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value (no default)
Example Property
module.[MODULE_ID].config.db.hibernate_search.elasticsearch.username = 

38.81.8Property: Enable FullText Content Index

 
Property Name Enable FullText Content Index
Property Key
Property Type BOOLEAN
Description Should the system index FullText Content on the resources stored in the repository. See Indexes for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.db.hibernate_search.index.fulltext_content = false

38.81.9Property: Enable Indexing of Search Parameters (experimental)

 
Property Name Enable Indexing of Search Parameters (experimental)
Property Key
Property Type BOOLEAN
Description Enables the indexing of token, string, and other search parameters in the Lucene Index. Reindexing could be required. See Indexes for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.db.hibernate_search.index.search_params = false

38.81.10Property: Store resource bodies in Lucene (experimental)

 
Property Name Store resource bodies in Lucene (experimental)
Property Key
Property Type BOOLEAN
Description Enables storing all data needed to load a resource in the Lucene Index. Reindexing could be required. See Indexes for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.db.hibernate_search.index.store_resources = false

38.81.11Property: Enable Terminology Index

 
Property Name Enable Terminology Index
Property Key
Property Type BOOLEAN
Description Should the system index terminology (i.e. CodeSystem) content in the Lucene Index. See Indexes for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.db.hibernate_search.index.terminology = true

38.81.12Property: Lucene Indexing Provider

 
Property Name Lucene Indexing Provider
Property Key
Property Type ENUM
Values
  • LUCENE_DISK
  • LUCENE_MEMORY
  • ELASTICSEARCH
Description Specifies which provider will be used. See Lucene Providers for information on the available options.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value LUCENE_DISK
Example Property
module.[MODULE_ID].config.db.hibernate_search.mode = LUCENE_DISK

38.81.13Property: Lucene Indexing Enabled

 
Property Name Lucene Indexing Enabled
Property Key
Property Type BOOLEAN
Description If enabled, Lucene will be used for indexing (default is disabled). Lucene can be used to provide fulltext searching, and enhances the capabilities of the Smile CDR Terminology Services.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.lucene.enabled = false
   38.80    LDAP Authentication 38.82    MDM