VOOZH about

URL: https://www.cdata.com/kb/tech/adobecommerce-odata-infragistics-reveal.rst

⇱ Analyze Adobe Commerce Data in Infragistics Reveal


Analyze Adobe Commerce Data in Infragistics Reveal

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Server to create an OData API on top of Adobe Commerce data and visualize live Adobe Commerce data in Infragistics Reveal.

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Adobe Commerce data. The CData API Server generates an OData API for Adobe Commerce, which is natively consumable in Reveal. In this article, we walk through connecting to Adobe Commerce in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Adobe Commerce from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open API Server and click Settings -> Connection -> Add Connection πŸ‘ Adding a connection
  2. Select "Adobe Commerce" πŸ‘ Selecting a Connector (Salesforce is shown).
  3. Enter the necessary authentication properties to connect to Adobe Commerce.

    Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

    • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

    • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

    πŸ‘ Configuring a connection (Salesforce is shown).

Add Adobe Commerce Resource Definitions in API Server

After connecting to Adobe Commerce, create Resources, which represent API endpoints for Adobe Commerce data.

  1. Click Settings -> Resources -> Add Resource πŸ‘ Adding a new resource
  2. Select the Adobe Commerce connection πŸ‘ Selecting a connection (Salesforce is shown)
  3. Select the table you wish to retrieve and click Next πŸ‘ Selecting a Table (Salesforce is shown)
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

Add an API Server User

Create a User to connect to Adobe Commerce from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the Adobe Commerce Connection and Resource(s) πŸ‘ Creating a new user
πŸ‘ API Server users

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

πŸ‘ Configuring CORS settings

Create a Dashboard in Reveal

With the API Server configured, we can visualize Adobe Commerce data in Reveal.

  1. Log into Reveal and click Dashboards -> New πŸ‘ Adding a new dashboard
  2. Click Data Source -> OData Feed πŸ‘ Adding a new OData data source
  3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc πŸ‘ Configuring the OData URL
  4. Select Generic Credentials and specify the API Server username and authentication token πŸ‘ Configuring the credentials
  5. Select the entity you wish to visualize πŸ‘ Selecting an entity to visualize (Salesforce is shown.)
  6. Select fields and choose a chart type πŸ‘ Visualizing data in Reveal (Salesforce is shown.)

More Information & Free Trial

At this point, you have created a simple dashboard from live Adobe Commerce data. For more information on creating OData feeds from Adobe Commerce (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Adobe Commerce data in tools that consume OData APIs.