Manage a Marketplace¶

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Marketplace owners are responsible for configuring and governing a marketplace so that data products are curated, compliant, and discoverable. This topic explains how to create and maintain a marketplace, set standards and badges, manage product listings, and assign roles to other users. It also explains how to set a default marketplace and take over ownership of a marketplace.

Create a New Marketplace¶

Define and Publish a Marketplace YAML Specification¶

Open a text editor and start a new file.

Use the specification provided in this swagger file to create the YAML file: Specification (navigate to the Schemas section and look for the Marketplace schema).

Send a POST request with the YAML file as the request body.

Confirm that the marketplace appears in the UI.

Here’s an example of a YAML file for a marketplace:

marketplace:
  contactEmail: [email protected]
  contactName: Allie
  dataProductRequirementsSchema: {}
  en:
    description: Sales datasets including ARR, new sales, renewals, and churn.
    name: Sales Data
    shortDescription: Sales data marketplace
    heroImage: https://qualified-production.s3.us-east-1.amazonaws.com/uploads/2Ca2L9pzrcXKAgCEexjCT3basD8AJBUmsGAo/89ad0e768282f8a08e764b84216708c7bcec6dc1be660a8dfa8558c8cec8656b.png
heroBackgroundColor: '#FFFFFF'
marketplaceId: sales_marketplace
badges:
  - check: The description of the product should describe where the data originated
    displayName:
      en: Origins
    key: product.description
    type: static
minimumStandard:
  - check: Product must have a contact email
    displayName:
      en: Has a contact email
    key: product.contactEmail
    type: static
  - check: Has declared a support response time SLA in the description
    displayName:
      en: Has a support SLA
    key: product.description
    type: static

Add Validation Conditions¶

To add validation conditions (standards and badges) to the spec, perfrom the following steps:

Open the marketplace YAML file.

Under marketplace, add the minimumStandard field.
Add one or more conditions using the format:
- key: "product.description"

type: static

check: "not null"

displayName:

   en: "Has a Description"
Optionally add badges: to include non-required certifications using the same format.

Save the updated YAML file.

Send a PUT request to /integration/data-products/v1/marketplace/ with the updated YAML.

YAML Field Reference¶

Each data product marketplace YAML file must include fields specified in the specification.

Field	Required	Description
`marketplaceId`	Yes	Unique ID for the marketplace
`contactEmail`	Yes	Email address for inquiries
`contactName`	Yes	Name of marketplace administrator
`en.name`	Yes	Display name
`en.description`	Yes	Long description of the marketplace
`en.shortDescription`	Yes	Short summary (max 200 characters)
`heroImage`	Yes	PNG or JPG image for branding
`heroBackgroundColor`	Yes	Hex color code for background
`minimumStandard`	Yes	Required conditions for product listing
`badges`	Yes	Optional badges for qualifying products

List a Product on a Marketplace¶

Submit the Product Using API¶

Ensure your product is created and has a productId and version.

Choose the target marketplace ID.

Use the endpoint /integration/data-products/v1/marketplace/{marketplace_id}/data-product/{product_id}/.

Include the version as a query parameter or let it default to the latest.

Send a POST request to publish the product.

Validate the Product¶

If your product fails validation:

Check that all required metadata fields are present.

Confirm that the schema section in each record set includes name, description, and type.

Review the error message in the response. It will list missing or invalid fields.

Make corrections to the YAML file.

Resubmit the file using the same API endpoint.

Monitor Marketplace Activity¶

To track how users are interacting with your marketplace, you can download a CSV file containing usage data.

Go to Data Product App > Manage Marketplace.

Go to the Activity & Insights section.

Click the download link to get a CSV file.

Open the file in a spreadsheet application to analyze usage.

The CSV may include data such as product views, access requests, or search terms with no results.

Assign Marketplace Roles¶

Use the UI to manage who can publish, maintain, or administer the marketplace.

Open the marketplace page.

Click the Permissions tab next to Activity & Insights.

Click Add to assign a new user or group.

Select the role from the dropdown list (Admin, Maintainer, Product Manager, Publisher, Viewer).

Click Save.

Only current marketplace admins can assign or remove roles for other users.

Edit a Marketplace¶

Update the marketplace’s visibility, title, description, short description, image, contact information, and auto-approval settings through the API

Open the current marketplace YAML file.

Make changes to any of the editable fields, such as en.name, en.description, en.shortDescription, heroImage, or contactEmail.

To change auto-approval behavior, edit the marketplace:manage_settings permissions or related flags if available.

Use the endpoint /integration/data-products/v1/marketplace/.

Send a PUT request with the updated YAML file as the request body.

Confirm the updates by refreshing the marketplace page.

To edit the marketplace via UI, perform the following steps:

Go to Data Product App > Manage Marketplace.

Click Edit Marketplace.

Click Edit YAML and make the required changes to the editable fields.

Click Save.

Delete a Marketplace¶

There is no option to delete a marketplace using the UI.

Note

Marketplace Admins can delete the marketplace. App-level admins can manage roles in marketplace and data products.

To delete a marketplace through the API:

Identify the marketplaceId of the marketplace you want to delete.

Use the endpoint /integration/data-products/v1/marketplace/{marketplace_id}/.

Send a DELETE request.

Confirm that the marketplace no longer appears in the UI.

Manage App Settings¶

Only Admins can change app settings and take ownership or transfer administrative control. You can add users to the Data Products App, change the privacy settings, or modify roles.

Confirm that you have the App Admin role for the Data Product Marketplace.

Open the Data Product App.

Select App Settings from the side navigation pane.

Perform the required changes to App privacy settings, roles, or to add users.