IndexRecordContainer

This page provides generated reference documentation for the IndexRecordContainer data model.

In ADITO, the 'index' is a kind of parallel data container, that can be filled with selected data of connected ADITO databases.

Overview

Property	Summary
affectedIds	Process that evaluates the database audit events. This process is used to determine whether a change is relevant for the index and whether the data record in…
affectedTables	Defines the tables whose changes (via DB audit) are evaluated by the incremental indexer in order to check them for relevant changes for the index.
boostPatternProcess	Provides a boost pattern for the index search.
configMode	Specifies the type of configuration for this record container.
description	Short technical description of the model in plain text.
documentation	Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
filterExtensions	The filter extensions given
indexBuilderType	—
indexFieldMappings	Specifies the list of record fields for the entity that are included in the index.
indexGlobalTags	Specifies whether all global tags (#) for the index group should be indexed automatically.
indexRecordAlias	Alias on which the processes of this index record field is executed.
isActive	Indicates whether the record container should be used.
isGlobal	Specifies whether the index group of this record container should be included in the global search (user search).
limit	Specifies the maximum number of entries that are indexed in a single query.
paging	Specifies whether the index group should be indexed in a paging fashion.
patternExtensionProcess	Provides an extension of the pattern of the index search.
query	Process that generates the SQL query that is used by the indexer to create the index group.
searchIndexGroups	The identifier of the index groups that are searched by this record container.
splitDataSubProcess	Process which is executed once per data record of the SQL SELECT and which allows the entries to be split into multiple entries.
subProcess	Process which is executed once per data record of the SQL SELECT and which allows the entries to be overwritten or changed.
title	Singular title of the model, e.g. Surname

---

affectedIds

Type: String
Requires: indexRecordAlias property group

Process that evaluates the database audit events. This process is used to determine whether a change is relevant for the index and whether the data record in the index needs to be updated. As a result, a list with the UIDs of the changed entries is expected.

Parameters

$local.idvalue
  The ID of the requested record. If it cannot be found in query, it must be checked with vars.exist

$local.values
  Contents of the changed values

$local.oldvalues
  Contents of the original values

$local.action
  I / U / D for the respective SQLAction

$local.user
  User who makes the change

$local.timestamp
  Timestamp of the change

$local.alias
  Alias of the change

$local.table
  Table of the affected record

$local.columns
  Affected columns (Array)

---

affectedTables

Type: String[]
Requires: indexRecordAlias property group

Defines the tables whose changes (via DB audit) are evaluated by the incremental indexer in order to check them for relevant changes for the index.

The actual check is done by the process affectedIds.

Parameters

$local.indexgroupAlias
  Contains the alias information of the index group

---

boostPatternProcess

Type: String
Requires: configMode property group

Provides a boost pattern for the index search.

Parameters

$local.pattern
  The original pattern

$local.locale
  The language of the user, e.g. "De_DE"

$local.indexgroupId
  The ID of the group to be searched

---

configMode

Type: EIndexConfigurationMode

Specifies the type of configuration for this record container.

• INDEXGROUP_DEFINITION: The record container is used by the indexer to create an index group and allows the fields and contents to be configured accordingly. This will use the properties in the IndexGroup, Indexsearch and IndexBuilder elements for further configuration.
• READ_ONLY: The record container only has read access to the index and supplies content based on other index groups. This will use the properties in the Search element for further configuration.

---

description

Type: String

Short technical description of the model in plain text.

---

documentation

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

---

filterExtensions

Type: FilterExtensions

The filter extensions given

---

indexBuilderType

Type: EIndexBuilderType

---

indexFieldMappings

Type: Mappings

Specifies the list of record fields for the entity that are included in the index.

The first three entries are always the three system fields #UID, #TITLE and #DESCRIPTION.

Entries for other system fields and entries for .value and .displayValue for each entity field can be added.

---

indexGlobalTags

Type: Boolean
Default: true
Requires: configMode property group

Specifies whether all global tags (#) for the index group should be indexed automatically.

NOTE: It set to true, the corresponding system field #TAG of the index does not have to be included in the list of indexFieldMappings.

WARNING: All values for hashtags that are set directly via the SQL of the query property overwrite all values that are loaded via this flag.

---

indexRecordAlias

Type: String
Requires: configMode property group

Alias on which the processes of this index record field is executed.

---

isActive

Type: Boolean
Default: true
Requires: configMode property group

Indicates whether the record container should be used.

If it is deactivated (false), it is not indexed and can neither be used by the record container nor by the global search.

---

isGlobal

Type: Boolean
Default: true
Requires: configMode property group

Specifies whether the index group of this record container should be included in the global search (user search).

---

limit

Type: Integer
Requires: paging = true

Specifies the maximum number of entries that are indexed in a single query.

NOTE: It can only be set if paging is true. The minimum value of the limit is 100. So if you set it below 100, it will be set to 100. You should also set the limit to a value that is one greater than the max number of entries with the same ID. If not, then paging will not work. To get the limit value in the query process, you should use $local.pagingLimit.

---

paging

Type: Boolean
Default: false
Requires: configMode property group

Specifies whether the index group should be indexed in a paging fashion.

NOTE: If paging is true, then a WHERE clause and LIMIT need to be added to the query process. The WHERE clause needs to check if the last ID from the previous page is equal or greater than the current ID.

---

patternExtensionProcess

Type: String

Provides an extension of the pattern of the index search.

This supplied pattern is then associated with "and" with the original pattern.

These localvar are available here:

• $local.pattern - the original pattern
• $local.locale - the language of the user as locale, e.g. "De_DE"
• $local.indexgroupId - group to be searched, cf. indexGroup

Parameters

$local.pattern
  The original pattern

$local.locale
  The language of the user, e.g. "De_DE"

$local.indexgroupId
  The ID of the group to be searched

---

query

Type: String
Requires: indexRecordAlias property group

Process that generates the SQL query that is used by the indexer to create the index group.

The columns in the SELECT must match the order and number of the entries specified in the recordFieldMappings.

Parameters

$local.idvalue
  The ID of the requested record. If it cannot be found in query, it must be checked with vars.exist

$local.indexgroupId
  Contains the name of the index group

$local.indexgroupAlias
  Contains the alias information of the index group

---

searchIndexGroups

Type: String[]
Requires: configMode property group

The identifier of the index groups that are searched by this record container.

---

splitDataSubProcess

Type: String
Requires: indexRecordAlias property group

Process which is executed once per data record of the SQL SELECT and which allows the entries to be split into multiple entries.

IMPORTANT: It is advised to reduce ressource heavy executions (e.g. entities.get*) to a minimum as it can have major negative performance impact as this processes will be called for every document!

Parameters

$local.idvalue
  The ID of the currently indexed record. If it cannot be found in query, it must be checked with vars.exist

$local.indexgroupId
  Contains the name of the index group

$local.indexgroupAlias
  Contains the alias information of the index group

$local.data
  The current row data for one record loaded by the indexer.

---

subProcess

Type: String
Requires: indexRecordAlias property group

Process which is executed once per data record of the SQL SELECT and which allows the entries to be overwritten or changed.

IMPORTANT: It is advised to reduce ressource heavy executions (e.g. entities.get*) to a minimum as it can have major negative performance impact as this processes will be called for every document!

Parameters

$local.idvalue
  The ID of the currently indexed record. If it cannot be found in query, it must be checked with vars.exist

$local.indexgroupId
  Contains the name of the index group

$local.indexgroupAlias
  Contains the alias information of the index group

$local.fields
  The indexed fields as imagemap

---

title

Type: String
Constraints: Verification: TITLE_LENGTH

Singular title of the model, e.g. Surname