Dashboard widgets

1

11.0.0

2

11.2.0

3

11.3.0

SpotIdentifier

Mandatory field, String, ApiVersion: 1

This attribute is assigned by the spot developer and is used to verify the replacement of the widget in the IXM Platform in order to see if it is the correct spot.

Example: "MyDemonstrationWidget"

SpotVersion

Mandatory field, String, ApiVersion: 1

The current version of the widget and JSON structure.

Example: "1.0.0"

ApiVersion

Mandatory field, Int, ApiVersion: 1

Specifies with which systems the widget is compatible with, whereas the API version 1 is valid from 11.0 onwards. If a widget uses newer features which are only available with a later API version, issues with the display or widget functionality can occur in older systems. The API version of the Dashboard widget is independent from the API version of the wizard spot.

SpotType

Mandatory field, String, ApiVersion: 1

The spot type must have the value of the Dashboard widget. It serves as an identifier for the backend and must be identical to the spot type stored there.

Fixed value for Dashboard widgets:

"SpotType": "DashboardWidget"

NumberOfSlots

Mandatory field, Int, ApiVersion: 1

Specifies how many slots the widget takes up. For this, valid values range from 1 to 3.

Example:

"NumberOfSlots": 2

Options

See Options.

Elements

See Elements.

PossibleNumbersOfSlots

Optional, Array, ApiVersion: 1

The possible number of slots which a widget is allowed to have. These slots should then however be supported programmatically.

Examples:

"PossibleNumbersOfSlots": [
  1,
  2,
  3
] 
"PossibleNumbersOfSlots": [
  1,
  3
]

PossibleNumbersOfRows

Optional, Array, ApiVersion: 2

This defines the line height that a widget occupies in the dashboard. Accordingly, these heights should then also be supported programmatically.

Example:

"PossibleNumbersOfRows": [
  1,
  2
]

HasDetailView

Optional, Boolean, ApiVersion: 1

With this option, it is possible to enable the option in the Grassfish IXM Platform to open a detail view for the widget and display additional information. The widget receives the information whether it should show its content in the detail view via the URL parameter detailMode. This can be requested in the code in the dataChanged event as follows, where it is commonly possible to read out the slot size:

Example:

"HasDetailView": true

Example implementation:

var detail;

// ApiVersion 1
detail = !!GFSpotBase.findUrlParam('detailMode');

// ApiVersion 2
detail = gfDashboardWidgetBase.isDetailView();

if(detail){
//do something
}

HasPrintSupport

Optional, Boolean, ApiVersion: 1

With this option, the printing request action is activated in the Grassfish IXM Platform. This feature must be implemented in the widget.

Example:

“HasPrintSupport” : true

Example implementation:

gfDashboardWidgetBase.registerPrintRequested(
function(){
var data, file;

data = "Ein beliebieger Text...";
file = "export.csv";
gfDashboardWidgetBase.saveToFile(data, file);
});

…

function onPrintRequested()
{
  var data = "Entity" + splitChar + "Name" + splitChar + "Id" + splitChar + "BoxId\n";
  var values;
  var item;
  for(var k in multiValues)
  {
    if(multiValues.hasOwnProperty(k))
    {
      values = multiValues[k];
      if(values)
      {
        for(var i = 0; i < values.length; i++)
        {
          item = values[i];
          data += k + splitChar + item.Name + splitChar + item.Id;
          if(item.BoxId)
          {
            data += splitChar + item.BoxId;
          }
          data += "\n";
        }
      }
    }
  }
  gfDashboardExtension.saveToFile(data, "EntityData.csv");
}

UseSingleElementUpdate

Optional, Boolean, ApiVersion: 1

With this option, it is possible to specifically react to changes in the respective element and it is not necessary to rebuild the entire spot when values are changed.

If this option is enabled, you do not have to necessarily register an Eventhandler for each element. If an element has no SingleElementDataChanged handler, the global DataChanged handler will continue to be triggered. If a SingleElementDataChanged handler is registered for the element, it will be the only one to be invoked, not the global DataChanged handler, if an element is changed.

Example:

"UseSingleElementUpdate": true

Example implementation:

gfDashboardWidgetBase.registerPrintRequested(
function(){
var data, file;

data = "Ein beliebieger Text...";
file = "export.csv";
gfDashboardWidgetBase.saveToFile(data, file);
});

…

function onPrintRequested()
{
  var data = "Entity" + splitChar + "Name" + splitChar + "Id" + splitChar + "BoxId\n";
  var values;
  var item;
  for(var k in multiValues)
  {
    if(multiValues.hasOwnProperty(k))
    {
      values = multiValues[k];
      if(values)
      {
        for(var i = 0; i < values.length; i++)
        {
          item = values[i];
          data += k + splitChar + item.Name + splitChar + item.Id;
          if(item.BoxId)
          {
            data += splitChar + item.BoxId;
          }
          data += "\n";
        }
      }
    }
  }
  gfDashboardExtension.saveToFile(data, "EntityData.csv");
}

DynamicResolution

Optional, Object, ApiVersion: 2

With this option you can manage that the wizard spot has a height and width which can be edited by the user. This option cannot be utilised in combination with the PossibleResolutions option.

Example:

"DynamicResolution": {
  "Active": true, 
  "MinWidth": 400, 
  "MaxWidth": 2000,
  "MinHeight": 300,
  "MaxHeight": 3000
}

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "boolean"

Value

Mandatory field, Boolean, ApiVersion: 1

Example:

"Value": false

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "number"

Value

Mandatory field, Number, ApiVersion: 1

Example:

"Value": 42

Options -> Minimum

Optional, Number, ApiVersion: 1

Specifies the minimum value of the number selection.

Example:

"Minimum": 1.0

Options -> Maximum

Optional, Number, ApiVersion: 1

Specifies the maximum value of the number selection.

Example:

"Maximum": 999

Options -> StepSize

Optional, Number, ApiVersion: 1

Specifies the rounding value of the number selection.

Example:

"StepSize": 0.1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|">"|">="|"<"|"<="]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "color"

Value

Mandatory field, String, ApiVersion: 1

The format depends on the UseRGBA option.

Example:

UseRGBA !== true :"Value": "#FF0000"

UseRGBA === true : “Value”: “rgba(72,70,189,0.64)

If the value is color value in the RGB hex format, starting with a hash. Since the global version 11.0, you can also use the RGBA format if UseRGBA is activated in the options.

Example:

"Value": "#FF0000"

Options -> UseRGBA

Optional, Boolean, ApiVersion: 1

By means of this option, the advanced color picker can be activated, which also supports alpha values. Depending on the setting, the value is in another format.

Example:

"UseRGBA": true

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "date"

Value

Mandatory field, String, ApiVersion: 1

A date string in the format YYYY-MM-DDThh:mm:ss.

Example:

"Value": "2015-09-13T00:00:00"

Options -> MinDate

Optional, String, ApiVersion: 1

By means of this option the minimum date can be specified. The entry may not go below this value.

Example:

"MinDate": "2015-09-11T00:00:00"

Options -> MaxDate

Optional, String, ApiVersion: 1

By means of this option, the maximum date can be specified. The entry may not exceed this value.

Example:

"MaxDate": "2015-09-15T00:00:00"

Options, Keyword ‘Today’

Optional, String, ApiVersion:1

For the threshold values MinDate and MaxDate, it is also possible to assign the keyword ‘today’. This is converted to the current date for the runtime.

Example:

„MaxDate“: „Today“

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|">"|">="|"<"|"<="]

Id, DisplayName

Mandatory fields, ApiVersion: 2

See Elements.

DataType

Mandatory field, String, ApiVersion: 2

"DataType": "dateRange"

Value

Mandatory field, Object, ApiVersion: 2

The format depends on the options TimeEnabled and TimeZoneEnabled.

Example:

Default:

"Value": {
	"From": "2015-09-13T00:00:00",
	"To": "2015-09-13T00:00:00"
}

TimeEnabled === true:

"Value": {
	"From": "2015-09-13T11:15:00",
	"To": "2015-09-13T23:30:00"
}

TimeEnabled === true && TimeZoneEnabled === true: "Value": {

"Value": {
	"From": "2015-09-13T11:15:00Z",
	"To": "2015-09-13T23:30:00Z"
}

Options -> MinDate

Optional, String, ApiVersion: 2

By means of this option it is possible to set the minimum date. The entry may not go below this value.

Example:

"MinDate": "2015-09-11T00:00:00"

Options -> MaxDate

Optional, String, ApiVersion: 2

By means of this option it is possible to set the maximum date. The entry may not exceed this value.

Example:

"MaxDate": "2015-09-15T00:00:00"

Options -> TimeEnabled

Optional, String, ApiVersion: 2

By means of this option the time entry can be activated.

Example:

"TimeEnabled": true

Options -> TimeZoneEnabled

Optional, String, ApiVersion: 2

By means of this option, it is possible to activate the entry of the time zone.

Example:

"TimeZoneEnabled": true

Note: For this option, TimeEnabled as well as the configuration of the IXM Platform for the support of time zones must be activated.

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": "?"

Options, Schlüsselwort "Today"

Optional, String, ApiVersion: 2

For the threshold values MinDate and MaxDate it is also possible to define the keyword Today. This is converted to the current date for the runtime.

Example:

"MaxDate": "Today"

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "time"

Value

Mandatory field, String, ApiVersion: 1

The format depends on the option WithSeconds.

Example:

WithSeconds !== true: "Value": "13:57"

WithSeconds === true: "Value": "13:59:57"

Options -> WithSeconds

Optional, Boolean, ApiVersion: 1

By means of this option, the entry of seconds can be enabled. Depending on the setting, the value is in a different format.

Example:

"WithSeconds": true

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|">"|">="|"<"|"<="]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "list"

Items

Mandatory field, Array

Example:

"Items": [
"Cow",
"Horse",
"Sloth"
]

Value

Mandatory field, String, ApiVersion: 1

The selected entry from the items array is saved under ‚value‘ (in the non-translated version).

Example:

"Value": "Horse"

Translations

Optional, Object, ApiVersion: 1

For dropdowns, it is possible to define translations for every value in Translations.

Example:

"Translations": {
"de": {
"DisplayName": "Irgendein Listeintrag2",
"Cow": "Kuh",
"Horse": "Pferd",
"Sloth": "Faultier"
}
}

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 2

See Elements.

DataType

Mandatory field, String, ApiVersion: 2

"DataType": "radiobutton"

Items

Mandatory field, String[], ApiVersion: 2

Example:

"Items": [
     "Cow",
     "Horse",
     "Sloth"
]

Value

Mandatory field, String, ApiVersion: 2

The selected entry from the items array is saved under ‚value‘ (in the non-translated version).

Example:

"Value": "Horse"

Translations

Optional, Object, ApiVersion: 2

In dropdowns, it is optional to define translations for each value. For this, the key corresponds to the entry in the items array, the value of the corresponding translation (e.g. de, en,..)

Example:

"Translations": {
"de": {
"DisplayName": "Tierauswahl",
"Cow": "Kuh",
"Horse": "Pferd",
"Sloth": "Faultier"
}
}

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "simpleText"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, each have a text property where an unformatted text is saved.

Example:

"Value": [
	{
		"Text": "some text." 
	},
	{
		"Text": "Another text."
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter you can control how many instances of a text input can be created by the user. If the value is not set or is set to 0 or 1, the user only sees a text box and cannot create other instances of text inputs.

Example:

"NumberOfInstances": 1

Options -> MultilineSize

Optional, Int, ApiVersion: 1

By means of this parameter you can control how large the text input is displayed (i.e. how many lines it has). If this value is not set or is set to 0 or 1, it is a single-line text input without a line break.

Example:

"MultilineSize": 4

Options -> MaxChars

Optional, Int, ApiVersion: 1

By means of this parameter you can determine how many characters the user is allowed to set. This part cannot be saved if this value for a text field is exceeded. If the text field has several instances, this value is valid for the respective instance.

Example:

"MaxChars": 120

Options -> Required

Optional, Boolean, ApiVersion: 1

By means of this parameter you can ensure that something has been entered in the text field.

Example:

"Required": true

Options -> ValidationRegExp

Optional, String, ApiVersion: 1

By means of this parameter you can store a regular expression that must be met for the user to be able to save the spot. In the event of an error the ValidationRegExpDescription is displayed, which can be translated in the translations. Take into consideration that backslashes must be specified twice.

Example:

"ValidationRegExp": "[\\d]*"

Options -> ValidationRegExpDescription

Optional, String, ApiVersion: 1

By means of this parameter you can define the error message for the regular expression. The message can be translated in Translations.

Example:

"ValidationRegExpDescription": "Hier sind nur Zahlen erlaubt."

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "spotGroup"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects which each have an ID and the name as properties (at the time of the selection).

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My spot group"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter you can control how many instances of a spot group may be added by the user. If the value is not set or set 0 or 1, the user is only able to select a spot group and is not able to create additional instances.

Example:

"NumberOfInstances": 1

Options -> IncludeTemplates

Optional, Boolean, ApiVersion: 1

This parameter specifies whether it is possible to select template spot groups when selecting spot groups.

Example:

"IncludeTemplates": true

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "mediaGroup"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects which each have an ID and the name (at the time of the selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My media group"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of a media group can be added by the user. If the value is not set or set to 0 or 1, the user is only able to select one media group and cannot add additional instances.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "location"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects which each have an ID and the name (at the time of the selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My location"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control the number of instances of a location can be added by a user. If the value is not set or set to 0 or 1, the user is only able to selection one location and is not allowed to create additional instances. Please note that locations can be nested in a hierarchical order.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "player"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, which each have an ID and the name (at the time of selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My player"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of a player can be added by the user. If the value is not set or set to 0 or 1, the user is only able to select one player and is not allowed to create additional instances.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "category"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, which each have an ID and the name (at the time of selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My category"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of a category can be added by the user. If the value is not set or set to 0 and 1, the user is only able to select one category and is not able to create any additional instances. Please note, that categories can be nested in hierarchical order.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "spot"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, which each have an ID and the name (at the time of selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "Mein Spot"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of a spot can be added by the user. If the value is not set or set to 0 and 1, the user is only able to select one spot and is not able to create any additional instances.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "media"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, which each have an ID and the name (at the time of selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "My medium"
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of a medium can be added by the user. If the value is not set or set to 0 and 1, the user is only able to select one medium and is not able to create any additional instances.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Id, DisplayName

Mandatory fields, ApiVersion: 1

See Elements table.

DataType

Mandatory field, String, ApiVersion: 1

"DataType": "edition"

Value

Mandatory field, Array, ApiVersion: 1

An array of objects, which each have an ID and the name (at the time of selection) as properties.

Example:

"Value": [
	{
		"Id": 123,
 		"Name": "WINDOWS",
 		"Guid": "My edition",
	}
]

Options -> NumberOfInstances

Optional, Int, ApiVersion: 1

By means of this parameter, you can control how many instances of an edition can be added by the user. If the value is not set or set to 0 and 1, the user is only able to select one edition and is not able to create any additional instances.

Example:

"NumberOfInstances": 1

Options -> Conditions

Optional, Object, ApiVersion: 2

Details see Conditional Elements.

"Operator": ["!="|"=="|"?"]

Function

Registers a call-back function that is initially invoked and if any data has changed in the HTML Wizard.

Parameters

function(jsonData)

jsonData the JSON data that come from the HTML Wizard (the modified content from the ascData.json file)

Examples

gfDashboardWidgetBase.
  registerDataChangedHandler(onDataChanged);

function onDataChanged(jsonData)
{
var elementData = gfDashboardWidgetBase.getElementData();
document.getElementById("myElement").innerHTML = elementData["myJsonElement"].Value;
}

Minimum Version

ApiVersion: 1

Grassfish IXM Platform: 11.0.0

Function

Starts the animation in the Dashboard widget. It is loaded from the container, if the animations should start in the Dashboard widget. Prior to this, the Dashboard widget should not play animations.

Parameters

None

Examples

gfDashboardWidgetBase.

registerPlayHandler(startMyAnimations);

Minimum Version

ApiVersion: 1

IXM Platform: 11.0.0

Function

This function does not currently have any effect.

Parameters

None

Example

gfDashboardWidgetBase.

registerStopHandler(resetMyAnimations);

Minimum Version

ApiVersion: 1

IXM Platform: 11.0.0

Function

Call-back function to process the print command from the IXM Platform in the Dashboard widget.

Parameters

None

Examples

gfDashboardWidgetBase.
  registerPrintHandler(onPrintRequested);

function onPrintRequested()
{
}

Minimum Version

ApiVersion: 1

IXM Platform: 11.0.0

Function

Support function to open a file dialogue in order to enable the implementation of saving data.

Parameters

Value string, the data

fileName string, the file name

filetype string, the type of file, optional, default: "application/octet-stream"

Examples

var content;

content = "ID,TEXT"\n";
content += "1,Ich"\n";
content += "2,werde"\n";
content += "3,exportiert"\n";

gfDashboardWidgetBase.saveToFile(content, "export.csv", "text/csv");

Minimum Version

ApiVersion: 1

IXM Platform: 11.0.0

Function

Logs the message in the on-screen log of the ascInterface. The log must be activated in the ascInterface via the URL parameter &debug=true.

Parameters

function(message)

message Message which is to be logged

Examples

gfDashboardWidgetBase.sendLog("message");

Minimum version

ApiVersion: 1

IXM Platform: 11.0.0

Function

Call-back function for sendLog for processing in the Dashboard widget.

Parameters

function(message)

message Message which is to be logged

Examples

gfDashboardWidgetBase.registerLogHandler(onLog);

function onLog(message)
{
}

Minimum

version

ApiVersion: 1

IXM Platform: 11.0.0