Versions Compared

Old Version 13

changes.mady.by.user Team Kolibri

Saved on

compared with

New Version Current

changes.mady.by.user Product Management

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more general information, refer to the Frequently Asked Questions.

The following Find here a presentation that explains how folder structures are set up and used (German only): Widget Connectorurlhttp://youtube.com/watch?v=U5dMdgl3T2I

Folder Structure Configuration

...

Figure 1: Standard structure of a folder

Children tree definition

The configuration for the standard structure is shown in the following code sample. The details are explained below. 

...

Reference tree definition

Supported since Beginning with product version 5.16 an additional tree is offered that shows all objects referencing the current folder.

The structure tree that was described in the first section is able to show all children of a folder. If you model id references to the folder it is useful to show also these references to the current folder. There may be many other referencing objects and it is useful to be able to navigate to them. 

Since product version 5.16, it is possible to model and use a reference tree to a an object. Contrary to the structure tree, that which is selecting all children, the reference tree is selecting all objects that have references to a target object. For example, you have two other objects, project and task , that reference to a target object. The object 'project' defines a an id reference field named 'participants' and the other object 'task' defines two reference fields named 'reviewer' and 'responsible'. We have 3 modeled id reference fields to the target object. The condition that is used to select these referencing object is this : 

...

Code Block
languagejs
titleReference definition example
[ 
{
        "title": "project",
        "title_locales": {
          "en": "Project",
          "de": "Projekt"
        },
        "key": "ReferenceType#project",
        "type": "project",
        "folder": [
          {
            "title": "participants",
            "title_locales": {
              "en": "Participants",
              "de": "Teilnehmer"
            },
            "key": "Referencefield#project.participants",
            "condition": "project.participants=#TARGETID#"
          }
        ]
      },
      {
        "title": "task",
        "title_locales": {
          "en": "Task",
          "de": "Aufgabe"
        },
        "key": "ReferenceType#task",
        "type": "task",
        "folder": [
          {
            "title": "Responsible",
            "title_locales": {
              "de": "Verantwortlich",
              "en": "Responsible"
            },
            "key": "Referencefield#task.responsible",
            "condition": "task.responsible=#TARGETID#"
          },
          {
            "title": "reviewby",
            "title_locales": {
              "de": "Prüfung von",
              "en": "Review by"
            },
            "key": "Referencefield#task.reviewby",
            "condition": "task.reviewby=#TARGETID#"
          }
        ]
      }

Each referencing type is given as a folder and each referencing field is a sub tree subtree element. To distinguish between the task responsible and the task reviewer a an additional condition is set, that is using the current target id. 

...

conditionUse 'condition'
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.


typeoptional

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

Info
title

optional

Note

Only lower-case characters are allowed.


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.
  • monthhistogram: For fields of type date and date/time. Aggregates objects by month.
    yearmonthhistgram: For fields of type date and date/time. Aggregates objects by a specific year and month (since product version 9.12)
  • 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'.

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

sizeoptional

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.

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 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 catalogue catalog 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 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.

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 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.
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 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

sortoptional

If an 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 set to 'count' (default), the most frequently frequent terms are returned first.
If set to 'title', the result is sorted alphanumerically by the user interface title.

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

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

Supported since product version 4.12

...

technical nameEnglish nameDescription

created

Created

Date of object creation.

creatortitle

Modified

'Last name, First name' of the creator.

filesizeFilesizeSize of the content in bytes.

mimetypegroup

File type

Group of files whose extension references one application. Examples: pdf, word, excel, image

modified

Edited

Date the object was last edited.

modifiertitle

Editor

'Last name, First name' of the last editor.

versionVersionCurrent version number (count starts with 1).

...

PARENT to resolve a hierarchical catalogue node.
This example shows all children of nodes with the value Europe which may be its countriesEmployeesEuropeEmpEuropepersonalfile.continent(PARENT)='Europe'It Comparing equability.
TokenUseDescription
#CURRENTUSER#PlaceholderDuring runtime, the logged-in user name is used for filtering
#CURRENTYEAR#PlaceholderDuring runtime, the current year is used for filtering

#LASTYEAR#

PlaceholderDuring runtime, the last year is used for filtering
#TODAY#PlaceholderDuring runtime, today is used for filtering
#YESTERDAY#PlaceholderDuring runtime, yesterday is used for filtering
#THISWEEK#Placeholder

During runtime, this week is used for filtering. Example:


Code Block
languagejs
{
  "title": "Edited by me this year",
  "key": "EditedByMeThisYear",
  "condition": "modifier=#CURRENTUSER# AND modified=#THISWEEK#"
}


#LASTWEEK#PlaceholderDuring runtime, the last week is used for filtering
#THISMONTH#PlaceholderDuring runtime, this month is used for filtering
#LASTMONTH#PlaceholderDuring runtime, the last month is used for filtering
#TARGETID#Placeholder

Target id (in most cases a folder) that is used in a reference tree as root id.

Supported since product version 5.16

#TARGETTYPE#Placehoder

Target type name  name that is used in a reference tree as root type.

Supported since product version 5.16

#CONTEXTID#Placeholder

Context folder id that is the common parent for a structure tree.

Supported since product version 5.16

#CONTEXTTYPE#Placeholder

Context folder type.

Supported since product version 5.16

YEARModifier

A field modifier that can be used on datetime or date fields. It provides access to the year value of the field.
Example:

Code Block
languagejs
{
  "title": "Edited in 2016",
  "key": "Edited2016",
  "condition": "modified(YEAR)=2016"
}


MONTHModifier

A field modifier that can be used

on datetime or date fields. It provides access to the month value of the field.
Example:

Code Block
languagejs
{
  "title": "
Edited in August 
2016",
  "key": "
Edited2016_08",
  "condition": "
modified(YEAR)=2016 AND modified(MONTH)=08"
}

Supported since product version 9.12

PARENTModifier

A field modifier that can be used for catalogue fields. The parent node itself is always included.

=Operator

to resolve a hierarchical catalog node.
This example shows all children of nodes with the value Europe which may be its countries:

Code Block
languagejs
{
  "title": "Employees in Europe",
  "key": "EmpEurope",
  "condition": "personalfile.continent(PARENT)='Europe'"
}

It can be used for catalogue fields. The parent node itself is always included.

=Operator

Compares for equality.
Example:

Code Block
languagejs
"coditioncondition":"modifier=#CURRENTUSER#"


!=Operator

Compares two values. Result is true if they are not equal.
Example:

Code Block
languagejs
"condition": "modifier!=#CURRENTUSER"


<Operator

Compares two values. Result is true if the first value is less than the second one.
Example:

Code Block
languagejs
"condition": "version<4"


>Operator

Compares two values. Result is true if the first value is greater than the second one.
Example:

Code Block
languagejs
"condition": "version>1"


>=Operator

Compares two values. Result is true if the first value is greater than or equal than to the second one.
Example:

Code Block
languagejs
"condition": "version>=1"

Since product version 5.8.

<=Operator

Compares two values. Result is true if the first value is less than or equal than to the second one.
Example:

Code Block
languagejs
"condition": "version<=1"

Since product version 5.8.

ANDOperator

Logically combines two terms.
Example:

Code Block
languagejs
"condition": "doc.status!='new' AND doc.status!=null"


OROperator

Logically combines two terms.
Example:

Code Block
languagejs
"condition": "doc.status='started' OR doc.status='tobereworked'"


nullValue

Without value.
Example:

Code Block
languagejs
"condition": "doc.active=null"


falseValue

For comparing Boolean fields.
Example:

Code Block
languagejs
"condition": "doc.active=false"


trueValue

For comparing Boolean fields.
Example:

Code Block
languagejs
"condition": "doc.active=true"


[0-9]Value

Integer value.
Example:

Code Block
languagejs
"condition": "doc.amount>4711"


...

Code Block
titleComplex configuration with many nodes and leaves
[
    {
      "title": "All",
      "key": "Common",
      "folder": [
        {
          "title": "Created by me",
          "key": "CreatedByMe",
          "condition": "creator=#CURRENTUSER#"
        },
        {
          "title": "Modified by me",
          "key": "ModifiedByMe",
          "condition": "modifier=#CURRENTUSER#"
        },
        {
          "title": "Modified by others",
          "key": "ModifiedByOther",
          "condition": "modifier!=#CURRENTUSER# AND modifier!='Bartonitz'"
        },
        {
          "title": "Modified by Martin",
          "key": "ModifiedByMartin",
          "condition": "modifier='Bartonitz'",
          "folder": [
            {
              "title": "Modified by Martin by years",
              "key": "modifiedyear",
              "field": "modified",
              "method": "yearhistogram"
            }
          ]
        },
        {
          "title": "By types",
          "key": "type",
          "field": "type"
        },
        {
          "title": "by file type",
          "key": "mimetypegroup",
          "field": "mimetypegroup"
        },
        {
          "title": "Year of modification",
          "key": "modifiedyear",
          "field": "modified",
          "method": "yearhistogram"
        },
        {
          "title": "Year of creation",
          "key": "createdyear",
          "field": "created",
          "method": "yearhistogram"
        },
        {
          "title": "By creator",
          "key": "creator",
          "field": "creatortitle"
        },
        {
          "title": "By modifier",
          "key": "modifier",
          "field": "modifiertitle"
        },
        {
          "title": "Time period of modification",
          "key": "ModifiedRange",
          "method": "daterange",
          "field": "modified"
        },
        {
          "title": "Time period of creation",
          "key": "CreatedRange",
          "method": "daterange",
          "field": "created"
        }
      ]
    },
    {
      "title": "Sickness notification",
      "key": "sicknessnotification",
      "type": "sicknessnotification",
      "folder": [
        {
          "title": "Longer then 3 days",
          "key": "sicknessnotificationlong",
          "condition": "sicknessnotification.numberdays>3"
        },
        {
          "title": "By years",
          "key": "year",
          "method": "yearhistogramyearmonthhistogram",
          "field": "sicknessnotification.begin",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "sicknessnotification.numberdays"
            }
          ]
        },
        {
          "title": "Child sick",
          "key": "sicknessnotificationchild",
          "condition": "sicknessnotification.sickness!='employee' AND sicknessnotification.sickness!=null",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "sicknessnotification.numberdays"
            }
          ]
        },
        {
          "title": "Employee sick",
          "key": "sicknessnotification",
          "condition": "sicknessnotification.sickness='employee'",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "sicknessnotification.numberdays"
            }
          ]
        }
      ]
    },
    {
      "title": "Vacation management",
      "key": "holidays",
      "type": "vacation",
      "folder": [
        {
          "title": "By year",
          "key": "year",
          "method": "yearhistogram",
          "field": "vacation.holidayfrom",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "vacation.holidaysrequested"
            }
          ]
        },
        {
          "title": "Approved by me",
          "key": "HolidaysApprovedByMe",
          "condition": "vacation.approvedby=#CURRENTUSER#",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "vacation.holidaysrequested"
            }
          ]
        },
        {
          "title": "Not yet approved",
          "key": "HolidayNotApproved",
          "condition": "vacation.approvedby=null",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "vacation.holidaysrequested"
            }
          ]
        },
        {
          "title": "Approved",
          "key": "HolidayApproved",
          "condition": "vacation.approvedby!=null",
          "folder": [
            {
              "key": "days",
              "method": "sum",
              "title": "Days",
              "field": "vacation.holidaysrequested"
            }
          ]
        }
      ]
    },
    {
      "title": "Statement of earnings",
      "key": "statementofearnings",
      "type": "statementofearnings",
      "folder": [
        {
          "key": "year",
          "title": "By years",
          "field": "statementofearnings.yearofpayment"
        }
      ]
    },
    {
      "title": "Contract documents",
      "key": "contract",
      "type": "contractdocuments",
      "folder": [
        {
          "title": "By type",
          "key": "type",
          "field": "contractdocuments.type"
        }
      ]
    },
    {
      "title": "Documents",
      "key": "documents",
      "type": "document",
      "folder": [
        {
          "title": "By status",
          "key": "state",
          "field": "basicdocument.status"
        }
      ]
    }
]

...

Code Block
languagejs
linenumberstrue
[
  {
    "title": "Urlaubsverwaltung",
    "key": "urlaubv",
    "condition": "type='abwesenheit' OR type='urlaubsverwaltung'",
    "folder": [
		{
			"title": "Urlaubsantrag",
			"key": "ulantr",
			"condition": "abwesenheit.art='Urlaub'",
			"folder": [
				{
					"title": "Geschäftsjahre",
					"hide": true,
					"key": "year",
					"field": "abwesenheit.geschaeftsjahr",
					"folder": [
						{
							"title": "Genehmigt",   
							"key": "state",
							"hide":true,
							"field": "basicdocument.status",
							"showempty":true,
							"folder": [
								{
									"title": "Tage",
									"method": "sum",
									"key": "days",
									"field": "abwesenheit.tage"
								 }
							]
						}
					]
				}
			]
	},
	{
		"title": "Urlaubsanspruch",
		"key": "ulantr2",
		"type": "urlaubsverwaltung"
	},
    {
      "title": "Project",
      "key": "Year",
      "type": "project",
      "field" : "project.startday",
      "method" : "yearhistogram",
      "expanded": true,
      "folder":[{
        "title": "Projects",
        "hide":true,
        "key": "ProjectMonth",
        "type": "project",
        "field" : "project.startday",
        "method" : "monthhistogram",
        "expanded": true
      }]
  }

]

Specific settings for Elasticsearch

A limitation regarding 'conditions' was introduced with the Elasticsearch version that is used in yuuvis® RAD 8.16.

Reason: https://github.com/elastic/elasticsearch/issues/55303

To solve this, this property is introduced: indices.query.bool.max_nested_depth

For more details, see this documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-settings.html

Solution for yuuvis® RAD since 8.16 LTS

  1. Add this line to the elasticsearch.yml file in the config folder of the elasticsearch installation:
    indices.query.bool.max_nested_depth: 100
  2. Restart the service.