Skip to end of metadata
Go to start of metadata

Introduction

The OData interface allows to publish any Focused Insights metrics (SAP Solution Manager or Focused RUN) to the SAP Analytics Cloud (SAC).

To use FINS2SAC interface, the SAC Tenant must be connected to the SAP Solution Manager or the FRUN with the SAP Cloud Connector.

The interface offers dedicated functions to access 3 types of format:

  • time series,
  • tables content (Solution Manager only),
  • datasets.

On the SAC side, models are constructed out of a generic OData connection. The dimensions offered by the FINS2SAC interface can be selected and filtered with the graphical editor, so that only relevant information are sent and to the SAC.

 

Time Series Interface

Service Name

OData ServiceTypeEntityFilter
/sap/opu/odata/STDF/SAC_EXTRA_SRV/Solution ManagerGadgetSeriesSetGADGET_ID
/sap/opu/odata/sap/FRN_FI_DP_SRV/FRUNSeriesSacSetIdDashbaord / IdGadget

Common Dimensions

NameDescriptionFilterFRUN
Dashboard IdUnique id of the dashboardYes (FRUN)Yes
Dashboard TitleTitle of the dashboard
Yes
Gadget IdUnique id of the gadgetYesYes
Gadget TitleTitle of the gadget
Yes
Gadget DescriptionDescription of the gadget
No
NameOCC query legend
Yes
Query NumberPosition of the OCC query in the gadget, starting from 1 (only visible queries are exported)
Yes
SourceTechnical name of the data provider used by the OCC query
Yes
G2YParameter G2Y in the OCC Query àThreshold Green To Yellow
Yes
Y2RParameter Y2R in the OCC Query àThreshold Yellow To Red
Yes
TrendAttribute TREND of OCC query
Yes
AggregationAttribute SLA of OCC query
Yes
ValueValue of the data point
Yes

Common Time Dimensions

NameDescriptionFRUN
ResolutionGadget’s resolution (YEAR, MONTH, WEEK, DAY, HOUR, RAW)Yes
Timestamp (*)Timestamp corresponding to one single data point of a time series, with format YYYYMMDDHHMNSS


•If gadget’s resolution is YEAR => YYYY0101000000
•If gadget’s resolution is MONTH => YYYYMM01000000
•If gadget’s resolution is WEEK => YYYYMMDD000000 (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below => YYYYMMDD000000

Yes
Date (*)Day corresponding to one or several data points of a time series, with format: YYYYMMDD


•If gadget’s resolution is YEAR => YYYY
•If gadget’s resolution is MONTH => YYYYMM
•If gadget’s resolution is WEEK => YYYYMMDD (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below => YYYYMMDD

Yes
Week (*)If gadget’s resolution is WEEK, HOUR, DAY or RAW, this dimension contains the week number of a data point; it is empty otherwise.Yes
Week Day (*)If gadget’s resolution is DAY or below, this dimension contains the week day number of a data point; it is empty otherwise.Yes
Hour (*)If gadget’s resolution is HOUR or below, this dimension contains the hour (00-23); it is empty otherwise. Hour under 10 start with character ‘0’ to guaranty correct sorting in the chartsYes

(*) If the query doesn’t return a time series (i.e. X-Axis is free text), dimensions Timestamp & Date contain the X-Axis values while dimensions Week & Hour remain empty

Specific Dimensions

FINS2SAC time series interface returns 5 additional dimensions which depend on the data provider and the the OCC Query. The specific dimensions have the following generic names: Dim1, Dim2, Dim3, Dim4, Dim5

The values of specific dimensions come from OCC query data provider’s attributes. They are populated  in the reading order, like in the example below:

 

Table Interface

Service Name 

OData ServiceTypeEntityFilter
/sap/opu/odata/STDF/SAC_EXTRA_SRV/Solution ManagerGadgetTableSetgadgetid

Common Dimensions

NameDescriptionFilterFRUN
Dashboard IdUnique id of the dashboard
Not supported
Dashboard TitleTitle of the dashboard
Not supported
Gadget IdUnique id of the gadgetYesNot supported
Gadget TitleTitle of the gadget
Not supported
Gadget DescriptionDescription of the gadget
Not supported
NameOCC query legend
Not supported
Query NumberPosition of the OCC query in the gadget, starting from 1 (only visible queries are exported)
Not supported
SourceTechnical name of the data provider used by the OCC query
Not supported

Common Time Dimensions

NameDescriptionFRUN
ResolutionGadget’s resolution (YEAR, MONTH, WEEK, DAY, HOUR, RAW)Yes
TimestampTimestamp corresponding to the beginning of the collected period, with format YYYYMMDDHHMNSS


•If gadget’s resolution is YEAR => YYYY0101000000
•If gadget’s resolution is MONTH => YYYYMM01000000
•If gadget’s resolution is WEEK or below => YYYYMMDD000000 (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below =>YYYYMMDD000000
•If gadget’s resolution is AUTO => YYYYMMDDHHMMSS where timestamp corresponds to the time the data was requested (vs the time the data was collected)

Yes
DateDay corresponding to the beginning of the collected period, with format: YYYYMMDD


•If gadget’s resolution is YEAR => YYYY
•If gadget’s resolution is MONTH => YYYYMM
•If gadget’s resolution is WEEK or below => YYYYMMDD (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below => YYYYMMDD
•If gadget’s resolution is AUTO => YYYYMMDD where date corresponds to the day the data was requested (vs the time the data was collected)

Yes
WeekIf gadget resolution is WEEK or below, this dimension contains the week number of the first week of the collected period.Yes
Week Day (*)If gadget’s resolution is DAY or below, this dimension contains the week day number of the first day of the collected period.Yes
HourIf gadget resolution is HOUR or below, this dimension contains the first hour of the collected period (00-23); it is empty otherwise. Hour under 10 start with character ‘0’ to guaranty correct sorting in the chartsYes

Column Dimensions

FINS2SAC Table interface returns 20 column dimensions which depend on table content. The column dimensions accept the following generic names: Col01, Col02, …, Col20

The values of column dimensions come from the content of the 20 first columns of the table as it is displayed by the OCC renderer DYNAMIC_TABLE. If the table has less than 20 columns, useless column dimensions remain empty

OCC query attribute SAC_TABLE_MAX_ROW indicates the maximum number of rows to return for the query

Specific dimensions Dim1, Dim2, Dim3, Dim4, Dim5 are available but optional.

Dataset Interface

The Dataset is the data source used by SAC Predictive Scenario. As for the time series & table interfaces, we use a 1:1 mapping between a gadget and a dataset.

Since the dataset contains a variable number of columns (one dedicated column per key figure) the FIN2SAC OData interface must rely on dynamic entity models. It means that one entity has to be generated per dataset/gadget exposed to the SAC.

To expose a gadget, we rely on the existing OCC dashboard flag “Discoverable”. Once an OCC dashboard is marked as discoverable, all its gadgets are automatically exposed to the SAC and the corresponding dataset entities are generated (one per gadget).

SAP Solution Manager examples:

 

Focused Run Examples:

Service Name

OData ServiceTypeEntity
/sap/opu/odata/STDF/SAC_EXTRA_SRV/Solution ManagerFIDS_[Gadgetname]_[GadgetID]
/sap/opu/odata/sap/FRN_FI_DP_SRV/FRUNFIDS_[Gadgetname]_[GadgetID]

JOBS

Datasets structures are dynamic and should be generated by a jobs in SAP Solution Manager or Focused RUN.

Jobs NameTypeParametersFilter
/STDF/GENERATE_DYN_ENT Solution ManagerGadget IDNA
FRN_FI_GENERATE_DYN_ENTFRUNDashboardID / Gadget ID

 

SAP Solution Manager

Focused RUN

Time Dimensions

NameDescriptionFRUN
ResolutionGadget’s resolution (YEAR, MONTH, WEEK, DAY, HOUR, RAW)Yes
Timestamp (*)Timestamp corresponding to one single data point of a time series, with format: YYYYMMDDHHMNSS


•If gadget’s resolution is YEAR => YYYY0101000000
•If gadget’s resolution is MONTH => YYYYMM01000000
•If gadget’s resolution is WEEK => YYYYMMDD000000 (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below => YYYYMMDD000000

Yes
Date (*)Day corresponding to one or several data points of a time series, with format: YYYMMDD


•If gadget’s resolution is YEAR => YYYY-01-01
•If gadget’s resolution is MONTH => YYYY-MM-01
•If gadget’s resolution is WEEK or below => YYY-MM-DD (where DD is the 1st day of the week)
•If gadget’s resolution is DAY or below => YYYY-MM-DD

Yes
Week (*)If gadget resolution is WEEK, HOUR, DAY or RAW, this dimension contains the week number of a data point; it is empty otherwise.Yes
Week Day (*)If gadget’s resolution is DAY or below, this dimension contains the week day number of a data point; it is empty otherwise.Yes
Hour (*)If gadget resolution is HOUR or below, this dimension contains the hour (00-23); it is empty otherwise. Hour under 10 start with character ‘0’ to guaranty correct sorting in the chartsYes

Dimensions & Key Figure(s)

NameDescriptionFRUN
Dashboard IdUnique id of the dashboardYes
Dashboard TitleTitle of the dashboardYes
Gadget IdUnique id of the gadgetYes
Gadget TitleTitle of the gadgetYes
Gadget DescriptionDescription of the gadgetNo
GroupName of the group if definedYes
<Key Figure(s)> *

One key figure per OCC query, it contains the time series values. The OCC query legends without the groups are used as columns names.

For example, if the gadget contains 3 queries with legends “Average Response Time”, “Maximum Response Time” & “Number of alerts”, the FINS2SAC interface returns 3 key figure columns “Average Response Time”, “Maximum Response Time” & “Number of alerts”. The columns contain the time series values of the corresponding OCC queries.

Yes

Remark about Group and Key Figure:

  • If the OCC query legend is “Average Response Time”, then the name of the group is empty and the name of the key figure is “Average Response Time”


  • If the OCC query legend is “A4H / Average Response Time”, then the name of the group is “A4H” and the name of the key figure is “Average Response Time”


Remarks

The graphical renderers used in the OCC gadgets data don’t influence the content exported by the FINS2SAC interface, only the OCC queries matters.

If a value is too long to fit in a SAC dimension (more than 256 characters), it’ll be automatically truncated by the FINS2SAC interface.See also: https://apps.support.sap.com/sap/support/knowledge/public/en/2651610



  • No labels