Configuration settings

On the Configuration page of the Collibra settings, you can view and edit core system configuration options, such as security, authentication, email notifications, and search indexes. The same settings are also available in Collibra Console.

Accessing the configuration settings

To access the Configuration page, you need a global role with the Configuration > View global permission. To edit settings, you also need the Configuration > Edit global permission. Both permissions are included in the Sysadmin role by default.

General settings

The general settings of the Collibra Platform:

Setting Description
Default locale

The default language and locale for users of the environment. It has to contain a language code and may contain a country code.

Examples: en-US, fr-FR.

Show target asset type above relation table

  • Green check icon Enabled (default): Show the asset type of the target asset in the title of relation tables on an asset page. The target asset can be either the head or the tail of the relation, depending on which asset page you have open.
  • Red close icon Disabled: Hide the asset type of the target asset.

Homepage

  • Green check icon Enabled (default): When you sign in to Collibra or click the application logo, the homepage is shown, instead of your default dashboard.
  • Red close icon Disabled: When you sign in to Collibra or click the application logo, your default dashboard is shown, instead of the homepage.
New Main Navigation Menu
  • Green check icon Enabled (default): When you sign in to Collibra, the navigation menu is on the far left and the menu options are organized by user persona.
  • Red close icon Disabled: When you sign in to Collibra or click the application logo, the navigation menu is to the right of the Collibra logo, and the menu is not organized by user persona.

Email configuration

The configuration of email notifications.

Note In a Collibra Platform environment, you cannot update the email server settings, such as host and port. For more information, see Collibra Platform infrastructure.

Setting Description
Default schedule

The cron schedule for sending automated workflow notification emails at specific times. This allows you to send emails in batches and prevent an overload of messages.

This setting applies only to automated workflow notification emails that inform users about task assignments or workflow status updates. It does not affect emails sent as part of an email task.

If you create an invalid cron pattern, Collibra stops responding.

Template map The location of template emails.
From address* The email address used as the sender of all outgoing emails.
Email address change notification
  • Green check icon Enabled (default): When you change the email address to which notifications are sent, a notification of the change is sent to the old email address.
  • Red close icon Disabled: When you change the email address to which notifications are sent, no notification of the change is sent to the old email address.

Notifications

The configuration of notification emails to users.

Note Users can override the notification settings set here on their profile.

Setting Description
Notification days

The days of the week on which Collibra sends notifications. The days are represented by numbers from 1 to 7, where 1 represents Sunday.

You can only add one day per row.

Daily roles The roles that receive notifications on the days defined in Notification days. The default role that will receive notifications on a daily or weekly basis is Business Steward.
Enable monthly notifications
  • Green check icon Enabled: The users receive a monthly summary.
  • Red close icon Disabled (default): The users do not receive a monthly summary.
Roles for monthly notifications The roles that receive monthly notification emails. This is only relevant if Enable monthly notifications is Green check icon Enabled. The default roles that will receive notifications on a monthly basis are Business Steward and Stakeholder.

Hyperlinking configuration

The configuration of automatic hyperlinks. When you change a setting, you have to rebuild the hyperlinks.

Setting Description
Enable hyperlinking

Green check icon Enabled: Hyperlinks are created automatically.

Red close icon Disabled (default): Hyperlinks aren't created automatically.

For more information about automatic hyperlinks, go to Automatic hyperlinking.

Warning Enabling this setting affects the platform performance.
Enable case sensitivity

Green check icon Enabled: Hyperlinks are case-sensitive.

Red close icon Disabled (default): Hyperlinks aren't case-sensitive.

Note If you edit this setting, you must reindexCollibra.

Excluded asset type IDs

List of asset types that are ignored by automatic hyperlinking. You can use this setting to exclude particular asset types so that not all the assets become potential targets for automatic hyperlinking.

Tip 
  • Each time you enter an asset type ID in this field, another field appears for you to add another ID. To exclude multiple asset types, use separate fields, instead of entering multiple IDs in a single field separated by commas.
  • Excluding assets reduces the amount of hyperlinks, which improves performance.
  • Exclude technical asset types such as Column, Field, Table, Code Value, and Code Set.

Note If you edit this setting, you must reindexCollibra.

Recommender configuration

The configuration of the recommender.
We recommend not to change the default values of this configuration.

Setting Impacts Description
Catalog recommender enabled All recommendations
  • Green check icon Enabled (default): The "Data sets you might like" section is included on the Catalog homepage. This section shows data sets you might be interested in, as determined by the recommender, which takes into account your data sets and the data sets of similar users.
  • Red close icon Disabled: The "Data sets you might like" section is not included on the Catalog homepage.
Data set recommender execution time Recommendations of data sets to users

The cron schedule by which the data set recommender looks for recommended data sets for a user.

By default the data set recommender does this every night.

Asset recommender execution time Recommendations of business assets to data assets The cron schedule by which the asset recommender looks for suggested relations between business assets and data sets.
Data set matcher execution time Data set matcher The cron schedule by which the data set matcher looks for similar data sets.
Data set similarity threshold Data set matcher

The amount of business assets that have to be related to two data sets before the data sets are considered to be similar.

This percentage is expressed by a decimal where 1 equals 100%.

Example If this value is 0.3 and at least 30% of the related business assets are related to both data sets, they are considered to be similar.

Duplicate schema threshold Schema matcher

The amount of assets that have to be related to both schemas before the schemas are considered to be similar.

This percentage is expressed by a decimal where 1 equals 100%.

Fuzzy vs exact matching strategy for business assets Recommendations of business assets to data sets and of business assets to column assets

The percentage that determines to what extent assets with a similar name become more important.

The ranking in the search engine results always has an impact on the suggestion score. However, similarity between the asset names can also be taken into account. If you decrease this percentage, the ranking of the search results becomes more important for the suggestion score, while the similarity between the asset names becomes less important. If you increase the percentage, assets with similar names will receive a higher suggestion score.

This percentage is expressed by a decimal where 1 equals 100%. You can enter a value greater than 1.

Recommendation weights for data sets Recommendations of data sets to users

An ordered comma-separated list of values that define the importance of properties for recommendations. The order of the values reflects the importance of the value.

This setting is only used for data set recommendations if your Collibra does not yet have enough data for relevant results from the active recommendations algorithms.

Possible values:

  • CERTIFIED: Data sets that are certified are considered more relevant.
  • POPULARITY: The number of visits to the data set page.
Active recommendation algorithms Recommendations of data sets to users and of business assets to data sets

A comma-separated list of algorithms that calculate recommendations. By default, all available algorithms are listed.

Possible values:

Data set elements threshold Recommendations of data sets to users

The maximum number of elements per data set that the recommender will use to train the model. The data set elements are taken randomly.
Lowering this number can prevent out-of-memory issues but also impacts the accuracy of recommendations for large data sets.

Warning If you create an invalid cron pattern, Collibra stops responding.

Search index configuration

The configuration of the search index.

Setting Description
UI search appends wildcard *

Green check icon Enabled (default): A wildcard (asterisk) is automatically added to the end of each search text to find more matches. For example, search text loan size is treated as loan size*, finding assets containing sizeable.

An asterisk isn't added if:

  • The search text contains a tilde (~).
  • The search text ends with a quotation mark (").

Note This setting applies only to search texts via the user interface. A wildcard isn't automatically added to search texts via REST API.

Red close icon Disabled: A wildcard isn't added to the search text.

Maximum batch size *

The maximum batch size for resource reindex.

  • Default value: 5,000
  • Minimum value: 100
  • Maximum value: 30,000

Maximum batch size for relations *

The maximum batch size for relation reindex.

  • Default value: 500
  • Minimum value: 10
  • Maximum value: 10,000

Maximum batch size for relation path preview *

The maximum batch size for the relation path preview of relation index.

  • Default value: 500
  • Minimum value: 50
  • Maximum value: 10,000
Relation-based search

Green check icon Enabled (default in new environments): The Data Marketplace search considers certain assets and relation types between assets. As a result, your search results not only include assets that directly match the search criteria, but also assets that match the criteria through specific relation types.

Example A column named Order is included in a data set named Customer. If the relation-based search is enabled and you search for Order in Data Marketplace, then the data set Customer appears in the search results because the data set contains this column.

Tip For more information about this feature and the default relation types, go to Filtering and searching based on relations in Data Marketplace.

Red close icon Disabled: The Data Marketplace search results do not consider relations.

After you enable this setting, you must reindex Data Marketplace relations or reindex Collibra completely.

Note In new Collibra environments, this setting is enabled by default. In upgraded Collibra environments, the previous status of this setting is retained.

Slow logs configuration

The configuration of the slow logs function.

Setting Description
Indexing threshold

The time limit, in milliseconds, after which an index query is logged in Elasticsearch.

If the value is set to 0 (zero), all index queries are logged.

Changes to this setting require a full reindex of your Collibra Platform environment.

Fetching threshold

The time limit, in milliseconds, after which a fetch query is logged in Elasticsearch.

If the value is set to 0 (zero), all fetch queries are logged.

Changes to this setting require a full reindex of your Collibra Platform environment.

Search Event Log configuration

The configuration of indexing.

Setting Description
Automatic relation indexing

This setting keeps Data Marketplace up to date if relations between assets are created, updated, or removed.

Example If the relation between asset A and asset B changes and this relation is used in relation-based filters or relation-based search, then the Data Marketplace search considers this change.

Green check icon Enabled: Automatically index certain relation type changes between assets so that the relation information remains consistent between Collibra and Data Marketplace. The relation types that are considered are the relation paths used by relation-based search and filters. If such a relation type between assets changes, the change is reflected in the search index after some time.

Tip For more information about this feature and the default relation types, go to Filtering and searching based on relations in Data Marketplace.
Note Collibra does not automatically reindex relations between assets for relation paths that end with an attribute. You need to manually reindex the relations.
Suppose that you created a path that ends with an attribute: Table A contains Column B with attribute Privacy. If you have a column with attribute Privacy and value "sensitive data," a user searching for "sensitive data" can find Table A based on the relation path. However, changes to the attribute value will not be picked up automatically during automatic reindexing.

Red close icon Disabled (default): Changes to relations are not automatically indexed. This can cause inconsistencies between Collibra and Data Marketplace. You can, however, reindex Data Marketplace relations manually.

Upload configuration

The configuration of the file upload service.

The file upload restrictions apply to the following actions in Collibra:

Setting Description
Accepted content types

The MIME type names of the files you want to allow for uploads.

For example, type application/pdf for PDF files.

Restricted content types

Content types in MIME type format that cannot be uploaded. Restricted content types take precedence over an accepted content types:

  • application/vnd.ms-excel.addin.macroenabled.12
  • application/vnd.ms-excel.sheet.binary.macroenabled.12
  • application/vnd.ms-excel.sheet.macroenabled.12
  • application/vnd.ms-excel.template.macroenabled.12
  • application/vnd.ms-powerpoint.addin.macroenabled.12
  • application/vnd.ms-powerpoint.presentation.macroenabled.12
  • application/vnd.ms-powerpoint.slide.macroenabled.12
  • application/vnd.ms-powerpoint.slideshow.macroenabled.12
  • application/vnd.ms-powerpoint.template.macroenabled.12
  • application/vnd.ms-word.document.macroenabled.12
  • application/vnd.ms-word.template.macroenabled.12

Statistics configuration

The configuration of statistics.

Setting Description
Buffer size

The maximum amount of statistics entries that the buffer can contain before saving them in the database.

The default value is 10.

Buffer flush time

The maximum amount of time in milliseconds to keep statistic entries in memory before saving them in the database.

The default values is 10,000.

Cron map

List of statistics, listed by their cron name, and a cron interval.

These are the default values:

Field key Field value

workflow-task

59 23 * * *

active-users

0/15 * * * *

term-count

59 23 * * *

vocabulary-count

59 23 * * *

page-hit

0 * * * *

task-count

0 * * * *

If you create an invalid cron pattern, Collibra stops responding.

Import configuration

The configuration for imports.

Setting Description
Enable workflows during import
  • Green check icon Enabled: Allow workflows to start as a result of the changes performed by an import operation.
  • Red close icon Disabled (default): Prevent workflows from starting as a result of the changes performed by an import operation.

Note This setting does not affect API import calls, which never start workflows.

Asset responsibilities support
  • Green check icon Enabled: Enable importing responsibilities at asset level.
  • Red close icon Disabled (default): Disable importing responsibilities at asset level.

Warning Setting specific responsibilities on a large number of resources will affect the performance and stability of the system.

Number of failed commands before stopping import job

An import job with the option to continue on error enabled will stop after the specified number of commands have failed. Any valid command is still committed to the database until the moment the job stops, which can lead to some resources being imported.

The default and maximum value is 100.

Temporary data location

The location of the temporary files used by the import job.

The default value is FILE.

Max number of concurrent import jobs

The maximum number of import jobs that can be executed at the same time via the API. This is to avoid memory issues.

The default value is 4. The maximum is 8.

Excel import configuration

The configuration of Excel import.

Setting Description
The default CSV separator character The default separator character of the CSV fields for complex relations.
The default CSV quote character The default quote character of the CSV fields for complex relations.

Number of rows per chunk of data

When importing views, the database is called repeatedly, each time importing a chunk of data from the import file. This option defines how many rows each chunk of data can contain.

Lower values reduce the burden on memory. Higher values require more memory, but may slightly increase the speed of the export.

The default value is 5,000.

Excel export configuration

The configuration of Excel export.

Setting Description
The default CSV separator character The default separator character of the CSV fields for complex relations.
The default CSV quote character The default quote character of the CSV fields for complex relations.

Number of rows per chunk of data

When exporting views, the database is called repeatedly, each time fetching a chunk of data to build the export file. This option defines how many rows each chunk of data can contain.

Lower values reduce the burden on memory. Higher values require more memory, but may slightly increase the speed of the export.

The default value is 5,000.

CSV export configuration

The configuration of CSV export.

Setting Description
Always use quotes
  • Green check icon Enabled: Use quotes for every cell in the CSV.
  • Red close icon Disabled (default): Only use quotes when necessary.

Number of rows per chunk of data

When exporting views, the database is called repeatedly, each time fetching a chunk of data to build the export file. This option defines how many rows each chunk of data can contain.

Lower values reduce the burden on memory. Higher values require more memory, but may slightly increase the speed of the export.

The default value is 5,000.

Security configuration

The configuration of security.

Setting Description
X-Frame options

Content of the HTTP-header X-Frame-Options. This is set on all rendered pages and is used to avoid clickjacking attacks. By default, only pages with the same origin can use the rendered pages in a frame.

Limit user sessions
  • Green check icon Enabled: Users can only open only one session.
  • Red close icon Disabled (default): Users can open multiple sessions.

Office research guest access

  • Green check icon Enabled: The Office research integration is always allowed guest access via REST, regardless of the general Guest access setting.
  • Red close icon Disabled (default): The general Guest access setting is retained.

Note Currently, the Office research integration is available only when Collibra Platform is publicly available, which is why this override setting is necessary.

Prevent advanced html features in text dashboard

Text widgets in dashboards can contain full HTML, which introduces the risk of cross-site scripting (XSS) attacks if malicious HTML is injected. You can use this setting to control the behavior of Text widgets.

  • Green check icon Enabled (default): Potentially dangerous HTML elements are removed from Text widgets after saving.
  • Red close icon Disabled : No HTML elements are removed from Text widgets after saving.
Note 
  • If this setting is set to True, only supported HTML tags are retained in Text widgets after saving.
  • Event handlers and script, including JavaScript, are always removed, regardless of this setting.
  • Some examples on unsafe CSS properties are as follows:
    • color: transparent;
    • filter
    • opacity
    • pointer-events: none;
    • position: fixed;
    • position: sticky;
    • visibility
Enable custom validation functions
  • Green check icon Enabled (default): Groovy scripts with custom validation functions can be loaded.
  • Red close icon Disabled: Groovy scripts with custom validation functions cannot be loaded.

LDAP

The configuration of an LDAP server to handle the authentication.

Setting Description
Enable LDAP integration
  • Green check icon Enabled: LDAP integration is enabled.
  • Red close icon Disabled (default): LDAP integration is disabled.
Sync after restore
  • Green check icon Enabled (default): LDAP data is synchronized with Collibra when an initial data set is bootstrapped.
  • Red close icon Disabled: LDAP data is synchronized with Collibra only when the LDAP synchronization job is triggered.
User page size

The page size that is used when retrieving users during synchronization.

The default value is 500. You can set it to 0 to disable paging.

Note This is a global setting. If you are working with multiple LDAP servers, only the value for the main server is considered.

Group page size

The page size that is used when retrieving groups.

You can set it to 0 to disable paging.

Note This is a global setting. If you are working with multiple LDAP servers, only the value for the main server is considered.

Time limit

The time limit in milliseconds for all LDAP searches.

The default value is 120,000.

You can set it to 0 to disable the time limit.

Tip 
  • If you get Time limit Exceeded error messages, increase the default value or check why the LDAP search takes too long.
  • We recommend that you modify the User page size and Group page size settings before you modify this setting.
Sync job enabled
  • Green check icon Enabled (default): The synchronization job is enabled.
  • Red close icon Disabled: The synchronization job is disabled.
Sync job cron

The schedule to perform an LDAP synchronization (CRON).

The default value for this setting is daily at midnight.

If you create an invalid cron pattern, Collibra stops responding.

User field mapping The configuration mapping of all the user fields. This determines which LDAP field is mapped to which user field. Empty fields are ignored during the synchronization.
Username *
The unique user ID in the LDAP, typically UID. This is required.
Email *
The corresponding email field in the LDAP directory. This is required.
First name
The first name field in the LDAP directory.
Last name
The last name field in the LDAP directory.
Middle name

The middle name field of the LDAP directory, this is usually givenName.

Enabled
An indication of whether a user is active or inactive in LDAP.
Language

The language and locale of the user. It must contain a language code and may contain a country code.

Example pl, en_US, nl_BE.

Title
The mapping for the user's job title.
Department
The mapping for the user's department.
Group

The LDAP property that defines to which Collibra groups the user should be added.

Use group names, this field does not support group IDs.

If there is a group entry in the LDAP directory, use the Group field mapping settings.

Additional email list

An additional email list.

Instant messaging fields
The mapping for the user's IM locations.
Website map
Enter the field value and field key to map a social media website.
Phone
The mapping for the user's phone.
Fax
The mapping for the user's fax number.
Mobile
The mapping for the user's mobile number.
Pager
The mapping for the user's pager number.
Private
The mapping for the user's private number.
Work
The mapping for the user's work number.
Other
The mapping for any other phone number for this user.
Home address
The mapping for the user's home address.
Street
The mapping for the user's street.
Number
The mapping for the user's number.
City
The mapping for the user's city.
Post code
The mapping for the user's postal code.
State
The mapping for the user's state.
Country
The mapping for the user's country.
Work address
The mapping for the user's work address.
Street
The mapping for the user's street.
Number
The mapping for the user's number.
City
The mapping for the user's city.
Post code
The mapping for the user's postal code.
State
The mapping for the user's state.
Country
The mapping for the user's country.
Gender
The mapping information for the user's gender.
Mapping
The attribute key for the gender value. If the content equals one of the male or female mappings, the user will be saved as male or female. Otherwise a default of UNKNOWN will be used.
Male value
The value for male users.
Female value
The value for female users.
Group field mapping Groups can be defined as a separate structure or as a userField. The following section allows you to sync with a group structure that is unrelated to the user structure.
Group name field

The name of the group to use in the application.

Users field
The user DNs that are member of the group.
Servers

The Collibra parameters to map with your LDAP server parameters.

LDAP server URL
The URL or IP address to the LDAP server, for example, ldap://ldap.yourcompany.com:389 or ldaps://ldap.yourcompany.com:636.
Bind DN
The DN of the administrator user that is used for authentication, for example, admin.
Bind password
The password of the administrator user.
Base DN
The base DN for when you are working with relative DNs. This base DN is used for all LDAP look-ups.
User base
The base DN of where the LDAP users for Collibra are located. If a base has been specified, it is used as a prefix for this user base. Subtree search is used, so all DNs located below are searched for matching users.
Authentication user LDAP filter
The filter that specifies which users can authenticate in the application. By default, all the objects found in the user base are selected, including the root.
Synchronization user LDAP filter

The filter that specifies which users are imported by the synchronization job. The users have to be the same as, or a subset of, the Authentication user LDAP filter.

If you provide no value for this setting, the same filter as specified for the Authentication user LDAP filter setting is used. That allows you to synchronize only the users that need to have access to the application, even if they have not signed in yet. Users in the Authentication user LDAP filter are synchronized each time they authenticate and are only available after the first sign-in to the application. This is the default setting.

Authentication type

The authentication mechanism for authenticating users on the LDAP servers.

Shutdown gracefully
  • Green check icon Enabled: The LDAP context is destroyed immediately. When using TLS, some servers require the connection to be shut down by the client before the LDAP context is destroyed.
  • Red close icon Disabled (default): The LDAP context is not destroyed immediately.
Referral Setting

Specifies what to do with referrals. The following table contains the possible values.

Note If you are experiencing slow searches on Microsoft Active Directory with the follow value for the Referral setting, try using the Global Catalog as Active Directory domain controller. The Global Catalog enables searching for Active Directory objects in any domain in the forest without the need for subordinate referrals. This can dramatically speed up searching. However, the Global Catalog only contains a subset of the attributes of an object. This solution is only viable if the attributes requested for the search results are stored in the global catalog. Note that the Global Catalog is accessible on port 3268/3269, not the standard 389/636 LDAP ports.

Group base DN
The base DN of where all the groups are located. If a base has been specified, that base is used as the prefix for this group base.
Group LDAP filter
The LDAP filter to which each group has to comply to be synchronized.
Batch synchronization The synchronization of the users with the LDAP server happens in batches.
Batch size

The number of users in each batch. If a batch fails, none of the users in that batch is updated and the user names are listed in the DGC service log. Other batches are processed as normal. After processing all batches, Collibra disables users that are no longer in LDAP, unless one ore more batches failed.

Set the value to 0 to disable batch processing.

Password

The configuration of passwords.

Setting Description
Minimum length

The minimum length of passwords.

The default minimum length is 12.

Maximum length

The maximum length of passwords.

The default maximum length is 1,024.

Digits required
  • Green check icon Enabled (default): Passwords have to contain one or more digits.
  • Red close icon Disabled: Passwords do not have to contain digits.
Non alphanumeric required
  • Green check icon Enabled (default): Passwords have to contain one or more non-alphanumeric (special) characters.
  • Red close icon Disabled: Passwords do not have to contain non-alphanumeric characters.
Uppercase required
  • Green check icon Enabled (default): Passwords have to contain one or more upper-case characters.
  • Red close icon Disabled: Passwords do not have to contain upper-case characters.
Lowercase required
  • Green check icon Enabled (default): Passwords have to contain one or more lower-case characters.
  • Red close icon Disabled: Passwords do not have to contain lower-case characters.
Username disallowed
  • Green check icon Enabled (default): Passwords cannot be the username.
  • Red close icon Disabled: Passwords can be the username.

Expiration interval (months)

The number of months before users have to change their passwords.

Set it to 0 if users never have to change their passwords.

The default interval is 3 months.

Allowed login failures

The number of consecutive failed login attempts that are allowed before the user account is disabled.

Set it to 0 for unlimited attempts.

The default is 3 login failures.

No reuse count

The number of previous passwords users cannot reuse. The default is 1: the user cannot change his password to what it currently is.

Set this to 0 to allow using the same password.

Password reset link validity period

The number of minutes that a link to reset a password remains valid. Beyond this time, the user has to request a new password reset link.

The default value is 60 minutes.

The minimum value is 15 minutes, the maximum value is 1,440 minutes (24 hours).

Account lock-out duration

The number of minutes that a user cannot sign in after too many failed sign-in attempts. If the number of minutes is set to 0, a Collibra administrator must reset the password to unlock the account. This setting is only applicable if the "Allowed sign-in failures" setting is defined.

A locked-out account does not mean that your account is disabled.

REST

The security configuration of the REST interface.

Setting Description
Limited CSRF

This option offers limited security, so we recommend upgrading to the Enhanced CSRF.

  • Green check icon Enabled: The validity of a request is checked with a CSRF token.
  • Red close icon Disabled (default): The validity of a request is not checked with a CSRF token.
Referrer enabled
  • Green check icon Enabled: The HTTP referrer header is used to identify the origin of the request.
  • Red close icon Disabled (default): The HTTP referrer header is not used to identify the origin of the request. It is recommended to leave this option disabled.
Referrer checking allow empty
  • Green check icon Enabled (default): The HTTP referrer header can be empty.
  • Red close icon Disabled: The HTTP referrer header cannot be empty.

SSL

The configuration of SSL.

Setting Description
Key store name The name of the keystore file. The file is expected to be in the <collibra_data>/dgc/security folder.
Key store password The password of the keystore.
Key store type The type of the keystore file. For example, JKS or PKCS12.
Trust store name The name of the truststore file. The file is expected to be in the <collibra_data>/dgc/security folder.
Trust store password The password of the truststore.
Trust store type The type of the truststore file. For example, JKS or PKCS12.

SSO

The configuration of Single Sign-On (SSO) authentication.

Setting Description
Mode

The SSO mode of Collibra.

The possible values are:

  • SAML_ATTRIBUTES
  • SAML_LDAP
  • SSO_HEADER
  • SSO_HEADER_LDAP
  • DISABLED
Header

The name of the header to be checked. The contents of this header is used for the search query, which is SSO_HEADER = username.

The value of the actual query depends on DN and possibly Attribute.

DN

If the SSO mode is SSO_HEADER_LDAP or SAML_LDAP, this field determines whether the distinguished name (DN) or attribute is used:

  • Green check icon Enabled: The header has to contain the distinguished name (DN) of the user in the LDAP.
  • Red close icon Disabled (default): The header has to contain the value of Attribute.

If the SSO mode is DISABLED, SSO_HEADER or SAML_ATTRIBUTES, this field is ignored.

Attribute

This field is only used if the SSO mode is SSO_HEADER_LDAP or SAML_LDAP, and if DN is False.

If the above criteria are met, the LDAP has to contain this value.

Disable automatic user creation when signing in via SSO

If users try to sign in via SSO, they still need a user account in Collibra. You can either create the user accounts automatically when they sign in, or create the user accounts manually or via LDAP synchronization

  • Green check icon Enabled: User accounts are not created automatically.
  • Red close icon Disabled (default): User accounts are created automatically.

Disable the Collibra signin page

When SSO is enabled, a user can still navigate to the /signin page and try to log in via that page. However, you can disable that page.

  • Green check icon Enabled: Users cannot access the Collibra signin page.
  • Red close icon Disabled (default): Users can access the Collibra signin page
SAML The configuration of SAML.
Metadata HTTP
The URL of the SAML metadata file to be used. The URL always has to be reachable by the Collibra environment.
Identity Provider Entity ID

The entity ID inside the metadata to be referenced.

Note A metadata file can describe multiple entity IDs, make sure to use in the entity ID from the correct metadata file.

Attribute fields

The mappings of attributes in the SAML response. The values are used as keys to look for in the SAML response.

Examples of attribute fields are first name, last name, address information, phone numbers and so on.

First name

The mapping for the user's first name.

This attribute is optional. The value can be empty.

Last name

The mapping for the user's last name.

This attribute is optional. The value can be empty.

Email

The mapping for the user's email address.

This attribute is optional for existing users, but mandatory for new users.

Warning If the email address is invalid when you synchronize, the user is deactivated and the user information is not updated.

Enabled
The mapping that indicates whether the account of the incoming user is enabled.
Title
The mapping for the user's job title.
Department
The mapping for the user's department.
Group

The mapping (attribute) which indicates to which Collibra groups the user should be added. If the groups don't exist yet, they will be created. This attribute can have multiple values (groups) or the groups can be sent as a comma-separated list of groups.

Use group names, this field does not support group IDs.

If passing groups in this attribute, you must set Groups DGC Managed to False.

Phone
The mapping for the user's phone.
Fax
The mapping for the user's fax number.
Mobile
The mapping for the user's mobile number.
Pager
The mapping for the user's pager number.
Private
The mapping for the user's private number.
Work
The mapping for the user's work number.
Other
The mapping for any other phone number for this user.
Home address
The mapping for the user's home address.
Street
The mapping for the user's street.
Number
The mapping for the user's number.
City
The mapping for the user's city.
Post code
The mapping for the user's postal code.
State
The mapping for the user's state.
Country
The mapping for the user's country.
Work address
The mapping for the user's work address.
Street
The mapping for the user's street.
Number
The mapping for the user's number.
City
The mapping for the user's city.
Post code
The mapping for the user's postal code.
State
The mapping for the user's state.
Country
The mapping for the user's country.
Instant messaging
The mapping for the user's IM locations.
AIM
The mapping for the user's AOL IM account.
Google Talk
The mapping for the user's Google Talk IM account.
Icq
The mapping for the user's ICQ IM account.
Jabber
The mapping for the user's Jabber IM account.
Messenger
The mapping for the user's Live Messenger IM account.
Skype
The mapping for the user's Skype IM account.
Yahoo Messenger
The mapping for the user's Yahoo Messenger IM account.
Gender
The mapping information for the user's gender.
Mapping
The attribute key for the gender value. If the content equals one of the male or female mappings, the user will be saved as male or female. Otherwise a default of UNKNOWN will be used.
Male value
The value for male users.
Female value
The value for female users.
Groups DGC managed

Option to configure that groups should be managed by Collibra, or that groups should be set by the SAML assertion (SAML+Attributes mode).

This option is only relevant if Mode is SAML_ATTRIBUTES.

  • Green check icon Enabled: The groups are fully managed by Collibra. In the UI the admin has the option to assign groups to users, without it being overwritten by SAML.
  • Red close icon Disabled (default): The groups are managed by the SAML assertions. In this case the groups are managed by the SAML IDP. Be sure to configure the Group attribute in the Attribute Fields section.
Service Provider Entity ID

Field that determines the value of the Entity ID parameter in the service provider metadata returned by Collibra. The default value is empty, in which case Collibra uses the value of the Base URL field.

Enter a custom value if the base URL does not match the audience configured in your SAML identity provider.

Warning The value of the audience restriction in the SAML response has to be exactly the same as the value of this field.

Note SSO does not work if the Service Provider Entity ID field contains the base URL with trailing forward slash (for example www.collibra.com/), and the audience of your IDP contains the base URL without a trailing forward slash (for example www.collibra.com).
Both values need to be exactly the same. In this case, you can resolve the issue by changing the value in the configuration of your IDP, or the value of this field. It does not matter whether both have a trailing forward slash or not, as long as they contain the same value.

Sign authentication requests
  • Green check icon Enabled: Authentication requests have to be signed.
  • Red close icon Disabled (default): Authentication request don't have to be signed.
Force authn
  • Green check icon Enabled (default): The SP authentication request forces re-authentication.
  • Red close icon Disabled: The SP authentication request does not force re-authentication.
Force passive
  • Green check icon Enabled: The reauthentication has to happen in the background.
  • Red close icon Disabled (default): The reauthentication does not have to happen in the background.

This is only relevant if Force authn is True.

Name ID

Name ID that is used in the SP authentication. The default value is urn:oasis:names:tc:SAML:2.0:nameid-format:persistent.

The Name ID value is mandatory.

Name ID allow create
  • Green check icon Enabled (default): The IDP can create a name ID to fulfill the SP authentication request.
  • Red close icon Disabled: The IDP cannot create a name ID to fulfill the SP authentication request.
Disable client address
  • Green check icon Enabled: The validation of the client IP address in the assertion message is disabled.
  • Red close icon Disabled (default): The validation of the client IP address in the assertion message is enabled.
SAML Requested authentication context

Settings for the SAML requested authentication context. The IDP uses the authentication context to authenticate the user. By default, the authentication context mandates user/password authentication over HTTPS.

Disable
  • Green check icon Enabled: The requested authentication context section is not sent in the SAML request.
  • Red close icon Disabled (default): The requested authentication context section is sent in the SAML request.
Comparison type

The comparison type that is transmitted in the requested authentication context.

Possible values:

  • minimum
  • maximum
  • better
  • exact (default value)

For more information about the comparison type values, refer to the SAML specifications.

Reference list

The list of class references in the requested authentication context. You can separate list items with the pipe character (|).

For more information about this list, refer to the SAML specifications.

Declaration list

The list of class declarations in the requested authentication context. You can separate list items with the pipe character (|).

For more information about this list, refer to the SAML specifications.

Response decryption mode

Enable the support for encrypted SAML responses.

  • DISABLED: Collibra only accepts plain-text SAML responses.
  • OPTIONAL: Collibra can handle both encrypted and plain-text SAML responses.
  • FORCED: Collibra only accepts encrypted SAML responses.

Once OPTIONAL or FORCED is selected, the encryption key pair is generated and added to the Collibra SAML keystore. A self-signed certificate is generated and works in most situations. If your IdP rejects self-signed certificates, you will have to add a certificate that is signed by a trusted 3rd party.

Validity period of the SAML certificate

The SAML certificate expiry date in years.

By default, the SAML certificate expires after 20 years.

Signout

The configuration of redirecting after signing out of Collibra.

Setting Description
Override signout URL
  • Green check icon Enabled: Redirect the user to a specific website after signing out.
  • Red close icon Disabled (default): Redirect the user to the sign-in page after signing out.
Signout redirect URL The URL to be redirected to when signing out.

Import/Export

The configuration to avoid the Formula Injection vulnerability in Excel.

Setting Description

Escape Excel formulas

The option to disable Formula Injection into Excel. When enabling this option, an escape character is added at the beginning of Excel formulas during the export and is removed when importing formulas.

The escape character will be added to fields that start with one of the following characters:

  • equation: =
  • plus: +
  • minus: -
  • at-sign: @

This option is enabled by default.

Excel formulas escape character

The escape character for Excel formulas when exporting or importing data.

JWT

The JSON Web Token configuration.

Setting Description
JSON Web Key Set URL

The URL to retrieve public key information needed to verify the authenticity of JSON Web Tokens (JWTs), issued by an authorization server.

This setting is required to enable JWT authentication.

JWT Token Types

A case-insensitive comma-separated list of accepted JWT media types coming in the typ header parameter.

Leave blank if the authorization server does not provide a media type parameter.

The default values is at+jwt,jwt.

JWT Algorithms

A comma-separated list of accepted JWT algorithms coming in the alg header parameter. See https://tools.ietf.org/html/rfc7518#section-3.1 for details.

Leave blank to accept all digital signature algorithms.

JWT Issuer

The accepted issuer coming in the iss JWT claim.

Leave blank if the authorization server does not provide an issuer claim.

JWT Audience

A comma-separated list of accepted audience values for the aud claim.

The value for this field is a configuration setting in your authorization server, which identifies your Collibra environment as the intended recipient of the JWT.

Leave blank if the authorization server does not provide an audience claim.

JWT Principal ID Claim Name. *

The name of the JWT claim containing the principal's identity. See https://tools.ietf.org/html/rfc7519#section-4.1.2 for details.

Defaults to the standard subject claim, sub.

Change this setting only if your authorization server has other means of identifying the principal, for example, a client_id claim.

This setting is required if JWT authentication is enabled.

JWT Maximum Clock Skew

The maximum acceptable difference in seconds between the clocks of the machines running the authorization server and Collibra.

Differences smaller than the given amount are ignored when performing time comparisons for token validation.

The default value is 60 seconds if left blank.

Setting Description
Force default header list

Force default values for headers in this list. Values specified in the configuration of security headers have no impact for headers in this list.

Whitelists

The configuration for whitelist placeholders that can be used in security headers.

Option Description
connect-src whitelist The 'connect-src' whitelist. To use this whitelist in a security header, use the '{connectSrcWl}' placeholder.
font-src whitelist The 'font-src' whitelist. To use this whitelist in a security header, use the '{fontSrcWl}' placeholder.
frame-src whitelist The 'frame-src' whitelist. To use this whitelist in a security header, use the '{frameSrcWl}' placeholder.
img-src whitelist The 'img-src' whitelist. To use this whitelist in a security header, use the '{imgSrcWl}' placeholder.
script-src whitelist The 'script-src' whitelist. To use this whitelist in a security header, use the '{scriptSrcWl}' placeholder.
style-src whitelist The 'style-src' whitelist. To use this whitelist in a security header, use the '{styleSrcWl}' placeholder.
frame-ancestors whitelist The 'frame-ancestors' whitelist. To use this whitelist in a security header, use the '{frameAncestorsWl}' placeholder.
Tableau frame-ancestors whitelist The tableau 'frame-ancestors' whitelist. To use this whitelist in a security header, use the '{tableauFrameAncestorsWl}' placeholder.

Disclaimer

The configuration of a disclaimer upon signing in to Collibra.

Setting Description
Disclaimer
  • Green check icon Enabled: Upon signing in, show a disclaimer that you have to agree with before you can continue.
  • Red close icon Disabled (default): Don't show a disclaimer.
Disclaimer message

The disclaimer message that is shown after signing in.

If you leave this field empty, there is a default message.

You can use basic HTML tags, such as headers, paragraphs, images and hyperlinks.

Collibra Connect

The configuration to communicate with Collibra Connect.

Setting Description
Base URL The URL to Collibra Connect.
Username The username to connect to Collibra Connect.
Password The password to connect to Collibra Connect.

Register data source

Global parameters that apply to Data Source Registration.

Setting Description
Table types to ignore A comma separated list of table types that are not ingested. For example, INDEX and SEQUENCE.

AWS regions restriction

A list of AWS regions that Data Catalog is allowed to connect to. For example, eu-west-3 and us-east-2. For a list of all AWS locations, see the AWS documentation.

  • If you want to allow Collibra to make a connection to any AWS region, leave the field empty.
  • If you remove a region from this list and that region was previously used for an S3 integration, you may want to delete the Glue database from the previously used region manually. By default, Collibra does not remove it. The Glue database has the following naming convention: collibra_catalog_<Asset Id>_<Domain Id>
    For example: collibra_catalog_d3174a88-5ffe-4d50-8fbe-7bf0832ec3af_5d198ce9-4e56-4d0e-a885-58204da50741
  • When using Edge, a warning is added to the logs if an invalid region is detected in the restricted regions list.
AWS API call rate

Allowed number of AWS API calls per second.

Use this option to limit the number of API calls per second to prevent throttling errors from the AWS API.

AWS fetch batch size

Number of assets in a single batch that are fetched from a Glue database and ingested into Collibra.

Integration configuration data refresh schedule

CRON schedule that specifies when to refresh configuration options from the external system for integrations that support this functionality.

Database registration via Edge

An option to enable database registration via Edge.
The available options are:

  • Green check icon Enabled: You can register a data source via Edge or Jobserver.
    Enabling data source registration via Edge doesn't prevent you from registering a data source via Jobserver as well.
  • Red close icon Disabled: You can register a data source via Jobserver only.

Warning Jobserver and all related Jobserver integrations reached their End of Life in commercial environments in October, 2024. In Collibra Platform for Government and Collibra Platform Self-Hosted environments, they will reach their End of Life on May 30, 2027.
For information on registering a data source via Edge, go to Registering and synchronizing a data source via Edge.

Maximum number of concurrent Edge jobs

This setting specifies the maximum number of Edge jobs that can run simultaneously to connect to a data source, update a schema list, or synchronize a schema. If the maximum number is reached, subsequent jobs are queued.
The default value is 10. You can enter a value from 1 to 20.
This setting applies only to JDBC data sources.

Maximum number of ingestion rules

The setting specifies the maximum number of synchronization rules that can be defined per schema.
The default value is 10. You can enter a value from 10 to 200.
This setting applies only to JDBC data sources.

Jobserver

The configuration of the Jobserver service.

Setting Description

Jobserver list

The list of registered Jobserver instances.

Name *

The name of the Jobserver as it will appear when you register a data source in Data Catalog.

The name is a freely chosen name but it is recommended to only use alphanumerical characters and dashes, for example Jobserver-1.

You will have to use this name as the ID of the gateway and in the address of this configuration.

Protocol *

The protocol that is used for the communication between the Data Governance Center service and the Jobserver service.

It is recommended to use HTTPS, especially if the services are hosted in different network segments.

Address *

The address (IP address, URL, hostname) of the Jobserver.

Trusted server CA certificate

The certificate of the trusted CA needed to validate the server certificate. If blank, the default truststore will be used. The default truststore is defined in the SSL configuration section of the DGC service.

The CA certificate of the server party (Jobserver).

Client certificate

The client certificate offered by the DGC service to the server. If blank, you cannot select mutual authentication as the Jobserver service authentication level.

Client private key

The private key of the DGC service's certificate.

Table profiling data size *

The approximate maximum disk size of the data in MB that will be used to profile a table. The value cannot exceed 10,000.

Test connection timeout

This timeout is a time limit (in seconds) after which the connection test is stopped and a timeout error is shown. The default value is 60 seconds.

Data profiling

Profiling must be executed again after a change in this section.

Setting Description
Database profiling via Edge

Set to Green check icon Enabled to enable profiling and classification via Edge. You can only enable profiling and classification via Edge if you also enable Database registration via Edge.

Beta features

The configuration of features in preview state.

Setting Description
Settings landing enabled
  • Green check icon Enabled (default): Show the new Settings landing page in your Collibra environment.
  • Red close icon Disabled : Use the classic Settings page in your Collibra environment.
Domain type default view

Enable this setting to allow admins to set a default domain view for a domain type in the operating model.

  • Green check icon Enabled: Admins can set a default domain view for a domain type in the operating model.
  • Red close icon Disabled: A default domain view cannot be set.

For more information, go to Set or remove a default domain type view (in preview).

Derived relation support
  • Green check icon Enabled: Activates the Derived Relations feature in the latest user interface. A derived relation is a kind of relation that shows how one asset is related to another asset that is multiple relations away.
  • Red close icon Disabled (default): Deactivates the Derived Relations feature in the latest user interface.

Enable Relation Table Default View Migration

Enables the relation table default view migration feature. In the migration tool, the default relation table views are exported along with the asset type assignments when this setting is enabled.

New Diagram Canvas
  • Green check icon Enabled: Enable the new diagram canvas in the user interface.
  • Red close icon Disabled (default): Use the standard diagram canvas.
Enable smart checks

Enable smart checks for assets.

Lifecycle management

Enables lifecycle management for status-based control, introducing granular control over asset lifecycle activities, allowing administrators to define mandatory steps, including smart checks, assessments, and required sign-offs based on the asset's current status. This applies to all asset types except BI Folder, BI Report, Data Element, and Data structure and its children.

Text attribute AI-powered writing agent assistant

Enables the AI-powered writing assistant, a feature designed to significantly boost productivity and content quality for asset pages. Once enabled, administrators can define and configure context-aware AI prompts for generating, transforming, summarizing, and explaining content across various textual attributes and asset types. This provides precise control for enforcing governance standards and guaranteeing consistent, high-quality metadata output.

Update externals mappings last sync date

Updates external mappings last sync date value after each import synchronization cycle.

Frontend features

Setting Description

History start date filter visibility enabled

Enable this option to show the Start Date filter for history on all pages. This may help with performance when there are many history entries.

Date format

Select the date format to use in the new Collibra Frontend experience.

The default value is LOCALE.

Allow user locale override

Allow a user's profile settings to override the environment language and locale.

External link notice

This section contains settings for showing a warning to users when they click a link that redirects them to an external website. These settings are applicable only to the latest user interface (UI).

Setting Description
External link notice enabled
  • Green check icon Enabled: Shows a dialog box when users click external links to warn them about the redirection to third-party websites. Enabling this setting may decrease the UI performance.
  • Red close icon Disabled (default): Does not show a dialog box when users click external links.
External link notice dontAskAgain enabled
  • Green check icon Enabled: Shows a checkbox in the dialog box to allow users to choose whether they want to receive the same warning again on the same system and browser.
  • Red close icon Disabled (default): Does not show a checkbox in the dialog box.

Graph query

The configuration of the Graph query engine which is used to retrieve data from the repository.

The Graph query settings are not available in on-premises environments.

Setting

Description

Optimize Output Module JOIN statements for statements referenced in filters
  • Green check icon Enabled (default): Enhance performance of Output Module queries having inclusive filters on not required relations changing LEFT OUTER JOINs into INNER JOINs.
  • Red close icon Disabled: Do not enhance performance of Output Module queries.

Graph query limits

Setting

Description

Enables limiting of the number of root nodes in result
  • Green check icon Enabled: Enable limiting the number of root elements as result of a Graph query.
  • Red close icon Disabled (default): Disable limiting the number of root elements as result of a Graph query.
Maximum number of root nodes that can be requested with graph query API

The maximum number of root nodes that you can request in the view configuration of an API call (REST or workflow).

If you exceed this value in the view configuration, an exception is shown. If no value is defined in the view configuration, then the default value is taken.

The default value is 100,000.

Note If the number of asset types or domain types exceeds the set number, the hierarchy will be incomplete. Make sure that the limit is always higher than the actual number of asset and domain types.

Maximum number of nodes that can be requested with the graph query API in a single page The maximum number of both root and children nodes that can be requested through Output API in a single data page. If the value is outside of the allowed range an exception is thrown. The default value is 1 million.

Graph query timeouts

Setting

Description

Maximum number of minutes a graph query can run

The maximum number of minutes that the graph query runs before it will time out. The maximum is 1,440 minutes (1 day).

The default value is 480.

Table

The configuration of tables and tiles.

Setting Description
Time limit for loading data in tables in seconds

Time limit after which a table stops loading on a page.

Example A value of 600 means that if a table hasn’t loaded within 600 seconds, the task is canceled and a timeout error is shown.

The default value is 60, the maximum value is 720 seconds.

Multi-column sort

The configuration of multi-column sorting.

Setting Description
Multi-column sorting on tables
  • Green check icon Enabled: Tables can be sorted on multiple columns.
  • Red close icon Disabled (default): Tables can be sorted on one column.
Number of columns available for multi-sort

Type the maximum number of columns that can be used to simultaneously sort tables.

The default value is 3, the minimum is 1, the maximum is 9.

This setting is only relevant is Multi-column sorting on tables is Green check icon Enabled.

Inherited responsibilities

Setting Description
Enable Inherited Responsibilities
  • Green check icon Enabled: Shows both direct and inherited responsibilities when filtering or showing assets in table and tile views.
  • Red close icon Disabled (default): Shows only direct responsibilities when filtering or showing assets in table and tile views.
Note 
  • This setting affects only asset views and tile sets. It doesn't affect the Responsibilities tab on asset pages.
  • If this setting is set to True, opening a table or tile view may take longer depending on factors such as asset count, selected columns, and applied filters.

Purge configuration

The configuration of the automatic purging of data from the repository database. Purging means to delete data of a specified age. This helps to keep your data relevant and keep the database from growing infinitely.

Setting Description

Purge schedule

Cron expression specifying the timing and frequency of purge cycles. The default value is 02:00 AM every day, which equates to 0 2 * * *. The minimum value is 1 minute, which equates to * * * * *.

Note 
  • Only the minute, hour, day, month, and day of the week fields are supported. Any values provided for the seconds field are invalid.
  • If you create an invalid cron pattern, Collibra stops responding.
Maximum time for each purge cycle

Maximum time, in seconds, allowed for each purge cycle. The default value is 7200 seconds, which is 2 hours.

Note Any qualifying data that couldn't be purged within the allowed time is processed in the next purge cycle. The next purge cycle resumes from where the previous cycle stopped.
List of data elements and age at which each will be purged

Data elements and the age, in months, at which they will be purged (deleted). If you add a data element and specify its age, all data specific to the data element older than the specified age is deleted from your environment without any possibility of recovery.

The following data elements are available for purging:

  • AUDIT_HISTORY: Platform audit history, which includes the data shown on the History tab of community, domain, asset, and user profile pages.
  • AUTHENTICATION_EVENTS: Data about authentication in your environment.
  • GLOBAL_CREATE_RECENT_ASSET_TYPES: Data about which types of assets were recently created in your environment. This data is shown on the Recent tab when users create assets. By default, this data element is set to 2 months, and is visible only to users who have the SUPER role. If deleted, it is automatically restored when the application restarts.
  • JOBS: Data about all the jobs created in your environment. By default, this data element is set to 6 months.
  • LICENSE_USAGE: Data about how licenses are used in your environment. By default, this data element is set to 24 months.
  • STATISTICS: Data used to calculate data quality.
  • VALIDATION_RESULTS: Information about data validation.
Note To purge audit history, after adding the AUDIT_HISTORY data element, you will need to also enable Audit history purge acknowledgment.

List of data elements and age at which each will be purged

Click Add to specify the age, in months, at which each individual data element will be purged. This setting is available only to users who have the SUPER role.

Note Removing this configuration reverts it to the default when Collibra restarts.
Enable removal of orphaned tags

Option to enable or disable the automatic deletion of tags that aren't assigned to any assets.

  • Green check icon Enabled (default): Orphan tags are deleted based on the timing and frequency specified in the Orphaned tags removal schedule field.
  • Red close icon Disabled: Orphan tags aren't deleted.
Orphaned tags removal schedule

Cron expression specifying the timing and frequency for deleting orphan tags. The default value is 01:00 AM every day, which equates to 0 1 * * *. The minimum value is 1 minute, which equates to * * * * *.

Note 
  • Only the minute, hour, day, month, and day of the week fields are supported. Any values provided for the seconds field are invalid.
  • If you create an invalid cron pattern, Collibra stops responding.
Audit history purge acknowledgment

Option to enable or disable the purging of audit history.

  • Green check icon Enabled: Audit history is purged, if you added the AUDIT_HISTORY data element for purging in List of data elements and age at which each will be purged. Note that this action will permanently delete audit history older than the specified age, with no possibility of recovery.
  • Red close icon Disabled (default): Audit history isn't purged.

Data Classification configuration

With data classification you can automatically assign data classes to ingested data.

Setting

Description

Enable Data Classification

  • Green check icon Enabled: Enable Collibra's data classification technology.
  • Red close icon Disabled (default): Do not use Collibra's data classification technology are not accepted.

This setting is no longer in use. For information, go to About Data Classification.

Unified Classification enabled

Enables the Unified Data Classification method on Edge.

  • Red close icon Disabled: The feature is not enabled.

Unified Classification migration tool enabled

Enables the Unified Data Classification migration process.

  • Green check icon Enabled: You can manually start the migration process in Unified Data Classification. The migration process:
    • Copies classification information from the old classification methods, old Edge method and Cloud Data Classification Platform, into the Unified Data Classification method.
    • Creates data classes in the Unified Data Classification method for existing Advanced Data Types (ADTs). ADTs are supported only for Jobserver, which will be end of life on September 30, 2024.
  • Red close icon Disabled (default): The migration process is not available.

Classification thresholds

Setting

Description

Enable automatic classification acceptance and rejection

Green check icon Enabled: The automatic acceptance and rejection of data classification suggestions is active.

Red close icon Disabled (default): Data classification suggestions are not automatically accepted or rejected.

Tip Start by manually accepting and rejecting a suggested data class. Only switch to automatic acceptance and rejection if you are comfortable with the data classification results.

Automatic acceptance threshold

The percentage that determines when data classification suggestions are automatically accepted.
For example, if you set this value to 75%, classification suggestions with a confidence level of 75% or higher are automatically accepted.

If multiple classification suggestions meet the threshold for a column, the suggestion with the highest confidence level percentage is accepted automatically, as long as this suggestion is the only one to have that confidence level percentage. If two or more suggestions have the same confidence level, none are accepted automatically, and all remain visible.

Example 

You set the automatic acceptance threshold to 85% and classify a table with 2 columns.

  • For column A, there are 3 classification suggestions with confidence level 93%,92%, and 90%.
  • For column B, there are 2 classification suggestions with the same confidence level of 86%.

The results of the automatic acceptance will be:

  • For column A, the classification suggestion with 93% is accepted automatically.
  • For column B, both suggestions remain visible, none are accepted automatically.

The default acceptance threshold is 90.

Automatic rejection threshold

The percentage that determines when data classification suggestions are automatically rejected. For example, if you set this value to 49%, data classification suggestions with a confidence level of 49% or lower are automatically rejected.

The default rejection threshold is 10.

Note If the acceptance threshold and rejection threshold are set to the same value, and a data classification suggestion has this confidence level percentage, the classification suggestion will be rejected.

Sampling configuration

Setting

Description

Sampling optimization enabled

By enabling this setting, the process of checking the Edge cache for samples is much faster.

  • Green check icon Enabled (default): If samples are already cached, they are immediately visible in the asset page.
  • Red close icon Disabled: The optimization feature is not enabled.

Reporting

For more information about these settings, go to Insights Data Access.

Setting

Description

Tableau report URL pattern

The Tableau URL pattern, which should contain {reportName}.

Tip You can paste the URL from the Link field in Tableau, as described in Generate the dashboard reports you configured in Collibra Platform Settings.

Reports definitions

 

Catalog experience

Data Catalog Experience improves the layout of Data Catalog asset pages.

Setting

Description

Enable Catalog experience

  • Green check icon Enabled: Catalog experience is enabled. This will improve the layout of Data Catalog's asset pages, such as those of Data Set, Schema, Table and Column assets.
  • Red close icon Disabled: Catalog experience is disabled.

Catalog Experience Titlebar theme

The theme for the Catalog experience. You can choose between the LIGHT and DARK.

This option is only applicable if the Enable Catalog experience option is enabled.

Data Notebook configuration

This setting determines if Data Notebook is available for users.

Diagrams

These settings allow you to configure diagram behavior, including loading time, size limits, flow depth, and filtering options.

Setting

Description

Maximum loading time for the back end

Time limit, in seconds, after which a diagram stops fetching data.

The value must be a positive integer and cannot be greater than 3,600 (one hour).

The default value is 300.

Example A value of 300 means that if a diagram hasn’t fetched all data within 300 seconds, the diagram stops fetching data and an empty diagram with a notification is shown.

Size limit for the backend

Maximum number of nodes plus edges that will be fetched by the backend, to build a diagram.

The value must be a positive integer and cannot be greater than 100,000.

The default value is 10,000.

Example A value of 10,000 means that if the total number of nodes plus edges is greater than 10,000, the diagram does not load and a notification is shown.

Size limit for the frontend

Maximum number of visible nodes plus edges that can be shown on the page.

The value must be a positive integer and cannot be greater than 10,000.

The default value is 2,000.

Example A value of 2,000 means that if the total number of visible nodes and edges is greater than 2,000, the diagram does not load and a notification is shown.

Maximum flow depth

System-wide maximum number of flow relations between the start node and any other diagram node.

The value must be an integer between 1 and 100.

The default value is 50.

Note 
  • If the maximum flow depth is specified in the selected diagram view, that value supersedes the maximum you specify here.
  • You can also manually adjust the flow depth in the diagram.

Diagrams Business Qualifier Filter

  • Green check icon Enabled: Users can filter diagrams by the specified Business Qualifier asset.
  • Red close icon Disabled (default): Users can't filter diagrams by Business Qualifier.

AI Diagram Description

  • Green check icon Enabled: Descriptions are automatically generated for diagram pictures in the latest UI.
  • Red close icon Disabled (default): Descriptions aren't automatically generated for diagram pictures in the latest UI.
Note This setting isn't applicable to the classic UI.

New Diagram UI

Note This setting isn't applicable to the classic UI.

Collibra Browser Extension configuration

The settings determine how and where you can use the Everywhere Chrome Extension.

Setting Description
Domains

Add a web domain, for example of a web application such as Power BI or Tableau, on which the Browser Extension automatically appears as overlay.

Tableau metadata API

You need the Tableau metadata API to ingest Tableau 2020.2 and newer.

Warning If you upgrade to Tableau version 2020.2 or newer, but previously synchronized an older Tableau version via the REST API and XML mapping, you have to prepare the migration procedure to prevent losing manually added relations, attributes, tags, comments and stitching results.

Setting

Description

Tableau Metadata API enabled

  • Green check icon Enabled: Tableau metadata API is enabled. This enables you to ingest Tableau 2020.2 or newer into Data Catalog.
  • Red close icon Disabled: Tableau metadata API is disabled. If you ingest Tableau 2020.2 or newer, the ingestion will fail. This prevents data loss of manually added relations and attributes.
Tableau on-premise instances

Note This setting is only applicable if you are using the latest Collibra UI.

A comma-separated list of your on-premises Tableau URLs. This list represents the values that appear in the Tableau URL or endpoint drop-down list on Tableau Server asset pages. You select a URL when setting up a connection to the on-premises Tableau instance.

Tableau Online URL regular expression

A regular expression that is used to validate the format of URL of the on-premises Tableau instance.

The default expression is ^https?:\/\/[a-zA-Z0-9.-]+\.tableau\.com\/?$. We recommend that you not change the default expression unless you find that it doesn't work.

Tableau API timeout (seconds)

Specify how long (in seconds) an HTTP connection between Collibra and a remote Tableau server will stay open when there is no response from the Tableau server. The default value is 600 seconds.

Note This setting applies only to Tableau integrations via Jobserver. The end of life of Jobserver and all related Jobserver integrations has been announced for September 30, 2024. This means that the Tableau via Jobserver integration method is deprecated and will also reach its end of life on September 30, 2024.

Workflows configuration

The configuration of the workflows.

Setting Description
Allow access to the Workflow Designer
  • Green check icon Enabled: Enable the Workflow Designer access global permission which allows access to the Workflow Designer, a visual tool for creating process definitions.
  • Red close icon Disabled (default): Disable the Workflow Designer access global permission.

Warning Do not enable this option if you are working in a CPSH environment. Workflow Designer is not supported for CPSH.

Task sidebar

  • Green check icon Enabled (default): Workflow tasks appear in the sidebar on both resource pages an the task management page. Task forms appear in the sidebar instead of dialog boxes. Users can seamlessly complete their tasks from the task management page and have a side-by-side view of the tasks and resource details on resource pages.
  • Red close icon Disabled: Workflow tasks appear in the task bar on resource pages and in a sidebar on the task management page. Task forms appear in dialog boxes. The behavior is the same as with older versions of Collibra.

Important  This feature is available only in the classic UI.

Identity

Setting

Description

Limit user information access
  • Green check icon Enabled: Limits user access to information related to other users.
  • Red close icon Disabled (default): Users have access to information related to other users.

Note Users that have a role with the System or User administration permission have full access regardless of this setting.

Lineage on Edge

Setting Description
DGC user name The DGC user that is used to ingest technical lineage data into the environment via the technical lineage servers.
DGC user password Password of the DGC user that is used to ingest technical lineage data into the environment via the technical lineage servers.
Collibra system name Enable this option if Lineage uses a Collibra system name.

Collibra Protect

Setting Description
Lazy sync enabled

Enables lazy sync. If you enable lazy sync, the synchronization of all data protection standards and data access rules occurs only when any standards, rules, or target data elements in Collibra have changed since the last synchronization

Lazy sync follows the schedule you set in the Lazy sync delay field.

Lazy sync delay (in minutes)

Lazy sync delay represents the time, in minutes, between two lazy synchronizations. The minimum value is 10, and the maximum value is 4320 (3 days). The default and recommended value is 60.

Full sync enabled

Enables full sync. If you enable full sync, the synchronization of all data protection standards and data access rules occurs regardless of whether any standards, rules, or target data elements have changed since the last synchronization.

Full sync follows the schedule you set in the Full sync delay field.

Full sync delay (in minutes)

Full sync delay represents the time, in minutes, between two full synchronizations. The minimum value is 10, and the maximum value is 4320 (3 days). The default and recommended value is 1440 (1 day).

Masking Conflict Resolution

Determines if masking conflicts in Protect are manually or automatically resolved.

  • Manually (default): Conflicts need to be manually resolved.
  • With Most Masked: Conflicts are automatically resolved by applying the most restrictive masking level to the affected column.
  • With Least Masked: Conflicts are automatically resolved by applying the least restrictive masking level to the affected column.

Data Privacy

The configuration of the Data Privacy landing page.

Setting Description
Privacy landing page

Generative AI

Setting

Description

Generate descriptions with Collibra AI
Important 

This is a cloud-only feature and is not certified for Collibra Platform for Government.

Allows users to ask Collibra AI for description suggestions for the following asset types:

  • Column
  • Table
  • Database View
  • Data Set

The possible values are:

Asset external link

Setting

Description

URL patterns to external asset pages

A list of URL patterns to external asset pages:

  • External system id: The external system ID as defined by the externalSystemId field of the import file used with the Collibra REST Import API.
  • External system label: The name that the external system has on the asset page.
  • URL pattern to external asset page: The pattern to construct the URL to external asset page, for example https://external-system.com/entity/{externalEntityId}. The externalEntityId is the one defined by the same field of the import file used with the Collibra REST Import API.

Assessment Configuration

Setting

Description

Show out of the box templates
  • Green check icon Enabled (default): Shows all out-of-the-box Collibra templates to all users on the Template Gallery page and also in the template drop-down list box when conducting an assessment.
  • Red close icon Disabled: Hides all out-of-the-box Collibra templates from all users on the Template Gallery page and also in the template drop-down list box when conducting an assessment.

Knowledge Graph Configuration

Setting

Description

New Commenting Experience
  • Green check icon Enabled: New commenting experience is available on community, domain, and asset pages in the latest UI. For more information, go to New commenting experience.
  • Red close icon Disabled (default): New commenting experience isn't available on community, domain, and asset pages.

Knowledge Graph Validation

These settings determine whether changes made to assets are validated against the operating model. The validation applies to changes made through the user interface, such as by using the Apply to all visible rows option in a table view, as well as through REST API or import API.

Note 
  • Enabling these settings may reduce performance during bulk operations and imports.
  • Enabling these settings can cause integrations to fail if they set statuses, attributes, or relations that are not assigned to the relevant asset types in the operating model. Before enabling these settings, ensure that all characteristics used by your integrations are assigned to the relevant asset types. Known affected integrations include Databricks Unity Catalog, Google Knowledge Catalog, and AI model integrations.

Setting

Description

Status validation
  • Green check icon Enabled: Changes to asset statuses are validated against the global and scoped assignments of the asset types. When changing the status of an asset, the system checks if the new status is assigned to the asset type. If it isn't, the operation fails.
  • Example 

    Suppose the Report asset type has only the following statuses assigned:

    • New and Obsolete, in the global assignment.
    • Approved and Rejected, in a scoped assignment named Privacy.

    Consider the following Report assets:

    • REP1: This Report asset is in a domain that belongs to the Default scope (global assignment).
    • REP2: This Report asset is in a domain that belongs to the Privacy scope (scoped assignment).

    With the status validation enabled:

    • The status of REP1 can be changed to either New or Obsolete. If you try changing the status to anything else, the operation fails. This is because only the New and Obsolete statuses are assigned to the asset type in the global assignment.
    • The status of REP2 can be changed to either Approved or Rejected. If you try changing the status to anything else, the operation fails. This is because only the Approved and Rejected statuses are assigned to the asset type in the scoped assignment.
  • Red close icon Disabled (default): Changes to asset statuses aren't validated against the global and scoped assignments of the asset types. You can change the status of an asset, regardless of the statuses assigned to the asset type.
Attribute validation
  • Green check icon Enabled: Changes to asset attributes are validated against the global and scoped assignments of the asset types. When changing the attribute of an asset, the system checks if the type of the new attribute is assigned to the asset type. If it isn't, the operation fails.
  • Example 

    Suppose the Report asset type has only the following attribute types assigned:

    • Definition, in the global assignment.
    • Abbreviation, in a scoped assignment named Privacy.

    Consider the following Report assets:

    • REP1: This Report asset is in a domain that belongs to the Default scope (global assignment).
    • REP2: This Report asset is in a domain that belongs to the Privacy scope (scoped assignment).

    With the attribute validation enabled:

    • Only the Definition attribute of REP1 can be changed. If you try changing a different attribute, the operation fails. This is because only the Definition attribute is assigned to the asset type in the global assignment.
    • Only the Abbreviation attribute of REP2 can be changed. If you try changing a different attribute, the operation fails. This is because only the Abbreviation attribute is assigned to the asset type in the scoped assignment.
  • Red close icon Disabled (default): Changes to asset attributes aren't validated against the global and scoped assignments of the asset types. You can change the attributes of an asset, regardless of the attribute types assigned to the asset type.
Relation validation
  • Green check icon Enabled: Changes to asset relations are validated against the global and scoped assignments of the asset types. When creating a relation between two assets, the system checks if the type of the new relation is assigned to at least one of the asset types involved. If it isn't, the operation fails.
  • Example 

    With the relation validation enabled:

    • If the Report asset type has the relation type Report contains Report Attribute, and the Report Attribute asset type lacks the relation type Report Attribute contained in Report: You can create a relation between a Report asset and a Report Attribute asset using the Report contains Report Attribute relation type.
    • If the Report asset type lacks the relation type Report contains Report Attribute, and the Report Attribute asset type has the relation type Report Attribute contained in Report: You can create a relation between a Report asset and a Report Attribute asset using the Report contains Report Attribute relation type..
    • If neither the Report asset type nor the Report Attribute asset type has the relation types Report contains Report Attribute and Report Attribute contained in Report, respectively: You can't create a relation between a Report asset and a Report Attribute asset using the Report contains Report Attribute relation type.

    Sometimes, further restrictions can apply to a relation type, limiting which specific asset types are allowed in a relation. Such restrictions may prevent you from creating a relation between two assets.

    Example 

    Suppose the Report asset type has the relation type Report contains Report Attribute. However, instead of allowing the Report Attribute asset type, the relation type is restricted to allow only the BI Report Attribute asset type and its descendant asset types, as defined in the Asset Type Filter column.

    Image of the Report asset type page

    With the relation validation enabled:

    • If you try to create a relation between a Report asset and a Report Attribute asset using the Report contains Report Attribute relation type, the operation fails. This is because Report Attribute isn't an allowed asset type under the restriction.
    • Conversely, if you try to create a relation between a Report Attribute asset and a Report asset using the Report Attribute contained in Report relation type, the operation fails. This is because Report Attribute isn't an allowed asset type under the restriction. However, this operation passes if the Relation validation setting is disabled.
    • If you try to create a relation between a Report asset and a BI Report Attribute asset using the Report contains Report Attribute relation type, the operation passes. This is because BI Report Attribute is an allowed asset type under the restriction.
    • If you try to create a relation between a Report asset and a Looker Report Attribute asset using the Report contains Report Attribute relation type, the operation passes. This is because Looker Report Attribute is a descendant of the BI Report Attribute asset type and is thus an allowed asset type under the restriction.
  • Red close icon Disabled (default): Changes to asset relations aren't validated against the global and scoped assignments of the asset types. You can change the relations of an asset, regardless of the relation types assigned to the asset type.
Complex relation validation
  • Green check icon Enabled: Changes to asset complex relations are validated against the global and scoped assignments of the asset types. When creating a complex relation, the system checks if the type of the new complex relation is assigned to the asset type involved in at least one of the relations. If it isn't, the operation fails.
  • Red close icon Disabled (default): Changes to asset complex relations aren't validated against the global and scoped assignments of the asset types. You can change the complex relations of an asset, regardless of the complex relation types assigned to the asset type.

Dashboard Configuration

Setting Description
Dashboard Ordering

Enable this setting to activate dashboard ordering and the dashboard navigation panel.

  • Green check icon Enabled:
    • Dashboards are shown in a dashboard navigation panel instead of in a tab bar.
    • Dashboards can be managed via the dashboard navigation panel. You can reorder them and update their names, descriptions, sharing rules, and owners.
  • Red close icon Disabled: Dashboard ordering and the dashboard navigation panel are disabled.

For more information, go to Order dashboards and Manage a dashboard.

Improved Search Widget on Dashboard

Enable or disable Search widget improvements such as the ability to add filters and configure the search result display.

  • Green check icon Enabled: You can add filters to and configure which characteristics are shown for search results in the Search widget.
  • Red close icon Disabled: The Search widget improvements are not available.

Stewardship

Setting Description
Semantic Model Editor

An option to enable a new navigation (in preview) for Stewardship. For more information, go to About Stewardship.

AI Features

Setting Description
Semantic Model Generation

An option to enable or disable Collibra AI features in the Guided Stewardship application.

If you already enabled Collibra AI Copilot, you can also activate the semantic layer agents using the AI Agents settings page.

Important The use of Collibra AI isn't available in Collibra Platform for Government and Collibra Platform Self-Hosted environments.