Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8a5f264
Create extensions.md
Mar 6, 2024
19f6805
Update extensions.md
Mar 6, 2024
3e64c2f
Create extensions folder
Mar 6, 2024
e670e6f
added images for extensions documentation
Mar 6, 2024
a5f116f
Delete static/attachments/refguide/extensions/temp.md
Mar 6, 2024
67125d3
Update extensions.md
Mar 6, 2024
fac3918
Move to the Marketplace and review
MariaShaposhnikova Mar 15, 2024
38894a7
add extensions as a category
Luyao-Zhang-1 Mar 15, 2024
a333a95
re-numbering
Luyao-Zhang-1 Mar 15, 2024
cf44e3f
remove "connector" as it's not a content type anymore
Luyao-Zhang-1 Mar 18, 2024
131230a
add info of extensions to modules index page
Luyao-Zhang-1 Apr 12, 2024
371224a
add an anchor to the note
Luyao-Zhang-1 Apr 12, 2024
4ca897e
restructure the section
Luyao-Zhang-1 Apr 12, 2024
76a7131
markdown styling
Luyao-Zhang-1 Apr 12, 2024
e4f8785
style
Luyao-Zhang-1 Apr 12, 2024
1f6aec6
Merge branch 'development' into patch-13
Luyao-Zhang-1 Apr 12, 2024
985045d
correct numbering
Luyao-Zhang-1 Apr 12, 2024
45d5806
Uppercase
Luyao-Zhang-1 Apr 12, 2024
61ba7f7
remove the broken link
Luyao-Zhang-1 Apr 12, 2024
eb4aaf3
move anchor to introduction
Luyao-Zhang-1 Apr 12, 2024
d20dd28
remove extensions from Studio Pro lower versions
Luyao-Zhang-1 Apr 12, 2024
f33de11
Update content/en/docs/appstore/overview/use-content.md
Luyao-Zhang-1 Apr 12, 2024
9585d12
Update use-content.md
Luyao-Zhang-1 Apr 12, 2024
b23e4f8
Merge branch 'patch-13' of https://github.com/mauritselzinga-mx/docs …
Luyao-Zhang-1 Apr 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The [Catalog](/catalog/) is a hub for shared registered assets made available in

### 2.2 Getting Mendix Connectors

Many existing Mendix [Connectors](/appstore/modules/#connectors) can be downloaded from the [Mendix Marketplace](https://marketplace.mendix.com/) directly into your app. Depending on your use case, your company's private Mendix Marketplace could also have a variety of Mendix connector modules available. For more information on the distinction between public and private Marketplace content, see the [Adding New Marketplace Content](/appstore/sharing-content/#adding) section of *Share Marketplace Content*.
Many existing Mendix Connectors can be downloaded from the [Mendix Marketplace](https://marketplace.mendix.com/) directly into your app. Depending on your use case, your company's private Mendix Marketplace could also have a variety of Mendix connector modules available. For more information on the distinction between public and private Marketplace content, see the [Adding New Marketplace Content](/appstore/sharing-content/#adding) section of *Share Marketplace Content*.

Because connectors expose data via custom microflow activities, you can find them in the Studio Pro [Toolbox](/refguide/view-menu/#toolbox) to implement when building your application logic. Then, you can drag them to where you want to use the connector functionality.

Expand Down
159 changes: 6 additions & 153 deletions content/en/docs/appstore/modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,165 +3,18 @@ title: "Modules"
url: /appstore/modules/
description: "Presents details on the modules available in the Mendix Marketplace."
weight: 5
no_list: true
no_list: false
tags: ["marketplace", "marketplace component", "module"]
---

## 1 Introduction
## 1 Introduction {#introduction}

The modules available in the Mendix Marketplace can be added to your app to provide new functionality with accompanying domain models and security options. These Marketplace modules function similarly to the [modules](/refguide/modules/) you create for your app.

When you download these modules, they will go into the **App** > **Marketplace modules** folder.

## 2 Categories

Modules in the Mendix Marketplace have different categories, as listed in the sub-sections below. Some modules may belong to more than one category.

To check out which modules a category contains, click the category in the list below, which directs you to the sub-section for this category.

* [Artificial Intelligence](#artificial-intelligence)
* [Authentication](#authentication)
* [AWS](#aws)
* [Communication](#communication)
* [Connectors](#connectors)
* [Data](#data)
* [Import/Export](#import-export)
* [Internet-of-Things](#internet-of-things)
* [Mobile](#mobile)
* [SAP Connector](#sap-connector)
* [Scheduling](#scheduling)
* [Tracing](#tracing)
* [User Interface](#user-interface)
* [Utility](#utility)
* [Visualization](#visualization)

### 2.1 Artificial Intelligence {#artificial-intelligence}

* [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/)
* [OpenAI Connector](/appstore/modules/openai-connector/)

### 2.2 Authentication {#authentication}

* [AWS Authentication](/appstore/modules/aws/aws-authentication/)
* [Deep Link ⚠](/appstore/modules/deep-link/)
* [Forgot Password](/appstore/modules/forgot-password/)
* [LDAP](/appstore/modules/ldap/)
* [Mendix SSO](/appstore/modules/mendix-sso/)
* [OpenID Connect (OIDC) SSO](https://marketplace.mendix.com/link/component/120371)
* [SAML](/appstore/modules/saml/)

### 2.3 AWS {#aws}

* [AWS Authentication](/appstore/modules/aws/aws-authentication/)
* [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/)
* [Amazon DynamoDB](/appstore/modules/aws/amazon-dynamodb/)
* [Amazon EventBridge](/appstore/modules/aws/amazon-eventbridge/)
* [Amazon Polly](/appstore/modules/aws/amazon-polly/)
* [Create a Database with Amazon RDS and the Mendix Database Connector](/appstore/modules/aws/amazon-rds-database-connector/)
* [Amazon Rekognition](/appstore/modules/aws/amazon-rekognition/)
* [Amazon S3](/appstore/modules/aws/amazon-s3/)
* [Add Machine Learning Capabilities to Your App with Amazon SageMaker](/appstore/modules/aws/amazon-sagemaker-machine-learning/)
* [Send Emails with Amazon SES and Mendix Email Connector](/appstore/modules/aws/amazon-ses-email-connector/)
* [Amazon SNS](/appstore/modules/aws/amazon-sns/)
* [Amazon Textract](/appstore/modules/aws/amazon-textract/)
* [Amazon Translate](/appstore/modules/aws/amazon-translate/)
* [AWS IoT SiteWise](/appstore/modules/aws/aws-iot-sitewise/)
* [AWS IoT TwinMaker](/appstore/modules/aws/aws-iot-twinmaker/)
* [AWS Lambda](/appstore/modules/aws/aws-lambda-connector/)
* [Build an AWS Connector](/appstore/modules/aws/build-aws-connector/)
* [Amazon SQS](/appstore/modules/aws/amazon-sqs/)

### 2.4 Communication {#communication}

* [Data Widgets](/appstore/modules/data-widgets/)
* [Data Grid 2](/appstore/modules/data-grid-2/)
* [Gallery](/appstore/modules/gallery/)
* [Tree Node](/appstore/modules/tree-node/)
* [Mendix Feedback](/appstore/modules/mendix-feedback/)
* [Push Notifications Connector](/appstore/modules/push-notifications/)

### 2.5 Connectors {#connectors}

* [Amazon Bedrock](/appstore/modules/aws/amazon-bedrock/)
* [AWS Authentication](/appstore/modules/aws/aws-authentication/)
* [AWS IoT SiteWise](/appstore/modules/aws/aws-iot-sitewise/)
* [Data Importer](/appstore/modules/data-importer/)
* [Email Connector](/appstore/modules/email-connector/)
* [OData Connector for SAP Solutions](/appstore/modules/sap/sap-odata-connector/)
* [OpenAI Connector](/appstore/modules/openai-connector/)
* [XSUAA Connector for SAP Business Technology Platform](/appstore/modules/sap/sap-xsuaa-connector/)

### 2.6 Data {#data}

* [Data Importer](/appstore/modules/data-importer/)
* [Database Connector](/appstore/modules/database-connector/)
* [Mendix Feedback](/appstore/modules/mendix-feedback/)
* [Mendix Mini Surveys](/appstore/modules/mendix-mini-surveys/)
{{% alert color="info" %}}Extensions are a special type of modules that allows you to add new functionality to your development environment in Studio Pro. Extensions are part of your application, and therefore will become available to all members of your app who are developing it. Extensions come as part of [add-on modules](/refguide/consume-add-on-modules-and-solutions/). This means you can download them directly from the Marketplace.</br>Currently, extensions can only be created by Mendix Partners and are available from Studio Pro versions [10.6.3](/releasenotes/studio-pro/10.6/#1063) and above.
{{% /alert %}}

### 2.7 Import/Export {#import-export}

* [Data Importer](/appstore/modules/data-importer/)
* [Database Replication](/appstore/modules/database-replication/)
* [Excel Exporter](/appstore/modules/excel-exporter/)
* [Excel Importer](/appstore/modules/excel-importer/)
* [PDF Document Generation](/appstore/modules/document-generation/)
* [User Migration](/appstore/modules/user-migration-module/)

### 2.8 Internet-of-Things {#internet-of-things}

* [MQTT Connector](/appstore/modules/mqtt/)
* [AWS IoT SiteWise](/appstore/modules/aws/aws-iot-sitewise/)

### 2.9 Mobile {#mobile}

* [Hybrid Mobile Actions ⚠](/appstore/modules/hybrid-mobile-actions/)
* [Nanoflow Commons](/appstore/modules/nanoflow-commons/)
* [Native Mobile AR](/appstore/modules/native-mobile-ar/)
* [Native Mobile Resources](/appstore/modules/native-mobile-resources/)

### 2.10 SAP Connector {#sap-connector}

* [BAPI Connector for SAP Solutions](/appstore/modules/sap/sap-bapi-connector/)
* [OData Connector for SAP Solutions](/appstore/modules/sap/sap-odata-connector/)
* [SAP Event Mesh Connector](/appstore/modules/sap/sap-event-mesh-connector/)
* [SAP Logging Connector](/appstore/modules/sap/sap-logger/)
* [XSUAA Connector for SAP Business Technology Platform](/appstore/modules/sap/sap-xsuaa-connector/)

### 2.11 Scheduling {#scheduling}

* [Process Queue ⚠](/appstore/modules/process-queue/)
* [Workflow Commons](/appstore/modules/workflow-commons/)

### 2.12 Tracing {#tracing}

* [Audit Trail](/appstore/modules/audit-trail/)
* [Advanced Audit Trail](/appstore/modules/advanced-audit-trail/)
* [Unit Testing](/appstore/modules/unit-testing/)

### 2.13 User Interface {#user-interface}

* [Atlas Core](/appstore/modules/atlas-core/)
* [Atlas UI Resources ⚠](/appstore/modules/atlas-ui-resources/)
* [Google Tag](/appstore/modules/google-tag/)
* [Image Crop](/appstore/modules/image-crop/)
* [Mendix Mini Surveys](/appstore/modules/mendix-mini-surveys/)
* [SAP Fiori UI Resources](/appstore/modules/sap-ui-resources/sap-fiori-3-0/)
* [SAP Horizon Native UI Resources](/appstore/modules/sap-ui-resources/sap-native-resources/)

### 2.14 Utility {#utility}

* [Administration](/appstore/modules/administration/)
* [App Switcher](/appstore/modules/app-switcher/)
* [Community Commons](/appstore/modules/community-commons-function-library/)
* [Encryption](/appstore/modules/encryption/)
* [Mendix Feedback](/appstore/modules/mendix-feedback/)
* [Mendix Mini Surveys](/appstore/modules/mendix-mini-surveys/)
* [Mx Model Reflection](/appstore/modules/model-reflection/)
* [Object Handling](/appstore/modules/object-handling/)
* [PDF Document Generation](/appstore/modules/document-generation/)
* [Web Actions](/appstore/modules/web-actions/)
When you download these modules, they will go into the **App** > **Marketplace modules** folder.

### 2.15 Visualisation {#visualization}
## 2 Documents in This Category

* [Any Chart](/appstore/modules/any-chart/)
* [Native Mobile AR](/appstore/modules/native-mobile-ar/)
80 changes: 63 additions & 17 deletions content/en/docs/appstore/overview/use-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This how-to covers the basics of accessing the Marketplace from Studio Pro and p
This how-to teaches you how to do the following:

* Download content from the Marketplace via Studio Pro
* Use content (for example, widgets, modules, and connectors) downloaded from the Marketplace in Studio Pro
* Use content (for example, modules) downloaded from the Marketplace in Studio Pro

{{% alert color="warning" %}}
If you are using Studio Pro on a Mac with Parallels, see [this update](https://kb.parallels.com/112091#section7) for improving the loading time of Marketplace in Studio Pro.
Expand All @@ -38,7 +38,9 @@ There are three ways to install a Marketplace component, which are described in
To download content in Studio Pro [9.19](/releasenotes/studio-pro/9.19/) and above, follow these steps:

1. Open Studio Pro and sign in with your Mendix credentials.

2. Open the app in which you want to install the component from the Marketplace.

3. To open the Marketplace in Studio Pro, you can either click the **View** menu in the top bar and select **Marketplace**, or you can click the Marketplace icon on the right side of the top bar

{{< figure src="/attachments/appstore/overview/use-content/toolbar.png" alt="Marketplace icon" >}}
Expand All @@ -59,19 +61,58 @@ To download content in Studio Pro [9.19](/releasenotes/studio-pro/9.19/) and abo

The details presented here correspond to what you see on the [component details page](/appstore/overview/#details) in the online Mendix Marketplace.

6. <a id="step-six"></a>Click **Download** to download the component. The correct version of the component that is compatible with your Studio Pro version is integrated directly into your application (for widgets, version compatibility is not applicable). By default, the highest correct version of the component is downloaded. If you want to download an older component version, go to the **Releases** tab and click **Download** for the desired version.
* If you download a widget, a pop-up window states the module was successfully imported; click **OK**, and you can find the imported widget in the **Toolbox**
* If you download a module or a connector, the **Import Module** dialog box opens, where you should perform the following steps:
1. Select one of these options:
* **Add as a new module** (default option when the module is downloaded to your app for the first time ) – if you select this option, new entities and attributes are created in your app
* **Replace existing module** (default option when the module already exists in your app) – if you select this option, you need to specify which **Module to replace**
{{% alert color="warning" %}}If you have made any changes to the existing module, selecting the **Replace existing module** option will replace all the changes that you made (for example, your renamed entities, attributes, and associations as well as their respective tables and columns represented in the database will all be replaced). Your user data will stay if you have not changed entities, attributes, or associations. If you have changed data types, your user data can be influenced as well. For more information, see [Attribute Type Migration](/refguide/attributes-type-migration/).{{% /alert %}}
2. Click **Import**.
3. Wait until a pop-up window states that the module was successfully imported. Click **OK**. You can find the imported module or connector in the **App Explorer**.
* If you download an app, the **Download Marketplace App** dialog box opens, where you should perform the following steps:
1. Select where the app should be stored: **New Mendix Team Server**, **Existing Mendix Team Server**, or **Locally on disk**.
2. Configure the necessary settings based on your storage choice.
3. Click **OK**. After the app is downloaded, it opens automatically in Studio Pro.
6. Click **Download** to download the component. The correct version of the component that is compatible with your Studio Pro version is integrated directly into your application (for widgets, version compatibility is not applicable). By default, the highest correct version of the component is downloaded. If you want to download an older component version, go to the **Releases** tab and click **Download** for the desired version.

7. Depending on whether the component is a widget, a module, an [extension](/appstore/modules/#introduction), (which is a special type of module), or an app, go to one of the sections below:

* [Widgets](#widgets)
* [Modules](#modules)
* [Extensions](#extensions)
* [Apps](#apps)

##### 2.1.1.1 Widgets {#widgets}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we could get rid of one level of heading by having

2.1 Finding and Download Content in Studio Pro 9.19 and above

2.2 Finding and Downloading Content in Studio Pro 9.18 and below

Not worth doing now, but perhaps we can look at the structure as this seems to be a very long section number for something which is actually quite simple!

Or perhaps we can do something without section numbers?

Not sure exactly - but something to look at later?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. We can take a look at this later.


If you download a widget, a pop-up window states the module was successfully imported. Click **OK**, and you can find the imported widget in the **Toolbox**.

##### 2.1.1.2 Modules {#modules}

If you download a module, the **Import Module** dialog box opens, where you should perform the following steps:

1. Select one of these options:

* **Add as a new module** (default option when the module is downloaded to your app for the first time ) – if you select this option, new entities and attributes are created in your app.

* **Replace existing module** (default option when the module already exists in your app) – if you select this option, you need to specify which **Module to replace**

{{% alert color="warning" %}}If you have made any changes to the existing module, selecting the **Replace existing module** option will replace all the changes that you made (for example, your renamed entities, attributes, and associations as well as their respective tables and columns represented in the database will all be replaced). Your user data will stay if you have not changed entities, attributes, or associations. If you have changed data types, your user data can be influenced as well. For more information, see [Attribute Type Migration](/refguide/attributes-type-migration/).{{% /alert %}}

2. Click **Import**.

3. Wait until a pop-up window states that the module was successfully imported. Click **OK**. You can find the imported module in the **App Explorer**.

##### 2.1.1.3 Extensions {#extensions}

If you download an [extension](/appstore/modules/#introduction), a warning dialog box opens.

* If you trust the extension, click **Trust module and enable extension**.

* If you decide to not trust the extension, you will get asked whether or not to trust the extension every time you reload the application.

Click **OK** in the confirmation pop-up window. Your extension is now installed and is ready to use. Depending on the extension that you have installed, the functionality appears in a certain location of your app. Read the extension-specific documentation to get more information on how to use it.

If you do not want to trust the extension and would prefer to remove the extension altogether, you can remove the add-on module that was added.

{{< figure src="/attachments/appstore/overview/use-content/trust-extension.png" class="image-border" alt="trust extension" >}}

##### 2.1.1.4 Apps {#apps}

If you download an app, the **Download Marketplace App** dialog box opens, where you should perform the following steps:

1. Select where the app should be stored: **New Mendix Team Server**, **Existing Mendix Team Server**, or **Locally on disk**.
2. Configure the necessary settings based on your storage choice.
3. Click **OK**.

After the app is downloaded, it opens automatically in Studio Pro.

#### 2.1.2 For Studio Pro 9.18 and Below

Expand All @@ -82,7 +123,12 @@ To download content in Studio Pro [9.18](/releasenotes/studio-pro/9.18/) and bel
3. Click the Marketplace icon in the top menu bar to open it in Studio Pro. The Marketplace opens within Studio Pro. The **Categories** menu item on the left side gives an overview of which types of content are available.
4. Use the **Search** bar to find the component that you want to download. Note that results for Marketplace content searches within Studio Pro may differ from those in the online [Marketplace](/appstore/overview/) due to synchronization issue.
5. Click the component (or the **Read more** button on the right side) to show the details of the component.
6. Continue from [step 6](#step-six) above.
6. Click **Download** to download the component. The correct version of the component that is compatible with your Studio Pro version is integrated directly into your application (for widgets, version compatibility is not applicable). By default, the highest correct version of the component is downloaded. If you want to download an older component version, go to the **Releases** tab and click **Download** for the desired version.
7. Depending on whether the component is a widget, a module, or an app, go to one of the sections above:

* [Widgets](#widgets)
* [Modules](#modules)
* [Apps](#apps)

### 2.2 Importing Content from Studio Pro's App Explorer {#import}

Expand Down Expand Up @@ -110,7 +156,7 @@ To import content downloaded from the online Mendix Marketplace into Studio Pro,
7. Click **Import**.
8. Wait until a pop-up window states that the module was successfully imported. Click **OK**.

You can find the imported module or connector in the **App Explorer**.
You can find the imported module in the **App Explorer**.

### 2.3 Manually Adding Content into App Directory {#add}

Expand Down Expand Up @@ -231,7 +277,7 @@ Each module that you download from the Marketplace is different. Some modules ca

Keep in mind that some modules you can download may come with their own user roles. If the **Security level** of your app is set to **Prototype/demo** or **Production**, you need to map the module roles to the applicable user roles in your app.

### 3.3 Using a Starter App
### 3.4 Using a Starter App

Downloading a starter app (via **Create New App**) creates a new app structure in the storage location that you select. After you click **Download**, a window will appear where you can specify how the app should be created.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.