Application settings in the file appsettings.json
Warning
The file must be in valid JSON format.
The file path is BaseDirectory\Concrii\appsettings.json.
Check out the definitions in the Installation thread to learn more about Concrii's filesystem properties.
Using the GUI, you can access, edit and save the appsettings.json under Configurationin the top navigation bar.
Within file appsettings.json, the application settings are placed beneath the system settings.
Id
| Type |
Description |
Default |
| string |
Id/name of this concrii instance. will be sent to your encryption service (audit), too. |
null |
OfflineForFriends
| Type |
Description |
Default |
| boolean |
Specifies whether this Concrii instance should be offline for Friends. |
false |
Friends
Dictionary of generic Friend configuration objects. Currently, Concrii supports httpsFriends which are accessible via http, and therefore also using REST requests.
| Attribute |
Type |
Description |
Default |
| Active |
boolean |
Specifies whether this Friend is active. |
true |
| Id |
string |
Specifies the Id of the Friend instance. |
null |
| Configuration |
object |
friend type specific configuration. |
null |
| Hips |
object [Hips](~/config/hips.md |
hips configuration. |
default Hips |
| Forwards |
object |
forwards configuration. |
default Forwards |
Configuration
Each Friend instance is allowed to specify how it is configured which is why every kind of a Friend instance has it's own configuration class. As of now, configuration takes place using the HttpFriendConfiguration class with the properties of an Endpoint and a Timeout in miliseconds. Following type:, the configuration requires the Full Qualified Domain Name (FQDN) of the configuration class. A FQDN consists of the class and the assemblyname, separated by a comma. The assemblyname gives away the .dll that the class is part of.
| Attribute |
Type |
Description |
Default |
| Id:type |
string |
Full Qualified Domain Name (FQDN) consisting of configuration class |
null |
bizconAG.concrii.Friends.HttpFriendConfiguration, bizconAG.concrii.Friends
| Property |
Type |
Description |
Default |
| Endpoint |
string |
Specifies the http Endpoint of the Friend. |
null |
Hips
| object [Hips](~/config/hips.md | hips configuration. | default Hips |
Forwards
The Forwards settings configures if index actions should be forwarded to available friends
Forwards settings
The respective settings to create, update and erase forwarding
| Nested Object |
Type |
Description |
Default |
| Active |
boolean |
Do forward this action (true). |
true |
| Parallel |
boolean |
Do this action in parallel to myself: true. |
false |
Schedules
| Attribute |
Type |
Description |
Default |
| Name |
string |
An identifying, unique name (log). |
null |
| Schedule |
string |
.net crontab configuration. Find out more about .net crontab here. |
null |
| Configuration |
object |
schedule type specific configuration. |
null |
Configuration
| Attribute |
Type |
Description |
Default |
| Id:type |
string |
Full Qualified Domain Name (FQDN) consisting of configuration class |
null |
SetIndexes scheduler checks configuration of indexes and sets its inital status.
bizconAG.concrii.Worker.ScheduledWorker.UpdateFriendsConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of friend ids to be excluded. | empty array |
UpdateFriends scheduler checks status of all configured friends and update its status. Most important here is, whether the friend is available or not (Usable).
bizconAG.concrii.Worker.ScheduledWorker.SetIndexesConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of index ids to be excluded. | empty array |
SetIndexes scheduler checks configuration whether there are indexes added or changed. If so, new indexes will be set and are available (Gui and api).
Warning
Indexes have to be (re)created in order to make changes effective.
bizconAG.concrii.Worker.ScheduledWorker.CreateIndexesConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of index ids to be excluded. | empty array |
CreateIndexes scheduler checks configuration CreateSchedule on all indexes. If setting is valid and schedule matches current time, index will be (re)created.
bizconAG.concrii.Worker.ScheduledWorker.UpdateIndexesConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of index ids to be excluded. | empty array |
UpdateIndexes scheduler checks configuration UpdateSchedule on all indexes. If setting is valid and schedule matches current time, index will be updated. Updated means, all collected update ids (from api update requests) will be processed.
bizconAG.concrii.Worker.ScheduledWorker.HealIndexesConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of index ids to be excluded. | empty array |
HealIndexes scheduler checks health status of all index. If health is bad, index will be healed; healing means: index will be recreated.
bizconAG.concrii.Worker.ScheduledWorker.UpdateTableStatusConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of table ids to be excluded. | empty array |
UpdateTableStatus scheduler queries all database tables to get total rows size. This is needed for internal calculations and decisions about how to search and retrieve data.
bizconAG.concrii.Worker.ScheduledWorker.UpdateColumnStatusConfiguration, bizconAG.concrii.Worker
| Attribute | Type | Description | Default |
| Exlcude | string array | A list of column ids to be excluded. | empty array |
UpdateColumnStatus queries all table columns to get average value length. This is needed for internal calculations and decisions about how to search and retrieve data.
Databases
Array of database objects that describe the databases that Concrii should be used for. Currently, Concrii supports MsSQL, Oracle, PostgreSQL and ODBC.
| Attribute |
Type |
Description |
Default |
| Id |
string |
Unique Id (needed for referencing to the database). |
null |
| Name |
string |
Needed to determine the database's name, which can then be used for MsSQL USE statements to change the database context to the specified database or database snapshot in SQL Server; not needed for Oracle. |
null |
| Configuration |
object Configuration |
database type specific configuration. |
null |
Configuration
| Attribute |
Type |
Description |
Default |
| Id:type |
string |
Syntax: type:configuration class to make database connection. |
null |
bizconAG.concrii.Database.MsSqlConfiguration, bizconAG.concrii.Database
| Property |
Type |
Description |
Default |
| ConnectionString |
string |
Specifies the Connectionstring to connect to the database. The Connectstring differs depending on what databases are used. You can see some examples here. |
null |
bizconAG.concrii.Database.OracleConfiguration, bizconAG.concrii.Database
| Property |
Type |
Description |
Default |
| ConnectionString |
string |
Specifies the Connectionstring to connect to the database. The Connectstring differs depending on what databases are used. You can see some examples here. |
null |
bizconAG.concrii.Database.PostgreSqlConfiguration, bizconAG.concrii.Database
| Property |
Type |
Description |
Default |
| ConnectionString |
string |
Specifies the Connectionstring to connect to the database. The Connectstring differs depending on what databases are used. You can see some examples here. |
null |
bizconAG.concrii.Database.OdbcConfiguration, bizconAG.concrii.Database
| Property |
Type |
Description |
Default |
| ConnectionString |
string |
Specifies the Connectionstring to connect to the database. The Connectstring differs depending on what databases and odbc drivers are used. You can see some examples here. |
null |
| LengthCommand |
string |
Override Length keyword within sql queries. |
"LENGTH" |
| AverageCommand |
string |
Override Average keyword within sql queries. |
"AVG" |
| CountCommand |
string |
Override Count keyword within sql queries. |
"COUNT" |
| RoundCommand |
string |
Override Round keyword within sql queries. |
"ROUND" |
| CastCommand |
string |
Override Cast keyword within sql queries. |
"CAST" |
| AsCommand |
string |
Override As keyword within sql queries. |
"AS" |
| FromCommand |
string |
Override From keyword within sql queries. |
"FROM" |
| OrderByCommand |
string |
Override Order By keyword within sql queries. |
"ORDER BY" |
| DistinctCommand |
string |
Override Distinct keyword within sql queries. |
"DISTINCT" |
| SelectCommand |
string |
Override Select keyword within sql queries. |
"SELECT" |
| FloatDatatype |
string |
Override Float datatype within sql queries. |
"FLOAT" |
| DecimalDatatype |
string |
Override Decimal datatype within sql queries. |
"DECIMAL" |
| ColumnForLengthCommandTemplate |
string |
When querying columns for (value) length, some databases need special treatment when speifying the column name. Adapt the template to your needs; {0} is replaced with the original column name. |
"{0}" |
| DatabaseUseStatement |
boolean |
Whether to call USE database sql statement or not. |
false |
| LimitOrOffsetFetch |
boolean |
Whether to use LIMIT statement (true) or OFFSET/FETCH statement(false) to limit query results |
true |
| AddOrderByIfMissingForOffsetFetch |
boolean |
If OFFSET/FETCH is used within query, an ORDER BY statement might be needed (depending on the underlying database type). If this ORDER BY statement is missing, it will be added as you specify it here (include ORDER BY). |
null |
Tables
Array of table objects. The Tables allows the User to specify the actual tables that should be searchable using Concrii.
| Attribute |
Type |
Description |
Default |
| Id |
string |
Unique Id for table has to be specified. The Id serves as common anchor. |
null |
| IdColumn |
string |
The Id of the Id column within the table where this column exists. |
null |
| Name |
string |
Database Name of the table (needed within queries). |
null |
| Database |
string |
The Database's Name(unique Id) that the table is part of. The Name can be specified in the Databases array. |
null |
| MaxWhereInUsage |
string |
In case the search results can already be limited to an arbitrary number of entries (same goes for the retrieval process), the SQL statement WHERE IN can be used. The MaxWhereInUsage attribute allows the specification of a maximum number of entries to the WHERE IN statement, that can be given as a number (string) or a percentage (e.g. 10%). |
"100%" |
| MaxWhereInUsageLimit |
integer |
Specifies the absolute limit of entries in the WHERE IN SQL statement, even if a percentage is given in MaxWhereInUsage. |
100000 |
Warning
MaxWhereInUsage and MaxWhereInUsageLimit are advanced settings, expert usage only!
EncryptorProvider
Object array of encryptor provider configuration objects. In order to carry out decryption and encryption tasks as part of a search, Concrii needs to be given several pieces of information about the Encryption Provider that is used. These can be several SDA (Secure Data Appliance) providers.
| Nested Object |
Type |
Description |
Default |
| Id:type |
string |
Full Qualified Domain Name (FQDN) consisting of configuration class |
null |
bizconAG.concrii.Encryptor.Sda.Configuration, bizconAG.concrii.Encryptor
| Attribute |
Type |
Description |
Default |
| PolicyUrl |
string |
Specifies the URL to connect to Secure Data Appliance (SDA). |
null |
| EnableCrlCheck |
boolean |
Either true to enable CRL check, or false to disable CRL check. |
true |
| AllowShortFpe |
boolean |
either true to allow FPE plaintext shorter than the cryptographically secure limit of 8 bits, or false to disallow short FPE plaintext. |
true |
| EnableCrlCheck |
boolean |
Either true to enable CRL check, or false to disable CRL check. |
true |
| EnableMemoryCache |
string |
Either true to enable in-memory caching, or false to disable in-memory caching. |
true |
| NetworkTimeout |
integer |
A value between 1 and 300 (0 means not set and use default value from SDA), inclusive, that will be used as the network timeout value for all network interactions with the Voltage SecureData Server. |
0 |
| FileCachePath |
string |
The directory that will be used as the root of the file-based caching that is enabled by calling this method. |
"" |
| KeyServerHost |
string |
The FQDN to be used in the URL constructed when requesting cryptographic keys and retrieving public parameters, and possibly to be used when constructing a URL to retrieve the Client Policy file to be associated with the LibraryContext instance you are building. (default: empty, not set) |
"" |
| PolicyFilePath |
string |
The path of the Client Policy file to be associated with the LibraryContext instance you are building. |
"" |
| AllowNonHardwareRNG |
string |
Either true to allow the use of a non-hardware-based PRNG seed value, or false to disallow the use of a non-hardware-based PRNG seed value. |
false |
| TrustStorePath |
string |
The directory to use as the truststore for non-Windows installations of the Simple API. |
"" |
| Authentication |
object Authentication |
SDA Authentication configuration. |
|
Authentication
| Nested Object |
Type |
Description |
Default |
| Type |
enum |
*SharedSecret* or *UserPassword*. SharedSecret is a string that contains the shared secret. Alternatively, Username and Password should be given as strings. |
null |
| Username |
string |
Username when type is UserPassword |
null |
| Password |
string |
Username when type is UserPassword |
null |
| SharedSecret |
string |
Username when type is SharedSecret |
null |
Encryptors
Dictionary that handles the configuration of the Encryptor which specifies how Concrii applies the SDA procedures directly to table columns. Supported standards are AES and FPE.
| Nested Object |
Type |
Description |
Default |
| EncryptorProvider |
string |
id from encryption provider must be specified here, see EncryptionProvider. |
null |
| Key(Id) |
string |
Id of the Encryptor must be specified. |
null |
| Configuration |
object Configuration |
Specific configuration object dependent to the type. |
null |
| Type |
enumeration EncryptorType |
*FPE* or *AES*. Type of encryption that is being used. |
FPE |
| Hips |
object HipsBase |
Basic hips factor for this encryptor. |
default HipsBase |
EncryptorType
Specifies type of encryption.
Configuration
| Attribute |
Type |
Description |
Default |
| Id:type |
string |
Full Qualified Domain Name (FQDN) consisting of configuration class. |
null |
bizconAG.concrii.Encryptor.Sda.FpeEncryptorConfiguration, bizconAG.concrii.Encryptor
| Attribute |
Type |
Description |
Default |
| Identity |
string |
Identity to be used for encryption. |
null |
| Format |
string |
Format to be used for encryption (FPE only). The format is configured in the SDA application, so make sure to use format attributes consistent with your SDA configuration. |
null |
| RandomizeMinLength |
integer |
Randomize the clear data length before encryption with at least RandomizeMinLength characters (needs RandomizeMaxLength to be valid). |
null |
| RandomizeMaxLength |
integer |
Randomize the clear data length before encryption with maximum RandomizeMaxLength characters (needs RandomizeMinLength to be valid). |
null |
| Appender |
string |
System setting describing how data is appended internally. |
"|" |
| Filler |
character |
System setting specifying which character is to be used during data length shift operations. |
'a' |
| Splitter |
string |
System setting specifying if database column value concatenates multiple encrypted values by this string. |
null |
| OverrideValueIntegrity |
boolean |
Set (override autodetected) value integrity of this encryptor. |
null |
bizconAG.concrii.Encryptor.Sda.AesEncryptorConfiguration, bizconAG.concrii.Encryptor
| Attribute |
Type |
Description |
Default |
| Identity |
string |
Identity to be used for encryption. |
null |
| Mode |
Enumeration |
Aes mode to be used: ECB or CBC. |
"ECB" |
| RandomizeMinLength |
integer |
Randomize the clear data length before encryption with at least RandomizeMinLength characters (needs RandomizeMaxLength to be valid). |
null |
| RandomizeMaxLength |
integer |
Randomize the clear data length before encryption with maximum RandomizeMaxLength characters (needs RandomizeMinLength to be valid). |
null |
| Appender |
string |
System setting describing how data is appended internally. |
"|" |
| Filler |
character |
System setting specifying which character is to be used during data length shift operations. |
'a' |
| Encoding |
string |
System settingwhich encoding to use on string operations. |
"utf-8" |
| OverrideValueIntegrity |
boolean |
Set (override autodetected) value integrity of this encryptor. |
null |
bizconAG.concrii.Encryptor.Intern.AesEncryptorConfiguration, bizconAG.concrii.Encryptor
| Attribute |
Type |
Description |
Default |
| Key |
string |
Key to be used for encryption. |
null |
| Mode |
Enumeration |
Aes mode to be used: ECB or CBC. |
"ECB" |
| RandomizeMinLength |
integer |
Randomize the clear data length before encryption with at least RandomizeMinLength characters (needs RandomizeMaxLength to be valid). |
null |
| RandomizeMaxLength |
integer |
Randomize the clear data length before encryption with maximum RandomizeMaxLength characters (needs RandomizeMinLength to be valid). |
null |
| Appender |
string |
System setting describing how data is appended internally. |
"|" |
| Filler |
character |
System setting specifying which character is to be used during data length shift operations. |
'a' |
| Encoding |
string |
System settingwhich encoding to use on string operations. |
"ascii" |
| OverrideValueIntegrity |
boolean |
Set (override autodetected) value integrity of this encryptor. |
null |
Columns
Array of column objects. Every datatable column that the search should be performed on needs to be configured.
| Attribute |
Type |
Description |
Default |
| Id |
string |
Unique Id is not relevant for referencing. |
null |
| Name |
string |
The name that the column should be given within the database (needed as part of queries). e.g. "FIRSTNAME". |
null |
| Table |
string |
Table that the column is part of (Id in the Tables object that describes the corresponding table). |
null |
| Encryptor |
string |
Encryptor Id (specify the encryptor if column is or will be encrypted). |
null |
Indexes
Array of index objects. The indexes are all handled in memory. If you did not configure any index, Concrii would still work, but always carry out searches on the database itself, increasing search time tremendously.
| Attribute |
Type |
Description |
Default |
| Id |
string |
Specify an unique Id needed for referencing. |
null |
| Type |
enumeration Index types |
Common type of an index *Index* (always). |
Index |
| Mode |
enumeration Index modes |
Datamode of an index. |
Columns |
| IdColumn |
string |
Id column to be used to create the index with corresponding keys (keyvalues). If null (default), id column of table will be used. If *columnId*, this column will be used as id (column MUST be within same table as columns). If `` (empty string), index entries will set without id / key. |
null |
| Columns |
string array |
Id of the column to be indexed. |
null |
| Where |
string |
A custom sql where query to filter data to be indexed. Omit usage of Where keyword. |
null |
| CreateOnStart |
boolean |
Create this index when application starts. |
null |
| CreateSchedule |
string |
.net crontab configuration when to (re)create indexes. Find out more about .net crontab here. |
null |
| UpdateSchedule |
string |
.net crontab configuration when to update indexes. Find out more about .net crontab here. If this setting is not empty (valid crontab expression), index update requests (api) will not be processed directly, but cached to be updated within this scheduler. Multiple index update requests or better the corresponding update ids will be merged. |
null |
| Friends |
enumeration Friends priorization |
*Off*, *On*, or *Prioritize* |
"Off" |
| OmitAutoDetect |
boolean |
if true, this index will not be detected via AutoDetect mode (search and retrieve). To use this index (search or retrieve), the id must be explicitly set within the request. |
false |
| UseIfUnhealthy |
boolean |
if true, this index will be used even if unhealthy (search and retrieve). |
true |
| UpdateIdsThresholdUseCreate |
string |
Decimal value (given as numer e.g. 1000 or as percentage e.g. 1%) which allows the update index process to switch to create index process when number of ids to update are greater then this threshold (total number, or percentage of number of index ids) |
"0.5%" |
| Hips |
object Hips |
Basic hips factor for this encryptor. |
default Hips |
| Partial |
string array |
Id of an index that will be additionally searched when current index is being searched. Use this feature together with Value / Id Filter when splitting an index over multiple Concrii Instances. |
null |
| Configuration |
object |
Index implementation specific configuration. |
null |
| CreateOnUpdateIfNotCreated |
boolean |
Create (recreate) index when update received but index not created. |
false |
| CreateOnUpdateIfUnhealthy |
boolean |
Create (recreate) index when update received und index is unhealthy. |
false |
| MaxHistoryEntries |
integer |
Number of entries to be kept in index history (filo, oldest entries will be discarded). |
100 |
| OverrideCanRetrieve |
boolean |
Declare index to be retrievable even if concrii autodetects that this index cannot retrieve data. If an index does not contain original values (maybe patched values) retrieving data is not possible. |
false |
| OverrideCanSearch |
boolean |
Declare index to be able to search even if concrii autodetects that this index cannot do searches with valid (correct) results. By now, indexes with mode Column can search, only |
false |
| OverrideCanBeUpdated |
boolean |
Declare index to be able to be updated (with api request) even if concrii autodetects that this index cannot be updated. By now, indexes with mode Column can be updated, only |
false |
| OverrideCanBeAutoDetectedOnSearch |
boolean |
Declare index to be able to be automatically determined during search task, even if concrii autodetects that this index cannot search data. |
false |
| OverrideCanBeAutoDetectedOnRetrieve |
boolean |
Declare index to be able to be automatically determined during retrieve task, even if concrii autodetects that this index cannot retrieve data. |
false |
| CreateErrorsThreshold |
integer |
Number of errors to be ignored during create process. Erroneous index create processes will be restarted / retried. |
0 |
| UpdateErrorsThreshold |
integer |
Number of errors to be ignored during update process. Erroneous index update processes will be reprocessed on next update. |
0 |
Configuration: Type string and configuration class
| Attribute |
Type |
Description |
Default |
| Id:type |
string |
Full Qualified Domain Name (FQDN) consisting of configuration class |
null |
bizconAG.concrii.Index.InMemoryDistinct.Configuration, bizconAG.concrii.Index
| Attribute |
Type |
Description |
Default |
| ValueEncryptor |
string |
Id of the Encryptor that specifies how to handle values within the index (values will be encrypted when configured). |
null |
| IdEncryptor |
string |
Id of the Encryptor that specifies how to handle Ids within the index (ids will be encrypted when configured). |
null |
| ValuePatcher |
string |
Id of Value Patcher to be used when adding values to the index. |
null |
| ValueFilter |
string |
Id of Value Filter to be used when adding values to the index. |
null |
| IdFilter |
string |
Id of Id Filter to be used when adding Ids to the index. |
null |
| PartitionPrefixLength |
integer |
The higher this value, the more partitioned the index will be created. The more partitioned the index is, the more performant all index updates requests will be. Within small indexes (< 10000 values) a value of 1 can be considered. For huge indexes (> 2000000 values) a value of 3 might be appropriate. Inbetween, use default value of 2. A value > 3 might only be used in very rare situations. The best value cannot be determined automatically, as it also depends on the index values itself, its type and its length. |
2 |
| Limiter |
string |
Id of Limiter to limit index data during search (not fully supported by now). |
null |
| MaxGetIdsUsage |
string |
In case the search results can already be limited to an arbitrary number of entries (same goes for the retrieval process), the WHERE IN logic can be used. The MaxGetIdsUsage attribute allows the specification of a maximum number of entries to the WHERE IN logic, that can be given as a number (string) or a percentage (e.g. %10). |
"50%" |
| MaxGetIdsUsageLimit |
integer |
Specifies the absolute limit of entries in the WHERE IN logic, even if a percentage is given in MaxGetIdsUsage. |
500000 |
Warning
MaxGetIdsUsage and MaxGetIdsUsageLimit are advanced settings, expert usage only!
bizconAG.Concrii.Index.InMemory.Configuration, bizconAG.concrii.Index
| Attribute |
Type |
Description |
Default |
| ValueEncryptor |
string |
Id of the Encryptor that specifies how to handle values within the index (values will be encrypted when configured). |
null |
| IdEncryptor |
string |
Id of the Encryptor that specifies how to handle Ids within the index (ids will be encrypted when configured). |
null |
| ValuePatcher |
string |
Id of Value Patcher to be used when adding values to the index. |
null |
| ValueFilter |
string |
Id of Value Filter to be used when adding values to the index. |
null |
| IdFilter |
string |
Id of Id Filter to be used when adding Ids to the index. |
null |
| PartitionPrefixLength |
integer |
The higher this value, the more partitioned the index will be created. The more partitioned the index is, the more performant all index updates requests will be. Within small indexes (< 10000 values) a value of 1 can be considered. For huge indexes (> 2000000 values) a value of 3 might be appropriate. Inbetween, use default value of 2. A value > 3 might only be used in very rare situations. The best value cannot be determined automatically, as it also depends on the index values itself, its type and its length. |
2 |
| Limiter |
string |
Id of Limiter to limit index data during search (not fully supported by now). |
null |
| MaxGetIdsUsage |
string |
In case the search results can already be limited to an arbitrary number of entries (same goes for the retrieval process), the WHERE IN logic can be used. The MaxGetIdsUsage attribute allows the specification of a maximum number of entries to the WHERE IN logic, that can be given as a number (string) or a percentage (e.g. %10). |
"50%" |
| MaxGetIdsUsageLimit |
integer |
Specifies the absolute limit of entries in the WHERE IN logic, even if a percentage is given in MaxGetIdsUsage. |
500000 |
| DistinctValues |
boolean |
Having one data column within index, this option will query distinct values, only. Expert usage only! |
false |
Warning
MaxGetIdsUsage and MaxGetIdsUsageLimit are advanced settings, expert usage only!
bizconAG.Concrii.Index.InMemoryValues.Configuration, bizconAG.concrii.Index
| Attribute |
Type |
Description |
Default |
| ValueEncryptor |
string |
Id of the Encryptor that specifies how to handle values within the index (values will be encrypted when configured). |
null |
| ValuePatcher |
string |
Id of Value Patcher to be used when adding values to the index. |
null |
| ValueFilter |
string |
Id of Value Filter to be used when adding values to the index. |
null |
| PartitionPrefixLength |
integer |
The higher this value, the more partitioned the index will be created. The more partitioned the index is, the more performant all index updates requests will be. Within small indexes (< 10000 values) a value of 1 can be considered. For huge indexes (> 2000000 values) a value of 3 might be appropriate. Inbetween, use default value of 2. A value > 3 might only be used in very rare situations. The best value cannot be determined automatically, as it also depends on the index values itself, its type and its length. |
2 |
| Limiter |
string |
Id of Limiter to limit index data during search (not fully supported by now). |
null |
| DistinctValues |
boolean |
Having one data column within index, this option will query distinct values, only. Expert usage only! |
false |
Index types
| Enum members |
Description |
| Index |
By now, the one and only value is Index. |
Index modes
| Enum members |
Description |
| Column |
An index will collect all its configured columns connected with the id column of its table. This is the very default mode. |
Friends priorization
| Enum members |
Description |
| Off |
Indexes of Friends will not be used. |
| On |
When an index is not created locally, Friends will be asked for the index. The search will then be carried out on the Friend's index if it exists. |
| Prioritize |
Friends' indexes will be prioritized over the local ones. |
Utils
Configuration section for utils.
| Attribute |
Type |
Description |
Default |
| GC |
object GC |
Setup garbage collection. |
null |
GC
| Attribute |
Type |
Description |
Default |
| Enforce |
object GC Enforce |
Configuration regarding garbage collection enforcement. |
null |
GC Enforce
GC Enforce Situation
| Attribute |
Type |
Description |
Default |
| Generation |
integer |
Which GC generation to use. The number of the oldest generation to be garbage collected. |
1 |
| CollectionMode |
enumeration |
GC collection mode specifies whether the garbage collection is forced. Values: Default, Forced, Optiomized, Aggressive |
Default(=Forced) |
| Blocking |
boolean |
true to perform a blocking garbage collection; false to perform a background garbage collection where possible. |
false |
| Compacting |
boolean |
true to compact the small object heap; false to sweep only. |
false |
| CompactingLOH |
boolean |
true to compact the large object heap (LOH). |
false |
Ui
Configuration section for the ui.
UiIndex
| Attribute |
Type |
Description |
Default |
| ShowSampleColumnData |
boolean |
Whether to show (true) sample column data on index details page or not (false). |
false |
UiValueSearch
| Attribute |
Type |
Description |
Default |
| ActivateEncrypt |
boolean |
Whether to activate (true) the Encrypt checkbox by default or not (false). |
false |
| ActivateExport |
boolean |
Whether to activate (true) the export by default or not (false). |
true |
| ExportSeperator |
string |
Default export seperator. |
"," |
| ExportQuotes |
string |
Default export quotes. |
"'" |
| ExportQuotesEscape |
string |
Default export escape quotes. If quotes are found within an export value, it will be escaped with this string. |
"\" |
ValuePatcher
Dictionary of Value Patcher objects.
| Nested Object |
Type |
Description |
Default |
| Id:type |
string |
Syntax: "id of Value Patcher":"configuration class to make ValuePatcher".Supported by now: bizconAG.concrii.Index.ValuePatcher.RegexSplitterConfiguration, bizconAG.concrii.Index. |
null |
bizconAG.concrii.Index.ValuePatcher.RegexSplitterConfiguration, bizconAG.concrii.Index
| Type |
Description |
Default |
| string |
A regular expression to be used to split a string (here: split the value). |
null |
Filter
Dictionary of Filter objects.
| Nested Object |
Type |
Description |
Default |
| Id:type |
string |
Syntax: "id of Filter":"configuration class to make Filter". Supported by now: bizconAG.concrii.Index.Filter.ByLinqQueryConfiguration, bizconAG.concrii.Index. |
null |
bizconAG.concrii.Index.Filter.ByLinqQueryConfiguration, bizconAG.concrii.Index
| Attribute |
Type |
Description |
Default |
| Query |
string |
A query that will be applied (using LINQ) to all strings to filter out certain values. |
null |
Limiter
Warning
Limiter is not fully supported yet, expert usage only!
Array of Limiter objects.
| Attribute |
Type |
Description |
Default |
| Id |
string |
Specify an unique Id. |
null |
Entries
List of objects that define the Limiter Entries
| Attribute |
Type |
Description |
Default |
| Match |
string |
A regular expression to be applied to the search terms in order to limit the index data early on. |
null |
| Start |
string |
When Match is found, start the index data at Start entry. When "%" is found, the start index will be calculated. |
null |
| End |
string |
When Match is found, end the index data at End entry. When "%" is found, the end index will be calculated. |
null |