Typedef

The execute function of an Action

The metadata of an action.

The metadata of a collection of actions implemented in one action.js file.

Example:

{
 sampleAlertAction: {
   execute: function(options() {
     ...
   })
 }
}

The result of a context query. A ContextResult is an object whose keys are EntityTypes and whose values are Arrays of EntityIds or EntityObjects

Example:

{
 PrimaryObject: ['1000', '1001', '1003'],
 DerivedSignal: [{foo: 'bar'}, {hello: 'world'}]
}

Callback function to inform an application that the context of an insightProvider has changed. In a typical implementation of this function an application will evaluate which context has changed, call the getContext method of insightProvider to retrieve the new context, and then call setContext of interested ipros to pass in the new context. {Object} insightProvider - The ipro that has changed the context {ContextQuery} contextQuery - The context that has changed.

An Object whose keys are the EntityTypes to query and whose values are the ContextQueryOptions for the requested entity. In general the ContextQuery expresses which information the application requests from the ipro.

Example:

{PrimaryObject: {selector: sap.pdms.ipro.api.ContextSelector.SELECTED}}

The options for a context query for a specific EntityType.

Indicates the return type of the context query. Possible values are sap.pdms.ipro.api.ContextReturnType.ID or sap.pdms.ipro.api.ContextReturnType.OBJECT. If sap.pdms.ipro.api.ContextReturnType.OBJECT is specified an array of ids is returned. If sap.pdms.ipro.api.ContextReturnType.OBJECT is specified an array of plain JavaScript objects is returned.

Enum of context return types. Exposed into global namespace sap.pdms.ipro.api.ContextReturnType

enum of ContextSelector's . Exposed into global namespace sap.pdms.ipro.api.ContextSelector

Defines what result set should be returned from a getContext call. Possible values are: sap.pdms.ipro.api.ContextSelector.SELECTED or sap.pdms.ipro.api.ContextSelector.ALL. sap.pdms.ipro.api.ContextSelector.SELECTED indicates that the ipro is supposed to return all entities that are currently selected usually through a user interaction. E.g. In table based ipro this refers normally to the selected rows or more specifically the context of those selected rows (e.g. all primaryObjectsIds associated with the selected context). sap.pdms.ipro.api.ContextSelector.ALL indicates that the ipro is supposed to return all entities.

An identifier for a single entity. E.g. an asset with id LC-5001.

An object which describes an entity. The object structure is specific to every EntityType.

An EntityType as string. E.g. Asset, DerivedSignal.

The supported features of an ipro.

the ui framework being used by the ipro. Exposed into global namespace sap.pdms.ipro.api.Framework

The data input and output for an ipro. Whenever the context for an EntityType listed in input has changed the application will call the ipro setContext method to pass in the new context. By adding a EntityType to output an ipro signals to an application that it might change the context for that EntityType. Declaring input and output enables an application to discover possible data flows between ipros. An output context of one ipro can be declared as an input context of another. Declaring a InsightProviderDataInterface is optional. If not declared the following InsightProviderDataInterface is assumed by default:

{
 input: ['PrimaryObject'],
 output: ['PrimaryObject']
}

The metadata of an ipro.

Options for creating an ipro

Callback function to inform an application of an intent of an insightProvider. An intent is an action that an ipro wants to trigger without knowing the exact details of that action. The one intent currently being defined is sap.pdms.ipro.api.StandardIntent.NAVIGATE_TO_CONTEXT. For instance, an ipro might expose a "Details" button to allow the user to navigate to the details page for a given EntityType. The ipro does not know what would be a suitable details page for this EntityType. So it communicates to the application the intent to navigate and then it is up to the application to implement the actual navigation. An intent can be thought of as an action whose implementation details are unknown to the ipro and thus represents an additional level of decoupling between actors expressing an intent and actors reacting to it.

The intent specific parameters. The expected parameter structure has to be defined by the intent type.

Example:

{PrimaryObject: '1001'}

Allows to restrict the number of entities returned from a context query. This parameter implies that the context query results are returned in a specific order.

The size of an ipro

enum for standard intents. Exposed into global namespace sap.pdms.ipro.api.StandardIntent