Show TOC

Analytical ConfigurationLocate this document in the navigation structure

The analytical configuration of APF specifies, for example, the available analysis steps, the representations that are used for each step, and the categories in which the analysis steps are displayed. It is written in JavaScript Object Notation (JSON) format.

Some of the objects used to specify the analytical content must be registered under a unique ID and can be accessed using this ID. The IDs must be unique within the configuration of an APF-based Web application.

The following table lists the objects used in an analytical configuration:

Object Type

Unique ID Required

step

Yes

request

Yes

binding

Yes

representation

Yes

representationType (optional)

Yes

facetFilter

Yes

navigationTarget

Yes

category

Yes

label

No

thumbnail

No

General Rules

The following rules apply when working with configuration objects in Analysis Path Framework:

  • Value representations in configuration objects must comply with the JSON format.

  • String values must be in double quotes.

  • The type property is optional, but it is useful for debugging and comprehensibility.

  • The id property is mandatory for those objects that require a unique ID. It must be a unique ID of type string.

  • Depending on the object type, configuration objects can contain various other properties. Changes to a set of properties must be compatible with the original configuration object. You can, for example, add new properties.

    Note

    Customer modifications may conflict with the SAP namespace and can be overwritten when updates are imported.