Table of contents:

Implementation

{
	"name":"rightDrawerContainer",
	"data":{
			...
		} 
}

Properties

Property	Description	required	Example
visible	Specifies whether the context info should be visible or not.		`"visible":` `true`
width	Specifies the width of the context info.		`"width":` `400`
multipleComponents	The components that are to be displayed in the context info are specified here. These are listed as objects in an array.		`"multipleComponents": [` `{` `...` `},` `{` `...` `}` `]`

Embedding components

Various components can be included in the context info under "multipleComponents".

Property	Description	required	Example
iconName	This indicates the icon that must be clicked to display the respective component. The icons can be found on "Font Awesome".		`"iconName":` `"question-circle"`
moduleName	Here you enter the path and the name of the component without file extension. There are components that can be used specifically for context info.		`"iconName":` `"info-circle",` `"moduleName":` `"app/core/components/quickInfo",` `"props": {` `...` `}`
props	Properties that the component requires are specified here.		`"props": {` `"url":` `"{{helpBaseUrl}}/inscd/{{helpVersion}}/{{helpLanguage}}/arbeiten-mit-projekten-und-einsaetzen/erste-schritte-mit-projekten"` `}`

"iframe"-Component

The "iframe" component makes it possible to integrate articles from Confluence. It should be noted that it is an article from the "inscd" area. Only the property "URL" is required in the "props". Enter the path to the Confluence article in "URL".

The "URL" property uses dynamic parameters. The root path, the current version and the corresponding language are automatically filled in.

{{helpBaseUrl}}/inscd/{{helpVersion}}/{{helpLanguage}}/

Only the title of the Confluence article must be entered manually in the URL property (see example).

Example

"moduleName": "app/core/components/iframe",
"iconName": "question-circle",
"renderAlways": true,
"props": {
	"url": "{{helpBaseUrl}}/inscd/{{helpVersion}}/{{helpLanguage}}/arbeiten-mit-projekten-und-einsaetzen/erste-schritte-mit-projekten"
	}

"quickInfo"-Component

The "quickInfo" component allows various statistics to be displayed within the context info.

Properties

Property	Description	Example
template	The data loaded from the "dynamicApi" can be edited in a template. You can find more information about the templates here. The data can be found in the object "data".
dynamicApi	With the property "dynamicApi" you can pull any data from an API and display it. The API with SQL is created in the "API Editor". The property "dynamicApi" is an object and consists of the properties "URL" and "parameters". The URL specified here consists of "Statistic/api/dynamicapi/" followed by the ID of the API. The URL ends with "/GetData". The parameters used by the API can be specified as a key-value pair. In the editing window of the API, you can find the ID in the last part of the URL. The window must be opened in a separate window.	`"dynamicApi": {` `"url":` `"Statistic/api/dynamicapi/a639a996-58ca-49d1-a2a3-182eedf24f92/GetData",` `"parameters": {` `"projnr":` `"entity.Projnr"` `}` `}`
statistics	In this property (array) you enter all statistics that are to be displayed in the context info.	`"statistics": [` `{` `...` `},` `{` `...` `}` `]`

Properties of a statistic

Property	Description	Example
title	Enter the name of the statistic here. You can also enter translations here.	`"title":` `"{{{WebSMS.Resource.Kosten}}}",`
statisticId	Enter the ID for the statistics here. If you are in the editing window of the statistics, you can find the ID in the last part of the URL. The window must then be opened in a separate window.	`"statisticId":` `"3d3baab1-95a4-4d98-bcee-124f452211e9"`
parameters	The parameters used by the statistic are entered here as a key-value pair.	`"parameters": {` `"projnr":` `"entity.Projnr"` `}`

Example of two statistics in the context info

"iconName": "info-circle",
"moduleName": "app/core/components/quickInfo",
"props": {
	"statistics": [	
		{
			"title": "{{{WebSMS.Resource.Kosten}}}",
            "statisticId": "3d3baab1-95a4-4d98-bcee-124f452211e9",
            "parameters": {
            	"projnr": "entity.Projnr"
             }
		},
		{
			"title": "{{{Statistik.Aktivität}}}",
			"statisticId": "0914415b-f1c7-4247-b663-2b040ece0e01",
			"parameters": {
				"projnr": "entity.Projnr"
			}
         }
	]
}

"baseDataTreeStructure"-Component

The "baseDataTreeStructure" component allows you to display information as a tree structure in the context info.

Example

"moduleName": "app/core/components/baseDataTreeStructure",
"iconName": "cogs",
"props": {
"template": "<span data-item-link data-item-url='#=item.appUrl#' class='span #=item.highlight==true?'highlight':''#'>
				#if(item.type==1){# 
					<i class='fal fa-fw fa-home'></i> 
				#} else if (item.type == 2) {#
					<i class='fal fa-fw fa-id-badge'></i> 
				#} else if (item.type == 3) {# 
					<i class='fal fa-fw fa-cogs'></i> 
				#}#
				#if(item.type==1){#
					#=item.values.adrnr# | #=item.values.adrname# 
				#} else if (item.type == 2) {#
					#=item.values.ansprechpartner#, #=item.values.vorname# 
				#} else if (item.type == 3) {#		
					#=item.values.maschnr# | #=item.values.maschbezeichnung# | #=item.values.maschtyp# 
				#}#
			</span>"
}

"gmEmbedApi"-Component

The "gmEmbedApi" component allows you to display a map with a marked point in the context info.

Properties

Property	Description
address	Here you can enter an address that can be displayed on the map.
latitude	The latitude of a point can be specified here.
longitude	The longitude of a point can be specified here.

Either enter an address or a longitude and latitude.

Example

"moduleName": "app/core/components/gmEmbedApi",
"iconName": "map-signs",
"props": {
	"latitude": "entity.Breitegrad",
	"longitude": "entity.Laengegrad"
}