Cloud Blob Storage Delivery Method

The Cloud Blob Storage Delivery method for outbound integration endpoints makes it possible to deliver exported files to blob storage. Currently, Amazon S3 and Microsoft Azure are supported. This delivery method is available in OIEPs and Export Manager.

Note: The Cloud Blob Storage Delivery Method is similar to the Azure Blob Storage Delivery Method here. The differentiation between the setup and functionalities is that the Cloud Blob Storage Delivery plugin is part of the STEP baseline, can also be used for Amazon S3, and the Export Manager and OIEP configurations use the gateway integration endpoints versus having separate delivery method integration properties.

Prerequisites

A gateway integration endpoint must be set up before moving ahead with the Export Manager and OIEP setups.

  • For Amazon S3, directions for setting up this endpoint can be found in the Configuring a Gateway Integration Endpoint - Amazon S3 Blob Storage topic in the Gateway Integration Endpoints section of the Data Exchange documentation here.

  • For Microsoft Azure, directions for setting up this endpoint can be found in the Configuring a Gateway Integration Endpoint - Microsoft Azure Blob Storage topic in the Gateway Integration Endpoints section of the Data Exchange documentation here.

Also, buckets (S3) and containers (ABS) must created. If they do not exist in advance, you will get an exception during the delivery method.

Configuring the OIEP Delivery

For information on a parameter, hover over the parameter label to display help text.

  1. Click the Select Delivery Method parameter to display the dropdown and choose Cloud Blob Storage Delivery.

  2. Click the ellipsis button () to the right of the Cloud Blob Storage Provider value field. You will select a gateway endpoint and the name and ID of that endpoint will display.

  1. Configure the Azure Blob Storage file path template.

In addition to selecting the appropriate connection string and container, it is possible to make use of Azure Blob Storage virtual directories. Four variables are available:

  • $systemname – The STEP system name. Useful when several STEP systems are delivering to the same blob container.
  • $timestamp([YMDHMS Format]) – Delivery timestamp. Desired format to be supplied in Java SimpleDateFormat compatible format.
  • $filename – Name of the file produced by the export.
  • $extension – The extension of the file produced by the outbound integration endpoint.

If the virtual directories do not already exist, the plugin will create them. As mentioned in the Prerequisites section, buckets (S3) and containers (ABS) must exist in advance or you will get an exception during the delivery method.

Important: Existing files with the same virtual directory path and file name will be overwritten.

  1. On the Edit Delivery Configuration dialog, click the OK button to save the delivery method.