Uploading to the Marketplace

Introduction

The Mendix Marketplace is driven by contributions from community members who share the connectors, modules, and apps they have built with the Mendix Platform.

Prerequisites

Before starting this how-to, make sure you have completed the following prerequisites:

• Familiarize yourself with Marketplace Overview and Using Marketplace Content.

Adding New Marketplace Content

To get started, click Add Content in the left pane of the Marketplace home screen. Follow the steps in these sections to add content.

General

Provide key details about your component on the General page.

Describing Your Content

Follow these steps to describe your content:

1. Select a Content Type for your component.

   You can only set the content type when creating the initial version of your content. You cannot change this setting after it is published.

2. Select the Visibility of your component:

   • Public Marketplace (all Mendix users) – Your component will be available to the entire Mendix community.
     • This content must be reviewed and approved by Mendix before it is available.
   • Private Marketplace (your company only) – Your content will receive the Private label, and be available only via your Company Content page.
     • Selected private content of a content group can also be made available to content group guests for download.
     • This content is not reviewed by Mendix.
       You can only set the visibility in the initial version of your content. You cannot change this setting by updating the Marketplace component later.

3. Add between one and three categories in the Category field. A category groups together similar components or services that share common characteristics, functions, or purposes. Categories make it easier for Marketplace users to find what they are looking for.

4. Enter a Name for your component.

5. Enter a Description of your component.

   You can use rich text in the editor. However, using rich text at the beginning of the description is not recommended, as it will not get rendered properly. You should add a few lines of regular text before using rich text.

Providing License Details

Select the type of License you want applied to your app.

Open-Source Software Licenses

These are the open-source software license options available and their requirements:

Proprietary Licenses

You can configure your own proprietary license for your company’s content. The license can be applied to multiple components, and it can be used by everyone within your organization.

This license can be created for a new Public Marketplace (all Mendix users) component by requesting a new license and submitting it alongside the component. The license needs to be approved by Mendix after you have created and submitted it the first time. Once it has been submitted for approval, you and the people within your organization can also use it for other components.

Follow these steps to configure a proprietary license for a new public component:

1. Click Request New License.
2. Add a License Name, which will be displayed on the component details page.
3. Add a License URL, which should lead the user to a web page that lists the terms and conditions for using the component. Users can navigate to this web page by clicking the license name on the component details page.
4. Add a Reason for the new license. This is solely for Mendix review purposes, and will not be displayed on the component details page.

Generating New Leads

A lead is a potential sales contact that expresses interest in your product or service. Lead routing is the end-to-end process of collecting the leads and distributing them to you. It is possible to configure lead routing for the following content types in the Marketplace:

• Solutions
• Industry templates

When prospective customers are interested in your product, they can leave their contact information using the Marketplace product listing. This is done by clicking a call-to-action button and filling in a form.

You can use one of these options as the name of your Main call-to-action button:

• Contact Us, Notify Me, and Request Demo – Requires the email address that will receive the customer information.

  If you choose to add one of these buttons, customers can contact you directly. If you start talking with the customer, it is your responsibility to provide access to the product for them. Mendix is not involved in such customer interactions.

• Download – No lead routing is established, but customers can directly download your product.

In the How would you like to receive information on new leads? field, you must specify the email address or addresses where notifications and information can be sent.

Adding an Icon

To finish the configuration on the General page, click Upload Image to upload a cover image for your component.

Package

1. Select one of the options for uploading the source file:

• Manual upload – Follow the steps in the dialog box for uploading the package source file.
  When you are finished, click Save.
• GitHub URL – Follow the steps in the dialog box for copying the link of the release you want to import. For details, see the Using a GitHub Repo section in Guidelines for Content Creators.
  To include the repo’s README.md file on the component’s Documentation tab, make sure you have selected the Import Documentation box.
  When you are finished, click OK.

2. Select the Studio Pro Version on which you built the content.

3. Add a version for your component. If this is the first version of the component you are uploading, the number in the Version section will be automatically set to 1.0.0.

4. Enter Release Notes for the component in the box provided describing what is new in that release.

Enable

On the Enable page, in the Documentation section, you can enter details on requirements and configuration for your component.

1. Follow the template for the recommended content:

• You must fill out the following sections in order to submit your component:
  • The Typical usage scenario for the component
  • The Features and limitations of the component
• These sections are optional:
  • Any Dependencies (for example, the required Studio Pro version, modules, images, and styles)
  • The Installation steps and details
  • The Configuration steps and details
  • Any Known bugs
  • Any Frequently Asked Questions

The editor comes with a set of basic formatting tools, such as bold, bullet lists, and URL links.

2. Click Upload Screenshot to upload images of the component from your computer. This is required for submitting a new component, and is especially important for configuration steps:

3. (Optional) Add a YouTube URL and a Demo URL.

Publish

Finally, on the Publish page, you can review all the details you entered so far, and edit them if necessary before publishing.

After you click Publish Content, your draft will be reviewed by Mendix before it is visible in the Marketplace.

For details on the approval process, see Governance Process.

Updating Existing Marketplace Content

After you publish a component in the Mendix Marketplace, it is your responsibility to make sure that the component is updated on a regular cadence. This is important to ensure compatibility with the latest versions of dependencies, especially Mendix Studio Pro. It is also required so Mendix can ensure the quality of components in the Marketplace.

This means you need to monitor, maintain, and evolve the component, thus making sure that the Marketplace listing is more noticeable, that you can build user loyalty, and that you can maintain the good reputation of your company.

If the component is not updated regularly, the Marketplace listing will be analyzed for removal from public visibility.

Mendix expects the following updates for components in the Platform, Community, and Premium support categories:

• Bug fixes
• New features
• Feature removal
• Compatibility updates with the latest Studio Pro version and other dependencies

To update content that has already been published, follow these steps:

1. Find the component in one of the following sections:

   • My Content
   • Company Content
   • Content Group
     If an existing Marketplace component is assigned to a content group as specific content group content, you can only update the component if you are a member of that group.

2. Click the menu item next to the component you want to update and select Manage Draft.

   Only one draft version of a component can exist at a time, so when one draft version is in progress, another draft cannot be started. If there is a draft version in progress, click Edit Draft on the page where you manage the component in order to see the draft.

3. You can edit all component details, as described in the Adding New Marketplace Content section above.

4. In the Version section of the Package page, update the Major, Minor, and Patch numbers so that the component is saved as a new version:

   • Major update – changes that break compatibility with earlier versions.
   • Minor update – new features that do not break existing usage.
   • Patch – a small change that fixes bugs or security issues.

5. On the Publish page, you can review all the details of your component entered so far and edit as necessary using the Edit button in each section before clicking Publish Content.