Creating a custom delivery method

An administrator can create custom delivery methods where the delivery of the data product is managed outside of Data Product Hub. Upon a successful subscription, the consumer is provided the information required to access the data.

Creating a custom delivery method

Required roles:
Data Product Hub community role: Administrator can enable or disable internal or external delivery methods and create a custom delivery method

To create a new delivery method:

  1. Go to Configuration and settings > Delivery.

  2. Select New delivery method.

  3. Edit the following sections:

    1. Information (required):
      1. Name
      2. Description
      3. Resource key (auto-generated)
      4. Language
    2. Localization: Edit and add languages using the details provided in the Information tab.
    3. Configuration:
      1. Type of method: External (default)
      2. Approval settings
      3. Select supported asset types
      4. Select supported data sources
    4. Provider input: Add properties that a data provider must provide while creating a data product with this delivery method. The supported types are:
      1. String: A data provider can include information about this delivery method.
      2. URL: A data provider can provide the URL to a page that explains the external process that delivers the data product to the consumer.
    5. Subscription input: Add properties that a consumer must respond to when they are subscribing to the data product. Here are a few examples on how you can use each property:
      1. Date range: Ask a consumer how long they would use the data product for or validity.
      2. Column: Ask a consumer to select all or a subset of the columns they would like to view.
      3. String: Ask a consumer for their project ID, username, or other qualifications that will be displayed in the subscription screen.

    This information will be available in the subscription details page.

  4. Click Save.

Completing subscription details

For custom delivery methods, the delivery of the data product is handled outside of Data Product Hub. When you are creating a new data product and you want to use a custom delivery method, ensure that the toggle for the delivery methods is on for the asset.

Public data products: Assets using custom delivery methods are automatically marked as Delivered. The data provider is responsible for delivering the data to the consumer outside of the Data Product Hub, as well as providing any required connection details and/or access credentials (for example, via email).

Required roles:
Data Product Hub community role: Editor can complete the subscription after the data product is delivered.

Subscription delivery APIs

List of APIs to complete the delivery of a subscription:

  • Get subscription

    GET /v2/asset_lists/{subscription_id}
GET /v2/asset_lists/{subscription_id}/items
GET /v2/asset_lists/{subscription_id}/items/{item_id}

  • Complete data asset delivery

    PATCH /data_product_exchange/v1/subscriptions/{subscription_id}/items/{item_id}
Payload (example) 
[
{
"op": "replace",
"path": "/data_product_delivery_state",
"value": "delivered"
}
]

  • Update subscription output properties

    PATCH /data_product_exchange/v1/subscriptions/{subscription_id}/items/{item_id}

Payload (example) 
[
{
"op": "replace",
"path": "/output",
"value": {        
"hostUrl": {
"name": "Host URL",
"type": "string",
"value": "https://dsta.cloud.unity.com"
    },
"port": {
"name": "Port",
"type": "string",
"value": "443"
    },
"credentialInfo": {
"name": "Credential Info",
"type": "string",
"value": "Will be emailed to you"
    }               
    }
}
]