Skip to main content

BIOVIA ELN Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a BIOVIA ELN location.
biovia_eln_api.png

BIOVIA ELN

  1. Click the + icon on the Nexset that will be sent to the BIOVIA ELN destination, and select the Send to Destination option from the menu.

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

  3. BIOVIA ELN destinations can be configured using pre-built endpoint templates, which expedite destination setup for common BIOVIA ELN endpoints.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to write/send data to common BIOVIA ELN endpoints. Each template is designed specifically for the corresponding BIOVIA ELN endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send 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 destination for this endpoint.

    Create Experiment

    Create a new experiment in BIOVIA ELN. Nexset must include name and projectId. Optional: description, templateId, status.

      All parameters are optional; omitting filters returns all available records.

      Update Experiment

      Update an existing experiment record in BIOVIA ELN. Nexset must include experimentId and fields to update.

      • Experiment ID (Required): The ID of the experiment to update.

      The Experiment ID parameter is required to identify the specific resource to retrieve.

      Create Sample

      Register a new sample in BIOVIA ELN. Nexset must include name and type. Optional: experimentId, properties.

        All parameters are optional; omitting filters returns all available records.

        Add Experiment Section

        Add a new section to an existing experiment in BIOVIA ELN. Nexset must include experimentId, sectionType, and content.

        • Experiment ID (Required): The ID of the experiment to add a section to.

        The Experiment ID parameter is required to identify the specific resource to retrieve.

        Upload Attachment

        Attach a file to an experiment or sample in BIOVIA ELN. Nexset must include entityType, entityId, and file data.

        • Entity Type (Required): The type of entity to attach the file to (experiment or sample).

        The Entity Type parameter is required to identify the specific resource to retrieve.

        Record Experiment Result

        Record structured measurement data or results into an experiment in BIOVIA ELN.

        • Experiment ID (Required): The ID of the experiment to record results for.

        The Experiment ID parameter is required to identify the specific resource to retrieve.

      Endpoint Testing​

      Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be sent according to the current settings. This allows users to verify that the destination 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​

      BIOVIA ELN destinations can be manually configured to send data to any valid BIOVIA ELN API endpoint. You can also configure Nexla to automatically send the response received from the BIOVIA ELN API after each call to a new Nexla webhook data source.

      First, select the API method that will be used for calls to the BIOVIA ELN API from the Method pulldown menu. Common methods for writing data to BIOVIA ELN include:

      • POST: For creating new experiment entries, notebook records, or other BIOVIA ELN objects
      • PUT: For replacing an existing experiment or record with new data
      • PATCH: For updating specific fields within an existing experiment or record

      Data Format​

      1. Select the format in which the Nexset data will be sent to the BIOVIA ELN API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. BIOVIA ELN APIs typically accept data in JSON format.

      API Endpoint URL​

      1. Enter the URL of the BIOVIA ELN API endpoint to which you want to send the Nexset data in the URL field. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

        Common BIOVIA ELN destination API endpoints include paths such as:

        • /api/experiments — to create new experiment records
        • /api/experiments/{'{experimentId}'} — to update a specific experiment by ID
        • /api/notebooks/{'{notebookId}'}/entries — to add entries to a specific notebook
        • /api/materials — to create or update materials and inventory records

      The exact API endpoint paths for writing data in your BIOVIA ELN instance depend on your version and configuration. Consult your BIOVIA ELN system administrator or the API reference documentation included with your BIOVIA ELN deployment for a complete list of writable endpoints and their required request body formats.

      Request Headers​

      Optional

      • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

        You do not need to include any headers already present in the credentials.

      Exclude Attributes from the Call​

      Optional

      • If any record attributes in the Nexset should be omitted when sending data to this BIOVIA ELN destination, select the attributes from the Exclude Attributes pulldown menu.

      • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

      Record Batching​

      Optional

      1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

      2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

      3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

      Response Webhook​

      Optional

      Nexla can automatically send the response received from the BIOVIA ELN API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

      • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

      Sample Request Payload​

      Sample request payloads containing a portion of the Nexset data that will be sent to the BIOVIA ELN API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

      • Click on a sample request payload to expand it and view the complete payload content.
      • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

      Endpoint Testing​

      After all endpoint settings have been configured, Nexla can send a test payload to the BIOVIA ELN API to ensure that the destination is configured correctly.

      1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

      2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

      3. Click the Send Test Data button at the top of a sample payload to send the test payload to the BIOVIA ELN API using the current settings.

      Save & Activate the Destination​

      • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured BIOVIA ELN endpoint, open the destination resource menu, and select Activate.

        The Nexset data will not be sent to the BIOVIA ELN endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.