Versions Compared

Old Version 8

changes.mady.by.user Team Kolibri

Saved on

compared with

New Version 9

changes.mady.by.user Team Kolibri

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added missing type property.

...

Term
Description

[ ]

mandatory

Opens and closes the whole folder structure configuration. Use JSON syntax for arrays.

{ }

mandatory

Opens and closes the configuration of a node, as well as each subnode. Use a comma ( , ) to separate sets of curly brackets ( { } ). Use JSON syntax for objects.

key

mandatory

There is a unique key for each level in the tree. It is used to reference the results in the structure tree.

title

mandatory

The label for the key.

field

optional

The contents of the index field referenced here are displayed as subfolders in the structure. The value of 'field' can be the technical name of general object attributes (see chapter 'List of general object attributes') or of individual index data with the format 'technical and normalized name of object type'.'technical name of index field' (qualified technical name).

If the field is one of an abstract object type, all objects of the derived object types are shown in the corresponding list of objects.

Info
titleNote

Only lower-case characters are allowed.


typeoptionalUse 'type' to filter for a specific type. All elements provided in the result are instances of this type.

condition

optional

Use 'condition' to filter objects. For more information, see the chapter 'Condition grammar'

method

optional

Use 'method' to aggregate objects in the following ways:

  • daterange: for fields of type date and date/time. Aggregates objects by today, yesterday, this week (last seven days), last week, this month, last month, this year and last year.
  • yearhistogram: for fields of type date and date/time. Aggregates objects by year.
  • sum: Adds up the values of the referenced 'field'.
  • avg: Build the average of the referenced 'field'.
  • min: Gets the minimum value of the referenced 'field'.
  • max: Gets the maximum value of the referenced 'field'.

The default, if 'method' is not given, is 'count'. The aggregation will count the objects referenced by 'field'.

sizeoptional

For count aggregations, the structure service returns the 10 top results. If you want more results, you can set a higher size (e.g. 10,000), for example if 'showempty' is used and there are more than 10 structure elements.

Note: A higher size can decrease the performance of the aggregation. It is not recommended to set a high size on each structure element definition.

The size property can only be used if the method is 'count'.

If the field reference is a catalog, it is not needed to set the size in the structure element definition. The size is automatically set to the number of possible elements in the catalog. But it is still possible to override this behavior by setting a size.

folderoptionalTo set up subfolder structures
hideoptionalA boolean that can be used to hide a folder from the result. It can be used to "pull-up" all child results. The result folder is always hidden from the result and all child results are shown in the parent result folder of this element.
expandedoptional

A boolean that controls whether a folder with substructure is shown expanded when the object view is opened. Default is 'false' (not shown expanded).

Supported since product version 3.32

showemptyoptional

A boolean that controls whether a folder with substructure shows all folders, regardless of whether an object can be found for it. Default is 'false' (no empty folders are shown).

This property can only be used, if the possible child elements are known. The element must have a field property. The child elements are known if a fixed catalogue is used, the 'type' field is used, or if a 'showemptylist' property is provided for a string field.

showemptylistoptional

'showemptylist' can be used for fields from type catalog and string. If use the elements of the list are shown even if no object with the value is given. If such element is marked in the structure tree it is offered within the create object menu and preset in the create form.

In case of a fields from type catalog the list values must be the data values of the catalog.

Code Block
[...,
{
    "title": "Documents",
    "key": "Docs",
    "field": "eoxdocument.eoxdocumenttype",
    "showempty": true,
    "showemptylist": ["Whitepaper","Correspondence"]
  },
...]

Supported since product version 4.10

hideemptyoptional

A boolean that controls whether a node folder element is shown if all child elements are empty. If set to 'true', the node element is hidden from the result, if the count of objects - the aggregations - are zero. If at least one child element is available, the folder element is shown.

The property 'showempty' controls the behaviour for empty child elements, while the property 'hideempty' controls the behaviour of the parent element.

Supported since product version 4.12

contextcondition

optional

The element is only visible, if the context folder condition matches.
In the following example the node 'Candidate' is only shown if the personalfile class is a 'Applicant'.

Code Block
languagejs
[ ...,
  {
    "key":"CandidateInformation",
    "title":"Candidate",
	"contextcondition":"personalfile.class='Applicant'",
	"folder":[ ... ]
  },
... ]

Hint: If a contextcondition is used, the service is doing a additional call to the eleasticsearch to resolve the index data of the context folder. If used to often, this will decrease the performance.

Supported since product version 4.12

sortoptional

If an aggregation of a field is buildt by using the field property and the default method 'count', the results are sorted by relevance returning the most frequently used terms first.

This behaviour can be changed by using the 'sort' property.
If set to the 'count' (default), the most frequently terms are returned first.
If set to 'title', the result is alphanumerical sorted by the user interface title.

If a catalogue is used for the 'field' property, the sort property can also be set to 'catalogue', In this case, the return is sorted by the designed order of the catalogue entries.

Code Block
languagejs
[ ...,
  {
    "title": "Documents",
    "key": "Docs",
    "field": "eoxdocument.eoxdoctype",
    "sort": "title"
  },
... ]

Supported since product version 4.12

...