Authoring Exchange Elements

This guide is designed to show you how to author your own Exchange Elements for private use.

Note: This feature is currently available for Professional and Enterprise Businesses only.

Table of contents

Element Types

Downloadable Content

Businesses can provide downloaded content for consumption by other business users. Each element has the ability to reference a single downloadable file.

Solution Template

Solution templates are self-contained solutions that provide a starting point for a new solution.

To get started with creating a new solution template:

  1. Download the latest version: Getting Started Solution Template (ZIP).
  2. Create your own private GitHub repo and commit the above ZIP contents to this repo.
  3. Add a version tag to the repo git tag -a -m "Release Version 0.0.1" "0.0.1"
  4. Read more: Documentation for the Getting Started Solution Template

    • Application Solution

      When authoring an Application Solution template, Murano will also include a collection of out-of-the-box, default services for every solution template. The default services for an Application Solution are listed below.

      Default Application Services
    • Product Solution (coming soon)

      When authoring a Product Solution template, Murano will also include a collection of out-of-the-box, default services for every solution template. The default services for a Product Solution are listed below.

      Default Product Services

OpenAPI Integration Service

(coming soon)

Authoring a New Exchange Element (Professional & Enterprise Tiers Only)

To author a new Exchange Element, you will need to visit the Exchange Authoring form and fill out all fields accordingly.

  1. Go to the Authoring Form:

  2. Add a Unique Element Name:

  3. Choose Element Type:

    • NOTE: When a Solution Template type is chosen, a public GitHub repo URL is required.

  4. Short Description: Give a brief overview of the element. As you add your short description, the Live Preview card will be updated on the right.

  5. Thumbnail Image: The thumbnail will be used on the Element card, and once added to this form, the live preview will update accordingly. The thumbnail image must be fixed at 200x150 pixels.

  6. Background Color: Use the background color as a fallback in case your thumbnail does not fill the full area.

  7. Full Element Description: Provide as much content as necessary to fully detail what the element is and what it provides businesses that choose to use the element.

  8. Tech Specs: Use this area as a high-level bulletpoint explanation of the element.

  9. Contact: Provide the desired point-of-contact businesses can use if they need to contact the author of the element.

  10. Detail Image: This image is a larger image that will be displayed on the Element Details page when users click on the element card for more information.

  11. Attachment Upload: When authoring a content download element, use this Attachment Upload feature to include the content this element will supply. The element can only support a single attachment. If multiple files are required, a ZIP file can be uploaded instead.

  12. Preview [button]: This button will open a dialog modal that shows what the Element's details page will look like using the current form field values, color, and detail image.