The step object in the analytical content configuration file defines static data such as labels, pictures indicating the representation types, and the category in which it is displayed in the analysis step gallery.
The step object consists of a request object and a binding object. The request defines the access to the server resource, that is, it retrieves the data that is displayed on the UI. The binding maps the required representation types to the analysis step, which defines the way in which the data is displayed on the UI, for example, in a chart or a list.
On the UI, analysis steps are shown in the analysis step gallery as template objects. The step template object is derived from the step object in the configuration file, but contains only the information that is required on the UI, for example, the texts and the representations. When a user selects an analysis step from the gallery, a new step instance is created. An instance of a step object provides the representation type that is currently used both in the analysis step display as a chart or a list, and in the analysis path display as a thumbnail.
The step object has the following format:
Syntax
{
"type" : "step", // optional
"id" : <id::string>,
"title" : <label> // optional
"longTitle" : <label> // optional
"request" : <request ID>,
"binding" : <binding ID>,
"picture" : <path/file>, // relative to Web application root
"hoverPicture" : <path/file>, // relative to Web application root
"thumbnail" : <thumbnail>
"categories" : [ <categroyID>* ],
}
The properties used in the step object denote the following:
Property | Description |
---|---|
id | Unique ID of type string |
title | Title displayed in the analysis step gallery and in the analysis path display. |
longTitle | Title displayed above the representation in the analysis step display. If no long title is defined, the title is used instead. |
request | ID of the request used for this analysis step. |
binding | ID of the binding used for this analysis step. |
picture | Icon indicating the representation type; displayed in the analysis step gallery. |
hoverPicture | Icon displayed in the analysis step gallery when hovering. |
thumbnail | Displayed in the analysis path display. |
categories | ID of the categories in which the analysis step is displayed in the analysis step gallery. |
For the initial analysis step of an APF-based Web application, the following applies:
The category defined in the step object must be initial. The category initial must be used only once in the analytical configuration file. The application checks whether the category initial exists in the configuration file and uses the related step object as the initial step when the user starts a new analysis.
The attributes picture and hoverPicture do not apply to the initial step.