Skip to content

Configuration Values

Jump to bottom
David Balash edited this page Mar 9, 2018 · 20 revisions

Herd can be customized in each environment by setting environment variables and by populating key/value pairs in the configuration table (i.e. "cnfgn"). The following tables describe the supported options, what they do, possible values that can be set, and the default value that will get used if an option is not specified. The key is specified in the "cnfgn_key_nm" column and the value is specified in the "cnfgn_value_ds" column by default or in the "cnfgn_value_cl" column for large entries if explicitly mentioned.

Environment Variables

Group Variable Name Description Values Default
Logging DM_LOG4J_OUTPUT_BASE_PATH The base path for application logs. This value will be used in the relative Log4J configuration and/or configuration override. log file location for your environment

Encrypting DM Configuration Values Using AWS CLI

All configuration options that require encryption must be encrypted using an AWS KMS encryption key. This AWS CLI example shows how to encrypt the string "mypassword" using an encryption key:

aws kms encrypt --key-id [insert your KMS key-id here] --plaintext mypassword --query CiphertextBlob --output text

Configuration Options

Database & Configuration

dm.environment
  • Encrypted: No
  • Type: DEV|QA|PROD

The herd environment name. This value will used by the Upload Single Initiation Post endpoint when building an S3 key prefix value.

org.springframework.orm.jpa.vendor.Database
  • Encrypted: No
  • Type: DB2|DERBY|H2|HSQL|INFORMIX|MYSQL|ORACLE|POSTGRESQL|SQL_SERVER|SYBASE

This defines which database type is being used as supported by Hibernate. A valid value must exist as one of the enums in this Java class.

hibernate.dialect
  • Encrypted: No
  • Type: Most dialects are contained within Hibernate's org.hibernate.dialect package. Examples: org.hibernate.dialect.Oracle10gDialect org.hibernate.dialect.MySQLDialect org.hibernate.dialect.ProgressSQL9Dialect

The hibernate dialect to use for the database. This must be the a valid Java class as supported by Hibernate.

hibernate.show_sql
  • Encrypted: No
  • Type: true|false
  • Default Value: false

A flag that determines whether SQL commands will be sent to the standard out or not. This could be set to true for debugging purposes.

herd.data.source.jndi.name
  • Encrypted: No
  • Default Value: java:comp/env/jdbc/herdDB

The JNDI name that is configured for the herd data source.

org.finra.dm.dao.ReloadablePropertySource.refreshIntervalSecs
  • Encrypted: No
  • Type: 60

This can be used to override the amount of time to wait in seconds before the application configuration settings are refreshed from the database when a configuration setting is requested. A value of "0" causes the configuration settings to be refreshed each time a setting is requested. The configured value should be a valid number. If not, an error will be logged and the previously configured value will remain.

template.token.delimiter
  • Encrypted: No
  • Type: ~

A delimiter that is used to denote individual tokens in template configurations.

field.data.delimiter
  • Encrypted: No

A delimiter that is used to delimit the field data.

field.data.delimiter.escape.char
  • Encrypted: No
  • Type: \

The escape character used to escape field data delimiter.

availability.ddl.max.partition.values
  • Encrypted: No
  • Type: A valid integer
  • Default Value: No limit

The maximum number of partition values allowed in the Business Object Data availability and DDL generation results.

db.in.clause.chunk.size
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 1000

The chunk size to use when creating database "in" clauses.

com.sun.xml.internal.bind.xmlHeaders
  • Encrypted: No
  • Default Value: '''

The JAXB XML headers to use when outputting XML from the REST tier. When this isn't set, XML 1.1 will be used: To use XML 1.0, the following could be configured: This property comes from the JAXB implementation that comes with the JDK. See com.sun.xml.internal.bind.v2.runtime.MarshallerImpl.

not.allowed.dm.endpoints
  • Encrypted: No
  • Type: Fully qualified method names in REST layer or Activiti tasks. For example, Delete business object data is currently not allowed in production environments: org.finra.dm.rest.BusinessObjectDataRestController.deleteBusinessObjectData

List of endpoints that are not allowed delimited by field.data.delimiter (|).

Logging

log4j.override.configuration
  • Encrypted: No
  • Type: A valid Log4J XML configuration.

The optional Log4J configuration override. This must be configured in the "cnfgn_value_cl" column. If specified and present at application startup, it will be used as the Log4J configuration instead of the one bundled within the herd application. If used, any subsequent changes made will automatically be picked up if the log4j.refresh.interval.millis configuration is not 0. This value is only retrieved at application startup.

log4j.override.resource.location
  • Encrypted: No
  • Type: A valid resource URL.

If the database Log4J configuration isn't being used (i.e. the log4j.override.configuration key), this key specifies a secondary optional resource location where a Log4J override configuration can be found (e.g. a file resource URL). This value is only retrieved at application startup.

log4j.refresh.interval.millis
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 60000

A refresh interval in milliseconds that will be used to monitor the Log4J configuration for changes. If changes are found, the Log4J configuration will be re-initialized with the changes. If 0 is specified, changes will not be monitored. This value is only retrieved at application startup.

Thread Pool

thread.pool.core.pool.size
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 5

The initial number of threads in the thread pool.

thread.pool.max.pool.size
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 10

The maximum number of threads to allow in the thread pool.

thread.pool.keep.alive.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 60

The number of seconds to elapse before threads may remain idle before being terminated.

JMS Listener

jms.listener.pool.concurrency.limits
  • Encrypted: No
  • Type: "lower-upper" String, e.g. "5-10". DefaultMessageListenerContainer#setConcurrency
  • Default Value: 3-10

JMS listener concurrency limits.

Spring Caching

dm.cache.time.to.live.seconds
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 300

The time to live for an element in seconds before it expires.

dm.cache.time.to.idle.seconds
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 0

The time to idle for an element in seconds before it expires.

dm.cache.max.elements.in.memory
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 10000

The maximum number of elements to be held in memory.

dm.cache.memory.store.eviction.policy
  • Encrypted: No
  • Type: Defined in net.sf.ehcache.store.MemoryStoreEvictionPolicy (LRU, LFU, FIFO)
  • Default Value: LRU

The eviction policy.

System Jobs

org.quartz.jobStore.driverDelegateClass
  • Encrypted: No
  • Type: Defined here Example: Postgre: org.quartz.impl.jdbcjobstore.PostgreSQLDelegate Oracle: org.quartz.impl.jdbcjobstore.oracle.OracleDelegate

The quartz driver delegate class, that works with the quartz database.

system.jobs.thread.pool.thread.count
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 5

This is the number of threads that are available for concurrent execution of system jobs.

file.upload.cleanup.job.cron.expression
  • Encrypted: No
  • Type: A valid cron expression
  • Default Value: 0 0 1 * * ?

The cron expression to schedule "fileUploadCleanup" system job.  For more information please see ac:link/ri:page/ac:link.  Default is to run the system job every night at 1 AM.

file.upload.cleanup.job.threshold.minutes
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 4320

The expiration time in minutes to be used to select dangling business object data S3_MANAGED_LOADING_DOCK records and orphaned multi-part upload parts for deletion.  Only the dangling business object data records and all orphaned multi-part upload parts that are older than this amount of time will be deleted by the job.  The default is 4320 minutes (3 days).

jms.publishing.job.cron.expression
  • Encrypted: No
  • Type: A valid cron expression
  • Default Value: 0 0/5 * * * ?

The cron expression to schedule "jmsPublishing" system job.  For more information please see ac:link/ri:page/ac:link.  Default is to run the system job every 5 minutes.

Jobs

activiti.job.definition.id.template
  • Encrypted: No
  • Type:  A valid template for Job Definition Id
  • Default Value:  namespace.jobName

The template that is used to construct the activiti job definition Id. The token delimiter is configured separately using the "template.token.delimiter" configuration option. The following tokens are supported: namespace, jobName

jobs.query.max.results
  • Encrypted: No
  • Type:  A valid integer
  • Default Value: 1000

The maximum number of results that are allowed to be returned when getting a list of jobs.

AWS & S3

http.proxy.hostname
  • Encrypted: No

The HTTP proxy hostname to be used by the application to communicate with AWS S3.

http.proxy.port
  • Encrypted: No

The HTTP proxy port to be used by the application to communicate with AWS S3.

s3.endpoint
  • Encrypted: No
  • Default Value: The Amazon S3 default.

The optional Amazon S3 endpoint to use when making S3 service calls. http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

s3.managed.bucket.name
  • Encrypted: No

The S3 managed bucket name that is used to determine which bucket should be used when writing to the S3 managed storage location. This will vary from environment to environment (e.g. 1234-4321-1234-herd). This value is required. This value is no longer supported as of version 0.2.0. Instead, the bucket.name attribute on the storage is used instead.

s3.attribute.name.bucket.name
  • Encrypted: No
  • Default Value: bucket.name

The optional S3 storage attribute key name to use for the name of the bucket associated with the storage. This is required if file existence validation is configured for the storage.

s3.attribute.name.validate.path.prefix
  • Encrypted: No
  • Default Value: validate.path.prefix

The optional S3 storage attribute key name to use when specifying whether path prefix validation is required.

s3.attribute.name.validate.file.existence
  • Encrypted: No
  • Default Value: validate.file.existence

The optional S3 storage attribute key name to use when specifying whether file existence validation is required.

s3.attribute.name.upload.role.arn
  • Encrypted: No
  • Default Value: upload.role.arn

The uploader role ARN storage attribute name for use with GetBusinessObjectDataUploadCredential.

s3.attribute.name.upload.session.duration.secs
  • Encrypted: No
  • Default Value: upload.session.duration.secs

The uploader session duration in seconds storage attribute name for use with GetBusinessObjectDataUploadCredential.

s3.attribute.name.download.role.arn
  • Encrypted: No
  • Default Value: download.role.arn

The downloader role ARN storage attribute name for use with GetBusinessObjectDataDownloadCredential.

s3.attribute.name.download.session.duration.secs
  • Encrypted: No
  • Default Value: download.session.duration.secs

The downloader session duration in seconds storage attribute name for use with GetBusinessObjectDataDownloadCredential.

s3.attribute.name.kms.key.id
  • Encrypted: No
  • Default Value: kms.key.id

The storage attribute name which specifies the KMS key ID to use to encrypt/decrypt objects in the bucket.

s3.key.prefix.template
  • Encrypted: No
  • Default Value: namespace/ dataProviderName/ businessObjectFormatUsage/ businessObjectFormatFileType/ businessObjectDefinitionName/ frmt-vbusinessObjectFormatVersion/ data-vbusinessObjectDataVersion/ businessObjectFormatPartitionKey=businessObjectDataPartitionValue

The template that is used to construct the S3 key prefix. The token delimiter is configured separately using the "template.token.delimiter" configuration option. The following tokens are supported: namespace dataProviderName businessObjectDefinitionName businessObjectFormatUsage businessObjectFormatFileType businessObjectFormatVersion businessObjectFormatPartitionKey businessObjectDataVersion businessObjectDataPartitionValue

file.upload.s3.key.prefix.template
  • Encrypted: No
  • Type: A valid S3 key prefix with acceptable tokens.
  • Default Value: environment/ namespace/ businessObjectDataPartitionValue

The template that is used the Upload Single Initiation Post endpoint to construct the S3 key prefix. The token delimiter is configured separately using the "template.token.delimiter" configuration option. The following tokens are supported: environment namespace businessObjectDataPartitionValue

aws.min.retry.delay.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 1

The minimum delay in seconds that will be waited before retrying an AWS operation when a retryable exception occurs. The actual delay between retries increases exponentially until  the maximum delay is reached.

aws.max.retry.delay.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 60

The maximum delay in seconds that will be waited before retrying an AWS operation when a retryable exception occurs. The actual delay between retries increases exponentially until  the maximum delay is reached.

aws.s3.exception.max.retry.duration.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 245

The maximum duration in seconds that a failed AWS S3 operation will be retried for.

aws.emr.exception.max.retry.duration.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 245

The maximum duration in seconds that a failed AWS EMR operation will be retried for.

aws.ec2.exception.max.retry.duration.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 245

The maximum duration in seconds that a failed AWS EC2 operation will be retried for.

aws.sts.exception.max.retry.duration.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 245

The maximum duration in seconds that a failed AWS STS operation will be retried for.

aws.sqs.exception.max.retry.duration.secs
  • Encrypted: No
  • Type: A valid integer
  • Default Value: 245

The maximum duration in seconds that a failed AWS SQS operation will be retried for.

aws.s3.retry.on.error.codes
  • Encrypted: No

The error codes delimited by field.data.delimiter (|) in AmazonServiceException that we re-try on for S3 operations.

aws.emr.retry.on.error.codes
  • Encrypted: No

The error codes delimited by field.data.delimiter (|) in AmazonServiceException that we re-try on for EMR operations.

aws.ec2.retry.on.error.codes
  • Encrypted: No

The error codes delimited by field.data.delimiter (|) in AmazonServiceException that we re-try on for EC2 operations.

aws.sts.retry.on.error.codes
  • Encrypted: No

The error codes delimited by field.data.delimiter (|) in AmazonServiceException that we re-try on for STS operations.

aws.sqs.retry.on.error.codes
  • Encrypted: No

The error codes delimited by field.data.delimiter (|) in AmazonServiceException that we re-try on for SQS operations.

aws.loading.dock.uploader.role.arn
  • Encrypted: No
  • Type: A valid Amazon Resource Name.

The Amazon Resource Name (ARN) of the role that is required to provide access to the S3_MANAGED_LOADING_DOCK storage. This value is required.

aws.loading.dock.uploader.role.duration.secs
  • Encrypted: No
  • Type: A valid time interval in seconds.  The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour).
  • Default Value: 900

The duration, in seconds, of the role session to access the S3_MANAGED_LOADING_DOCK storage. This is the amount of time the temporary upload or extended upload credentials are valid for before they will expire and need to be refreshed. Note that this value should ideally be lower than the application server session timeout to ensure that continuous extend credential API calls won't fail because the session timed out.

aws.kms.loading.dock.key.id
  • Encrypted: No

The AWS Key Management Service (KMS) unique identifier for the key to be used for encryption when uploading files to S3_MANAGED_LOADING_DOCK storage. This value is required.

aws.kms.external.key.id
  • Encrypted: No

The AWS Key Management Service (KMS) unique identifier for the key to be used for encryption when copying files to S3_MANAGED_EXTERNAL storage. This value is required.

aws.external.downloader.role.arn
  • Encrypted: No
  • Type:  A valid Amazon Resource Name.

The Amazon Resource Name (ARN) of the role that is required to provide access to the S3_MANAGED_EXTERNAL storage. This value is required.

aws.external.downloader.role.duration.secs
  • Encrypted: No
  • Type: A valid time interval in seconds.  The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour).
  • Default Value:  3600

The duration, in seconds, of the role session to access the S3_MANAGED_EXTERNAL storage.

aws.s3.default.upload.session.duration.secs
  • Encrypted: No
  • Type: A valid time interval in seconds. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour).
  • Default Value:  3600

The session duration in seconds for GetBusinessObjectDataUploadCredential API for any storage, if the storage does not have a session duration configured in its attributes.

aws.s3.default.download.session.duration.secs
  • Encrypted: No
  • Type: A valid time interval in seconds. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour).
  • Default Value:  3600

The session duration in seconds for GetBusinessObjectDataDownloadCredential API for any storage, if the storage does not have a session duration configured in its attributes.

EMR

emr.cluster.name.template
  • Encrypted: No
  • Type: A valid EMR cluster name with acceptable tokens.
  • Default Value: namespace.emrDefinitionName.clusterName

The template that is used to construct the EMR cluster name. The token delimiter is configured separately using the "template.token.delimiter" configuration option. The following tokens are supported: namespace emrDefinitionName clusterName

max.emr.instance.count
  • Encrypted: No
  • Type: 1000

The maximum number of instances allowed in EMR cluster (including master, core and task).

mandatory.aws.tags
  • Encrypted: No
  • Type: Delimited AWS tag names.

Mandatory AWS tags for instances. The token delimiter is configured separately using the "template.token.delimiter" configuration option.

s3.staging.bucket.name
  • Encrypted: No

The S3 staging bucket name where DM scripts are stored. This will vary from environment to environment (e.g. bucket-name-application-staging). This value is required.

s3.staging.resources.base
  • Encrypted: No

Prefix for the ${S3_STAGING_RESOURCE_LOCATION} variable

s3.url.protocol
  • Encrypted: No
  • Default Value: s3://

S3 protocol name to form the S3 URL for EMR bootstrapping scripts

s3.path.delimiter
  • Encrypted: No
  • Default Value: /

Delimiter for forming the S3 URL for EMR bootstrapping scripts

emr.aws.valid.states
  • Encrypted: No
  • Type: STARTING|BOOTSTRAPPING|RUNNING|WAITING

Cluster states for the active clusters

emr.aws.node.condition
  • Encrypted: No
  • Default Value: instance.isMaster=true

Condition to be passed to execute the bootstrapping script only on the Master node

emr.aws.node.conditional.script
  • Encrypted: No
  • Default Value: s3://elasticmapreduce/bootstrap-actions/run-if

Conditional script provided Amazon to execute only on the Master node

emr.aws.configure.daemon
  • Encrypted: No
  • Default Value: s3://elasticmapreduce/bootstrap-actions/configure-daemons

Hadoop daemon configuration script provided by Amazon

emr.spot.price.history.product.descriptions
  • Encrypted: No
  • Release: 0.19.0

The list of product descriptions to filter by when looking up EMR spot price history. The list is delimited by the character specified by "field.data.delimiter"

emr.aws.configure.hadoop
  • Encrypted: No
  • Default Value: s3://us-east-1.elasticmapreduce/bootstrap-actions/configure-hadoop

Hadoop parameter configuration script provided by Amazon

emr.aws.run.shell.script.jar
  • Encrypted: No
  • Default Value: s3://elasticmapreduce/libs/script-runner/script-runner.jar

Jar provided by Amazon to run shell scripts in the cluster

emr.encryption.script
  • Encrypted: No
  • Default Value: scripts/bootstrap/encrypt_disks.sh

Encryption script used for EMR cluster

emr.oozie.script
  • Encrypted: No
  • Default Value: scripts/bootstrap/install_oozie.sh

Oozie installation script used for EMR cluster

emr.oozie.tar
  • Encrypted: No
  • Default Value: scripts/bootstrap/oozie-4.0.1-distro.tar

Ooize tarball

emr.oozie.dm.wrapper.workflow.s3.location
  • Encrypted: No

The folder on S3 where the herd wrapper workflow will exist. This is a required value.

emr.oozie.dm.wrapper.workflow.hdfs.location
  • Encrypted: No
  • Default Value: /user/hadoop/datamgmt/oozie_wrapper/

 The folder on HDFS where the herd wrapper workflow is copied to.

emr.s3.hdfs.copy.script
  • Encrypted: No

S3 to HDFS copy script. Used to copy /herd wrapper workflow and client workflow to HDFS. Required Value.

emr.oozie.url.template
  • Encrypted: No
  • Default Value: http://:11000/oozie/

The oozie url template, used to access oozie on EMR.

emr.dm.support.security.group
  • Encrypted: No

The DM EMR support security group. This group is added to EMR master node to apply additional security rules. Presently it is used to open incoming traffic on oozie port 11000.

emr.s3.staging.resources.location
  • Encrypted: No
  • Type: ${S3_STAGING_RESOURCE_LOCATION}
  • Default Value: ${S3_STAGING_RESOURCE_LOCATION}

Name of the Replacement variable ${S3_STAGING_RESOURCE_LOCATION} in the config xml file

emr.oozie.run.script
  • Encrypted: No
  • Default Value: scripts/bootstrap/run_oozie.sh

Oozie run script to invoke Oozie client on the EMR Master to schedule the job

emr.oozie.jobs.to.include.in.cluster.status
  • Encrypted: No

The number of RUNNING Oozie jobs to return with EMR cluster status.

emr.aws.shell.script.jar
  • Encrypted: No
  • Default Value: s3://elasticmapreduce/libs/script-runner/script-runner.jar

Jar provided by AWS to run a shell script in the cluster as a EMR step

emr.default.ec2.node.iam.profile.name
  • Encrypted: No

The default value for EMR cluster definition's ec2NodeIamProfileName EMR Cluster Definition_

emr.default.service.iam.role.name
  • Encrypted: No

The default value for EMR cluster definition's serviceIamRole EMR Cluster Definition_

Security

security.enabled.spel.expression
  • Encrypted: No
  • Type: false

SpEL expression that must evaluate to a boolean value, request(javax.servlet.http.HttpServletRequest) is made available as variable in the expression evaluation context. When this value evaluates to "true", the security is turned on. e.g. "true" � to enable security for all requests. "false" to disable security for all requests. Note that all request's user will be TRUSTED_USER in the audit. �#request.scheme == 'https'� � to turn on security for https protocol.

security.http.header.implementation
  • Encrypted: No
  • Type: A valid boolean value( "true" or "false")
  • Default Value: false

Indicates whether to use http header based security.

security.http.header.names
  • Encrypted: No
  • Type: " delimited. The following headers need to be defined: useridHeader firstNameHeader lastNameHeader emailHeader rolesHeader sessionInitTimeHeader
  • Default Value: useridHeader=userprincipalname|firstNameHeader=ctfirstname|lastNameHeader=ctlastname|emailHeader=ctemail|memberofHeader=memberof|sessionInitTimeHeader=ct-session-init-time

The http header values that are used to build user. These are "

security.http.header.role.regex
  • Encrypted: No
  • Type: A valid regex, or blank to disable using multiple roles
  • Default Value: CN=(?[^,]+)

The regular expression used to parse a single role from the header value defined in security.http.header.names's rolesHeader. This regex will be matched against the configured header value until no more matches are found. If a security.http.header.role.regex.group value is configured, the regex must define a group name of the value given in security.http.header.role.regex.group, which will be used as the role. If security.http.header.role.regex.group is not configured, the entire match will be used as the role.

security.http.header.role.regex.group
  • Encrypted: No
  • Type: A string, or blank to use entire match as the role
  • Default Value: role

A named group to use to extract the role name from the match from the regex defined in security.http.header.role.regex.

ESB

dm.notification.sqs.enabled
  • Encrypted: No
  • Type: A valid boolean value( "true" or "false")
  • Default Value: false

Indicates whether the ESB consumable herd events are posted to AWS SQS.

dm.notification.sqs.outgoing.queue.name
  • Encrypted: No
  • Type: A name for an already existing AWS SQS queue that (TBD) herd AWS account has permisssion to write to.

AWS SQS queue name where ESB consumable herd events are posted to.

dm.notification.sqs.application.name
  • Encrypted: No
  • Type: Herd

The application name to be used when posting ESB consumable herd events to SQS.

dm.notification.sqs.environment
  • Encrypted: No
  • Type: Development|Integration|Production

The environment name to be used when posting ESB consumable herd events to SQS.

dm.notification.sqs.xsd.name
  • Encrypted: No
  • Type: The XSD file name to be used when posting ESB consumable herd events to SQS.
  • Default Value: datamgt-typesV01.xsd
dm.notification.sqs.sys.monitor.request.xpath.properties
  • Encrypted: No
  • Type: A valid properties formatted string. Ensure the keys don't contain periods (.) since they can't be referenced within the velocity template (i.e. they are used to indicate a sub-property or sub-method).
  • Default Value: incoming_message_correlation_id=/monitor/header/correlation-id incoming_message_context_message_type=/monitor/payload/contextMessageTypeToPublish

Properties of keys to XPath expressions that are applied to an incoming system monitor request message to set variables in the velocity context that can be used when building a system monitor response message. The keys are the keys that will be set in the velocity context and the values should be valid XPath expressions. This configuration value doesn't need to be set if incoming system monitor request messages are not processed by the system.

dm.notification.sqs.sys.monitor.response.velocity.template
  • Encrypted: No
  • Type: A valid velocity template. The velocity context will be populated with the following properties that can be referenced from within the velocity template: org.apache.commons.lang3.StringUtils class org.apache.commons.collections.CollectionUtils class dm_notification_sqs_environment: The "environment" configuration entry current_time: The current date/time as a String in XMLGregorianCalendar format. uuid: A universally unique identifier created using UUID.randomUUID() username: The username of the currently logged in user. In addition, the keys that are defined using the "dm.notification.sqs.sys.monitor.request.xpath.properties" configuration entry are available.

The velocity template that is used to generate the system monitor response message.

dm.notification.sqs.business.object.data.status.change.velocity.template
  • Encrypted: No
  • Type: A valid velocity template. The velocity context will be populated with the following properties that can be referenced from within the velocity template: org.apache.commons.lang3.StringUtils class. org.apache.commons.collections.CollectionUtils class. dm_notification_sqs_environment: The "environment" configuration entry current_time: The current date/time as a String in XMLGregorianCalendar format uuid: A universally unique identifier created using UUID.randomUUID(). username: The username of the currently logged in user. businessObjectDataKey: The business object data key. newBusinessObjectDataStatus: The new business object data status. oldBusinessObjectDataStatus: The optional old business object data status. No value will be present if there was no previous status. businessObjectDataId: The business object data Id.

The velocity template that is used to generate the business object data status change message.

JDBC Service

jdbc.max.statements
  • Encrypted: No
  • Type: Integer

The maximum number of statements that are allowed to be requested for execution. If not specified, the number of statements will not be limited.

jdbc.result.max.rows
  • Encrypted: No
  • Type: Integer

The maximum number of rows returned from a QUERY statement. If not specified, the number of rows will not be limited.

Elasticsearch search index

credstash.aws.region.name
  • Encrypted: No
  • Type: String
  • Default Value: us-east-1

This value is only needed when connecting to the Elasticsearch cluster REST client via https. The AWS region where the credstash is located.

credstash.table.name
  • Encrypted: No
  • Type: String
  • Default Value: credential-store

This value is only needed when connecting to the Elasticsearch cluster REST client via https. The name of the table in the credstash database where the credentials are stored.

credstash.encryption.context
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"AGS":"AGS_VALUE","SDLC":"SDLC_VALUE","Component":"COMPONENT_VALUE"}

This value is only needed when connecting to the Elasticsearch cluster REST client via https. The encryption context is used when obtaining credentials from credstash.

elasticsearch.bdef.document.type
  • Encrypted: No
  • Type: String
  • Default Value: doc

The document type of the business object definition Elasticsearch index.

elasticsearch.bdef.index.name
  • Encrypted: No
  • Type: String
  • Default Value: bdef

The name of the business object definition Elasticsearch index.

elasticsearch.bdef.mappings.json
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"properties": { "id": { "type": "long" } } }
  • Note: This value is a CLOB (Character large object) and is stored in the cnfgn_value_cl column in the cnfgn table.
  • Recommended Value: BDEF MAPPINGS JSON

The mappings file for the business object definition Elasticsearch index. This must be configured in the "cnfgn_value_cl" column.

elasticsearch.bdef.settings.json
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"analysis":{"filter":{"field_ngram_filter":{"type":"edgeNGram","min_gram":1,"max_gram":16,"side":"front"}}}}
  • Note: This value is a CLOB (Character large object) and is stored in the cnfgn_value_cl column in the cnfgn table.
  • Recommended Value: BDEF SETTINGS JSON

The settings file for the business object definition Elasticsearch index. This must be configured in the "cnfgn_value_cl" column.

elasticsearch.best.fields.query.boost
  • Encrypted: No
  • Type: Float
  • Default Value: 1.0f

The Elasticsearch boost value for the best fields query.

elasticsearch.column.match.highlight.fields
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"fields": ["*"]}

Fields on which highlighting should be done when the column match is used.

elasticsearch.highlight.fields
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"fields": ["*"]}

Fields on which highlighting should be done, defaults to all fields.

elasticsearch.highlight.posttags
  • Encrypted: No
  • Type: String
  • Default Value: </hlt>

Post-tags used for highlighting.

elasticsearch.highlight.pretags
  • Encrypted: No
  • Type: String
  • Default Value: <hlt class="highlight">

Pre-tags used for highlighting.

elasticsearch.phrase.prefix.query.boost
  • Encrypted: No
  • Type: Float
  • Default Value: 1.0f

The Elasticsearch boost value for the phrase prefix query.

elasticsearch.phrase.query.boost
  • Encrypted: No
  • Type: Float
  • Default Value: 1.0f

The Elasticsearch boost value for the phrase query.

elasticsearch.rest.client.hostname
  • Encrypted: No
  • Type: String
  • Default Value: localhost

The hostname used when connecting via REST to the Elasticsearch cluster.

elasticsearch.rest.client.port
  • Encrypted: No
  • Type: Integer
  • Default Value: 9200

The port number used when connecting via REST to the Elasticsearch cluster.

elasticsearch.rest.client.scheme
  • Encrypted: No
  • Type: String
  • Default Value: http

The schema used when connecting via REST to the Elasticsearch cluster.

elasticsearch.rest.client.usercredentialname
  • Encrypted: No
  • Type: String
  • Default Value: null

This value is only needed when connecting to the Elasticsearch cluster REST client via https. The user credential name used when connecting to credstash to obtain the password used when connecting to the Elasticsearch cluster REST client via ssl.

elasticsearch.rest.client.username
  • Encrypted: No
  • Type: String
  • Default Value: null

This value is only needed when connecting to the Elasticsearch cluster REST client via https. The username used when connecting to the Elasticsearch cluster REST client via ssl.

elasticsearch.searchable.fields.ngrams
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"*.ngrams": "1.0"}

The fields in the Elasticsearch indexes that will be searched during an ngram match query.

elasticsearch.searchable.fields.shingles
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"*.shingles": "1.0"}

The fields in the Elasticsearch indexes that will be searched during an shingles match query.

elasticsearch.searchable.fields.stemmed
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"*.stemmed": "1.0"}

The fields in the Elasticsearch indexes that will be searched during an stemmed match query.

elasticsearch.tag.document.type
  • Encrypted: No
  • Type: String
  • Default Value: doc

The document type of the tag (aka. category) Elasticsearch index.

elasticsearch.tag.index.name
  • Encrypted: No
  • Type: String
  • Default Value: tag

The name of the tag (aka. category) Elasticsearch index.

elasticsearch.tag.mappings.json
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"properties": { "id": { "type": "long" } } }
  • Note: This value is a CLOB (Character large object) and is stored in the cnfgn_value_cl column in the cnfgn table.
  • Recommended Value: TAG MAPPINGS JSON

The mappings file for the tag (aka. category) Elasticsearch index. This must be configured in the "cnfgn_value_cl" column.

elasticsearch.tag.settings.json
  • Encrypted: No
  • Type: JSON String
  • Default Value: {"analysis":{"filter":{"field_ngram_filter":{"type":"edgeNGram","min_gram":1,"max_gram":16,"side":"front"}}}}
  • Note: This value is a CLOB (Character large object) and is stored in the cnfgn_value_cl column in the cnfgn table.
  • Recommended Value: TAG SETTINGS JSON

The settings file for the tag (aka. category) Elasticsearch index. This must be configured in the "cnfgn_value_cl" column.

herd Logo

Clone this wiki locally