Top
Top
LibraryEASYProcess Installation/UpgradeECC
1) Before Starting ECC Setup

ECC Setup Instructions

Step 1: Setup Instructions and Prerequisites

  • The instructions listed in this document should be followed in order
  • Each step shows detailed instructions and screenshots of what needs to be done to get ECC up and running
  • If errors occur at any point during the setup, see the Troubleshooting section of the document, raise a ticket in EASYTracking, or email support@krisesystems.com
  • To continue to step 2, you must be logged in to your EASYProcess application with an account with Admin privileges and have the following prerequisites.
  • Prerequisites
  • JDE Data Connection Information
  • See step 3 for more details
  • JDE Control Connection Information
  • See step 4 for more details
  • JDE BSFN Connection Information
  • See step 5 for more details
  • Windows server 2008+ (64 bit)
  • 4 GB Ram
  • Dual core CPU
  • Must have network access to:
  • Any databases which ECC is intended to interface with
  • Any JDE instance which ECC is intended to interface with
  • Must have internet access to connect on ports 80 and 443
  • Java 8+ (64 bit)
  • Windows path environment variables should be set up to access java
  • The appropriate JDE Tools .JAR files for the JDE version which ECC is intended to interface with
  • See step 7 for more details
  • The JDBC driver(s) .JAR file(s) for any database provider/management system which ECC is intended to interface with
  • See step 7 for more details

Step 2: Add/Configure new ECC Client

  • Go to the EASYCloud Connector Clients page in the admin menu of the EASYProcess application.
  • The page should look something similar to the screen shown in Image 2a (without an existing client)

Image 2a - EASYCloud Connector Clients Grid

  • Click the Add/Configure New Client link highlighted above. It should bring up a window shown in Image 2b below with the following settings that need to be filled out
  • ClientId
  • Id generated by the EASYProcess application to uniquely identify the client
  • Client IP Address
  • This should be the public IP of the installation network for ECC.
  • This is used as an extra layer of security that will only allow clients to connect from this IP address.
  • Installation Path
  • This is the path ECC will be installed on your network server
  • It’s used to generate a Windows scheduled task XML file that can be imported to run ECC on a schedule and keep it alive.
  • We recommend putting this in a folder like “C:\EASYProcess\DV\” with the environment name since you will need 1 ECC install per environment.

Image 2b - Add/Configure Client

  • Once the client has been added, it should appear in the client list as shown in Image 2a above.

Note: If the configuration needs to be updated after initially creating the client, you can do so in the “Configure” link shown in the Step 2 column of the ECC Clients grid. Changing the config normally means you have to re-download and install the ECC starting from Step 6.

Step 3: Download Client

  • Once the client has been configured as detailed in steps 2-5, you can download the client by clicking the “Download” link in the “Step 6” column of the EASYCloud Connector Clients Grid shown in Image 2a
  • It should download a <clientid>.zip file containing the ECC program along with a Windows scheduled task XML file used to create the scheduled task shown in Image 6a below.
  • You can use 7zip, winrar, or another zip utility to view/extract the files

Image 6a - Client.zip contents

Step 4: Install Client

  • Install Java 8+ (64 bit)
  • The PATH environment variable must exist for ECC to run properly.
  • You can check if this is correct by opening a CMD window and running the “java -version” command which should display version 1.8 or higher.
  • The version of java may change depending on the version of jar files you get from JDE directory.
  • The contents of the <clientid>.zip file downloaded from Step 6 should be extracted to the installation directory as shown below.
  • If your installation directory from Step 2 was “C:\EASYProcess\DV\” then the contents of your installation directory should look as shown in Image 7a below.
  • From the target JDE Enterprise Server’s “~\system\classes” folder, all .JAR files should be copied into the ECC “jde_alljarfiles” folder located inside your installation directory.  Once copied, navigate your command line interface to this “jde_alljarfiles” folder and run the “runsubsetcpy.bat” batch script; this will copy only the necessary jar files into the installation’s “jde_jars” folder.  Keep in mind that you may need to run this script with elevated privileges (depending on the location of your ECC client’s installation directory) in order for it to execute properly.
  • Any appropriate JDBC driver .JAR files should be copied or moved to the ECC “jdbc_jars” folder located inside your installation directory.  JDBC driver .JAR files should be acquired from the database\database management system provider(s) for any database which ECC will be connecting to.  Additionally, the JDBC driver for Microsoft SQL Server is already included in the download.

Image 7a - Installation Directory

  • Next, import the EASYCloudConnector.xml file from your installation directory as a scheduled task by:
  • Open windows task scheduler as shown in Image 7b (below)
  • Click Import Task
  • Browse to your ECC installation directory
  • Select the EASYCloudConnector.xml file
  • Press OK
  • Once imported, the task should show in the Task Scheduler Library and will automatically run after ~1 minute. You can hit the Refresh button shown in Image 7b to verify that the scheduled task eventually runs.
  • Note: If the task does not ever go to the “Running” status, please refer to the “Troubleshooting” section at the end of this document

Image 7b - Task Scheduler

Step 5: Configure JDE Data Library Connection

  • To configure the JDE Data library connection, go to the EASYCloud Client Connector Clients Grid from Image 2a and click the “JDE Data” link under the Step 3 column. The window will look like Image 3a shown below.
  • If you do not want to store sensitive data (like username / password) in the EASYProcess database, you can use defined variables as shown in the “Client Config Parameters” section at the end of this document.
  • Configure the variables below then hit save at the bottom
  • ConcatOperator
  • This will change concat operators used by the applications between + and ||
  • Used in SQL (+)
  • Used in iSeries/Oracle (||)
  • ConnectionString
  • This is the JDBC-formatted connection string used by ECC to connect to the JDE Data library
  • See Table 3.1 (below) for sample JDBC connection string formats.
  • DbName
  • This should be the JDE Data library name (e.g. TESTDTA, CRPDTA etc.)
  • DbType
  • This is the type of database driver used for the JDE Data Library

Table 3.1

Database Provider/Database Management System

JDBC Connection String

Microsoft (SQL Server)

jdbc:sqlserver://;serverName=<db server>;user=<user id>;password=<password>;databaseName=<database>;

Oracle

jdbc:oracle:<driver type>:<user id>/<password>@<db server>:<port>:<system identifier>

IBM DB2

(Native Connection)

jdbc:db2://<db server>:<port>/<database>;user=<user id>;password=<password>;

IBM DB2

(On remote IBM i)

jdbc:as400://<db server>/<database>;prompt=false;user=<user id>;password=<password>;

Image 3a

Step 6: Configure JDE Control Library Connection

  • To configure the JDE Control library connection, go to the EASYCloud Client Connector Clients Grid from Image 2a and click the “JDE Control” link under the Step 4 column. The window will look like Image 3a above.
  • If you do not want to store sensitive data (like username / password) in the EASYProcess database, you can use defined variables as shown in the “Client Config Parameters” section at the end of this document.
  • Configure the variables below then hit save at the bottom
  • ConcatOperator
  • This will change concat operators used by the applications between + and ||
  • Used in SQL (+)
  • Used in iSeries/Oracle (||)
  • ConnectionString
  • This is the JDBC-formatted connection string used by ECC to connect to the JDE Control library
  • See Table 3.1 (above) for sample JDBC connection string formats.
  • DbName
  • This should be the JDE Control library name (e.g. TESTCTL, CRPCTL etc.)
  • DbType
  • This is the type of database driver used for the JDE Data Library

Step 7: Configure JDE BSFN Connection

  • To configure the JDE BSFN connection, go to the EASYCloud Client Connector Clients Grid from Image 2a and click the “JDE BSFN” link under the Step 5 column. The window will look like Image 3a above.
  • If you do not want to store sensitive data (like username / password) in the EASYProcess database, you can use defined variables as shown in the “Client Config Parameters” section at the end of this document.
  • Configure the variables below then hit save at the bottom (configs not mentioned below should be left blank)
  • BSFNServerPollFrequency
  • Leave Blank
  • EnterpriseServer
  • Name or IP Address of the server to send the XML request to
  • Environment
  • JD Edwards environment (ie DV920)
  • JDENETPort
  • Port defined in the jde.ini file on the Enterprise Server to accept XML Requests
  • UserId
  • UserId used to run the BSFN
  • Password
  • Password used to run the BSFN
  • Role
  • Role used for JDE User
  • Leave blank will default to *ALL
  • SessionRecycleCount
  • Number of requests that will be processed for each JDE session before closing the session
  • Leave blank if you’re not sure
  • Timeout (in ms)
  • Timeout for sending requests to the Enterprise server. EP will give up after this amount of time
  • ToolsVersion
  • JDE Tools version

Step 8: Test Client

  • Once the client is “Running” refresh the EASYCloud Client Connector Grid from Image 2a and check that the “Verified” status has changed to “True”.
  • To test a connection, open the “Test” link under Step 8 column in the EASYCloud Client Connector Grid from Image 2a.
  • This will open the window shown in Image 8a (below).  This interface is the test console for ECC and allows you to both test the connection to ECC as well as verify the installation’s integrity in several ways:
  • The Reload Config button (highlighted in blue) will tell the client that its configuration may have been changed.  This will cause the client to attempt to refresh its configuration with the server.  This option should be used if any of the details entered in steps 3-5 are changed.
  • The Get Client Diagnostic button (highlighted in green) will run a series of tests, to obtain details about the connection to the client as well as the client’s functional capabilities.  When run, the following information (highlighted in red) will be returned:
  • The client’s connection latency with the server (ping), in milliseconds, along with one of the following ratings* of the connection quality:

Rating

Ping (ms)

Good

< 51

Unstable

< 81

Poor

≥ 81


* Note: These benchmarks are subject to change and are not intended to be used as an indicator of general network/system stability or quality.

  • The results of testing the client’s ability to connect using the JDE Data, JDE Control, and JDE BSFN configurations entered in steps 3-5.  If any error occurs, it will display the error message along with any known resolutions to the error.

Image 8a

Client Config Parameters

   When configuring the connection parameters in steps 3-5 above, you have the option to store sensitive data in a local configuration file, within the ECC installation directory.  These can be configured within the Client.properties text file in the bin subfolder of your installation, shown in Image A1 (below).


Image A1

Within this file, custom-defined properties can be defined according to the following rules:

  • Empty lines and lines beginning with ‘#’ characters are ignored.
  • Each custom-defined property should be on its own line in the file.
  • Each custom-defined property should be separated from its associated value by ONLY an equals sign.
  • Each custom-defined property’s name may only contain alphabetic characters.
  • Every custom-defined property MUST have a non-blank value.

Once the custom properties are defined, you can place references to them within the configuration fields, in place of the actual values.

  • Custom property reference format:
  • [ClientProperty:myCustomPropertyName]
  • Example:
  • Let’s say we do not want to share the connection string for JDEData library
  • First, we edit our previously mentioned Client.properties file; adding lines similar to those shown in Image A2-a (below).  For this example, we are connecting to the TESTDTA schema of the JDE_DEVELOPMENT database which is located on our Enterprise Server’s database server, “MyJDEEnterpriseServer”.
  • Next, change the config in Step 3 to use the references “[ClientProperty:jdeDataDB]” and “[ClientProperty:jdeDataDBName]”, as shown in Image A2-b (below), and save the changes.
  • Finally, If you are changing configuration properties of an ECC client that is already running, do not forget to use the Test link (Step 8) to send a Reload Config command so that your new properties will be applied.

Image A2-a

Image A2-b

Troubleshooting

 Following is a list of scenarios useful for troubleshooting the ECC client installation.

  • Manually running the ECC client within its installation directory

     
    This scenario is useful primarily for obtaining more details about errors that occur on startup and which cause the client to terminate prematurely.  Additionally, this scenario can be useful in determining whether or not a connection is able to be established between the ECC client and its target server.
  1. End and Disable the Scheduled task from Step 8
  2. Open a command prompt* and navigate to <Installation Directory>\ecc
  3. Run the ecc_invoker.bat file
  4. Observe the console output and log files (“<Installation Directory>\ecc\bin\logfiles\”) for errors.
  5. If the program did not self-terminate, use the “stop” command to attempt to gracefully shut down the client.  (Ctrl-C may be used to terminate batch execution if this command appears to get stuck for more than a few seconds).
  6. Make changes and repeat steps 3-6 until all critical errors have been resolved.
  7. Don’t forget to close any manually-executing instance of the client and re-enable the scheduled task once finished.

Powered by EASYProcess (© 2019 K-Rise Systems, Inc).