Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Reltio source in Nexla.
reltio_api.png

Reltio

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Reltio connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Reltio account, and click Next; or, create a new Reltio credential for use in this flow.

  3. In Nexla, Reltio data sources can be created using pre-built endpoint templates, which expedite source setup for common Reltio endpoints. Each template is designed specifically for the corresponding Reltio endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Reltio sources can also be configured manually, allowing you to ingest data from Reltio endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Reltio endpoints. Each template is designed specifically for the corresponding Reltio endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get users for a customer

    This endpoint template retrieves all the users belonging to a specific customer from your Reltio account. Only Customer Administrators can use this API. Use this template when you need to retrieve information about users for a specific customer, including user IDs, names, and other user metadata.

    • Enter the customer ID in the Customer ID field. This should be the unique identifier of the customer who has administrator access. The customer ID determines which customer's users will be retrieved.

    This endpoint returns all users belonging to a specific customer from your Reltio account, including user IDs, names, and other user metadata. Only Customer Administrators can use this API. The endpoint returns a list of users for the specified customer.

    For detailed information about user management, API response structures, and available user data, see the Reltio API documentation.

    Get Heavy Operations for a Tenant

    This endpoint template gets detailed information about responses with error code 507 for the last one hour for the specified tenant from your Reltio account. Use this template when you need to retrieve information about heavy operations that may have caused quota limit errors.

    • Enter the environment URI in the Environment URI field. This should be the environment URI for your Reltio instance (e.g., https://api.reltio.com). The environment URI determines which Reltio environment will be queried.
    • Enter the tenant ID in the Tenant ID field. This should be the unique identifier of the tenant for which you want to retrieve heavy operations. The tenant ID determines which tenant's heavy operations will be retrieved.

    This endpoint returns detailed information about responses with error code 507 for the last one hour for the specified tenant from your Reltio account, including operation details and error information. The endpoint returns a list of heavy operations that may have caused quota limit errors.

    For detailed information about heavy operations, API response structures, and available operation data, see the Reltio API documentation.

    Filter entities

    This endpoint template filters entities by query parameter from your Reltio account. Use this template when you need to retrieve entities that match specific filter criteria, including entity IDs, attributes, and other entity metadata.

    • Enter the environment URI in the Environment URI field. This should be the environment URI for your Reltio instance (e.g., https://api.reltio.com). The environment URI determines which Reltio environment will be queried.
    • Enter the tenant ID in the Tenant ID field. This should be the unique identifier of the tenant for which you want to filter entities. The tenant ID determines which tenant's entities will be filtered.
    • Enter the filter query in the Filter Query field. This should be the filter query parameter that defines the criteria for filtering entities. The filter query determines which entities will be returned based on the specified criteria.

    This endpoint returns entities that match the specified filter criteria from your Reltio account, including entity IDs, attributes, and other entity metadata. The endpoint uses the filter query parameter to determine which entities will be returned.

    For detailed information about entity filtering, API response structures, filter query syntax, and available entity data, see the Reltio API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Reltio data sources can be manually configured to ingest data from any valid Reltio API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Reltio sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Reltio API from the Method pulldown menu. Reltio API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Reltio API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your environment URI, the API path (e.g., /reltio/api/{tenant_id}/entities, /reltio/api/{tenant_id}/monitoring/heavyOperations), and any required query parameters. Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Reltio API endpoint URL should include your environment URI, tenant ID, and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Reltio API responses, use $[*] to extract all items from the response array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Reltio API response. Reltio API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.