Skip to main content
Skip table of contents

How To Complete a Single Instance Cantara Installation

This guide provides step-by-step instructions for completing the installation and configuration of a single instance of a Cantara installation using an Apache Tomcat server and Oracle MySQL.

A Cantara installation includes the following steps:

  1. Deploy the Cantara JDE Objects to your Oracle JD Edwards EnterpriseOne instance.

  2. Ensure that your JDE Enterprise Server has the appropriate configuration settings in the JDE.INI
  3. Install and configure Apache Tomcat 8.0.

  4. Set up the necessary folders and permissions.

  5. Install the required database components (Enterprise Edition only)
  6. Deploy the Cantara Access Server.

  7. Deploy the Cantara Administration Console.

  8. Configure the Cantara Administration Console.

  9. Define the access server.

  10. Define a JDE environment.

  11. Create a new function service.

Deploying the Cantara JDE Objects to Your JD Edwards Server

To deploy the Cantara JDE objects

The Cantara JDE Objects are available on the Rinami Customer Portal at

Once you have registered for you license you can access the downloads section and select your Oracle JD Edwards release and your preferred Java Application Server. A minimum installation will require you to download the Cantara Access Server, Cantara Administration Console and Cantara JD Edwards Components. You can optionally download the Cantara JD Edwards Services PAR which provides a number of business functions that wrap up common business processes in a number of JD Edwards modules.

The steps required to deploy the Cantara JD Edwards Components to your Oracle JD Edwards EnterpriseOne system are:

  1. Create an OMW project and promote it so that new objects can be created within the project. The most common configuration would be to promote the project to status 21 and create the objects within the DV environment.
  2. Download the Cantara JD Edwards Components PAR from the Rinami Customer Portal.
  3. Within OMW, select the new project and click the Restore action.
  4. Select Yes to use a ZIP file and then choose the Cantara JD Edwards Components file from your download location. An example of the file name would be PRJ_CNTR_BASE_E920_4.2.1.par
  5. Ensure that all of the objects within the project are checked in
  6. Complete a Full package build and deployment to any enterprise servers that will be connected to Cantara
  7. Once the package is deployed, go back into OMW and generate the tables included in the project
  8. You can promote and deploy the objects to each required path code using the normal JD Edwards OMW and deployment server process.

A Full build is required

Cantara is an Oracle Validated Integration and uses the system code Q35. As the base components introduce a new code library within Oracle JD Edwards EnterpriseOne a full build is required to initialise this library. Subsequent updates and enhancements can be deployed via an update package.

Refer to the JD Edwards Objects and Configuration topic for more details.

Configuration the JD Edwards Enterprise Server

To ensure the correct operation of the Cantara Integration Platform you must ensure that all relevant kernels and components on the target Oracle JD Edwards EnterpriseOne Enterprise servers are configured correctly. This should be completed using Server Manager but can also be done via direct edit of the JDE.INI if that is standard policy.

Details of the elements to be modified are available at JD Edwards Objects and Configuration under JDE.INI settings.

These changes must be done to each JD Edwards Enterprise or Batch server that will be integrated to via Cantara.

Installing and Configuring Apache Tomcat 8.0

Refer to the Apache Tomcat documentation relevant to your operating environment. The documentation is located at

Apache Tomcat will require the inclusion of three additional JAR libraries which should be placed in $CATALINA_HOME/lib

  1. javax.mail.jar available at
  2. xercesImpl.jar available at
  3. mysql-connector-java-5.1.x-bin.jar available at

Please  ensure the minimum heap size is correctly configured as per the technical requirements for the Cantara Access Server and Cantara Administration Console.

Java Settings

Java options are generally set in either the or setenv.bat files located in the bin directory of your Tomcat installation. If you are deploying both the Cantara Access Server and Cantara Administration Console on the same instance, the following are the recommended minimum settings:

JAVA_OPTS="-Xms512m -Xmx512m";

Setting Up the Necessary Folders and Permissions

Both the Cantara Access Server and Administration Console require several configuration and definition files to operate correctly. Although not recommended, it is possible to define only a single folder to store all the necessary server files. The user that the Tomcat server is running as must have read and write permissions to this folder.

An example folder structure for a Linux server:

  • /usr/rinami/cantara to stage the Cantara applications for deployment

  • /var/rinami/cantara/console for the administration console configuration file

  • /var/rinami/cantara/environments for the environments definition file

  • /var/rinami/cantara/components for the component definition files (not required if utilising database storage)

  • /var/rinami/cantara/logs for the server log files

An example folder structure for a Windows server:

  • c:\rinami\cantara\apps to stage the Cantara applications for deployment

  • c:\rinami\cantara\config\console for the administration console configuration file

  • c:\rinami\cantara\config\environments for the environments definition file

  • c:\rinami\cantara\config\components for the component definition files (not required if utilising database storage)

  • c:\rinami\cantara\config\logs for the server log files

Refer to the guides on setting up the folders for the Cantara Access Server and the Cantara Administration Console for more information.

Installing and Configuration Oracle MySQL 5.7

Enterprise Edition only

You are required to have an Enterprise Edition license to make use of database configuration. If you are using the Standard Edition then only folder configuration storage is supported.


The MySQL database can be installed on the same host that Apache Tomcat has been installed on. Alternatively you can use any of the other supported database platforms with details available at Setting up the Cantara Database

Please refer to the Oracle MySQL 5.7 documentation regarding server installation which is available at

Once you can installed and configured the MySQL server you can create a new database schema for Cantara. You will need one schema per Cantara environment. So if you intend to have a single production instance and a single test instance then you will need two schemas. If you intend to have two production instances of Cantara you would only need a single schema. It is recommended that the schema collation be utf8_bin.

The user that the Cantara Access Server connects to the database as must have read/write permission to all tables.

You can then run the appropriate database table creation script against the schema. You can find the installation scripts at Setting up the Cantara Database.

Deploying the Cantara Access Server

To deploy the Cantara Access Server
  1. Extract the provided application .ZIP archive file into the folder defined for staging the applications for deployment.  Refer to the documentation on installing the Cantara Access Server web application. You should see a single index.jsp file and the following four folder names under the main folder:
    • images

    • META-INF

    • uploads

    • WEB-INF 

  2. As per the documentation, copy the required JD Edwards JAR libraries from either a fat client or your deployment server into the WEB-INF/lib folder. You can find the JAR libraries in <JDE Client Install Directory>\system\Classes. For the 9.1.x Tools releases on an Apache Tomcat 8.0 server, the following files are required:

    JD Edwards Library Files

    • Base_JAR.jar
    • JdeNet_JAR.jar
    • jmxremote_optional.jar
    • jmxri.jar
    • ManagementAgent_JAR.jar
    • System_JAR.jar
    • xmlparserv2.jar
  3. You should also copy the file into WEB-INF/classes from the JDE Server Manager Agent home.
  4. Once the required libraries have been included in the application it can now be deployed. Copy the context.xml from within the META-INF folder into the $CATALINA_HOME/conf/Catalina/localhost folder. The file should be renamed to match the context that will be used for the deploy. By default this would be cantara.xml.
  5. The context file includes the context name to be used for the deployment and example connection settings for database and email JNDI definitions.
  6. Please refer to the Tomcat documentation at with details on how to configure the JNDI entries specific to your deployment.
  7. When deployment is complete, you should be able to navigate to the Cantara Access Server landing page. For a default installation this would be found at http://localhost:8080/cantara/

Deploying the Cantara Administration Console

To deploy the Cantara Administration Console
  1. Extract the provided application .ZIP archive file into the folder defined for staging the applications for deployment. Refer to the documentation on installing the Cantara Access Server web application. Once the file is extracted, you should see the following four folder names under the main folder:
    • META-INF

    • static

    • WEB-INF 

  2. Follow the same process you used with the Cantara Access Server to deploy the new web application. The default context for the application is /cantara-console

JD Edwards Library Files NOT required

Unlike the Cantara Access Server, the Cantara Administration Console does not require the JD Edwards library files to be copied into the WEB-INF/lib folder.

Configuring the Cantara Administration Console

When you launch the Cantara Administration Console you will be greeted with a login prompt. The default username and password are admin/admin.

On first login will be prompted to define the Cantara Administration Console configuration file name and path. In this example, the Linux path would be /var/rinami/cantara/console/config.xml and for Windows it would be c:\rinami\cantara\console\config.xml

You should then create an administrator user and change the administration password. User configuration is found under the Configuration menu.

Please refer to the Administration Console Configuration documentation for further details.

Defining a Cantara Access Server

Once you have defined the configuration file and administrator user for the Administration Console, you will be able to define a connection to the Access Server.

To define a Cantara Access Server
  1. Click the Server option on the navigation menu.
  2. Click the Add Server button. 
  3. Enter the name, endpoint, username and password for the server. Details can be found at Adding a Server
  4. Once the server has been added you will be prompted to enter your license details to activate the server for the first time. Your license details will available on the Rinami Customer Portal at Details on how to configure the license are available at Defining the Cantara License.
  5. After the server has been activated you will then need to complete the server configuration. Full configuration information is available at Configuring a Server

Adding an Environment

Once you have connectivity to the Cantara Access Server, you must define at least one environment before you can execute function, queries or reports on the JD Edwards server.

To add an environment
  1. Expand the navigation menu under the newly created server.
  2. Click the Environments option.
  3. Click the Create Environment button located on the far right. 
  4. Give the environment a meaningful name.
  5. Enter the details of the JD Edwards server you are connecting to. Enter the required values for hostname, port, environment and timeout. If you do not know the port that your JD Edwards server listens on, you can refer to the jde.ini file for the server you are connecting to.
  6. Click the Save Environment button.
  7. If you want to access the media object queues for the JD Edwards server, you must enter the FTP configuration for the server hosting the files. Click the Load Queues button to identify the media queues that are available. At this point you will be prompted for your JDE username and password to be able to access the data. Click the Save Environment button to finalise the environment definition. See Defining an Environment.

Testing Connectivity

To confirm that you have connectivity to the JD Edwards server you can execute a simple function from within the Administration Console.

To test connectivity
  1. Click the Functions menu option located under the server name in the navigation menu.
  2. Select the FormatLocation function to open the function definition panel.
  3. Enter an existing JDE Branch/Plant in the branch parameter's default value field. Enter XXXXX in the fileLocation parameter's default value.
  4. Click the Execute Function button to run the test. If the test is successful, you should see the expected result in the three text areas located at the bottom of the page. See the Testing a Function topic for more information.

On This Page

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.