Deploy Pipelines to SDC Edge

After designing edge pipelines in Data Collector, you deploy the edge pipelines to SDC Edge installed on an edge device. You run the edge pipelines on SDC Edge.

You can use the following methods to deploy edge pipelines to SDC Edge:
  • Download the Data Collector Edge executable along with your designed edge pipelines.

    When you first get started with SDC Edge, the easiest way to deploy pipelines to SDC Edge is to use Data Collector to download the Data Collector Edge executable along with your designed edge pipelines. After SDC Edge is installed, you'll need to use either the publishing or exporting method to deploy new or updated pipelines to SDC Edge.

  • Publish edge pipelines directly to SDC Edge.

    Use this method when SDC Edge is running and is accessible by the Data Collector machine.

  • Export edge pipelines, and then move them to SDC Edge.

    Use this method when SDC Edge is not running or when it is not accessible by the Data Collector machine.

Publish Pipelines Directly

When SDC Edge is running and is accessible by the Data Collector machine, you can use the publish method to deploy edge pipelines to SDC Edge. You can publish a single pipeline or multiple pipelines at one time.

Note: Data Collector can also automatically publish edge pipelines to SDC Edge when you preview, validate, or start the edge pipeline from the Data Collector UI, as explained in Using the Data Collector UI.

Publishing a Single Pipeline

  1. Open the edge pipeline in the pipeline canvas.
  2. On the General tab, set the Data Collector Edge URL property to the URL of the SDC Edge instance that you want to deploy the pipeline to.
    The default URL is http://localhost:18633.
  3. In the top toolbar, click the Publish Pipeline to Data Collector Edge icon:
    Data Collector publishes the pipeline to the <SDCEdge_home>/data/pipelines directory on the edge device where SDC Edge is installed.

Publishing Multiple Pipelines

  1. On the General tab of each pipeline that you want to publish, set the Data Collector Edge URL property to the URL of the SDC Edge instance that you want to deploy the pipeline to.
    The default URL is http://localhost:18633.
  2. From the Data Collector Home page, select multiple pipelines from the list, click the More icon, and then click Publish Pipelines to Data Collector Edge.
    Data Collector publishes the pipelines to the <SDCEdge_home>/data/pipelines directory on the edge device where SDC Edge is installed.

Export Pipelines

If SDC Edge is not running or if it is not accessible by the Data Collector machine, you must use the export method to deploy edge pipelines to SDC Edge.

  1. Open the edge pipeline in the pipeline canvas.
  2. From the Properties panel, click the More icon () to view the pipeline configuration REST response data:

    The browser displays the pipeline configuration in JSON format.

  3. In the browser, copy the complete contents of the pipeline configuration and save it to a text file named pipeline.json.
  4. In the address bar of the browser, type ?get=info after the pipeline ID.
    For example:
    https://localhost:18630/rest/v1/pipeline/EdgeSending76d9d551-217d-4b44-8b03-8fbe444962c5?get=info

    The browser displays the pipeline information in JSON format.

  5. In the browser, copy the complete contents of the pipeline information and save it to a text file named info.json.
  6. On the edge device where SDC Edge is installed, create a folder named with the pipeline ID in the following directory:
    <SDCEdge_home>/data/pipelines
    For example:
    <SDCEdge_home>/data/pipelines/EdgeSending76d9d551-217d-4b44-8b03-8fbe444962c5
  7. Copy the pipeline.json and info.json files that you created for the pipeline into this folder.

    Now you can start and manage the pipeline on SDC Edge as described in Sending Commands to SDC Edge.

    If you modify the same pipeline in Data Collector, view the pipeline configuration REST response data and then copy the updated data into the existing pipeline.json in the SDC Edge installation. You do not need to update the info.json file after you originally create it in the pipeline folder.