Skip to main content

Data Source

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

Plytix

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 Plytix connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Plytix account, and click Next; or, create a new Plytix credential for use in this flow.

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

    Plytix sources can also be configured manually, allowing you to ingest data from Plytix 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 Plytix endpoints. Each template is designed specifically for the corresponding Plytix 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 available asset filters

    This endpoint template retrieves available asset filters from your Plytix account. Use this template when you need to retrieve information about available filters for assets, including filter names, types, and other filter metadata.

    • This endpoint automatically retrieves all available asset filters from your Plytix account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns a list of available asset filters from your Plytix account, including filter names, types, and other filter metadata. Use this endpoint to discover which filters are available in your Plytix account before using them with other Plytix endpoints.

    For detailed information about asset filters, API response structures, and available filter data, see the Plytix 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​

Plytix data sources can be manually configured to ingest data from any valid Plytix 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 Plytix 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 Plytix API from the Method pulldown menu. Plytix API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Plytix API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Plytix endpoint (e.g., https://pim.plytix.com/api/v1/filters/asset). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Plytix API endpoint URL should include the API version (/api/v1/) and the resource type 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 Plytix API responses, use $.data[*] to extract all items from the data 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 Plytix API response. Plytix 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.