...
| 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.
| |||||
| type | optional | Use '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:
If 'method' is not defined, the default is 'count'. The aggregation will count the objects referenced by 'field'. | |||||
| size | optional | For count aggregations, the structure service returns the first 10 results. If you want more results, you can set a higher limit (e.g., 10,000), for example, if 'showempty' is used and there are more than 10 structure elements. Note: A higher limit can decrease the performance of the aggregation. It is not recommended to set a high limit 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 necessary 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. | |||||
| folder | optional | To set up subfolder structures | |||||
| hide | optional | A 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. | |||||
| expanded | optional | 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 | |||||
| showempty | optional | A boolean that controls whether a folder with substructure shows all folders, regardless of whether an object can be found for it. The 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 catalog is used, the 'type' field is used, or if a 'showemptylist' property is provided for a string field. | |||||
| showemptylist | optional | 'showemptylist' can be used for fields of type catalog and string. If used, the elements of the list are shown even if no object with the value is given. If such an 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 field of type catalog, the list values must be the data values of the catalog.
Supported since product version 4.10 | |||||
| hideempty | optional | 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 number of objects - the aggregations - is zero. If at least one child element is available, the folder element is shown. The property 'showempty' controls the behavior for empty child elements, while the property 'hideempty' controls the behavior of the parent element. Supported since product version 4.12 | |||||
contextcondition | optional | The element is only visible if the context folder condition matches.
Hint: If a contextcondition is used, the service will carry out an additional call to Eleasticsearch to resolve the index data of the context folder. If used too often, this will decrease the performance. Supported since product version 4.12 | |||||
| sort | optional | If aggregation of a field is built by using the field property and the default method 'count', the results are sorted by relevance returning the most frequently used terms first. This behavior can be changed by using the 'sort' property. If a catalog is used for the 'field' property, the sort property can also be set to 'catalog', In this case, the return is sorted by the designed order of the catalog entries.
Supported since product version 4.12 |
...