0% found this document useful (0 votes)
25 views28 pages

How Can We Access Analytical Reporting API Webcast Slide Deck

The document outlines a webcast series on Reporting APIs, focusing on the Ariba API which facilitates integration with business applications in a simple, scalable, and secure manner. It details the functionalities of Analytical Reporting APIs, including data fetching methods (synchronous and asynchronous), data limits, and the report creation process. The document also explains the types of endpoints available and their respective limitations.

Uploaded by

Sergio Manchado
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
25 views28 pages

How Can We Access Analytical Reporting API Webcast Slide Deck

The document outlines a webcast series on Reporting APIs, focusing on the Ariba API which facilitates integration with business applications in a simple, scalable, and secure manner. It details the functionalities of Analytical Reporting APIs, including data fetching methods (synchronous and asynchronous), data limits, and the report creation process. The document also explains the types of endpoints available and their respective limitations.

Uploaded by

Sergio Manchado
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
You are on page 1/ 28

Platform Support Webcast Series – Reporting APIs

OCT 28, 2020

PUBLIC
Agenda

10 Introduction to API and developer Portal

10 Analytical Reporting

15 Demo

10 Q&A

Q & A Panelist
© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 2
Ariba API

What is It ?

Ariba API’s is an interface that allows you to build new industry


standard solutions that can easily communicate/Integrate with
other Business apps in 3’S ways .

3’S. What are they?

1. Simple

2. Scalable and

3. Secure

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 3


Simple –Have you not tried using our Developer portal ?

• Self service Portal where you can –


• Manage organization and their Users
• Create Application and request for production Access
• Sandbox testing
• Generate Oauth Client Secret

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 4


Secure- How safe is the Transfer of Data

• Oauth 2.0 : Fetch data only after an access token is granted .


• IP White listing : This feature enables customers to create a
whitelist of authorized IP addresses using CIDR notation. When a
whitelist has been applied to an API client application, only requests
originating from an IP address within one of the CIDR ranges on
the IP whitelist will be permitted.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 5


Scalable – Are there Limits on the data that we can fetch ?

There are three types of limits imposed on Reporting APIs:

1. Time Limit - The number of transactions posted within a certain time period may not exceed a
certain maximum

2. Volume Limit - Total data retrieved shouldn’t exceed a certain size


 Asynchronous: 50,000 records or 10 files containing 5000 records per file. This files expire within 48
hours
 Synchronous: 50,000 records and 50 records per page.

3. Rate Limit - The number of API calls made every minute/day/week/month may not exceed a
certain limit

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 6


Reporting API’s

1. Analytical Reporting API

2. Operational reporting API for Procurement

3. Operational reporting API for Strategic Sourcing

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 7


Analytical Reporting API

These APIs let you

 Create a reporting view templates.

 View metadata for a specific view template.

 List all reporting view templates

 Update an existing reporting view template (view template name, view template status, select
attributes and filter criteria)

 Get the report Data

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 8


Reporting API work Flow

Synchronous API Asynchronous API

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 9


Fetching the data can be further divided as –

1. Synchronous

2. Asynchronous

In the asynchronous usage, requested output is batched into ZIP files containing 1000 records per
file, and these files can be downloaded one at a time. The maximum number of records returned is
10,000, or 10 files containing 1000 records per file. Files created in response to asynchronous
requests expire after 48 hours.

In the synchronous usage, requested output is batched and paginated, and results are returned
one page at a time in JSON format. The maximum number of records returned is 10,000. The
maximum number of records per page is 50.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 10


Analytical reporting

1. ASM data loads


2. Facts and Dimension
3. Create a sample report

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 11


ASM data loads

• Automated ASM loads are responsible for loading


the data from downstream and upstream to the
reporting module.
• ASM loads are not scheduled on a specific hour, Downstream Upstream
but they start at the earliest every 6 hours from DB DB
the time the last data load finished.
• If the ASM load queue is full, then the waiting
ASM load will begin as soon as a slot is available.
ASM Load ASM Load
• If a record is created/updated when an ASM data
load is InProgress, then the changes will
be reflected in reporting only in the next load.
• To check the status of the ASM load operation on
Reporting DB
your realm, go to the below link:
Presentation schema
Manage > Administration > Reporting
Manager > Schema Manager > Presentation
schema

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 12


Facts and Dimension
Facts
What is a fact:

• Facts hold information related to the Requisition Fact


transactional objects like Requisition, Purchase Cost Center
Requisition Id
Cost Center Id
order, Contract Workspace, Sourcing Project etc.
Dimension
• While creating the report decide what information
you are looking for and choose the facts that will Cost Center Id Purchase Order
provide it. For example, if you want to report on Cost Center Name Fact
requisition spend, use Requisition fact. Cost Center PO Id
Management Hierarchy Cost Center Id

What is a dimension?

• Dimensions are categories of information into


Invoice Fact
which facts fall such as Commodity, Supplier ,
Invoice Id
Cost center etc. Cost Center Id

• Dimensions can be used across multiple fact


tables.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 13


Report Creation

Report creation involves 3 steps:

• Selecting the source Data

• Pivot Layout

• Refine Data

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 14


First Step : Select the source data
• Title and Description – Add a title and
optional description
• Reporting Currency – Select the currency
you want to use for report data. The list of
currencies available in the drop down
depends on the other supported currencies
added on customer settings page
• Source Data – Select the main fact you
want to report on
• Available measures – You must add at least
one measure field to your report.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 15


Other supported currencies for reporting:

• We can add maximum of 7 currencies for reporting including the realms base currency.

• Go to Manage > Administration > Reporting Manager > Customer settings.

• You can select additional currencies from Other Supported Currencies drop down.

• For customers in dedicated schema, work with your SV deployment lead if you want to add
additional currencies to reporting.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 16


Second Step : Pivot Layout
• After selecting the main fact in Source data
page, based on the fact that you have
selected certain fields will be added to the
detail field section of the report by default
• To add additional field ,click on the Available
Hierarchies drop down and select Available
fields to show the list of all available fields.
• Select the field and add as Page
field/Column Field/ Row field/Detail field
• After adding the field, you can drag and
drop fields between the areas of the pivot
layout to move them from row to column to
page.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 17


Third Step: Refine Date
• Refine data page of the report allows you to set initial filters for the report

• All reports includes a date field filter on Refine data page

• Use Advanced Options to filter even more precisely by date if your report includes more than
one date field.

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 18


© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 19
Analytical API

The Analytical reporting APIs enable you to create a client application that
extracts reportable data from reporting facts and dimensions such as you
would select in the user interface when creating an analytical report.

Facts/ Document Types

Ex: Contract Workspace fact


Contract fact
Invoice fact
Requisition fact

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 20


Types of Endpoints

1. Metadata
2. Default templates
3. Create templates
4. View template data

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 21


Types of Analytical API

Synchronous Asynchronous

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 22


Synchronous
The Synchronous API for analytics enables you to submit smaller requests and receive results
synchronously. In the synchronous usage, requested output is batched and paginated, and
results are returned one page at a time. The maximum number of records returned is 50,000

Maximum number of records returned is 50,000

Maximum timespan for records returned is one year

Maximum number of records per page is 50

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 23


Asynchronous- Job Submission API

The Job submission API for analytics allows you to submit larger jobs for asynchronous
processing, using reporting view templates. To retrieve the output from these jobs, use the
Job results API for analytics

The maximum number of records returned is 50,000

The maximum timespan for records returned is one year


10 files containing 5000 records per file.
This files expire within 48 hours

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 24


Limitations

Synchronous Asynchronous

1. API rate Limit- 1/second, 3/minute, 50/hour, 300/day 1. API rate Limit - 1/second, 2/minute, 8/hour, 40/day
2. Data limit – 50,000 records 2. Data limit - 50,000 records
3. Filter limit - one year 3. Filter limit - one year

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 25


Demo

Synchronous Asynchronous

1. View Metadata 1. Schedule Job


2. View Standard templates 2. Job Status
3. View Data 3. Download Data from files
4. Create template
5. View Data on New Template
6. Patch template
© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 26
Asynchronous job - When records are more than 50000

© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 27


© 2020 SAP SE or an SAP affiliate company. All rights reserved. ǀ PUBLIC 28

You might also like