Ready to get started?

Learn more about CData API Server or sign up for a free trial:

Learn More

Consume EDGAR Online OData Feeds in SAP Lumira

Use the API Server to create data visualizations on EDGAR Online feeds that reflect any changes in SAP Lumira.

You can use the CData API Server and the ADO.NET Provider for EDGAR Online (or any of 190+ other ADO.NET Providers) to create data visualizations based on EDGAR Online data in SAP Lumira. The API Server enables connectivity to live data: dashboards and reports can be refreshed on demand. This article shows how to create a chart that is always up to date.

Set Up the API Server

Follow the steps below to begin producing secure EDGAR Online OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to EDGAR Online

After you deploy the API Server and the ADO.NET Provider for EDGAR Online, provide authentication values and other connection properties needed to connect to EDGAR Online by clicking Settings -> Connection and adding a new connection in the API Server administration console.

  1. Navigate to https://developer.edgar-online.com/ and create an account.
  2. Register a new application and retrieve the AppKey. You should select one of the available Web APIs this application will use like HackPack, Insider Trades or Institutional Ownership.
    Note: HackPack is the most important Web API that an application can use since it supports a large number of endpoints. If you are getting the "Access Denied" error you must create a new app and select the correct Web API which supports the resource you are querying.
  3. After successfully creating a new app, you can access your keys through your "my account" area. Set the AppKey connection property value equal to the Key of your application.

When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

You can then choose the EDGAR Online entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Connect to EDGAR Online from SAP Lumira

Follow the steps below to retrieve EDGAR Online data into SAP Lumira. You can execute an SQL query or use the UI.

  1. In SAP Lumira, click File -> New -> Query with SQL. The Add New Dataset dialog is displayed.
  2. Expand the Generic section and click the Generic OData 2.0 Connector option.
  3. In the Service Root URI box, enter the OData endpoint of the API Server. This URL will resemble the following: https://your-server:8032/api.rsc
  4. In the User Name and Password boxes, enter the username and authtoken of an API user. These credentials will be used in HTTP Basic authentication.
  5. Select entities in the tree or enter an SQL query. This article imports EDGAR Online Subscriptions entities.

  6. When you click Connect, SAP Lumira will generate the corresponding OData request and load the results into memory. You can then use any of the data processing tools available in SAP Lumira, such as filters, aggregates, and summary functions.

Create Data Visualizations

After you have imported the data, you can create data visualizations in the Visualize room. Follow the steps below to create a basic chart.

  1. In the Measures and Dimensions pane, drag measures and dimensions onto the x-axis and y-axis fields in the Visualization Tools pane. SAP Lumira automatically detects dimensions and measures from the metadata service of the API Server.

    By default, the SUM function is applied to all measures. Click the gear icon next to a measure to change the default summary.

  2. In the Visualization Tools pane, select the chart type.
  3. In the Chart Canvas pane, apply filters, sort by measures, add rankings, and update the chart with the current EDGAR Online data.