CustomDatasourceConfig.md

CustomDatasourceConfig

Structure describing config properties of a custom datasource

Fields

Field	Type	Required	Description	Example
name	String	✔️	Unique identifier of datasource instance to which this config applies.
displayName	Optional<String>	➖	The user-friendly instance label to display. If omitted, falls back to the title-cased name.
datasourceCategory	Optional<DatasourceCategory>	➖	The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to this for more details.
urlRegex	Optional<String>	➖	Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. Note: urlRegex is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.	https://example-company.datasource.com/.*
iconUrl	Optional<String>	➖	The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
objectDefinitions	List<ObjectDefinition>	➖	The list of top-level objectTypes for the datasource.
suggestionText	Optional<String>	➖	Example text for what to search for in this datasource
homeUrl	Optional<String>	➖	The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page.
crawlerSeedUrls	List<String>	➖	This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling.
iconDarkUrl	Optional<String>	➖	The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
hideBuiltInFacets	List<HideBuiltInFacet>	➖	List of built-in facet types that should be hidden for the datasource.
canonicalizingURLRegex	List<CanonicalizingRegexType>	➖	A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list.
canonicalizingTitleRegex	List<CanonicalizingRegexType>	➖	A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results
redlistTitleRegex	Optional<String>	➖	A regex that identifies titles that should not be indexed
connectorType	Optional<CustomDatasourceConfigConnectorType>	➖	N/A
quicklinks	List<Quicklink>	➖	List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira
renderConfigPreset	Optional<String>	➖	The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. web or gdrive. Please refer to this for more details
aliases	List<String>	➖	Aliases that can be used as app operator-values.
isOnPrem	Optional<Boolean>	➖	Whether or not this datasource is hosted on-premise.
trustUrlRegexForViewActivity	Optional<Boolean>	➖	True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load.
includeUtmSource	Optional<Boolean>	➖	If true, a utm_source query param will be added to outbound links to this datasource within Glean.
stripFragmentInCanonicalUrl	Optional<Boolean>	➖	If true, the fragment part of the URL will be stripped when converting to a canonical url.
identityDatasourceName	Optional<String>	➖	If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already and the datasource with identity info should have its visibility enabled for search results.
productAccessGroup	Optional<String>	➖	If the datasource uses a specific product access group, then the name of that group.
isUserReferencedByEmail	Optional<Boolean>	➖	whether email is used to reference users in document ACLs and in group memberships.
isEntityDatasource	Optional<Boolean>	➖	True if this datasource is used to push custom entities.
isTestDatasource	Optional<Boolean>	➖	True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings.