Tenant Configuration Parameters Reference
Learn about the configurable parameters available at the tenant level in Reltio and how they influence storage, search, relations, streaming, and operational behavior.
Tenant-level configuration parameters define how Reltio manages data storage, search indexing, relations, crosswalks, streaming, lifecycle actions, and logging for a tenant. This topic summarizes the configurable parameters from the Tenant Storage Management API that can be safely exposed in public documentation.
Use this topic as a high-level reference and consult the linked configuration and API topics at the end of each section for implementation details and examples.
Administrative and General Tenant Properties
These parameters identify the tenant and control general operational behavior.
| Parameter | Description | Type | Default |
|---|---|---|---|
| tenantId | Unique identifier of the tenant. | String | Required |
| tenantName | Human-readable name of the tenant; defaults to tenantId if omitted. | String | None |
| customerName | Name of the customer organization associated with the tenant. | String | None |
| ownerEmails | List of tenant owner email addresses notified about configuration actions. | Array | None |
| maxRequestsPerCluster | Maximum number of concurrent requests processed per cluster for this tenant. | Integer | Unlimited |
| maxPeriodicTasksPerTenant | Maximum number of periodic tasks allowed to run for the tenant. | Integer | None |
| immutableRefAttrsByDefault | Specifies whether reference attributes are treated as immutable unless explicitly configured otherwise. | Boolean | false |
| useActivityLogInTasks | Enables use of the activity log as a data source for tasks and processing. | Boolean | false |
For more information about tenant-level setup, see Tenant Configuration at a glance.
Storage and History Configuration
These parameters influence database storage behavior, history handling, and object limits for the tenant.
| Parameter | Description | Type | Default |
|---|---|---|---|
| dataStorageConfig | Defines primary data storage configuration for the tenant. | JSON | Required |
| historyDataStorageMode | Controls whether history data is stored in normal or compact mode. | String | standard |
| interactionTtl | Time-to-live for interactions, after which they may be purged from storage. | Integer | None |
| eventsSizeLimit | Maximum serialized size of event messages published for the tenant. | Long | Unlimited |
| maxChangedObjects | Maximum number of entity changed events generated from a single operation. | Integer | -1 (unlimited) |
| updateAttributesEntitiesBatchSize | Number of entities processed per batch for attribute updates. | Integer | None |
| interactionTtl | Configures retention period of interaction objects before deletion. | Integer | None |
For details on storage options, see Configuration API.
Search and Index Configuration
These parameters control search index structure, performance tuning, and indexing behavior.
| Parameter | Description | Type | Default |
|---|---|---|---|
| searchStorageConfiguration | Defines configuration of search indices, shards, and replicas. | JSON | Required |
| waitForAllShards | Waits for all shards to be available before returning index operations. | Boolean | true |
| prefixSearchMaxExpansions | Maximum term expansions allowed for prefix searches. | Integer | 50 |
| maxAttributeLength | Maximum length of attribute text stored in the search index. | Integer | None |
| preserveCursor | Preserves search cursor between paginated requests. | Boolean | false |
| indexRDMLookups | Enables indexing of RDM lookups for search. | Boolean | false |
| indexOnlySearchableAttributes | Indexes only attributes marked as searchable. | Boolean | false |
| indexOvStrategy | Defines strategy for indexing operational values versus all values. | String | OV_ONLY |
| indexMLRules | Includes machine learning rules in the index where applicable. | Boolean | false |
| indexActivityDelta | Enables indexing of activity delta information. | Boolean | false |
| indexRefreshInterval | Frequency at which the index is refreshed. | String | 1s |
| useSingleIndex | Uses a single shared index for all entity types. | Boolean | false |
| refreshIndexOnInserts | Refreshes the index immediately after insert operations. | Boolean | false |
| maxNumberOfResults | Maximum number of search results returned in a single query. | Integer | 10000 |
| numberOfShards | Number of primary shards for main search indices. | Integer | 5 |
| numberOfRelationsShards | Number of shards for relation indices. | Integer | 5 |
| numberOfInteractionsShards | Number of shards for interaction indices. | Integer | 5 |
| numberOfActivitiesShards | Number of shards for activity indices. | Integer | 5 |
| indexingErrorsMonitoring | Enables monitoring and tracking of indexing errors. | Boolean | false |
| prepareRelationIndex | Configures whether relation data is prepared specifically for indexing. | Boolean | true |
| indexRelations | Enables indexing of relations for search and reporting. | Boolean | true |
| maxSearchFileLines | Maximum number of lines allowed in search export files. | Integer | 1000000 |
| defaultBoostFactor | Default relevance boost factor applied to indexed fields. | Float | 1.0 |
| indexRequestTimeout | Maximum time allowed for index requests before timeout. | Integer | 60000 |
| indexExportCsvHeaders | Controls whether CSV downloads include header rows. | Boolean | true |
| appendEqualsAnalyzedForContainsWordStartingWith | Tunes analyzers for contains-word-starting-with and equals queries. | Boolean | false |
| proximateGeoTokenVersion | Version of the geo tokenization algorithm used for proximity searches. | Integer | 1 |
For information on search behavior and tuning, see Search API.
Matching, Grouping, and OV Behavior
These parameters control matching behavior, grouping logic, and operational value (OV) calculation.
| Parameter | Description | Type | Default |
|---|---|---|---|
| collapseNonOvNestedsWhenMatchOvOnlyEnabled | Collapses non-OV nested values when matchOvOnly is enabled for attributes. | Boolean | false |
| dropOvBeforeAndAfterLcaForNonDefaultGroups | Drops OV calculation before and after lifecycle actions for non-default groups. | Boolean | false |
| suppressRelevanceInMatchOutput | Omits relevance scores from match output responses. | Boolean | false |
| doNotTakeRequiredFromSubnested | Prevents required constraint propagation from sub-nested attributes. | Boolean | false |
| groupingConfig | Defines grouping behavior and grouping rules for entities. | JSON | None |
| enabled | Turns the grouping functionality on or off for the tenant. | Boolean | false |
| ovCalculationVersion | Selects the algorithm version for OV calculation. | Integer | 1 |
For matching and survivorship configuration, see Configuring Survivorship Rules in the L3 .
Reference, Crosswalk, and RDM Configuration
These parameters control how references, crosswalks, and lookup values behave across entities.
| Parameter | Description | Type | Default |
|---|---|---|---|
| resolveLoserStartEndObjectsInRelations | Reassigns relations to winner entities when start/end entities are merged. | Boolean | false |
| sortCrosswalksInLUDNonAdvanced | Sorts crosswalks in last updated date order for non-advanced flows. | Boolean | false |
| updateRawValueToCanonicalCode | Updates raw attribute values to canonical lookup codes. | Boolean | false |
| readEntitiesInAutoMergeHandlerAsInMergeByCrosswalks | Reads entities during auto-merge using merge-by-crosswalks semantics. | Boolean | false |
| useRawValueAsDefaultForCleanse | Uses the raw value as default when cleanse does not return a result. | Boolean | false |
| enableCleanseCrosswalkLog | Logs crosswalk changes resulting from cleansing operations. | Boolean | false |
| changeCleanseCrosswalkUpdateDate | Updates crosswalk update dates when cleanse changes values. | Boolean | false |
| cleanse.chain.resolvelookup | Enables resolve-lookup step within the cleanse chain. | Boolean | false |
| populateSingleAttributeUpdateDatesInRefCrosswalk | Populates update dates for single attributes in reference crosswalks. | Boolean | false |
| excludeMergeCrosswalksFromMergeTree | Excludes merge crosswalks when building merge tree. | Boolean | false |
| skipEndDatedReferenceAttributes | Skips end-dated reference attributes in specific API responses. | Boolean | false |
| ignoreNonOVChangesWhenUpdateThroughReferencedEntity | Suppresses events when only non-OV values change in referenced entities. | Boolean | false |
| useOnlyOvValuesInReferencedEntities | Restricts referenced entities to OV values so non-OV changes do not propagate. | Boolean | false |
| permanentLookupsStore | Configures use of permanent storage for lookup values. | Boolean | false |
| transcodeByEndDatedCrosswalks | Allows lookup transcoding using end-dated crosswalks. | Boolean | false |
| includeDisabledLookups | Includes disabled lookup values during transcoding. | Boolean | false |
| multiParentTranscoding | Enables transcoding where a lookup can have multiple parent values. | Boolean | false |
| publishRDMErrors | Publishes RDM-related errors to logs or monitoring. | Boolean | false |
| cache | Controls whether RDM lookup data is cached. | Boolean | true |
| cached | Indicates if the RDM tenant configuration is cached. | Boolean | true |
| rdmTenants | Defines the list or mapping of RDM tenants used by this tenant. | Array | None |
| oauthInstance | OAuth instance identifier used for RDM integration. | String | None |
| serviceUri | Service endpoint URI for RDM or external lookup services. | String | None |
| loqateDefaultCountry | Default country code used when cleansing addresses with Loqate. | String | USA |
| Verification status mapping | Maps Loqate verification statuses to tenant-specific statuses. | JSON | None |
| Address cleanser process | Defines which address cleanse process (for example, CASS or SERP) is used. | String | License-dependent |
| dataProtectionTaskTimeWaitThreshold | Maximum number of days a data protection task waits before processing. | Integer | 7 |
| updateAttributeUpdateDatesOnActualChanges | Updates attribute updatedDate only when the underlying value changes. | Boolean | true |
| alwaysFillStartEndObjectCrosswalks | Ensures both start and end object crosswalks are always populated when creating relations. | Boolean | false |
| connectRelationsToDefaultCrosswalk | Uses the tenant's default crosswalk as start/end crosswalk when relations are created using URIs. | Boolean | true |
For lookup and RDM configuration, see RDM Lookups API and Set Cleanse Functions Configuration.
Streaming and Messaging Configuration
These parameters control event streaming, JMS publishing behavior, filters, and payload structure.
| Parameter | Description | Type | Default |
|---|---|---|---|
| streamingEnabled | Enables or disables event streaming for the tenant. | Boolean | true |
| streamingAPIEnabled | Controls whether events from API operations are published to streaming destinations. | Boolean | true |
| JMSEventsFilteringFields | Defines entity fields included in JMS event payloads. | Array | None |
| RelationEventsFilteringFields | Defines relation fields included in JMS event payloads. | Array | None |
| skipPayload | When true, sends metadata-only events without full payload body. | Boolean | false |
| analyzeOvChanges | Analyzes OV changes when determining whether to publish events. | Boolean | false |
| emptyStartEndRelationCrosswalks | Controls whether relation events may contain empty start/end crosswalks. | Boolean | false |
| largeObjectsSupport | Enables support for publishing large objects in events. | Boolean | false |
| JMSEventsTimeToLive | Time-to-live for JMS events in the message broker. | Integer | TBD |
| JMSIncludeMergeTime | Includes merge time information in JMS event payloads. | Boolean | false |
| typeFilter | Filters event publication by object type. | String | None |
| dtssQueue | Defines the queue name used for DTSS-related streaming. | String | None |
| messaging | Grouping object for messaging configuration parameters. | JSON | None |
| messagingName | Logical name for the messaging configuration. | String | None |
| name | Name of an individual messaging endpoint configuration. | String | None |
| type | Type of messaging provider (for example, JMS or cloud queue). | String | None |
| provider | Provider identifier for the messaging system. | String | None |
| JMSDestinationPrefix | Prefix applied to JMS destination names. | String | None |
For details on streaming configuration, see Configuration API.
Lifecycle and LCA Processing
These parameters control how lifecycle actions and hooks are invoked and how events are published around merges and saves.
| Parameter | Description | Type | Default |
|---|---|---|---|
| earlyPublishEventsBeforeAfterSaveLCAHook | Publishes events before afterSave or afterMerge lifecycle hooks are executed. | Boolean | false |
| triggerBeforeMergeLCAonManualOnly | Triggers beforeMerge and afterMerge lifecycle hooks only for manual merges. | Boolean | false |
| lifecycleActionsService | Specifies the service endpoint handling lifecycle actions. | String | None |
| dropOvBeforeAndAfterLcaForNonDefaultGroups | Disables OV recalculation before and after lifecycle actions for non-default groups. | Boolean | false |
For lifecycle action configuration, see Life Cycle Actions (LCA) Service API.
Activity Log Configuration
These parameters configure storage, retention, and usage of the activity log.
| Parameter | Description | Type | Default |
|---|---|---|---|
| activityLogConfig | Container for tenant-level activity log configuration. | JSON | None |
| ttl | Retention period for activity log records in primary storage. | String | 4 months |
| longTermStorage | Parameters controlling long-term storage of activity logs in external systems (for example, GBQ). | JSON | Disabled |
| returnObjectLabelsInScan | Determines whether object labels are returned when scanning activity logs. | Boolean | true |
| convertNullsToEmptyLabelsInCassandra | Returns empty labels instead of null for unspecified labels in activity storage. | Boolean | false |
| useActivityLogInTasks | Enables activity log usage as a data source for tasks. | Boolean | false |
| extendedLogMaxObjectsPerPostLimitExceeded | Maximum number of objects logged when post-limit-exceeded events occur. | Integer | None |
For usage of the activity log, see Search using Activity Log API.
Export and Quotas Configuration
These parameters control export behavior, GBQ integration, quotas, and JSON compression.
| Parameter | Description | Type | Default |
|---|---|---|---|
| exportConfig | Defines tenant-level configuration for export operations. | JSON | None |
| quotasLowWatermarkPercent | Percentage threshold at which quota low-watermark alerts are generated. | Integer | 80 |
| quotasControlEnabled | Enables enforcement of tenant quotas. | Boolean | false |
| compressJsons | Compresses JSON payloads for exports and storage where supported. | Boolean | false |
| gbqLimitBytes | Maximum number of bytes allowed per GBQ export operation. | Long | None |
| table | Target table name used for GBQ or external export destinations. | String | None |
For export options and quotas, see Export Service APIs.
Storage-Level Parameters
These parameters control tenant history, Bigtable usage, and storage behavior for specific storage backends.
| Parameter | Description | Type | Default |
|---|---|---|---|
| historyGBTMigration | Enables dual-writing history to Google Bigtable during migration. | Boolean | false |
| historyBigTableConfig | Defines the configuration for storing history in Google Bigtable. | JSON | None |
| historyKeyspaceConfig | Specifies the keyspace configuration for primary history storage. | JSON | None |
| historySecondaryKeyspaceConfig | Defines secondary history keyspace configuration when dual storage is enabled. | JSON | None |
| matchKeyspaceConfig | Configuration for the Cassandra keyspace used for match column families. | JSON | None |
| interactionKeyspaceConfig | Keyspace configuration for storing interaction objects. | JSON | None |
Optional and Miscellaneous Parameters
These parameters control optional behaviors and fine-tuning aspects for the tenant.
| Parameter | Description | Type | Default |
|---|---|---|---|
| useNewDCRs | Enables use of the new Data Change Request (DCR) model. | Boolean | false |
| useNewDCRsAsDefault | Uses the new DCR model as the default for change management. | Boolean | false |
| repeatAllOperationsOnConflict | Repeats operations when conflicts are detected during updates. | Boolean | false |
| allowRebuildInBackground | Allows rebuild operations to run in the background. | Boolean | false |
| detailedTracing | Enables detailed tracing logs for troubleshooting. | Boolean | false |
| disableUseHashForRecleanse | Disables hash-based optimization for recleanse operations. | Boolean | false |
| fullySerializeStartEndCrosswalks | Serializes full start and end crosswalk content for relation objects. | Boolean | false |
| allowSkipReferenceObjectsUpdate | Prevents skipping ENTITY_CHANGED events for referenced entities when optimizations apply. | Boolean | false |
| allowSkipRefChecks | Skips validation of reference object consistency when assembling business objects. | Boolean | false |
| overridePrevValueStatus | Allows a new value to override pin or ignore status even when identical to the previous value. | Boolean | false |
For optional configuration patterns, see Tenant Configuration at a glance.
Tenant Configuration Guidelines
Use these parameters with consideration for tenant size, data volume, and performance requirements. For large tenants, review shard counts, indexing settings, and event streaming limits with Reltio Support to avoid performance bottlenecks.
Always validate configuration changes in a non-production environment.