Logo

Table of Contents:

Integration scenarios

Integrating your software with Gekkobrain falls in 2 catgories:

1) Gekkobrain pushes data 2) Data is pulled from Gekkobrain

Push scenarios

In the Insights framework you can chose to enable messages and depending on the trigger and the timing the data will be pushed from our cloud.

Only administrators can subscribe and unsubscribe users from email notifications.

Setting up which push notofications a user receives is done on the user details page.

Webhook

Gekkobrain supports pushing JSON data to webhooks and the JSON body can be defined by you. We have predefined a JSON for Slack and we support this integration, meaning any changes in this JSON will be done by our development team.

Email

Gekkobrain supports sending emails with an html payload. Its an effective way of getting time notifications and many users appreciate the ability to circulate emails to other peers.

Gekkobrain uses a special middleware that ensures delivery and it tracks delivery failures but it is worth mentioning that emails with a similar subject field is sometimes caught by spam filters. This means that emails that have many subscribers will from time to time be subject to blocking. Please check your spam-folder if for example daily reports stop coming.

Pull scenarios

Gekkobrain has published a number of APIs, ie webservices, that you can call. The endpoints return JSON payloads. The endpoints requires authentication which means only known credentials can pull data. In pull scenarios Gekkobrain, which is a multi-tenant solution, ensures Quality of Service for all customers by limiting the number of repeated calls that an application can do.

Generating credentials for Basic Authentication

Most applications that consume webservices support basic authentication. We will provide an example for Microsoft Excel using Power Query but any other tool can be used.

Issuing Basic Auth keys is done in the cloud and the credentials are personal and connected to the account, meaning that they will register as login activity on the user which has generated them. Athenticate against the account for access to the data and check that the user has the right to access that data.

You find the Basic Auth key on your own user profile in the cloud.

There is no limit to the number of credentials you can create. Its however not possible to view the creditial details more once. This decreases the risk of them being misused and we encourage you not to share them with anyone as they are personal.

You can revoke a set of credentials at any time. If your user is deleted by your administrator then the credentials you have issues are automatically revoked. If the account is closed or suspended they will also be revoked.

You can revoke them yourself by simply pressing the revoke button next to them.

List of API endpoint URLs

Currently Gekkobrain offers these 5 endpoints 1) Data matching the issue list in the HANAREADY project, not filterable 2) Data matching the issue list in the S4ESTIMATE project, not filterable 3) Application statistics for TCODE activity, Filters: tcode, list of tcodes, date 4) Application statistics for Fiori/ODATA activity, Filters: servicename, list of servicename, date 5) Application statistics for RFC including BAPI, but excluding internal RFC activity, Filters: functionmodulename, list of functionmodulenames, date

How to construct the http_get request URLs for the endpoints

Regarding API # 1

https://<cloud_url>/api/client/objects?system=<systemid>
- cloud_url : The url for your cloud account. For example gekkobrain.gekkobrainhosted.com 
- systemid : The SAP system id that you have created in the cloud which has a HANAREADY project

Regarding API # 2

https://<cloud_url>/api/client/s4objects?system=<systemid>
- cloud_url : The url for your cloud account. For example gekkobrain.gekkobrainhosted.com 
- systemid : The SAP system id that you have created in the cloud which has a S4ESTIMATE project

Regarding API # 3

https://<cloud_url>/api/client/appstat/<periodtype>/<systemid>/<periodvalue>?root=<tcodevalue>
- cloud_url : The url for your cloud account. For example gekkobrain.gekkobrainhosted.com 
- periodtype : Write either MONTHLY or DAILY as periodtype
- systemid : The SAP system id that you have created in the cloud which has an APPSTATS datasource
- periodvalue : For DAILY write this as YYYY-MM-DD
                For MONTHLY write this as YYYY-MM
- tcodevalue : Either a single transactioncode or a comma-seprated list of tcodes

Regarding API # 4

https://<cloud_url>/api/client/webstat/<periodtype>/<systemid>/<periodvalue>?servicename=<odataservice>
- cloud_url : The url for your cloud account. For example gekkobrain.gekkobrainhosted.com 
- periodtype : Write either MONTHLY or DAILY as periodtype
- systemid : The SAP system id that you have created in the cloud which has an APPSTATS datasource
- periodvalue : For DAILY write this as YYYY-MM-DD
                For MONTHLY write this as YYYY-MM
- odataservice : Either a single odata or a comma-seprated list of odata services

Regarding API # 5

https://<cloud_url>/api/client/rfcstat/<periodtype>/<systemid>/<periodvalue>?functionname=<rfcfunctionname>
- cloud_url : The url for your cloud account. For example gekkobrain.gekkobrainhosted.com 
- periodtype : Write either MONTHLY or DAILY as periodtype
- systemid : The SAP system id that you have created in the cloud which has an APPSTATS datasource
- periodvalue : For DAILY write this as YYYY-MM-DD
                For MONTHLY write this as YYYY-MM
- rfcfunctionname : Either a single functionmodule name or a comma-seprated list of functionmodule names

Consuming a Gekkobrain endpoint using Microsoft Excel

Microsoft Excel is given as an example, but any other tool that can ingest JSON can be used. The example given is for retrieving from API # 3, the APPSTATS endpoint.

Open a new Excel sheet and goto the Data tab. “Queries & Connections” opens the shoulder for exisiting queries (should this be an existing sheet) otherwise choose “Get Data”.

Under “Get Data” choose From Web

Enter the URL

Once the URL is entered Excel will prompt for authentication. If the excel sheet is not a new sheet this prompt will not appear as the credentials are kept in the excel.

After pressing “Connect” the “Power Query” tool opens.

Choose “To Table”

After which this list appears

Press the “expand to columns” button

Then choose which columns to bring into the expansion

Now chose to load into the excel (which closes Power Query)

The sheet works on getting the data for a while depending on network, your computers ressources etc

Now, edit the settings for refresing if needed

Keep in mind that the query name is not the query itself,but just derived from the CGI parameters

Now start working with the data in Excel!