Page Comparison

id String

Name of the source

conn String

Used connection.
Refer to ELO connections

sourceType String

In case of ELO: elo

keyName String

Name of the indexed object. If not set, it will default to sord.Name

key String

Unique Id of the indexed object. If not set, it will default to sord.Guid

runInterval Integer

reindex interval of the source in seconds

runDelay Integer

delay before the first reindex run in seconds.

runAt String

instead of using an interval, you can define a specific time when the reindex will be triggered. Example:

runtAt: 07:00

maxResultSize Integer

Per default, the ELO results are limited to 10.000 elements. By defining this property, you can overwrite the default to a higher value.

excludeKeysFromSuggestions
List<String>

This list excludes the Keys from being added to the suggesters. Suggesters are used inside the search as “Completion Suggester” and “Did you Mean”.

For ELO sources, a good practice is to filter all the internal fields. Example:

excludeKeysFromSuggestions: [guid, key, path, xDateIso, iDateIso, fileExtension, owner, parentId, isDocument, fileSize, desc, icon]

icon String

See Entry Icons

sourceSpecific.mask String

Keywording mask

Either the name of the mask or the SordID

sourceSpecific.searchParams
List<String name, String value>

A list of ELO index fields to narrow the search.

A list entry consists of the internal group name of an ELO index field and the value.

Example:

searchParams:
- name: SALDOCTYPE
  value: Auftragsbestätigung
- name: COMPANY
  value: 'CRONUS AG'

sourceSpecific.documentDate

These settings are under sourceSpecific and limits the search to a time range – either into the future or the past.

The range will be applied on the ELO-Sord property “External Date“ (aka. Document Date).

Example:

documentDate:
  from: 365
  to: 730

This example limits the reindex to documents that are older than two years or newer than a year.

It is also possible to use exact dates. The dates have to be written in the ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format. Example:

documentDate:
  from: 2021-01-01
  to: 2021-12-31

This example limits the reindex to all documents from 2021.

sourceSpecific.archivingDate

These settings are under sourceSpecific and limits the search to a time range – either into the future or the past.

The range will be applied on the ELO-Sord property “Internal Date“ (aka. Archiving Date).

Example:

archivingDate:
  from: 0
  to: 90

This example limits the reindex to documents that are archived at max for 90 days. The property from: is set to zero, so could also be left out.

It is also possible to use exact dates. The dates have to be written in the ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format. Example:

archivingDate:
  from: 2021-01-01
  to: 2021-12-31

This example limits the reindex to all documents that have been archived in 2021.

sourceSpecific.maps
List<object>

Index ELO maps of a given object. Due to a lot of different configuration setups, you must define which fields are imported.

Example:

maps:
  - domain: objekte
    name: INVOICE_TAX
    type: table
  - domain: formdata
    name: MY_VERY_LONG_TEXT
    type: string

Domain
You need to define which domain you want to use, typically this would be objekte or formdata - in case of fields used in Business Solutions.

You can also define your own domain (e.g. ApplicationA). See also de.elo.ix.client.MapDomainC in the ELO IndexServer documentation.

Type
Can either be string or table. If the type is table, Portrait will collect a value and convert it into a table and store it as a list of objects.

Name
The name of the map field or the common prefix of a map-table.

Given the above examples, the map fields can be accessed via the following names from the UI:

• string: map_formdata_MY_VERY_LONG_TEXT

• table: table_objekte_YOUR_TABLE_PREFIX

sourceSpecific.blacklistAdministrationexcludeEntriesWithinAdministration
boolean

Default: true

Determines if sords within the ‘administration’ folder are blacklisted and therefore not indexed.

sourceSpecific.blacklistChaosablageexcludeEntriesWithinChaosFolder
boolean

Default: true

Determines if sords within the ‘chaosablage’ folder are blacklisted and therefore not indexed.

sourceSpecific.excludeEntriesWithinFolder
List of GUIDS

Default: empty

Can be set to exclude certain directories for indexing. All Sords within the specified folders and its subdirectories are ignored.

Example

      excludeEntriesWithinFolder:
        - '(448C7C94-36A1-F634-158B-A70D0B29986A)'