The OData feed function allows users to capture a special URL or snippet that allows them to read in the result set of the item's query into another client technology that consumes data.
This lets you edit live queries from Pyramid in other clients, like Excel, or copy queries from multiple clients into a single application.
The OData feed differs from the OData source in Model, which enables Pyramid to consume other OData feeds. Instead, the OData feed uses Pyramid queries as a data source.
Note: The OData Feed capability requires separate licensing.
Access the OData Feed URL
The OData Feed can be accessed via a data discovery's Actions Panel, the App Tab Menu, and presentations in runtime. The OData Feed is also accessible to Basic users, who are given access to embedded content items only.
Runtime Presentation
While the presentation is in runtime, right-click on the relevant query; click OData > OData Option from the context menu. Depending on whether you are displaying the new Context Menu, this link might or might not be under Content Details:
Using OData in Excel
Example. Copy OData Link to Excel
Start by opening the presentation in runtime.
Right click on the relevant visualization and click "OData Link" from the context menu.
Open Excel and click "Get Data" from the Data ribbon. Select "From Other Sources" and then "From OData Feed".
Paste the OData link copied from Pyramid into the URL field of the OData Feed dialog and click OK. You will most likely be prompted to enter your Pyramid login credentials; do so and then click Connect.
From the Navigator dialog, select the query that you copied from Pyramid and click Load.
The query is loaded in Excel.
Example: Using the OData Snippet in Excel
If you want to use Pyramid data inside another tool but need to connect using web token authentication, you need to copy one of the OData Snippet options. This will copy the special snippet to your clipboard for use in Excel.
Next, switch to Excel, and open a new worksheet. Go to the Data tab, choose Get Data > From Other Sources > Blank Query.
Paste your snippet URL into the text box (red arrow):
Click Edit Credentials and, in the dialog that opens, select Web API (red arrow).
Copy the appropriate Authentication key from Pyramid to your clipboard:
- If you want to authenticate as the user that is currently logged in to Pyramid, go to the System Info page and click the Copy icon alongside the Authentication token (red arrow, below).
- If you are an administrator, you can authenticate as a different user via the Admin Console. For details, see Get Authentication Token.
Go back to the OData feed dialog in Excel, and paste the Authentication key into the Key field. Click Connect.
A preview of the result set opens in the Query Builder. Click Close & Load to import the data.