Skip to main content

Nexus Datasets

Nexus datasets is a solution to sync up with the current nexus data sets API. Data can be extracted from the nexus API after providing the required data in the config. Data set name should be provided aliong with the other details to sync the data. API Documentation

Prerequisites

  • Nexus customer organization with Data Mesh rights
  • Export data set created in the customer organization
  • Data API Agent user configured in the customer organization

Airbyte OSS and Airbyte Cloud

  • Name of the data set to be synced
  • Data API Agent user name / Cliend access key ID / Secret key for the Data API Agent user
  • Data Key (API Key) for the customer organization

Setup guide

Step 1: Nexus Configuration

Step 1.1: Create Nexus Customer Organization

  1. Create customer organization in the nexus platform

Step 1.2: Configure Data Mesh in the Customer Organization

  1. Log into the admin side of the nexus application
  2. Set up the Data Mesh rule for the organization
  3. Create users with the Data Mesh previledges
  4. Make sure this user can be logged in to the nexus platfrom

Step 1.3: Configure export data pipeline in the Nexus

  1. Log into the nexus platform using created user in the step 2
  2. Go to Analytics » Data Mesh Console
  3. Click on Export tab to go into the exportable data sets
  4. Click Create to create new export pipeline using the existing models
  5. Schedule the data set to run

Step 1.4: Summary

  • Base URL for the nexus platform
  • Nexus customer organization with relevant user with rights
  • Export data set
  • Data API Agent user (DAPI user)
  • DAPI user id / access key id / secret key
  • Data key (API key)

Step 2: Set up the source connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Nexus Datasets from the Source type dropdown and enter a name for this connector.
  4. Add Base URL
  5. Add Dataset Name
  6. Add Infor Streaming Mode (default Full)
  7. Add User ID
  8. Add Access Key ID
  9. Add Secret Key
  10. Add API Key
  11. Click Set up source

For Airbyte OSS:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Nexus Datasets from the Source type dropdown and enter a name for this connector.
  4. Add Base URL
  5. Add Dataset Name
  6. Add Infor Streaming Mode (default Full)
  7. Add User ID
  8. Add Access Key ID
  9. Add Secret Key
  10. Add API Key
  11. Click Set up source.

Configuration

InputTypeDescriptionDefault Value
base_urlstringBase URL. Enter base url for your data set
dataset_namestringName of the dataset. Enter dataset name to be synced
infor_streaming_modestringName of the dataset. Enter dataset name to be synced
user_idstringData API agent user ID. Enter DAPI agent user id configured in the nexus
access_key_idstringAccess key ID. Enter access key ID for the DAPI agent user
secret_keystringSecret key. Enter secret key for the DAPI agent user
api_keystringData API key. Enter data API key for the organization

Supported sync modes

The Nexus Datasets source connector supports the following sync modes:

  • Full Refresh
  • Incremental

Streams

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
datasetsDefaultPaginator

Custom Components

NexusCustomAuthenticator is a primary component which handles the HMAC authentication for nexus API.

HMAC stands for Hash-based Message Authentication Code. In HMAC authentication, every request is independently established using a cryptographic hash function. For each API request, the client computes a hashed "signature" using a secret key and submits it in the Authorization header.

Please refer https://developer.infornexus.com/api/authentication-choices/hmac for more details to get the data to calculate the HMAC signature.

Error Codes

200 : Data set is ready to stream 202 : Data set is not ready but try again later. 304 : Data set is not ready, check the source again.

Reference

Config fields reference

Field
Type
Property name
string
access_key_id
string
api_key
string
base_url
string
dataset_name
string
secret_key
string
user_id
string
mode

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.12026-02-0372789Add missing registryOverrides to metadata.yaml
0.1.02025-09-3069349Nexus datasets connector first version