home

Objectives

ReltioProductsDeveloper resourcesRolesApplicationsObjectives
ReltioProductsDeveloper resourcesRolesApplicationsObjectives

Unify and manage your data

Show Contents

thumbnailObjectives

Configure Reltio UI with the configuration file

Configure the Properties object

Learn how to configure the Properties section in the UI configuration file.

The properties object defines global settings that apply across the entire Reltio UI. It includes tenant-wide configuration options such as:

  • Attribute formatting
  • Lookup behavior
  • Validation rules
  • UI branding (logo, color, header)
  • Date and time masks
  • Workflow server paths
  • Custom scripts and security scopes

You typically configure the properties object once per tenant to set defaults, enforce standards, or activate global features.

Prerequisites for global properties

Before editing the properties object:

  • You need access to the Reltio Console
  • Back up your current configuration before making changes.

Common Configuration Parameters

ParameterDescriptionPossible ValuesExample
attributes Attributes configuration.
  • presentation: AttributesPresentation (see description below).
  • sorting (optional): Strategy used for sorting attributes when adding new ones. Possible values: "ascByName".
Object with fields 

attributes: {
  presentation: {
    "configuration/entityTypes/HCP/attributes/MDMID": {
      "thousandSeparator": ""
    }
  },
  sorting: "ascByName"
}
\
cleanse (optional) Address cleanse configuration. Each key represents an entity type URI and maps to a CleanseConfiguration object. Object with fields 

cleanse: {
  "configuration/entityTypes/Location": {
    actions: {
      blur: {
        attributes: ["configuration/entityTypes/Location/attributes/AddressInput"],
        type: "configuration/entityTypes/Location/cleanse/infos/default"
      }
    },
    defaultType: "configuration/entityTypes/Location/cleanse/infos/other",
    hideForExist: ["configuration/entityTypes/Location/attributes/AddressInput"],
    hideForNew: []
  }
}
customScripts Configuration for custom scripts. Array of CustomScript objects (see description below). Array of CustomScript 

customScripts: [
  {
    files: ["https://mysite.com/hideAttr.js"],
    permissions: ["https://[^.]+.reltio.com/reltio/api/..."],
    processApiRequest: ["regex or link patterns"]
  }
]
defaultRoute (optional) Specifies the default perspective to open when no perspective is defined in the browser URL. If not configured, the Search perspective is used by default. StringdefaultRoute: "dashboard"
entity Specifies the default number of attribute values to be displayed in the requested entity.
  • maxValuesInResponse (optional): number
Object with fields entity: {maxValuesInResponse: 3}
headerColor (optional) Specifies the background color of the UI header. StringheaderColor: "#002855"
i18n (optional) Map from locale to translation file URL. Object (key=locale, value=file URL) 

i18n: {
  en: "https://reltio-ui-localization.s3.amazonaws.com/en.json"
}
logo (optional) Specifies the link to the image that is displayed on the top-left corner of the screen. The height of the icon should be 35 px or less. String (URL)logo: "https://mysite.com/my-logo.png"
lookups Lookup configuration. showCode: boolean
autocomplete (optional): object with fields:

  • includeAttributes (optional): array of string

  • excludeAttributes (optional): array of string

Object with fields 

lookups: {
  showCode: true,
  autocomplete: {
    includeAttributes: ["configuration/entityTypes/HCO/attributes/Status"],
    excludeAttributes: ["configuration/entityTypes/HCO/attributes/Name"]
  }
}
masks (optional) Configuration for date and date-time masking.
  • dateMask (optional): string
  • dateTimeMask (optional): string
Object with fields (optional) 

masks: {
  dateMask: "99-99-9999",
  dateTimeMask: "99-99-9999 99:99:99"
}
profileCheckUpdate (optional) Configuration options for checking updates after saving a profile.
  • autoUpdateInReadMode (optional): array of string
  • entityTypes (optional): array of string
Object with fields 

profileCheckUpdate: {
  entityTypes: ["*"],
  autoUpdateInReadMode: ["HCP"]
}
showAttributeDescription (optional) Determines whether to show attribute descriptions in Profile and Relationship views. BooleanshowAttributeDescription: true
showEntityId (optional) Determines whether to display the entity ID in the profile header. BooleanshowEntityId: true
showMasking (optional) Determines whether to display masked attributes. If true, values are masked in the UI. If false, the UI hides the unmask button and relies on the API to mask. BooleanshowMasking: true
showSearchByOv (optional) Enables the "Search by OV" option for search. BooleanshowSearchByOv: true
validation Validation configuration.
  • levels (optional): array of string — "ERROR", "WARNING"
  • validateReadMode (optional): boolean
  • validateRelations (optional): boolean
  • validateReferenceEntityInReadMode (optional): boolean
  • strictAuthoringValidation (optional): boolean
Object with fields 

validation: {
  validateReadMode: true,
  levels: ["ERROR", "WARNING"],
  validateRelations: true,
  validateReferenceEntityInReadMode: true
}
workflow Configuration for workflow service.
  • enabled (optional): boolean
  • path (optional): string
Object with fields 

workflow: {
  enabled: true,
  path: "https://example.reltio.com/workflow"
}

Updated on September 19, 2025

Footer

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.

© 2025 The RELTIO® mark is a registered trademark of Reltio, Inc. in the United States and other countries; DataDriven and Reltio Data Cloud are trademarks of Reltio, Inc. Other names or marks are trademarks of their respective owners.

Terms and Conditions, Privacy Policy, and