ElasticSearch extension - Compatible with OpenSearch

Plugin ID

The plugin ID for Apache ActiveMQ is fr.cantor.c4i.ElasticSearchDelivery.

Properties

Environment independent parameters (set in extension configuration or properties file)

Property keyDescriptionMandatoryDefault value
configAssetIdThe ID of the asset containing the YAML mappingsYes
connectionThe name of the connection in the c4i.properties fileYes
prefixIndexNamesWithContextIdtrue or false to indicate whether or not to prefix the index names with the context IDsYes
batchSizeThe maximum number of elements to send in a single queryYes
deleteElementsNotMatchingFilterstrue or false to indicate if elements not matching filters should be deleted from the databaseNofalse
cacheConfigThe ID of the asset containing the JCS configurationNo
displayPerfStattrue to display performance statistics (see Performance statistics dedicated page)Nofalse

Environment dependent parameters (set in centralized c4i.properties file)

Property keyDescriptionMandatoryDefault value
hostURL of the ElasticSearch instance, without the portYes
portThe port to connect to the ElasticSearch instanceYes
usernameThe username to connect to the ElasticSearch instance, or AWS Access KeyNo
passwordThe password to connect to the ElasticSearch instance in standalone mode only, or AWS Secret KeyNo
enableSsltrue enables TLS/SSL connection.Nofalse
compatibilityELASTICSEARCH or OPENSEARCHNoELASTICSEARCH
authenticationModeNONE, PASSWORD, AWS_SECRET_KEY or OAUTH2_CLIENT_CREDENTIALSNoNONE
oAuth2TokenEndpointThe endpoint to retrieve the OAuth2 tokenNo
oAuth2ScopeThe OAuth2 token scopeNo
pathPrefixThe URL prefix before the API URINo

Configuration example

extensions.[0].pluginId=fr.cantor.c4i.ElasticSearchDelivery
extensions.[0].configAssetId=C4I-Configuration
extensions.[0].connection=elasticSearch
extensions.[0].prefixIndexNamesWithContextId=true
extensions.[0].deleteElementsNotMatchingFilters=true
extensions.[0].batchSize=100
pluginId=fr.cantor.c4i.ElasticSearchDelivery
connection=elasticsearch
configAssetId=/Path/to/C4I/Configuration.yml
prefixIndexNamesWithContextId=true
deleteElementsNotMatchingFilters=true
licenseAssetId=/Path/to/C4I/License.cat
batchSize=100
cacheConfig=/Path/to/JCS/Config.ccf
elasticsearch.host=localhost
elasticsearch.port=9200
elasticsearch.username=c4i
elasticsearch.password=secure_password
elasticsearch.enableSsl=false
elasticsearch.compatibility=ELASTICSEARCH
elasticsearch.authenticationMode=OAUTH2_CLIENT_CREDENTIALS
elasticsearch.oAuth2TokenEndpoint=https://my-oauth2-endpoint.com/auth/realms/myrealm/protocol/openid-connect/token
elasticsearch.oAuth2Scope=my-custom-scope
elasticsearch.pathPrefix=v1
opensearch.host=mydomain-opensearch-tdfvjn2xk7vewapaigbkadzo6y.us-east-1.es.amazonaws.com
opensearch.port=442
opensearch.username=AKIAZRH4PHFLLQB4CMO6
opensearch.password=secure_access_key
opensearch.enableSsl=true
opensearch.compatibility=OPENSEARCH
opensearch.authenticationMode=AWS_SECRET_KEY
opensearch.pathPrefix=v1
Last Updated: