Tenant-Level Settings

These are default settings. To edit them, work with your Smart Search onboarding representative.

These typically one-time administrator settings affect Smart Search’s default behavior and usability at the tenant (organizational) level.

Setting

Default Setting

Description

emailReportTemplate.subject

${objectname} report ${date}

Default subject for an email report containing search results

emailReportTemplate.body
Hi -- Here is the report of the recent search you ran\n. Thanks\n!

Body prelude for an email report containing search results

limits.alias

15 (Max: 30)

Number of private aliases permitted per user

limits.globalAliasList

50 (Max: 100)

Number of public aliases permitted globally for the entire tenant

limits.enableLargeFileSearch

false

Enable large file search for the tenant.

limits.docSearchLimit

2000

Maximum number of documents that will be pulled up for a keyword search

limits.searchResultLimit

100

Maximum number of records to pull up during a regular search

limits.pageSize

30

Maximum number of records to fit into a single client page. If more records are returned, they are subjected to automatic pagination.

limits.snippetWindowSize
limits.maxSnippetsInSearch
limits.matchWholeWordsOnly
limit.preferWholeWordsMatch
limits.enableSynonymSearch
limits.snippetMatchIgnoreCase
limits.startSnippetMatchAtPage
limits.endSnippetMatchAtPage
limits.enableContentDocumentSearch
limits.enableDocVersionSearch
limits.enableAgreementDocSearch

See API-level settings.

See API-level settings for details. These are tenant-level defaults.

limits.applyDefaultAlias
limits.personalize

See API-level settings.

See API-level settings for details. These are tenant-level defaults.

limits.keywordCacheTimeout

30 (minutes)

Time (in minutes) keyword search hits are saved in cache for future searches.

API-Level (Search) Settings 

Setting

Comments

Description

options.fetchResults (payload)

Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, user queries resolve to actual records in the data provider (e.g., SFDC). Else only the query is returned.

options.sessionTreatment (payload)

Default: clear

Endpoints:

  • resolvephrase

  • resolvequeryplan

  • If omitted, the user is logged out and session info is purged. Subsequent searches suffer the overhead of recreating the session.
  • If set to clear, the session is reset after running the search command. If left idle for 5 minutes, the session is purged.
  • If set to keep-alive, the session continues so that followup queries can be sent to Max just like a conversational UI. This mode is not fully supported

options.fetchQueryPlan (payload)

Default: false

Endpoints:

  • resolvephrase

This is for internal unit test purposes only

options.timeout (payload)

Default: 60 secs (Max: 90 secs)

Endpoints:

  • resolvephrase

  • resolvequeryplan

  • document/*

Defines how long an API call waits for a response before timing out.

timezone (query param)

Default: America/Los_Angeles

Endpoints:

  • ichronos/*

  • resolvephrase

  • resolvequeryplan

Time zone for API requests. Typically set by the client to the user’s time zone.

options.searchResultLimit (payload)

Default: 100

Endpoints:

  • resolvephrase

  • resolvequeryplan

Number of records to pull up during a regular search

options.pageSize (payload)

Default: 30

Endpoints:

  • resolvephrase

  • resolvequeryplan

Number of records that will fit into a single client page. If more records are returned, they are automatically paginated.

options.snippetWindowSize (payload)

Default: 200

Endpoints:

  • snippet

  • snippetfromrequest

  • snippetfromfile

Size of extracted snippet matching keywords

options.maxSnippetsInSearch (payload)

Default: 10

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromrequest

  • snippetfromfile

Number of snippets extracted for matching keywords.

This is a user-adjustable per-search setting.

options.matchWholeWordsOnly (payload)

Default: true

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromrequest

  • snippetfromfile

If true, matches whole words only. Otherwise, also matches substrings.

This is a user-adjustable per-search setting.

options.preferWholeWordsMatch (payload)

Default: true

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromrequest

  • snippetfromfile

If true, first tries whole-word match. If none, found try partial word (substring) match.

This setting overrides matchWholeWordsOnly.

This is a user-adjustable per-search setting.

options.enableSynonymSearch (payload)

Default: false

Endpoints:

  • resolvephrase

  • resolvequeryplan

  • snippet

  • snippetfromchunks

  • snippetfromrequest

  • snippetfromfile

If true, search matches synonyms in addition to keywords.

This is a user-adjustable per-search setting.

options.snippetMatchIgnoreCase (payload)

Default: true

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromrequest

  • snippetfromfile

If true, search performs a case-insensitive keyword match.

This is a user-adjustable per-search setting.

options.startSnippetMatchAtPage (payload)

Default: 0

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromfile

The 0-based page index at which the snippet search will begin.

Negative values signify page numbers in reverse direction:

  • -1 => last page, -2 => second to last…

options.endSnippetMatchAtPage (payload)

Default: -1

Endpoints:

  • snippet

  • snippetfromchunks

  • snippetfromfile

The 0-based page index at which the snippet search will end.

Negative values signify page numbers in reverse direction:

  • -1 => last page, -2 => second last…

options.applyDefaultAlias (payload)

Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, default aliases will apply to searches. For instance, when user asks for opportunities, only opportunities that are still open are filtered by default.

Setting this to false automatically turns off the default.

options.personalize (payload)

Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, a default “my” clause is appended to the searches. When user asks for agreements matching certain criteria, the search is conducted on agreements that the user either created or is owner of.

Under certain circumstances, personalization is turned off automatically. Setting this to true does not mean personalization will always apply: it means the user is asking Max to resort to its default behavior: to personalize when it makes sense to do so.

Setting this to false turns off personalization.

limits.enableContentDocumentSearch (payload)

Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, ContentVersion and associated ContentDocument are searched

limits.enableDocVersionSearch (payload)


Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, ContentVersion and the associated DocVersion are searched

limits.enableAgreementDocSearch (payload)

Default: true

Endpoints:

  • resolvephrase

  • resolvequeryplan

If true, ContentVersion and the associated AgreementDocument are searched

options.includeFiles (payload)

Default: ["*"]

Endpoints:

  • resolvephrase

  • resolvequeryplan

  • resolvefollowup

List of regular expressions identifying files that are included in the document search; for example: ["test*.docx", "intelligent*.pdf", "*.rtf"]

options.excludeFiles (payload)

Default: []

Endpoints:

  • resolvephrase

  • resolvequeryplan

  • resolvefollowup

List of regular expressions identifying files that are excluded from the document search; for example: ["*.jpg", "*.png"]