paper-planeSubmit Component

Submit a component to the Partner Library.

As a registered partner, you can submit new components directly from the Partner Library. The component submission is a clearly defined workflow process that includes metadata entry, file uploads, or category assignment. All the components submitted by Emporix partners undergo a diligent review process from the Emporix side to ensure the appropriate level of quality and security. The partners can easily track the status of the component submission, from draft, through review, to publish stages.

Prerequisites

Take into account these rules and good practices for the components submission.

  • Attachments validation rules

    Emporix supports attachments that are compatible with the Emporix platform to allow proper rendering and functioning after installation on customers' tenants.

    • AI agents, value streams, or custom entities in question need to be first exported directly from the Emporix Management Dashboard using the export functionality.

    • MD extensions and MD perspectives must follow the MD extension templatearrow-up-right. For more information, see the Enabling Custom Extensions guide.

  • Components IDs naming convention

    The IDs of the AI agents and custom entities that you attach during component submission must start with your company name prefix, like <partner-name>-agentName.

    For example, partnerrix-overstock-agent, partnerrix-contractEntity.

    This convention ensures that there are no clashing IDs and the attachments are properly assigned. So, before exporting the necessary subcomponents, make sure that their IDs follow the convention pattern.

  • Custom entities single import

    If the component you intend to submit uses a custom entity, inlude it in the attachments. If more than one custom entity is required and one references another, first export all the relevant custom entities in one go to a single JSON file and then import it as a single attachment to avoid entities duplication and IDs collission. For more information, see the Custom Entities.

Add a component

To submit a new component to the Partner Library, follow these steps.

1

Choose to add a component

In the Partner Library, go to the My Components view and choose Create a new component option.

2

Provide the component details

Fill in the form with the general details of the component you intend to submit, including basic information about its purpose, use cases, categories, icons, and billing costs. All details you provide in the form are visible on the component details page so customers can make informed purchase decisions.

Submit component - general information
Submit component - general information
3

Attach the component

Choose the relevant component category:

  • AI Agent

  • Value Stream

  • Cloud Function

  • MD Extension

  • MD Perspective

  • Custom Entity (applicable if your component requires usage of a custom entity)

From your device directory, select the file containing the matching component and drag it to the upload space. The upload starts automatically.

For complex components, attach multiple files for each separate component in the package. Choose the + to add more files and associate them with relevant categories.

circle-info

If you use an AI agent within a value stream, you do not need to attach the agent separately. The agent is already a part of the JSON file defining the value stream.

Supported file types:

  • AI agents, value streams, and custom entities - attach valid JSON files.

  • Cloud functions, MD extensions and MD perspectives - attach ZIP files.

Submit component - select component type
Submit component - select component type
Submit component - attach file
Submit component - attach file
4

Describe features and benefits

Provide the component key features and benefits it brings to the customer. Enter these one by one by adding +.

Submit component - describe features and benefits
Submit component - describe features and benefits
5

Define regional settings

Select the supported regions and languages for your component.

Submit component - define regional settings
Submit component - define regional settings
6

Submit component

Your agreement to accept terms and conditions is required to submit a component. When you fill in all the details, choose the Submit component option. As a result, the component is visible in the My components listing with the In progress status. This means that the component is in the draft mode and is not yet reviewed nor published. You are able to apply changes and edit the component details at this stage.

Submit component - draft
Submit component - draft state
7

Request review

When you are happy with the component shape and descriptions, submit it to Emporix for technical and quality review.

Submit component - request review
Submit component - request review

The status changes to Pending for the time Emporix team reviews all the details.

Submit component - pending status
Submit component - pending status
circle-info

You get email confirmation when Emporix starts the review process and subsequent email notifications about the review outcomes.

8

Apply review amendments and publish

If required, correct any inconsistencies spotted by Emporix during the review and submit again.

Submit component - rejection message
Submit component - rejection message
Submit component - rejected status
Submit component - rejected status

When you're done with the relevant edits and Emporix approves your component, it is published and activated in the Partner Library.

Submit component - published status
Submit component - published status

As a result, the component is available in the Component Overview for all customers to be requested and purchased.

Last updated

Was this helpful?