Import plugin

In order for MTA to communicate with the Application under test, you need to import a module created by Menditect that will initiate this communication. This is the MTA Plugin module. To import and configure this module, read this page or watch this video.

caution

Don't make changes to elements inside the MtaPluginModule. Configure Constants in the Project settings in Studio Pro.
Menditect will not provide support if the MtaPluginModule is changed after you have imported it into your Mendix project.

Importing MTA Plugin

Import the MTA Plugin Add-on module into your Application from the Mendix Marketplace.

info

After importing, make sure to delete any old JAR files like mta-plugin-xxx.jar from the userlib subfolder in your project directory.
If you are experiencing compilation errors or errors in the After startup microflow, try cleaning up your deployment directory first.

Supported Versions

	MTA Plugin 9/10/11	MTA Plugin 4.8.1	Any older MTA Plugin
MTA 3.0	Supported	Partial support	Not supported
MTA 2.10	Supported	Supported	Not supported
MTA 2.9	Not supported	Not supported	Not supported

changed versioning

Because Menditect now hosts all Mendix Runtime versions (9, 10 and 11) in the same marketplace component, we have moved to a different versioning system. The major MTA Plugin version indicates the Mendix Runtime version. The remaining digits indicate the internal version of the MTA Plugin.

Updating from MTA Plugin 4.8.1

delete before replace

Delete the existing MTA Plugin from your Mendix project, delete MTA Plugin related JAR files from userlib, and delete the MTA Plugin directory from javasource in your project directory.

Upgrading Mendix

To upgrade the major version of your Mendix App (for example, from Mendix 9.24 to 10.12), you need to make sure to replace all the files related to the MTA Plugin Module. Delete the complete module from the project and delete the JAR files from the userlib subfolder in your project directory. Then, download the respective MTA plugin module from Github that matches the newer Mendix version as listed above. You can do all this before performing the upgrade.

Configuring MTA Plugin

After you have imported the Plugin into your Mendix App that you want to test with MTA, you can configure the Plugin to connect to MTA.

If you are working in a new MTA environment, make sure to first create MTA Manager and Tester accounts in MTA. After logging in as Tester in MTA, it is possible to register the Mendix App, which will trigger the creation of an Application Instance, that you need to configure the Plugin.

Including After startup microflow

• Open the App Settings window in Mendix Studio Pro.
• Navigate to the Runtime tab.
• On the "After startup" setting, click on 'Show' if there is an After startup microflow already selected.
• Make sure to include a Call Microflow action to the ASU_Setup_Connection_MTA microflow in the MtaPluginModule.
• Otherwise, just select the ASU_Setup_Connection_MTA in the popup window.

Configuring Connection user in MTA

MTA will create a Connection user when starting up for the first time.

In order to allow a Mendix App to connect to MTA, you need to set the password for this Connection user. There is only one Connection user per MTA node so the password is the same for all Mendix Apps that you want to test in MTA.

If you have already set the password previously for another App, use that password. Otherwise follow these steps.

• Login to MTA as MTA Manager.
• Navigate to MTA management, MTA Users.
• Edit the 'MTAConnectionUser' account.
• Set the password.
• Save the password in a password manager that you can share with your colleagues.

Setting Constants

To configure the MTA Plugin, there are 5 constants that you have to assign a value. If you are testing an app that is running locally, assign the values in the project configuration settings (Mendix docs: https://docs.mendix.com/refguide/configuration/#2-configuration-settings) but never inside the MtaPluginModule.

To find the values for any of these Constants, simply open the details of the Application Instance in MTA and click on a Copy button.

danger

Never set these constants on a Production environment!

ApplicationInstanceToken

This corresponds with an ID that MTA has generated for an Application Instance. You can set this constant after you have added an Application Instance in MTA.

ConnectionMethod

This will determine if your app will try to connect to MTA, either

• 'AfterStartup': After deployment the app will try to connect to MTA using the provided token and Connection User's credentials.
• 'Manual': You have to establish the connection to MTA manually, with the Plugin Home page in the app.
• 'None': This will disable the connection to MTA.

Any other value will result in an error message when attempting to establish the connection to MTA.

MTAConnectionUsername

This is the username that is set for the Connection user in MTA. The default value is 'MTAConnectionUser'.

MTAConnectionPassword

This is the password that is set for the Connection user in MTA in the previous step.

MTAConnectionUrl

This is the URL that the app will use to connect to MTA. The URL is setup as follows:

wss://{URL to MTA}

Example: wss://mta-mtatraining.mendixcloud.com

info

The constant NoAssociationResponse should not be modified. The feature is experimental, and not officially supported.

Configuring Plugin Home page

Including this page in your App is necessary if you want to manually connect to MTA (with ConnectionMethod = "Manual").

• Create a Page with a Responsive layout.
• Insert the "MTAPluginPage" snippet from the MTA Plugin Module.
• Add Project User Roles to the Page.
• Add the "MTAPluginUser" Module role from the MTA Plugin Module to all of these Project User Roles.
• Include the new Page in the Navigation.

You can now view connection details and manually connect to MTA, with accounts having the Project User Roles that you specified.

Feedback?

Missing anything? Let us know!

Last updated 30 June 2025