Setting the API connectivity


This setting is only available if M3 Functions are installed.

The API connectivity is needed only if the MI feature is used, for example, to call an M3 API in a mapping.

  1. Select Windows > Preferences.
  2. Expand the view of Mapper and select M3 API Connectivity.
  3. Click New.
  4. Specify this information:

    Specify a descriptive name for this connection.


    Specify the host name or IP of the server where M3 Business Engine runs.


    Specify the M3 Business Server port number to connect to M3 Interface (MI) programs.

    Use the port number in the property boot.batchdispatcher.port which is located in M3 Properties file.

    If the port data is not valid, a message is displayed in the lower half of the page.


    Specify an M3 user name for the API communication.

    This user establishes the environment (M3 database), company and division, and other details for the API calls.


    Specify the M3 user password.

  5. Click OK to add the new connection in the Configured M3 API locations list.
  6. Optionally, select the new M3 API and click Test Connection to verify the connection to the M3 API.

    If the connection is successful, the M3 API Server version is shown. Otherwise, an error message is shown. Click OK to return to the M3 API Connectivity page.

  7. Optionally, select this M3 API and click Make Default.
  8. Click Apply to save the connection settings.
  9. Click OK.