> > > Using the Production Server

Using the Production Server

13th July 2016

Sean Hoppe Consulting Group

In a previous Quick Reference Guide, we discussed the Test Server that is included within your Cleo Clarify’s server environments. We discussed what it is, and how you should use it when it comes to synchronizing it with an SVN Repository and what additional steps you should take before deploying and testing your Projects.

In that same manner, we’re going to break down what the Production Server is and the steps you should follow before processing your real-live data!

What is the Test Server?

A Production Server is installed on a different machine than the Studio. Once you complete testing on the Test Server, deploy the Project(s) to the Production Server, where your production data processes.

To ensure the best results when using the Production Server, the following guidelines should be followed:

  • Ensure that communications to your trading partners are enabled
  • Ensure that all objects are saved in your SVN Repository, or in a different branch for production data

The Production Server will require adequate memory and disk space to process the types of documents you wish to file. This is the environment that will process your data live, and where logs should be reviewed to address concerns.


After my Production Server is installed, how do I use it?

The steps we will review should be followed after you’ve fully tested the data through the Test Server.  If you haven’t read our guide, click here, as it is essential to complete those steps prior to following these for your Production Server.

Before deploying into Production, the first step is to (1) take all the Projects that currently reside in the Test workspace that we’ve previously created and branch them in your SVN Repository.  Once you are done with that, you should have your trunk (development/design), Test branch, and a Production branch.  As this area serves to easily access the Projects, and to keep a location with all Projects deployed to Production.  This can be very helpful if a workspace is corrupt and requires new deployment, as they can be quick available from the SVN Repository.

Next, you’ll  (2) create a new workspace called Production, this helps in identifying Projects maintained in Test and Production environments when they are running simultaneously.  At this point, you’ll have your normal design workspace, the Test workspace, and the Production workspace.

Once your workspace is created and you are using that workspace, you can (3) check out the Projects from the Production branch.  This will allow those Projects and resources to be available in your Project Explorer.

Once they are checked out and inside the new workspace’s Project Explorer, (4) modify the objects and resources within the Projects essential to process successfully in production.  Many of these values should be maintained using Global Variables, and can be resolved automatically, but it is important to verify that these are all configured accordingly.  Some objects that may require editing can include any objects that were previously changed for testing needs, such as:

  • EDI Envelopers may need to be revised to ensure that they are using production values, such as the proper Test/Production qualifier.
  • Routes may need to be revised to ensure that they are using production values, such as incoming values for Inbound EDI Routes.
  • FTP Adapters may need to be revised to ensure that they are using production values, such as an alternate filename, or a different testing directory on the FTP Server.
  • Global Variables may need to be revised to ensure that they are using production values. Global Variable values can be maintained after deployment in the Settings view in the Admin Console.
  • Business Processes may need to be revised to ensure that they are using production values, such as SendEmail tasks and EXTOL Secure Exchange (ESX) tasks.
  • Database objects may need to be revised to ensure that the Production Database URL, production username, password, and schema/library are used.  Also, ensure that the database fields are the same as a last check.
  • Process Schedulers will need to be configured for each trading partner for Outbound EDI processing to run according to you, or your partner’s specifications.


Note:  Some folders and data that you may be using on your local or test server machine for testing using the Local Test or Test Servers may not exist on the Production Server environment.  Be mindful to choose different values for your File Adapters, File Monitors, and other objects.  Or, copy those folders over to your Production environment to ensure that your objects are being properly directed.  For example, if you are using a specific folder for all of your EDI documents, copy that folder from your local or test system to the Production Server’s system in the same location.  This folder may contain essential values that need to be referenced, such as the JDBC Driver for your database connection, and must be available on this server as well.

The next step will be to (5) deploy and install the Projects to the Production Server to begin running your processes from your trading partners.

Deploy and Install Projects

Follow the steps above when on-boarding every new trading partner to your Production Server.  Those steps are:

1.  Copy your new Projects into the Test branch of your SVN Repository.
2.  Switch your workspace to the Test workspace that was created.
3.  Check out the Projects into the Project Explorer.
4.  Modify the objects accordingly to ensure that they are using testing values.
5.  Deploy and install the Projects.  


By: on