Enable 9 PIM Installation Manual - Zendesk · 2019-04-09 · Enable 9 Installation Guide Page 1 of 247 Revised 10/18/2018 Enable 9 Product Information Management (PIM) Installation

Enable 9 Installation Guide

Page 1 of 247 Revised 10/18/2018

Enable 9

Product Information Management (PIM)

Installation Manual

Enable9 1.0.41 Build 10182018_1425

EnableServer 9.0 Build 10152018_1513

Revised 10/18/2018

EnterWorks®, Inc.

46040 Center Oak Plaza Suite 115

Sterling, VA 20166



©EnterWorks, Inc. Loudoun Tech Center 46040 Center Oak Plaza Suite 115 Sterling, VA 20166 1.888.242.8356 (Sales and General Information) 1.888.225.2705 (U.S. Support) http://www.enterworks.com EnterWorks ® Enable 9 PIM™ Installation Manual Copyright © 2018 EnterWorks, Inc. All rights reserved. Law prohibits unauthorized copying of all or any part of this document. Use, duplication, or disclosure by the U.S. Government is subject to the restrictions set forth in FAR 52.227-14. “EnterWorks” and the “EnterWorks” logo are registered trademarks and “Enable PIM”, “EnterWorks Process Exchange” and “EnterWorks Product Information Management” are trademarks of EnterWorks, Inc. Windows, .NET, IIS, SQL Server, Word, and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Java and all Sun and Java based trademarks are trademarks or registered trademarks of the Oracle Corporation in the United States and other countries. Oracle is a registered trademark and Oracle 10g is a trademark of Oracle Corporation. Pentium is a registered trademark of Intel Corporation in the United States and other countries. JBoss is a registered trademark of Red Hat, Inc. All other trademarks and registered trademarks are the property of their respective holders. All icons and graphics, with the exception of the "e." logo, were obtained from West Coast Icons and Design at http://www.bywestcoast.com. EnterWorks, Inc. retains copyrights for all graphics unless otherwise stated. All other trademarks and registered trademarks are the property of their respective holders. This document is furnished for informational purposes only. The material presented in this document is believed to be accurate at the time of printing. However, EnterWorks Acquisition, Inc. assumes no liability in connection with this document except as set forth in the License Agreement under which this document is furnished.



Table of Contents

1 Document Conventions ...................................................................................................... 7

2 Customer Support ............................................................................................................... 8

3 Overview ............................................................................................................................. 9

4 Third-party Software Versions ............................................................................................ 9

4.1 Software ........................................................................................................................... 9

4.2 Java JAR Files .................................................................................................................. 11

5 Enable Installation ............................................................................................................ 11

5.1 Overview ........................................................................................................................ 11

5.1.1 Server Architecture ............................................................................................. 11

5.1.2 Installation Procedure Overview ......................................................................... 12

5.1.3 Environment-Specific Configurations and Data Loads ........................................ 13

5.2 Pre-installation Requirements ....................................................................................... 13

5.3 Operational Verification Procedures ............................................................................. 15

5.4 Uninstall Instructions ..................................................................................................... 16

5.5 Installation Procedures .................................................................................................. 16

5.5.1 Server Software Prerequisites ............................................................................. 16

5.5.2 Installing Server Software Prerequisites ............................................................. 16

5.5.3 Setting up the Database ...................................................................................... 33

5.5.4 Restore Databases from Backups........................................................................ 34

5.5.5 Enable Application Installation ........................................................................... 44

5.6 Modular Deployment Procedures .................................................................................. 86

5.6.1 Configure the DAM .............................................................................................. 86

5.6.2 Confirm DAM Application is Functional .............................................................. 99

5.7 Update Application Configurations .............................................................................. 101

5.8 Install and Deploy Jasper Server Reports ..................................................................... 105

5.8.1 Install Jasper Tomcat Server ............................................................................. 105

5.8.2 Deploy Reports .................................................................................................. 113

5.8.3 Install iReport .................................................................................................... 118



5.8.4 Integrate Jasper Reports with EnterWorks Enable ........................................... 123

5.9 To Uninstall Jasper Reports .......................................................................................... 127

6 SecureAuth Integration ................................................................................................... 128

6.1 Installation .................................................................................................................... 129

6.1.1 Enable Server Patch........................................................................................... 129

6.1.2 IdP Installation ................................................................................................... 129

6.1.3 SP Initiated Authentication Installation ............................................................ 130

6.2 Configuration of SecureAuth Services ......................................................................... 132

7 Configuring Restored Server Images .............................................................................. 138

7.1 Web Server ................................................................................................................... 140

7.1.1 Enable PIM ........................................................................................................ 140

7.1.2 Enable PIM (Slaves) ........................................................................................... 145

7.1.3 Enable Web ....................................................................................................... 151

7.1.4 PIMQL ................................................................................................................ 153

7.1.5 Enable Utilities .................................................................................................. 156

7.1.6 IIS Proxy ............................................................................................................. 161

7.2 App Server .................................................................................................................... 162

7.2.1 EPX ..................................................................................................................... 162

7.2.2 Enable PIM (Slaves) ........................................................................................... 170

7.2.3 Enable Utilities .................................................................................................. 176

7.3 Database Server ........................................................................................................... 182

7.3.1 Database Update ............................................................................................... 182

8 Installing Channel Readiness .......................................................................................... 184

8.1 MongoDB ...................................................................................................................... 184

8.1.1 Installing MongoDB ........................................................................................... 184

8.1.2 Configuring MongoDB ....................................................................................... 193

8.2 Robo 3T ........................................................................................................................ 196

8.2.1 Installing Robo 3T .............................................................................................. 196

8.2.2 Robo 3T Setup ................................................................................................... 201

8.3 Node.js.......................................................................................................................... 206

8.3.1 Installing Node.js ............................................................................................... 206



8.3.2 Configuring Node.js ........................................................................................... 210

8.4 Express Server .............................................................................................................. 212

8.4.1 Setting up the Express Server ........................................................................... 212

8.5 Angular ......................................................................................................................... 213

8.5.1 Setting up Angular ............................................................................................. 213

8.6 Confirming Channel Readiness is Installed .................................................................. 213

9 Installing AlignTrac .......................................................................................................... 214

9.1 Erlang ............................................................................................................................ 214

9.1.1 Installing Erlang ................................................................................................. 214

9.2 RabbitMQ ..................................................................................................................... 218

9.2.1 Installing RabbitMQ ........................................................................................... 218

10 Elasticsearch & Auto-Classification ................................................................................. 222

10.1 Erlang ........................................................................................................................ 222

10.1.1 Installing Erlang ............................................................................................. 222

10.2 RabbitMQ.................................................................................................................. 226

10.2.1 Installing RabbitMQ ....................................................................................... 226

10.3 Elasticsearch ............................................................................................................. 230

10.3.1 Establish Java Environment Variable ............................................................. 230

10.3.2 Installing Elasticsearch ................................................................................... 231

10.3.3 Configure Elasticsearch ................................................................................. 236

11 Windows Authentication ................................................................................................ 237

11.1 EPIM .......................................................................................................................... 237

11.1.1 Setting Up Integrated Security with Database (Logging on to Database with Network Domain Account) ............................................................................................. 237

12 Microservices .................................................................................................................. 239

12.1 Microservices Third-party Dependencies ................................................................. 239

12.2 Microservice List ....................................................................................................... 240

12.3 Service Installation Constraints ................................................................................ 242

12.4 Basic Installation ....................................................................................................... 243

12.5 Example Add-on Microservice .................................................................................. 245

12.5.1 Additional Static Files .................................................................................... 245



12.5.2 Proxies ........................................................................................................... 246

12.5.3 Custom Microservices ................................................................................... 246



1 Document Conventions

This EnterWorks document uses the following typographic conventions:

Convention Usage

pathnames Pathnames are shown with backslashes, as for Windows systems.

Courier New

font

Denotes sample code, for example, Java, IDL, and command line information. May be used to denote filenames and pathnames, calculations, code samples, registry keys, path and file names, URLs, messages displayed on the screen.

If italicized and in angle brackets (< >), it denotes a variable. Variables may also be written in red to further emphasize them in a long code sample.

Calibri Font (bold) When used in body text, it denotes an object, area, list item, button, or menu option within the graphical user interface; or a database name or database-related object. (Examples: the Save button; the Product tab; the Name field; the SKU repository)

Can also be used to denote text that is typed in a text box. (Example: Type “trackingNo” in the Name field)

Blue underlined text Words, phrases or numbers in blue are active links that can be clicked. Clicking these active links will bring the user to the required information, steps, pages chapters, or URL.

http://www.enterworks.com/



2 Customer Support

EnterWorks provides a full spectrum of customer support. Check your maintenance contract for details about the level of support purchased. The first time you contact customer support, you will be issued a customer identification number. Keep this number for future reference when using the EnterWorks customer support service.

How to reach us Comments

On the Web: http://support.enterworks.com Via email: [email protected]

For detailed discussions of hardware, software, configuration issues, or Helpdesk credentials, contact your EnterWorks representative.

Phone: U. S. Support 1.888.225 2705

Support hours are from 9:00 a.m. to 8:00 p.m., United States Eastern Time (-0500 UTC), Monday through Friday.

Postal mail: EnterWorks Acquisition Inc. Customer Support Team Loudoun Tech Center 46040 Center Oak Plaza Suite 115 Sterling, VA 20166 USA

Please include your telephone number and customer identification number or project name in your letter.

http://support.enterworks.com/

mailto:[email protected]



3 Overview

This document covers procedures for installing EnterWorks’ Enable 9 Product Information Management (PIM) system. It covers prerequisite, install steps, configurations, and validation activities for server, application and database installations. It is recommended that installation activities be handled by the System Administrator.

A System Administrator (users assigned to the Administration security group) will have access to all Enable system features and functions, but not all functionality is covered in this document so refer to the following documents for additional information.

• For user functionality, see the “Enable 9 PIM User Manual”.

• For system administration processes and procedures, see the “Enable PIM Administration

Manual”.

• For publication functionality, see the “Enable PIM Publication Manual”.

4 Third-party Software Versions

4.1 Software

Below are the version numbers of the approved versions of third-party software to be installed with Enable 9. If elsewhere in this document (in text or in a screenshot image) the version number given for an application is different than it is listed in this table, use the version listed in this table.

Product Name Version Number Source

Apache Tomcat 6.0.41

Elasticsearch 5.0.2 https://www.elastic.co/downloads/elasticsearch

Erlang OTP 20 http://www.erlang.org/downloads

Ghostscript 9.23 https://www.ghostscript.

com/download/

version: https://github.com/Artif

exSoftware/ghostpdl-

downloads/releases/downl

oad/gs923/gs923w64.exe

https://www.elastic.co/downloads/elasticsearch

https://www.elastic.co/downloads/elasticsearch

http://www.erlang.org/downloads

https://www.ghostscript.com/download/

https://www.ghostscript.com/download/

https://github.com/ArtifexSoftware/ghostpdl-downloads/releases/download/gs923/gs923w64.exe





Page 10 of 247 Revised 10/18/2018


ImageGlue .NET 7.101

JasperReports 5.2

Jaspersoft IReport Designer Professional

5.2.0

jTDS 1.2

JDK 1.7.0_51 https://ws.onehub.com/workspaces/323831/folders/663550458

Microsoft Visual C++ 2008 with Service Pack 1

http://go.microsoft.com/?linkid=7729279

Microsoft .NET Framework 3.5

Microsoft .NET Framework Features

• .NET

Extensibility

3.5

• .NET

Extensibility

4.5

• ASP.NET 3.5

• ASP.NET 4.5

Microsoft .NET Framework CLR v2.0.50727

Microsoft SQL Server 2008, 2012, or 2014

MongoDB Community Server 3.6.6 https://www.mongodb.com/download-center?initial=true#production

Node.js v4.4.7 https://nodejs.org/en/download/

RabbitMQ Server 3.7.8 https://www.rabbitmq.com/download.html

Robo 3T 1.2.1 https://robomongo.org/download

https://ws.onehub.com/workspaces/323831/folders/663550458




https://www.mongodb.com/download-center?initial=true#production

https://www.mongodb.com/download-center?initial=true#production

https://nodejs.org/en/download/

https://www.rabbitmq.com/download.html

https://www.rabbitmq.com/download.html

https://robomongo.org/download


Page 11 of 247 Revised 10/18/2018


SAML 2.0 https://ws.onehub.com/workspaces/323831/folders/663550458

Windows Server 2012

4.2 Java JAR Files

Version numbers included in Java JAR filenames are listed in the section in which they are referenced: Integrate Jasper Reports with EnterWorks Enable.

5 Enable Installation

5.1 Overview

5.1.1 Server Architecture

Enable application components will be installed as follows:

Installation

Instance Server Name Server Function Installed Applications

PROD, QA, or DEV

XXXXXXXX Web -Enable Server (JBoss Master and Tomcat) -Enable (.NET)

-ImageGlue (third-party)

-Application Request Routing (IIS Proxy) and dependencies.

-JasperReports

PROD, QA, or DEV

XXXXXXXX Application -EPX (JBoss and Tomcat) -Enable Server JBoss Slave Instance 1 (JBoss) -Enable Server JBoss Slave Instance 2 (JBoss)

PROD, QA, or DEV

XXXXXXXX Database SQL Server




Page 12 of 247 Revised 10/18/2018

The following high-level steps are required to install the Enable Suite of applications. Each overview step is covered in its own subsection under Installation Procedures.

5.1.2 Installation Procedure Overview

Below is an overview of the Enable installation process. For the complete installation procedure, see Installation Procedures.

Database Server:

1. Backup the database of the source environment (for example, DEV).

2. Restore the backup created in the above step to the target environment database (for

example, QA).

3. Delete test data from the restored backup.

Web Server:

1. Install Enable Server using an existing database (the restored/cleaned up database from

step #3 above).

• Enable Server is the primary application. It provides main web UI (Apache

Tomcat) as well as batch job processing (JBoss).

2. Install Enable.

• Enable provides support (.NET) to Enable Server application for Digital Assets

Management (DAM) modules.

3. Install ImageGlue.

• ImageGlue provides support to the Enable application in generating image

variants.

4. Install Application Request Routing (ARR) and dependencies.

• This provides primary IIS entry point into the Enable suite of web applications.

5. Install the JasperReports application.

• JasperReports is a third-party reporting engine that supports Product

Information Guide and Brand Approval Report publications.


Page 13 of 247 Revised 10/18/2018

Application Server:

1. Install EPX.

• EPX is the EnterWorks workflow engine. It provides workflow support to Enable

suite applications.

2. Install Enable Server JBoss Slave Instance 1.

• This one of two batch job processing queues. It is controlled by the Web server’s

Master JBoss installation.

3. Install Enable Server JBoss Slave Instance 2.

• This is the second batch job processing queue. It is controlled by the Web

server’s Master JBoss installation.

5.1.3 Environment-Specific Configurations and Data Loads

In addition to the software installation described above (see High-Level Installation Steps), several configuration settings need to be updated for the specific environment. Below is a high-level description of the process. Detailed instructions are provided in Installation Procedures.

The procedure for updating configuration changes is:

1. Configure the DAM.

2. Confirm that the Enable DAM (.NET) application is functional.

3. Update application configurations.

4. Load data.

5. Deploy Dashboard widget JSPs.

5.2 Pre-installation Requirements

Generate a database backup for the epim database existing in the corresponding source environment (<ServerName>/PIMINT).

1. In the case of QA, a database backup will be created from the DEV epim database. A list

of source and target environments is listed below as reference:


Page 14 of 247 Revised 10/18/2018

Source Environment Target Environment

DEV QA

QA PROD

2. Restore the backup generated in the previous step to the target server, calling the

restored database: epim.

3. Run the following script on the restored epim database. This script will delete all test

data that was updated/created in the source environment. The script will take several

minutes to complete and will need to be modified for each customer.

4. Create one additional database on the target database host server and call it EPX.

5. Create a login epimsys and assign owner privileges to the epim and EPX databases.

Take note of the password, as it will be required during installation procedures.

6. Give Enable SQL login epimsys read-only access connection to the database.

7. Create an Enable network account (i.e., SVC-PIM-QA). Enable services will

impersonate this account and the account will later be given appropriate read/write

access to the EnterWorks base install directory on both the web and application servers

(steps included in subsequent sections).

8. Submit a request to grant admin access to the service account in step #6 to both the

Web server and application server.

9. Create an email distribution group. This group’s email address will be set up as the

“From” email address in workflow notifications.

10. Create a base directory (<drive>:\enterworks) on the application server and Web

server. It is suggested that the drive used is not the same drive that contains the

operating system, so that in the unlikely event that the disk is filled, the operating

system will still function.


Page 15 of 247 Revised 10/18/2018

11. Submit a request to grant access to Active Directory (AD) groups, if ADs are being used.

If required, two groups can be created - one with read access and one with full access

for each server.

12. After step #8 is complete, submit a request to add a service account (SVC-PIM-QA) as

a member of RWXD active directory groups created in step #8.

13. Create a directory on the Web Server \\<ServerName>\e$\temp and place all

installation files found in the source server \\<ServerName>\e$\temp in that

directory.

5.3 Operational Verification Procedures

The below is an overview of the processes to confirm proper installation.

Web Server:

• Confirm that the Enable (Tomcat) application is operational by logging in to the Enable

UI.

• Confirm that the Enable (Master JBoss) application is operational via the Web server’s

Services console.

• Confirm that the Enable UI is accessible via http://<WebServerName>/webcm/

by logging in as the default system user. This confirms installation of Application

Request Routing.

• Via Enable UI, navigate to the Asset Explorer feature bar link. This confirms installation

of Enable (.NET) application.

Application Server:

• Successfully log on to EPX design console. This confirms installation of EPX.

• Confirm JBoss slave 1 is installed and operational via the application server’s Services

console.

• Confirm JBoss slave 2 is installed and operational via the application server’s Services

console.


Page 16 of 247 Revised 10/18/2018

5.4 Uninstall Instructions

Contact EnterWorks for directions on uninstalling components.

5.5 Installation Procedures

For the version numbers of approved third-party software, see Third-party Software Versions.

5.5.1 Server Software Prerequisites

• Microsoft SQL Server

• Windows Server

• Windows Service Account

5.5.2 Installing Server Software Prerequisites

5.5.2.1 Windows IIS & Microsoft .NET Installation

1. Open the Server Manager (icon on bottom left).


Page 17 of 247 Revised 10/18/2018

1. Select the Add roles and Features wizard. The wizard will appear.

2. Select Installation Type on left selection bar.

3. Select the Role-based or feature-based Installation option.

4. Click the Next button.


Page 18 of 247 Revised 10/18/2018

5. Select the server you are installing Windows IIS on.



Page 19 of 247 Revised 10/18/2018

7. Select the Web Server (IIS) option.

8. The Add Features Required for Web Server (IIS) window will appear.


Page 20 of 247 Revised 10/18/2018

9. Click the Add Features button.

10. The Add Features window will appear.


Page 21 of 247 Revised 10/18/2018

11. Select Features on left selection bar.

12. Select the .NET Framework <version> features option as shown below (where <version>

is the approved version number as noted in Third-party Software Versions).


14. The Web Server Role (IIS) window will appear.


Page 22 of 247 Revised 10/18/2018

15. Navigate to Role Services.



Page 23 of 247 Revised 10/18/2018

17. Select the services as shown below.


Page 24 of 247 Revised 10/18/2018


19. The Confirm Installation Selections window will appear.


Page 25 of 247 Revised 10/18/2018

20. Check the checkbox next to the Restart the destination server automatically, if

required.


Page 26 of 247 Revised 10/18/2018

21. If you get the error above:

a. Click the Specify an alternative source path link. (If the install can’t find the

path)

b. Specify the location of the WinSXS folder, as shown below.

NOTE: You may have to get the Windows Install Media mounted if source files are not present.

c. Click the OK button.

d. The Confirm Installation Selections window will appear.


Page 27 of 247 Revised 10/18/2018

22. Click the Install button.

23. Click the Close button when the installation has successfully completed.


Page 28 of 247 Revised 10/18/2018

24. When the installation has successfully completed, click the Close button.

5.5.2.2 Visual C++ Runtime

1. Open the Chrome browser.

2. Use the address listed in Third-party Software Versions to download and install the

component.

3. Run the downloaded setup installation file.



6. Agree to the license.

7. Uncheck the Allow Visual Studio to receive and display online RSS content checkbox.



Page 29 of 247 Revised 10/18/2018

9. Agree to the license.

10. Uncheck the Allow Visual Studio to receive and display online RSS content checkbox.



Page 30 of 247 Revised 10/18/2018

12. Uncheck the two checkbox options.





Page 31 of 247 Revised 10/18/2018

16. You do not need to register this product. When the Installation has completed, click the

Exit button.

5.5.2.3 ImageGLue .NET

1. Go to OneHub and download ImageGlue.

2. Extract ImageGlueNet.zip to temp folder.

3. Run Installer setup.exe.

4. After install, go to the program IGSettings from the start menu.


Page 32 of 247 Revised 10/18/2018

5. The IGSettings window will appear.

6. Enter the license key from the ProductKeys.txt file in the temp folder.

7. Enter the license key from the ProductKeys.txt file in the temp folder.

NOTE: If there are more than one keys in the ProductKeys.txt file, use the one with the highest version number.

8. Click the Set Key button.


Page 33 of 247 Revised 10/18/2018

9. Click the OK button.

5.5.3 Setting up the Database

5.5.3.1 Creating the ewsys user login

1. Log into the SQL Server as a user with permission to create users and databases.

2. Open the SQL Server Management Studio.


Page 34 of 247 Revised 10/18/2018

3. Create a login account named ewsys:

a. Enter ewsys as Login Name.

b. Enter the Password and Confirm the password.


5.5.4 Restore Databases from Backups

Databases can be created from backups or created from scripts. This section covers the steps needed to restore from backups. To create a database from scripts, see Creating Databases Using Scripts.

5.5.4.1 Restoring the EPX database

1. Restore the EPX database from the backup files located in the

<drive>:\Enterworks\EPX\rdms\epx.bak folder.

2. The Source window will appear.


Page 35 of 247 Revised 10/18/2018

3. Select the backup file.

4. Override the Restore database files path and filename, if needed.

5. Click Options on left navigation bar.


Page 36 of 247 Revised 10/18/2018

6. Click the OK button to restore the database.

5.5.4.2 Creating the ewsys Database User

When the database restore has completed, create a new ewsys user under the EPX database.

1. Select New User.


Page 37 of 247 Revised 10/18/2018

2. The Database User – New window will open.


Page 38 of 247 Revised 10/18/2018

3. For User type, select SQL user with login.

4. For User Name, enter ewsys.

5. For Login Name, enter ewsys.

6. For the Default Schema, enter dbo.


8. Click the Owned Schema option on the left navigation bar.


Page 39 of 247 Revised 10/18/2018

9. Select the db_owner Schema.

10. Click the Membership option on the left navigation bar.


Page 40 of 247 Revised 10/18/2018

11. Select the db_owner Database Role Membership.

12. Click the Ok button to assign the ewsys user as database owner of the EPX database.

13. Using SQL Server Studio Query Tool, update reference in EPX database, adjust

@APP_SERVER_NAME@ and @WEB_SERVER_NAME@ :

UPDATE S_PROFILE_VALUE SET PROFILE_VALUE_STRING='http://@WEB_SERVER_NAME@:80/tm' WHERE PROFILE_VALUE_ID=1;

UPDATE S_PROFILE_VALUE SET PROFILE_VALUE_STRING='http://@WEB_SERVER_NAME@:80/websource' WHERE PROFILE_VALUE_ID=4;

UPDATE S_SERVER SET SERVER_UID='EPX_@APP_SERVER_NAME@', NAME = 'EPX_@APP_SERVER_NAME@', SOAP_SERVICE_URL='http://@APP_SERVER_NAME@:9040/soap/servlet/rpcrouter' WHERE SERVER_ID=1;


Page 41 of 247 Revised 10/18/2018

5.5.4.3 Restoring the EPIM database

1. Restore EPIM database from backup files located in

<drive>:\Enterworks\EnableServer\rdms\epim.bak folder. (For

instructions on restoring a database from backup files, see Restoring the EPX database.)

2. Create an ewsys user for EPIM and assign it as the EPIM database owner (For

instructions on creating a database user, see Creating the ewsys Database User.)

5.5.4.4 Creating Databases Using Scripts

Create the EPIM database.

1. Select New Database.

2. Click the Ok button.


Page 42 of 247 Revised 10/18/2018

3. Assign user ewsys as database owner (see Creating the ewsys Database User).

4. Open the file epim.sql in SQL Studio query tool.


Page 43 of 247 Revised 10/18/2018

5. Ensure the EPIM database is selected (in the top-left drop-down list, the example below

shows EPIMTraining database, but normally the database name would be EPIM).

6. Click the Execute button (to the right of the database selection dropdown) to execute

the script.

7. Create the EPX database in the same manner as the EPIM database was created.

8. Assign user ewsys as database owner (see Creating the ewsys Database User).

9. Open the file epx.sql in SQL Studio query tool.

10. Click crtl+h to open the search and replace window.


Page 44 of 247 Revised 10/18/2018

11. Search for the term @APP_SERVER_NAME@ and replace it with the name of your App

server.

To retrieve your server name:

a. Click ctrl+r

b. Type cmd and press the enter key.

c. Type the hostname in the command line window and the press enter key.

12. Click the Replace All button.

13. Search for the term @WEB_SERVER@ and replace it with the name of your Web server.

If installing a single server configuration, the server name will be the same as the App

server.

14. Click the Replace All button.

15. Ensure the EPX database is selected (in the top-left drop-down list).

16. Click the Execute button to the right to execute the script.

5.5.5 Enable Application Installation

Enable can be configured to run on one or two servers, with up to four slaves. Single-server configurations will place all the components in one server. Two-server configurations require distributing components between a Web server and an App server.

The components to be installed are:

• EPIM JBoss (Master or Independent)

• EPIM Tomcat

• EPIM JBoss Slave 1-4

• Enable Web

• EPX JBoss

• EPX Tomcat

• PIMQL

NOTE: Each JBoss and Tomcat component (including slaves) requires a dedicated CPU with at least 1GB memory.


Page 45 of 247 Revised 10/18/2018

5.5.5.1 Possible Component Distributions

This section lists possible configurations according to the desired number of servers and slaves. For directions on performing the installation of a configuration, see First Steps for All Configuration Options.

Type of Configuration Single Server/Web Server App Server

Single Server Independent

• EPIM Tomcat

• EPIM JBoss Independent

• Enable Web

• EPX JBoss

• EPX Tomcat

• PIMQL

None

Single Server with Two Slaves

• EPIM JBoss Master

• EPIM JBoss Slave 1


• EPIM Tomcat

• Enable Web

• EPX JBoss

• EPX Tomcat

• PIMQL

None

Two Servers with Two Slaves

• EPIM Tomcat


• Enable Web

• PIMQL

• EPX Tomcat



• EPX JBoss

Two Servers with Three Slaves

• EPIM Tomcat


• Enable Web

• PIMQL

• EPX Tomcat




• EPX JBoss


Page 46 of 247 Revised 10/18/2018

Type of Configuration Single Server/Web Server App Server

Two Servers with Three Slaves Alternate

• EPIM Tomcat



• Enable Web

• PIMQL

• EPX Tomcat



• EPX JBoss

Two Servers with Four Slaves

• EPIM Tomcat



• Enable Web

• PIMQL

• EPX Tomcat




• EPX JBoss

5.5.5.2 Install Components

The Enable installer installs the necessary components on one server at a time. Two-server configurations are built by installing a Web server with one or more slaves and an App server with one or more slaves.

5.5.5.2.1 First Steps for All Configurations

1. Run the installer EWSetup.exe in administrator mode. (Right-click on File and select

Run as Administrator.


Page 47 of 247 Revised 10/18/2018

2. The Enable Installation wizard appears.



Page 48 of 247 Revised 10/18/2018

4. Accept the license agreement radio button.



Page 49 of 247 Revised 10/18/2018

6. Select the configuration option associated with the server being installed (see Possible

Configurations).


8. Choose an install folder or leave it as the default.


10. Enter the database connection information.

First set of database connection information:


Page 50 of 247 Revised 10/18/2018

Second set of database connection information:


Page 51 of 247 Revised 10/18/2018

11. Click Next.

12. The installer will then check the database connection parameters. If the connection fails,

it will show the following error message and let the user continue with the installation

or go back and correct the connection information.

a. Common Reasons for failure:

i. Server Network Configuration TCP/IP protocol is disabled.

ii. Server Network Configuration TCP/IP ports not specified.

13. The following sections contain the instructions for the remaining steps needed to Install

Enable.

5.5.5.2.2 Build a Specific Configuration

After the initial Installation steps are performed (see First Steps for All Configuration Options), the specific configuration must be built.

To build a single-server configuration, follow the directions for that configuration as listed below.


Page 52 of 247 Revised 10/18/2018

To build a two-server configuration, first follow the steps for installing a Web server with the desired number of slaves, then follow the steps for installing an App server with the desired number of slaves. (See Possible Component Distributions for an installation map.)

5.5.5.2.2.1 Single Server Independent

The Single Server Independent configuration uses no slaves and is contained in one server. Its components consist of:

• EPIM Tomcat

• EPIM JBoss Independent

• Enable Web

• EPX JBoss

• EPX Tomcat

• PIMQL

From the Enable Installer Get Server Information page:

1. Click Next.

2. The Tomcat Port window will appear.


Page 53 of 247 Revised 10/18/2018

2. Click the Next button to accept the Tomcat Ports.

3. The JBoss Independent Ports window will appear.


Page 54 of 247 Revised 10/18/2018

4. Click Next to get to the EPX Ports page.

The configuration specific instructions have been completed. To finish the installation, go to Final Steps for All Configurations.

5.5.5.2.2.2 Single Server Master 2 Slaves

This configuration has one server with two slaves. It consists of the following components:

• EPIM Tomcat




• Enable Web

• EPX JBoss

• EPX Tomcat

• PIMQL

From the Enable Installer Get Server Information page:


Page 55 of 247 Revised 10/18/2018

1. Click the Next button to accept the server information.

2. Click the Next button to accept the Tomcat ports.


Page 56 of 247 Revised 10/18/2018

3. Click the Next button to accept the JBoss Master Ports.

4. Click the Next button to accept the JBoss Slave 1 Ports.


Page 57 of 247 Revised 10/18/2018

5. Click the Next button to accept the JBoss Slave 2 Ports.

6. Click Next to get to the EPX Ports page.


5.5.5.2.2.3 Web Server Master Only or 4th Slave

Configurations with two servers (a Web server and an App server) have 2 -3 slaves on the App server. An additional slave (slave 4) can be configured on the Web server. The instructions here pertain to building a Web server configuration with or without a 4th slave.

This configuration consists of the following components and should be executed on the Web server:

• EPIM Tomcat


• Enable Web

• PIMQL

From the Enable Installer Get Web and App Server Information page:


Page 58 of 247 Revised 10/18/2018

1. Update the App Server name. The Web Server will default to the Web server it is being

installed on.

2. Click the Next button to accept the Web and App Server information.


Page 59 of 247 Revised 10/18/2018

3. Modify the Tomcat Ports if necessary.

4. Click the Next button to accept the Tomcat Ports for the Web server.

5. Modify the JBoss Master Ports value if necessary.

6. Click the Next button to accept the JBoss Master Ports for the Web server.


Page 60 of 247 Revised 10/18/2018

7. Modify the JBoss Slave 1 Port value if necessary.

8. Click the Next button to accept the JBoss Slave 1 Port for the Web server.


Page 61 of 247 Revised 10/18/2018

9. Modify the JBoss Slave 2 Port value if necessary.

10. Click the Next button to accept the JBoss Slave 2 Port for the Web server.

5. If a third slave is needed, repeat the last two steps for Slave Port 3. If not, click the Next

button to quit adding slaves.

6. If a forth slave is needed, repeat those steps again for Slave Port 4. If not, click the Next

button to quit adding slaves.

The process of configuring the Web server is complete. Continue on to configure the App server.

5.5.5.2.2.4 App Server with 2 or 3 Slaves

App servers can have up to three slaves. The following components should be executed on the App server:

• EPX Tomcat




Page 62 of 247 Revised 10/18/2018

• EPIM JBoss Slave 3 (optional)

• EPX JBoss

From the Enable Installer Get Web and App Server specification page:

1. Enter the Web Server and App Server names and the Shared Key.



Page 63 of 247 Revised 10/18/2018

3. Modify the Tomcat Ports value if necessary.

4. Click the Next button to accept the TomcatPort for the App server.


Page 64 of 247 Revised 10/18/2018

5. Modify the JBoss Master Port value if necessary.

6. Click the Next button to accept the JBoss Master Port for the Web server.

NOTE: It is not necessary to have a slave 3 on the Web Server to have a Slave 4 on the App Server.

7. For slaves 1 through 3 (slave 3 is optional):

a. Modify the JBoss Slave x Ports values if necessary.

b. Click the Next button to accept the JBoss Slave x Port for the Web server.


Page 65 of 247 Revised 10/18/2018

8. If a JBoss Slave 4 is required:

a. Check the checkbox next to Slave 4.

b. If necessary, modify the JBoss Slave 4 Port value.

c. Click the Next button to accept the JBoss Slave 4 Port.

9. If a JBoss Slave 4 is not required, just click the Next button.


Page 66 of 247 Revised 10/18/2018


5.5.5.2.3 Final Steps for All Configurations

From the Enable Installer Get EPX ports page:


Page 67 of 247 Revised 10/18/2018

1. If necessary, modify the EPX Server Port. (Note that on a two server configuration, this

will only be installed on the App server).

2. Click the Next button to accept the EPX Server Port.

1. If necessary, modify the PIMQL Host and Port values. (Note that on a two-server

configuration, this will only be installed on the Web server).


Page 68 of 247 Revised 10/18/2018

2. Click the Next button to accept the PIMQL Host and Port values.

NOTE: Shared Directory is for exports, publications and imports. If sharing across the two servers, then the server path should be the UNC network path: //<servname>/<SharedfolderName>

3. Setup a shared network directory (recommended on the App server). Click the Next

button to accept the Shared Directory or modify as needed.

NOTE: Shared Directory is for exports, publications and imports. If sharing across the two servers, then the server path should be the UNC network path: //<servname>/<SharedfolderName>

4. Setup a shared network directory (recommended on the App server). Modify the

Shared Directory values as needed.

5. Click the Next button to accept the Shared Directory values.


Page 69 of 247 Revised 10/18/2018

6. Modify the values for the Shortcut Folder as necessary.

7. Click the Next button to accept the Shortcut Folder.


Page 70 of 247 Revised 10/18/2018

8. Verify the installation information.


5.5.5.3 Configure IIS Application

After installing the selected Enable configuration:

1. From the Start menu, go to User Accounts.

2. Click Manage Another User Account.


Page 71 of 247 Revised 10/18/2018

3. Click Add a User Account


Page 72 of 247 Revised 10/18/2018

4. Create new ewservice user account with password Enterworks?123

5. Grant Full Control permission to the <drive>:\Enterworks folder.

a. Right click on the <drive>:\Enterworks folder and select Properties.

b. Click Edit.

c. Click Add.

d. Type ewservice into the Enter the object names box.

e. Click Check Names.

f. Click OK.

g. Click on ewservice in the Group or User Names box.

h. Click the checkbox for Full Control.

i. Click Apply.

6. Grant Modify Permission to

<drive>:\Windows\Microsoft.NET\Framework\<version>\Temporar

y ASP.NET

files and

<drive>:\Windows\Microsoft.NET\Framework64\<version>\Tempor

ary ASP.NET

files, where <version> is replaced with the current version number for Microsoft .NET Framework CLR in Third-party Software Versions.

7. Open IIS, From Start Menu → Administrative Tools → Internet Information Services (IIS)

Manager.

8. Expand the <server name> folder

9. Click the Application Pools node and click the Add Application Pool… link.


Page 73 of 247 Revised 10/18/2018

10. Enter Enable in the Name field.

11. Select the .NET CLR Version <version> option, where <version> indicates the version

number as per Third-party Software Versions.


13. Select the newly created application pool and click the Advanced Settings… link:


Page 74 of 247 Revised 10/18/2018

14. In the advanced settings window…

a. Update the setting Enable 32-Bit Applications under the General section to

True.

b. Set the application to run as the network service user account network account

by taking the following actions:

i. Click on the three dots (…) for the Identity option:

ii. Select Custom Account and click the Set button.

iii. Enter username and credentials for the enable account.


Page 75 of 247 Revised 10/18/2018

iv. Click the OK button.

c. Click the OK button.

15. Expand the Sites folder and select the Default Web Site.

16. From the Actions menu, select Basic Settings.

17. Select the Select button next to Application pool and select the enable app pool.

18. Be sure to click the test settings button also to verify connections.

19. Click OK to exit.


Page 76 of 247 Revised 10/18/2018

20. Click the Default Documents feature under the IIS section and click enter.

21. If default.aspx does not exist then add default.aspx to the list of sites in the Action

window. At the site level, move default.aspx to the top of the list.

22. Right-click Default Web Site and select Add Virtual Directory.

a. Enter enable into Alias.

b. Enter <drive>:\Enterworks\EnableWeb into the physical path.

c. Click the Connect as… button.


Page 77 of 247 Revised 10/18/2018

d. Enter credentials for the network account. Be sure to click the Test Settings

button to verify settings.

e. Click the OK button.

f. Right-click on the enable virtual directory and select Convert to Application.


Page 78 of 247 Revised 10/18/2018

g. Select Application pool as enable. Be sure to click the test settings button,

too.

h. Click OK.


i. Alias: damroot

j. Physical Path: <drive>:\Enterworks\Damroot

k. Connect As…: Enter credentials for the network account.

NOTE: Be sure to click the test settings button also.


Page 79 of 247 Revised 10/18/2018

l. Click OK.

24. Verify the ISAPI Module and ISAPI Filter Modules are installed in IIS. To verify, open IIS

Manager and select Features View tab at the bottom of the center Home screen. See

the grouping of IIS and double click on Modules.


Page 80 of 247 Revised 10/18/2018

25. Once you open the feature, check that the highlighted Modules (in picture below) are

installed.

NOTE: If it is not installed, install this feature by following the directions in Windows IIS & Microsoft .NET Installation.

26. Select the IIS Server Node, then open the ISAPI/CGI Restrictions feature from Feature

View.


Page 81 of 247 Revised 10/18/2018

27. Once you open the feature, the list of already allowed ISAPI’s and CGI’s will be

displayed. A new ISAPI Restriction must be added, so click on Add from the Actions

Pane on the right. The Add ISAPI or CGI Restriction screen will appear.


Page 82 of 247 Revised 10/18/2018

28. Set the ISAPI DLL path to

<drive>:\enterworks\IISProxy\isapi_redirect.dll

29. Set Description to jakarta.

30. Select the checkbox for Allow extension path to execute (below the Description field).

31. Click OK.

32. The Default Web Site Home window will appear.

33. Select the Default Web Site node from the menu tree on the left.

34. Select ISAPI Filter.

35. Once you open the feature, the list of already applied filters will be visible. A new filter is

necessary, so select Add from the Actions pane on the right.


Page 83 of 247 Revised 10/18/2018

36. Once you open the feature, the list of already applied filters will be visible. A new filter is

necessary, so select Add from the Actions pane on the right.

37. Set Filter Name to jakarta.

38. Set Executable to <drive>:\enterworks\IISProxy\isapi_redirect.dll

39. Click OK.

40. The Default Web Site Home window will appear.


Page 84 of 247 Revised 10/18/2018

41. Select the Default Web Site node from the menu tree on the left.

42. Select Handler Mapping.

43. Select Edit Feature Permission for the ISAPI-dll.

44. Select checkboxes to grant Read, Script and Execute permissions.

45. Click OK.



Page 85 of 247 Revised 10/18/2018

47. Set Alias to jakarta

48. Set Physical Path to <drive>:\Enterworks\IISProxy

49. Click Connect As….

50. Enter the credentials for the network account.

51. Be sure to click the test settings button too.


5.5.5.4 Post Installation Steps

1. Log into Enable through the web browser as the system user.

a. If not accessible, create an inbound firewall connection rule.

2. Apply the latest patch.

3. Open the DamConfig repository.

4. Replace the SourceFolder and DestinationFolder’s Key values to reflect the installation

path if different than the default as shown below.

5. Replace the <servername> with your servername in the UNCPath,

DamAsssetURL, DamAssetPath, and EPIMURL Key values.


Page 86 of 247 Revised 10/18/2018

Key Value

SourceFolder <drive>:\Enterworks\Shared\DAM_Drop

DestinationFolder <drive>:\EnterWorks\Shared\DAMRoot\Original

UNCPath \\<servername>\Shared\DAMRoot\Original

DamAssetURL http://<servername>/Damroot

DamAssetPath \\<servername>\Shared\DAMRoot

EPIMURL http://<servername>/webcm/

5.6 Modular Deployment Procedures

The following section provides deployment procedures for the various modules used by the Enable basic installation:

1. Configure the DAM.

2. Confirm the Enable DAM (.NET) application is functional.

3. Update the application configurations.

4. Load data.

5. Deploy the Home Page Widget JSPs.

5.6.1 Configure the DAM

Before configuring the DAM, create the following directories in the NAS where DAM images are to be stored.

IMPORTANT: Replace references to <DEV> with the appropriate name depending on the target environment.

5.6.1.1 Create New Directories

Create the directories necessary for the configuration described in the following steps. Here are examples:

• \\Northamerica\ADFS9\DEPT\Data\D108740_LA\AN_PIM\<DEV>\DAMRoot

\WebDisplay


Page 87 of 247 Revised 10/18/2018


\Original


\StoreDisplay


\MobileDisplay


\Thumbnail

• \\Northamerica\ADFS9\DEPT\Data\D108740_LA\AN_PIM\<DEV>\DAM_Dro

p

5.6.1.2 Update Environment-Specific Configurations

To configure the DAM to the above two directories, updates to the DAMConfig and

DAMVariants repositories are needed:

• DAMConfig – provides configurations like DAMRoot path (i.e., NAS directory path),

Image URL, etc.

• DAMVariants – provides configurations for the different image variants (i.e.,

Thumbnail, WebDisplay, StoreDisplay, etc.)

To make the necessary configuration changes, take the following steps:

1. Log into Enable and export all data (all attributes) for DAMConfig and DAMVariant

repositories by taking the following these steps:

a. In the Features Bar, in the Content menu, navigate to DAMConfig.


Page 88 of 247 Revised 10/18/2018

b. Select all records in the DAMConfig repository by first checking the All

checkbox and then the Export icon.

c. Leave the defaults in the pop-up window and click Export.


Page 89 of 247 Revised 10/18/2018

d. Navigate to the Job Monitor via the Quick Links drop-down.

e. In Job Monitor, click the Reload button to check progress of your job.


Page 90 of 247 Revised 10/18/2018

2. Retrieve the resulting export file by clicking the Download icon.

3. Choose the option to open the file.


Page 91 of 247 Revised 10/18/2018

4. Open the Excel file contained in the downloaded .zip file.

5. Edit the Excel file in above steps and update the following environment-specific settings

to values pertinent to the target environment.


Page 92 of 247 Revised 10/18/2018

a. References to DEV (from screenshot above) in any of the physical path values

need to be replaced by the target environment’s specific directory name. This

should point to the DAMRoot folder created in the previous procedures.

b. References to the source environment’s Web server name ww00512d (from the

screenshot above) in any of the URL values need to be replaced by the target

environment’s Web server name: <WebServerName>.

c. Save the Excel file in your local directory for later retrieval.

6. Navigate back to the DAMConfig repository as detailed in step 1b.

7. Once in the DAMConfig repository, click the Import icon.

8. The Import window will appear.


Page 93 of 247 Revised 10/18/2018

9. Click Next.


Page 94 of 247 Revised 10/18/2018

10. Click the Browse button to find the generated excel file.

11. Click Next.

12. Enable will auto-map the source columns to repository field names. Click Finish.


Page 95 of 247 Revised 10/18/2018

13. Navigate to the Job Monitor via the Quick Links drop-down.

14. In Job Monitor, click the Refresh button to check progress of the job.


Page 96 of 247 Revised 10/18/2018

Once completed, navigate back to the DAMConfig repository and confirm that all 24 records

exist.


Page 97 of 247 Revised 10/18/2018

15. Repeat above steps for DAMVariants repository. Update the environment-specific

settings to the DAMVariants’ export file as follows.

a. References to DEVINT in the OutputPath column need to be replaced by the

target environment’s specific directory name. This should point to the

DAMRoot folder created in Pre-installation Requirements.

b. Expected record counts: 5.


Page 98 of 247 Revised 10/18/2018

5.6.1.3 Update IIS Settings

1. On the Web server open IIS and edit Basic Settings for the DAMRoot virtual directory.

2. Update Physical Path to the environment-specific DAMRoot folder created in previous

steps. For example:

\\Northamerica\ADFS9\DEPT\Data\D108740_LA\AN_PIM\QA\DAMRoot

3. Click OK.


Page 99 of 247 Revised 10/18/2018

4. Restart IIS: Click Start, type CMD to drop to DOS, and type IISRESET.

5.6.2 Confirm DAM Application is Functional

Now that all required Enable objects are present, confirm that the DAM (which is reliant on those objects) is accessible by following these steps:

1. Restart EnterWorks services on both the web and App servers by taking the following

steps (in this order):

a. Stop Sequence:

i. Stop App Services via:

<drive>:\Enterworks\bin\Stop Enterworks.cmd.

ii. Stop Web Services via:

<drive>:\Enterworks\bin\Stop Enterworks.cmd.

b. Start Sequence:

i. Start Web Services via:

<drive>:\Enterworks\bin\Start Enterworks.cmd.

ii. Start App Services via:

<drive>:\Enterworks\bin\Start Enterworks.cmd.

2. When services are back up, navigate to Asset Explorer via the Enable UI:

a. Open up the Feature Bar by clicking on the arrow in the top left corner of the

page:


Page 100 of 247 Revised 10/18/2018

b. Click the Assets menu in the Feature Bar and select Asset Explorer. The Asset

Explorer tab should open up and show the following page. It can take a moment

for the page to come up after the initial install or after an IIS restart.

NOTE: If the Enable (.NET) application is not accessible to the primary application (tomcat), then you’ll get some type of Page Not Found notification. This could be a problem with either the .NET installation directory or IIS (ARR setup).


Page 101 of 247 Revised 10/18/2018

5.7 Update Application Configurations

The following steps provide instructions for updating the configuration files containing most of the environment-specific variables used by various processes.

1. Remote connect to the Web server (<WebServerName>) of the target environment

and navigate to

<drive>:\Enterworks\EnableServerMaster\tomcat\webapps\webcm

\WEB-INF\classes.

2. Copy the file WorkflowHandlerConfig.properties from a source

environment’s Web server:

\\<WebServerName>\E$\Enterworks\EnableServerMaster\jbo

ss\server\default\conf

to a local place on your computer.

3. Edit the WorkflowHandlerConfig.properties file on your local computer and

update the following property as follows:

integration.epx.url=http://<WebServerName>:9040/tm/app

s/enable/directCreateWorkItem.jsp

4. Save the changes.

5. Copy the modified WorkflowHandlerConfig.properties from your local

computer to each of the following directories, overriding the existing files:


Page 102 of 247 Revised 10/18/2018



\\<AppServerName>\E$\Enterworks\EnableServerSlave1\jbo




6. Add Promotion and Trigger processing configuration properties to the

sharedConfig.properties file in each of the following directories:



\\<WebServerName>\E$\Enterworks\EnableServerMaster\tom

cat\webapps\webcm\WEB-INF\classes





a. Add Promotion Configuration Properties. Add the properties included in the

embedded text file below to all four sharedConfig.properties. (The text

is installation specific. Modify it as necessary.) Reference the screenshot below

for placement. If content exists between the two points displayed in the

screenshots below, it should be replaced by the new properties in the above

embedded text file.


Page 103 of 247 Revised 10/18/2018

b. Add Trigger Configuration Properties. Add the properties included in the embedded

text file below to all four sharedConfig.properties.

Reference the screenshot below for placement. If content exists between the two points displayed in the screenshots below, it can be replaced by the new properties in the above embedded text file.


Page 104 of 247 Revised 10/18/2018

7. Restart Enterworks services on both the Web server and App server by taking the

following steps (in this order):

a. Stop Sequence


<drive>:\Enterworks\bin\Stop Enterworks.cmd



iii. Delete the directory localhost from the following directory:

\\<WebServerName>\E$\Enterworks\EnableServerMaste

r\tomcat\work\Catalina

b. Start Sequence


Page 105 of 247 Revised 10/18/2018

i. Start Web Services via:

<drive>:\Enterworks\bin\Start Enterworks.cmd

ii. Start App Services via:

<drive>:\Enterworks\bin\Start Enterworks.cmd

5.8 Install and Deploy Jasper Server Reports

5.8.1 Install Jasper Tomcat Server

In these instructions, in addition to replacing <drive>, replace <version> with the appropriate version number, per Third-party Software Versions.

1. Set the appropriate permissions on the SQL server login epimsys to allow it to create a

database on the target server. The Jasper server installer will require these permissions

as the installer will create the database along with the schema.

2. On the Web server, unzip the file:

apache-tomcat-<version>-windows-x64.zip

to a new directory called:

<drive>:\Enterworks\Jasper.

The result should be a directory named apache-tomcat-<version> in

<drive>:\Enterworks\Jasper.

3. Copy <drive>:\temp service.bat to:

<drive>:\Enterworks\Jasper\apache-tomcat-<version>\bin.

Overwrite the existing file.

4. Unzip the file:

jasperreports-server-<version>-bin.zip

to:

<drive>:\temp.

The result should be a directory called jasperreports-server-<version>-

bin in <drive>:\Enterworks\Jasper.

5. Copy the file default_master.properties from:

<drive>:\temp


Page 106 of 247 Revised 10/18/2018

to:

<drive>:\temp\jasperreports-server-<version>-

bin\buildomatic\

6. Edit the file:

<drive>:\temp\jasperreports-server-<version>-

bin\buildomatic\default_master.properties

and set the appropriate environment-specific settings for dbHost,dbInstance,

dbUsername, and dbPassword. Note, the screenshot below is an example; use

target environment settings.

7. Open up the command prompt as administrator and run the following commands:

a. Change to the buildomatic directory under

<drive>:\temp\jasperreports-server-<version>-bin by

executing the following commands:

cd <drive>:\temp\jasperreports-server-<version>-

bin\buildomatic

<drive>:


Page 107 of 247 Revised 10/18/2018

b. Run the following command:

js-install.bat minimal

c. A series of steps performed by the installer will be displayed in the command

window. This could take more than 20 minutes.


Page 108 of 247 Revised 10/18/2018

d. Successful installation will display the following message on the command

window:

e. Close the cmd prompt.


Page 109 of 247 Revised 10/18/2018

8. Install the jasperReportsTomcat windows service by executing the following

commands on a new cmd prompt:

cd <drive>:\Enterworks\Jasper\apache-tomcat-6.0.41\bin

<drive>:

service.bat install jasperReportsTomcat

9. Rename tomcat6w.exe in <drive>:\Enterworks\Jasper\apache-

tomcat-<version>\bin to jasperReportsTomcat.exe.


Page 110 of 247 Revised 10/18/2018

10. Copy jasperserver.license from <drive>:\temp to

<drive>:\Enterworks\Jasper\apache-tomcat-

<version>\webapps\jasperserver-pro

11. From <drive>:/temp copy the following jar files:

jasperreports-htmlcomponent-<version>.jar

jtds-<version>.jar

Copy to:

<drive>:/Enterworks/Jasper/apache-tomcat-

<version>/webapps/jasperserver-pro/WEB-INF/lib

12. Open security-config.properties for editing. It is located here:

<drive>:/Enterworks/Jasper/apache-tomcat-

<version>/webapps/jasperserver/WEB-INF/classes/esapi

13. Set the following property to false: security.validation.sql.on=false

14. Go to the services console and set the jasperReportsTomcat service to run as the

SVC-PIM-QA network service account.


Page 111 of 247 Revised 10/18/2018

15. Start the jasperReportsTomcat service.

16. Confirm the server is accessible by opening up a web browser and going to

http://<servername>:8080/jasperserver-pro/

NOTE: Use the appropriate server name in the URL for the target environment.


Page 112 of 247 Revised 10/18/2018

The Jaspersoft login window should appear. Note that upon initial startup, it may take a few minutes to see the login screen:

17. In the Jaspersoft login window, log in as User ID: superuser Password: superuser

18. Uncheck the Heartbeat Data Collection Opt-in checkbox.


Page 113 of 247 Revised 10/18/2018

19. A successful installation will display the following page upon login:

20. The Jasper reports server is now installed.

5.8.2 Deploy Reports

1. Log on to JasperReports by opening up a web browser and going to:

http://<servername>:8080/jasperserver-pro/

NOTE: Use the appropriate server name in the URL for the target environment.

2. In the Jaspersoft login window, log in as User ID: superuser Password:

superuser.

3. Click on the Manage menu option and choose Server Settings.


Page 114 of 247 Revised 10/18/2018

4. Click the Import icon on the Settings pane on the left side of the screen.

a. Browse to the file: <drive>:\temp\deployJasperReports.zip

b. Ensure that all Import options are NOT selected.

c. Click the Import button. A Please Wait message will appear.


Page 115 of 247 Revised 10/18/2018

5. Upon successful import, you will see a message on the top of the page. Click the close

link.

6. Click the View drop-down menu and select Repository.

7. In the Repository view, navigate down to the Reports folder and confirm that you see

all imported reports.


Page 116 of 247 Revised 10/18/2018

8. Click on the Data Source folder, click the Enable data source name and click the Edit

button.

9. Make the appropriate updates to environment-specific settings (URL and Password).

Test your connection and, when successful, click the Save button.


Page 117 of 247 Revised 10/18/2018

10. Navigate back to the repository via View > Repository. In the navigation tree, navigate

down to the Reports folder and click on a report to run it and confirm successful

execution.


Page 118 of 247 Revised 10/18/2018

11. The JasperReports have now been deployed.

5.8.3 Install iReport

In this section, <version> refers to the Jaspersoft IReport Designer Professional version number as per Third-party Software Versions.

1. Right click <drive>:\temp\iReport-Professional-<version>-

windows-installer.exe and run as administrator.

2. The Jaspersoft IReport Designer Professional <version> Setup wizard window opens.

Click Next.

3. The License Agreement wizard step appears. Accept the license agreement by clicking

the button I Agree.

4. The Choose Components wizard step appears. Leave the default Jaspersoft iReport

Designer Professional <version> selected and click Next.

a. The Choose Install Directory wizard step appears. Set Destination Folder to

<drive>:\Enterworks\Jasper\iReport-Professional-

<version>

5. The Choose Start Menu Folder wizard step appears. Leave the default value of:

Jaspersoft\iReport-Professional-<version>

and click the Install button.

6. At the end of the install process, a confirmation appears. Leaving Run Jaspersoft

iReport Designer Professional <version> selected, click the Finish button.


Page 119 of 247 Revised 10/18/2018

7. iReport opens and provides a prompt to install the license. If the prompt does not

appear, skip to step SelectJasperRepository.

8. Click the Install New License button.


Page 120 of 247 Revised 10/18/2018

9. When prompted to browse, choose the file:

<drive>:\Enterworks\Jasper\apache-tomcat-

<version>\webapps\jasperserver-

pro\jasperserver.license

10. A confirmation window will appear.

11. From the Window menu, select JasperReports Server Repository.


Page 121 of 247 Revised 10/18/2018

12. The Report Navigator panel opens on the left side of iReport. Click the Add new server

button.

13. The JasperServer Plugin window opens. Set the following values:

ID: localhost

JasperReports Server URL: http://localhost:8080/jasperserver-pro/services/repository


Page 122 of 247 Revised 10/18/2018

Username: superuser

Password: superuser

14. The new server is displayed in the Repository Navigator panel. Open the localhost

node and confirm that the customer specific folder and corresponding subfolders are

listed.


Page 123 of 247 Revised 10/18/2018

15. iReport is now installed.

5.8.4 Integrate Jasper Reports with EnterWorks Enable

1. Open the tomcat sharedConfig.properties file for editing. The file is

located at:

\\<WebServerName>\Enterworks\EnableServerMaster\tomcat\we

bapps\webcm\WEB-INF\classes

Add the following entry at the end of the file:

################################################################

#########

# Report Manager Settings

################################################################

#########

report.manager.url=http://<jasperreportsservername>:8080/jaspers

erver-

pro/flow.html?_flowId=homeFlow&j_username=superuser&j_password=s

uperuser


Page 124 of 247 Revised 10/18/2018

report.listing.url=http://<WebServerName>:8080/jasperserver-

pro/flow.html?_flowId=searchFlow&mode=search&j_username=superuse

r&j_password=superuser

2. Open the EPX Enterworks.properties file for editing. The file is located at:

\\<AppServerName>\\Enterworks\EPX32\bin\conf

Add the following entry at the end of the file. The target directories can be set to any place on the network that the Enable services account has access to. Customize the code below as necessary.

##Jasper report scheduler properties

jasper.server.url=http://<WebServerName>:8080/jasperserver-

pro/services/repository

jasper.server.login=superuser

jasper.server.password=superuser

jasper.targetDirectory.brands=\\\\wa00433q\\Enterworks\\<cu

stomer specific>\\ProductGuides\\Brands

jasper.targetDirectory.brandFamilies=\\\\ <AppServerName>

\\Enterworks\\<customer

specific>\\ProductGuides\\BrandFamilies

jasper.targetDirectory.categories=\\\\ <AppServerName>

\\Enterworks\\<customer

specific>\\ProductGuides\\Categories

3. Open the EPX web wrapper file EPX_WEB_9040_9039_wrapper for editing.

The file is located at: \\wa00433q\\Enterworks\EPX32\bin\.

After the entry: wrapper.java.classpath.61=../lib/Services.jar, add the following entries:

wrapper.java.classpath.62=../lib/com-jaspersoft-ireport-

jasperserver.jar

wrapper.java.classpath.63=../lib/com-jaspersoft-ireport.jar

wrapper.java.classpath.64=../lib/commons-collections-3.2.jar

wrapper.java.classpath.65=../lib/commons-digester-1.7.jar

wrapper.java.classpath.66=../lib/commons-logging-1.0.4.jar

wrapper.java.classpath.67=../lib/itext-2.1.7.js2.jar

wrapper.java.classpath.68=../lib/jasperreports-5.2.0.jar


Page 125 of 247 Revised 10/18/2018

wrapper.java.classpath.69=../lib/jasperreports-fonts-5.0.0.jar

wrapper.java.classpath.70=../lib/jasperreports-htmlcomponent-

5.0.1.jar

wrapper.java.classpath.71=../lib/jasperserver-common-ws-

5.2.0.jar

wrapper.java.classpath.72=../lib/js_activation-1.1.jar

wrapper.java.classpath.73=../lib/js_axis-1.4patched.jar

wrapper.java.classpath.74=../lib/js_commons-codec-1.3.jar

wrapper.java.classpath.75=../lib/js_commons-discovery-0.2.jar

wrapper.java.classpath.76=../lib/js_commons-httpclient-3.1.jar

wrapper.java.classpath.77=../lib/js_jaxrpc.jar

wrapper.java.classpath.78=../lib/js_mail-1.4.jar

wrapper.java.classpath.79=../lib/js_wsdl4j-1.5.1.jar

wrapper.java.classpath.81=../lib/log4j-1.2.15.jar

wrapper.java.classpath.82=../lib/org-openide-util-7.2.jar

wrapper.java.classpath.83=../lib/org-openide-util-lookup-

8.3.1.jar

wrapper.java.classpath.84=../lib/servlet-api-2.4.jar

wrapper.java.classpath.85=../lib/xercesImpl-2.10.0.jar

wrapper.java.classpath.86=../lib/xml-apis-1.4.01.jar

4. Copy all jar files in:

<drive>:\temp\JasperJars

to:

\\<AppServerName>\\Enterworks\EPX32\lib

When prompted, overwrite any files already existing in the target directory.

Contents of the <drive>:\temp\JasperJars directory include:

com-jaspersoft-ireport-jasperserver.jar

com-jaspersoft-ireport.jar

commons-collections-3.2.jar

commons-digester-1.7.jar


Page 126 of 247 Revised 10/18/2018

commons-logging-1.0.4.jar

itext-2.1.7.js2.jar

jasperreports-5.2.0.jar

jasperreports-fonts-5.0.0.jar

jasperreports-htmlcomponent-5.0.1.jar

jasperserver-common-ws-5.2.0.jar

js_activation-1.1.jar

js_axis-1.4patched.jar

js_commons-codec-1.3.jar

js_commons-discovery-0.2.jar

js_commons-httpclient-3.1.jar

js_jaxrpc.jar

js_mail-1.4.jar

js_wsdl4j-1.5.1.jar

log4j-1.2.15.jar

org-openide-util-7.2.jar

org-openide-util-lookup-8.3.1.jar

servlet-api-2.4.jar

xercesImpl-2.10.0.jar

xml-apis-1.4.01.jar

5. Stop Jasper services on the Web server via the Services console.

6. Start Jasper services on the Web server via the Services console.

7. Restart EnterWorks services on both the Web server and App server by performing

the following steps (in this order):

a. Stop Sequence:





b. Start Sequence:


Page 127 of 247 Revised 10/18/2018

i. Start Web Services via <drive>:\Enterworks\bin\Start

Enterworks.cmd

ii. Start App Services via <drive>:\Enterworks\bin\Start

Enterworks.cmd

8. Stop EPX services on the App server by running the script (as admin):

<drive>:/Enterworks/bin/Stop EPX.cmd.

9. Start EPX services on the App server by running the script (as admin):

<drive>:/Enterworks/bin/Start EPX.cmd.

10. Log on to Enable and confirm that Jasper reports is accessible from the Report

Manager menu:

11. Jasper is now integrated with Enable.

5.9 To Uninstall Jasper Reports

1. Uninstall iReport via Start -> All Programs -> Jaspersoft -> iReport-Professional-

<version> -> Uninstall.


Page 128 of 247 Revised 10/18/2018

2. Stop jasperReportsTomcat using Administrative Tools / Services window.

3. Delete the above windows service by running the following scripts via cmd line:

sc delete jasperReportsTomcat

4. Delete directories:

<drive>:\Enterworks\Jasper

6 SecureAuth Integration

Enable can integrate with SecureAuth to authenticate for user login. This will enable a Single Sign-on into the environment and the Enable system. When this feature is turned on, all users must be authenticated by the SecureAuth system. The only way to logon using a local user or system user would be to physically be signed onto the server.

The SecureAuth service can be setup to use Identity Provider (IdP) initiated authentication or Service Provider (SP) initiated authentication.


Page 129 of 247 Revised 10/18/2018

6.1 Installation

6.1.1 Enable Server Patch

1. Stop all Enable Services.

2. Apply latest Enable Server Patch build.

3. Copy the files serializer.jar, xercesImpl.jar and xml-apis.jar

from the install endorsed folder to the following folder, overwriting files:

<EnableServerInstallDir>\tomcat\common\endorsed

6.1.2 IdP Installation

In this section, <version> should be replaced by the version number indicated in Third-party

Software Versions.

1. Modify the sharedConfig.properties file in the folder:

<EnableServerInstallDir>\tomcat\webapps\samlplugin\WEB-

INF\classes

at around line# 868. (Repeat for all JBoss servers):

fromApp.list=enable,secureAuth

#

#SecureAuth Settings

#

fromApp.secureAuth.trustedSignOn=true

fromApp.secureAuth.name=SecureAuth

fromApp.secureAuth.gId=**********

# type - 0 SAML <version> IDP initiated, 1 - SAMLE

<version> SP initiated

fromApp.secureAuth.idp.type=0

fromApp.secureAuth.idp.url=https://secureauth01aaws.enterwo

rks.com/SecureAuth2/

fromApp.secureAuth.certificate.validate.signature=false

fromApp.secureAuth.certification.issuer=https://SecureAuth0

1aAWS.enterworks.com

fromApp.secureAuth.certificate.public.key.file.location=D:/

Enterworks/bin/certificate.wse3.cer

#blank or Base64Encoded

fromApp.secureAuth.idp.userid.encoding=


Page 130 of 247 Revised 10/18/2018

fromApp.secureAuth.idp.paramater.encoding=

fromApp.secureAuth.sp.userid.encoding=Base64Encoded

fromApp.secureAuth.sp.paramater.encoding=

6.1.3 SP Initiated Authentication Installation

In the following section, <version> should be replaced with the version number indicated in Third-party Software Versions. Note that when the folder jdk1.6 is referenced below, the 1.6 should not be replaced with the version number.

1. Install JDK <version>.

a. Download jdk<version>-windows-x64.zip from OneHub→ Product

Development Releases→ SecureAuth from the address specified in Third-party

Software Versions.

b. Rename jdk folder to jdk1.6. This may be in one of the following locations:

<drive>:\Enterworks\jdk

<drive>:\Enterworks\EnableServer\jdk

<drive>:\Enterworks\EPIM\jdk

c. Extract file jdk<version>-windows-x64.zip to the jdk folder.

d. Repeat for each Slave Server if it has a separate jdk folder.

2. Edit the worker.properties file in the folder

<drive>:\Enterworks\IISProxy to add following lines:

/samlplugin/*=epimWorker

/samlplugin/*.jsp=epimWorker

/samlplugin/servlet/*=epimWorker

3. Install the SAML Plugin.

a. Download SecureAuthSamlplugin.zip from OneHub→ Product

Development Releases→ SecureAuth from the address specified in Third-party

Software Versions.

b. Extract to a temporary location.

c. Copy samlplugin folder to the folder:

<EnableServerInstallDir>\tomcat\webapps

4. Configure the SAML Plugin by replacing following tokens in the SAML configuration files:


Page 131 of 247 Revised 10/18/2018

Key Value Description

@ENTERWORKS_ROOT@ <drive>:/Enterworks Root folder of installation.

@EPIM_HTTP_PORT@" 8090 Enable Server tomcat http port.

@WEB_SERVER_NAME@ servername Web server host name.

@SECURE_AUTH_IDP_URL@

https://secureauth0

1aaws.enterworks.co

m/SecureAuth4/

SecureAuth URL for SP Initiated authentication.

@SECURE_AUTH_CERTIFICAT

E_ISSUER@

https://SecureAuth0

1aAWS.enterworks.co

m

Certificate issuer domain name.

@SECURE_AUTH_CERTIFICAT

E_PATH@

D:/Enterworks/bin/c

ertificate.wse3.cer Path to certificate.

a. Edit file samlplugin.properties in

<EnableServerInstallDir>\tomcat\webapps\samlplugi

n\WEB-INF\classes

and replace tokens.

b. Edit file log4j.properties in


n\WEB-INF\classes

and replace tokens.

c. Edit file log4j2.xml in


n\WEB-INF\classes

and replace tokens.

2. Modify the sharedConfig.properties file in the folder:

<EnableServerInstallDir>\tomcat\webapps\samlplugin\WEB

-INF\classes

at around line# 868. (Repeat for all JBoss servers):


Page 132 of 247 Revised 10/18/2018

fromApp.list=enable,secureAuth

#

#SecureAuth Settings

#

fromApp.secureAuth.trustedSignOn=true

fromApp.secureAuth.name=SecureAuth

fromApp.secureAuth.gId=**********

# type - 0 SAML <version> IDP initiated, 1 - SAMLE <version>

SP initiated

fromApp.secureAuth.idp.type=1

fromApp.secureAuth.idp.url=https://secureauth01aaws.enterwor

ks.com/SecureAuth2/

fromApp.secureAuth.certification.issuer=https://SecureAuth01

aAWS.enterworks.com

fromApp.secureAuth.certificate.public.key.file.location=D:/E

nterworks/bin/certificate.wse3.cer

#blank or Base64Encoded

fromApp.secureAuth.idp.userid.encoding=

fromApp.secureAuth.idp.paramater.encoding=

fromApp.secureAuth.sp.userid.encoding=Base64Encoded

fromApp.secureAuth.sp.paramater.encoding=

6.2 Configuration of SecureAuth Services

1. Configure the SecureAuth Realm. Please refer to SecureAuth documentation for

properly setting up the SecureAuth Realm.

2. In the Data tab, enable the following profile fields

a. First name

b. Last Name

c. Groups

d. Email 1

3. Optionally add following additional profile fields and/or mappings.

a. workPhone

b. cellPhone

c. homePhone

d. fax

e. companyName

f. employeeNumber


Page 133 of 247 Revised 10/18/2018

g. department

h. businessTitle

i. title

j. manager

k. addressLine1

l. addressLine2

m. city

n. state

o. postalCode

p. country

4. In the Post Authentication tab

a. In the Post Authentication group, for Authenticated User Redirect field, select one

of the following:

i. IdP Initiated: SAML <version> (ldP Initiated) Assertion Page

ii. SP Initiated: SAML <version> (SP Initiated) Assertion Page


Page 134 of 247 Revised 10/18/2018

b. User Id Mapping: Authenticated User ID

c. Name Id Format: unspecified

d. Encode to Base64: true

e. SAML Consumer URL:

i. IdP Initiated: http://<WebServerName>/webcm/login.do

ii. SP Initiated: http://<WebServerName>/webcm/

f. WSFed/SAML Issuer: <NameOfIssure>

g. Download the certificate and save it to the <drive>:\Enterworks\bin folder.

h. Open the certificate file in a text editor. If the there is no line feed after “-----

BEGIN CERTIFICATE-----“ insert a line feed and save file.


Page 135 of 247 Revised 10/18/2018


Page 136 of 247 Revised 10/18/2018

i. Add following additional parameters (required) with base64 encoded

iii. secureauthind

iv. firstName

v. lastName

vi. groupList

vii. email

j. Add these additional optional parameters:

viii. workPhone

ix. cellPhone


Page 137 of 247 Revised 10/18/2018

x. homePhone

xi. fax

xii. companyName

xiii. employeeNumber

xiv. department

xv. businessTitle

xvi. title

xvii. manager

xviii. addressLine1

xix. addressLine2

xx. city

xxi. state

xxii. postalCode

xxiii. country


Page 138 of 247 Revised 10/18/2018

7 Configuring Restored Server Images

After restoring a new WEB, APP, and/or Database Server from an image of another server, (for example, when copying a production suite to a QA suite), update the configuration files as described below. The assumption is that all installed paths and ports will be the same, and only the server names and database server name will be different. The line numbers are a close approximation and may not be exactly the same as in your installation.

Keys to update:

Key Description Old Value New Value

WEB_SERVER_NA

ME

Web server name. oldwebserver

name

newwebserver

name

APP_SERVER_NA

ME

App server name. oldappserver

name

newappserver

name

DB_HOST_NAME Database server name. olddbservern

ame

newdbservern

ame

DB_INSTANCE_N

AME

Database instance name (if any).

olddbinstanc

ename

newdbinstanc

ename

DB_HOST_URL SQL Server Database "host name" or "host name\instance name".

olddbserverh

ost\olddbins

atncename

newdbserverh

ost\newdbins

atncename

DB_USER Database owner user name. ewsys ewsys

DB_PASS Database password (unencrypted).

ewsys ewsys


Page 139 of 247 Revised 10/18/2018


DB_PSWD_ENCRY

PTED

Database password encrypted using Enable. (Execute command prompt at:

<drive>:\Enterworks\

EnableServer\bin\ folder

getEncryptedString.b

at dbpassword

uMb/Xk0BwIA= Generate the password using script.

DB_PSWD_ENCRY

PTED_JBOSS

Database password encrypted using JBoss. (Execute command prompt at <drive>:\Enterworks\

EnableServer\bin\ folder getEncryptedJbossStr

ing.bat dbpassword

68404395c603

3b93

Generate the password using script.

DB_PSWD_ENCRY

PTED_EPX

Database password encrypted using EPX (Execute command prompt at <drive>:\Enterworks\EPX\bin\ folder

getEncryptedString.b

at dbpassword

L+wNQKjWrkuq

dw5f3F0Q5g==

Generate the password using script.

DB_EPIM EPIM database name. EPIM EPIM

DB_EPX EPX database name. EPX EPX

AWSAccessKey Amazon S3 connection access key (if applicable).

Ignore – not using.


AWSSecretKey Amazon S3 connection secret key (if applicable).



AWSRegion Amazon S3 connection region (if applicable)



AWSBucketName Amazon S3 connection bucket name (if applicable)




Page 140 of 247 Revised 10/18/2018


AWSDAMRootFol

der

Amazon S3 connection root folder (if applicable)



7.1 Web Server

7.1.1 Enable PIM

The Enable PIM component may be installed in one of the following folders:

<drive>:\Enterworks\EPIM

<drive>:\Enterworks\EnableServer

7.1.1.1 Enable PIM JBoss Master

May be in subfolder jboss or jbossMaster.

1. Modify the file login-config.xml in the folder:

<drive>:\Enterworks\EnableServer\jboss\server\default\

conf

login-config.xml

DB_USER Line 46: <module-option name =

"username">@DB_USER@</module-

option>

DB_PSWD_ENCRYPTED_JBOSS Line 46: <module-option name =


option>

2. Modify the file sharedConfig.properties in the folder :


conf


Page 141 of 247 Revised 10/18/2018

sharedConfig.properties

APP_SERVER_NAME Line 28: jboss.context.url=@APP_SERVER_NAME@:8034

WEB_SERVER_NAME Line 72: webapps.baseUrl=http://@WEB_SERVER_NAME@/w

ebcm/

WEB_SERVER_NAME Line 73: webservices.baseUrl=http://@WEB_SERVER_NAM

E@:@EPIM_HTTP_PORT@/webcm/

DB_USER Line 90: epim.connection.username=@DB_USER@

DB_PSWD_ENCRYPTE

D

Line 91: epim.connection.password=@DB_PSWD_ENCRYPTE

D@

DB_HOST_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver://

@DB_HOST_NAME@:@DB_PORT@;databasename=@DB_

EPIM@;instance=@DB_INSTANCE_NAME@

DB_PORT Line 92: epim.connection.url=jdbc:jtds:sqlserver://



DB_EPIM Line 92: epim.connection.url=jdbc:jtds:sqlserver://



DB_INSTANCE_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver://



APP_SERVER_NAME Line 751: epx.server.host=@APP_SERVER_NAME@

WEB_SERVER_NAME Line 872: fromApp.enable.baseUrl=http://@WEB_SERVER_

NAME@:80/enable


Page 142 of 247 Revised 10/18/2018


WEB_SERVER_NAME Line 1286: job.controller.master=@WEB_SERVER_NAME@:80

34

APP_SERVER_NAME Line 1287: job.controller.slave.list=@APP_SERVER_NAME

@:8035, @APP_SERVER_NAME@:8036

PIMQL_Host Line 1359 pimql.server.host=@WEB_SERVER_NAME@

3. Modify the file WorkFlowHandlerConfig.properties in the folder:


conf

WorkFlowHandlerConfig.properties

APP_SERVER_NAME Line 6: integration.epx.url=http@APP_SERVER_NAME@:

9040/tm/apps/enable/directCreateWorkItem.j

sp

4. Modify the file mssql-ds.xml in:


deploy

mssql-ds.xml

DB_HOST_NAME Line 13: <connection-

url>jdbc:jtds:sqlserver://@DB_HOST_NAME@:@DB_

PORT@;databasename=@DB_EPIM@;instance=@DB_INS

TANCE_NAME@</connection-url>


Page 143 of 247 Revised 10/18/2018

mssql-ds.xml

DB_PORT Line 13: <connection-




DB_EPIM Line 13: <connection-




DB_INSTANCE_N

AME

Line 13: <connection-




7.1.1.2 Enable PIM Tomcat Master

May be in subfolder tomcat or tomcatMaster.

1. Modify the file sharedConfig.properties in the folder:

<drive>:\Enterworks\EnableServer\tomcat\webapps\webcm\

web-inf\classes


APP_SERVER_NAM

E

Line 28: jboss.context.url=@APP_SERVER_NAME@:8034

WEB_SERVER_NAM

E

Line 72: webapps.baseUrl=http://@WEB_SERVER_NAME@/we

bcm/

WEB_SERVER_NAM

E

Line 73: webservices.baseUrl=http://@WEB_SERVER_NAME

@:8090/webcm/



Page 144 of 247 Revised 10/18/2018


DB_PSWD_ENCRYP

TED

Line 91: epim.connection.password=@DB_PSWD_ENCRYPTED

@

DB_HOST_NAME

Line 92: epim.connection.url=jdbc:jtds:sqlserver://@

DB_HOST_NAME@:@DB_PORT@;databasename=@DB_EP

IM@;instance=@DB_INSTANCE_NAME@

DB_PORT Line 92: epim.connection.url=jdbc:jtds:sqlserver://@



DB_EPIM Line 92: epim.connection.url=jdbc:jtds:sqlserver://@



DB_INSTANCE_NA

ME

Line 92: epim.connection.url=jdbc:jtds:sqlserver://@



APP_SERVER_NAM

E

Line 751: epx.server.host=@APP_SERVER_NAME@

WEB_SERVER_NAM

E

Line 872: fromApp.enable.baseUrl=http://@WEB_SERVER_N

AME@:80/enable

WEB_SERVER_NAM

E

Line 1286: job.controller.master=@WEB_SERVER_NAME@:803

4

APP_SERVER_NAM

E

Line 1287: job.controller.slave.list=@APP_SERVER_NAME@

:8035, @APP_SERVER_NAME@:8036

PIMQL_Host Line 1359: pimql.server.host=@WEB_SERVER_NAME@


Page 145 of 247 Revised 10/18/2018

7.1.2 Enable PIM (Slaves)

The Enable PIM component may be installed in one of the following folders:


<drive>:\Enterworks\EPIMSlave1

<drive>:\Enterworks\EnableServerSlave1

7.1.2.1 Enable PIM JBoss Slave1

The JBoss Slave 1 component may be in one of the following subfolders:

<drive>:\Enterworks\EnableServer\jbossSlave1

<drive>:\Enterworks\EnableServerSlave1\jboss

<drive>:\Enterworks\EPIMSlave1\jboss


<drive>:\Enterworks\EnableServer\jbossSlave1\server\default

\conf

login-config.xml



option>



option>



\conf



\conf


Page 146 of 247 Revised 10/18/2018



WEB_SERVER_NAME Line 72: webapps.baseUrl=http://@WEB_SERVER_NAME@/

webcm/

WEB_SERVER_NAME Line 73: webservices.baseUrl=http://@WEB_SERVER_NA

ME@:@EPIM_HTTP_PORT@/webcm/


DB_PSWD_ENCRYPTE

D

Line 91: epim.connection.password=@DB_PSWD_ENCRYPT

ED@

DB_HOST_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver:/

/@DB_HOST_NAME@:@DB_PORT@;databasename=@D

B_EPIM@;instance=@DB_INSTANCE_NAME@

DB_PORT Line 92: epim.connection.url=jdbc:jtds:sqlserver:/



DB_EPIM Line 92: epim.connection.url=jdbc:jtds:sqlserver:/



DB_INSTANCE_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver:/





Page 147 of 247 Revised 10/18/2018


WEB_SERVER_NAME Line 872: fromApp.enable.baseUrl=http://@WEB_SERVER

_NAME@:80/enable

WEB_SERVER_NAME Line 1286 job.controller.master=@WEB_SERVER_NAME@:8

034

APP_SERVER_NAME Line 1287: job.controller.slave.list=@APP_SERVER_NAM

E@:8035, @APP_SERVER_NAME@:8036


4. Modify the file WorkFlowHandlerConfig.properties in the folder:


\conf


APP_SERVER_NAME Line 6: integration.epx.url=http@APP_SERVER_NAME@

:9040/tm/apps/enable/directCreateWorkItem

.jsp

5. Modify the file mssql-ds.xml in the folder:


\deploy

mssql-ds.xml

DB_HOST_

NAME


url>jdbc:jtds:sqlserver://@DB_HOST_NAME@:@DB_PORT


Page 148 of 247 Revised 10/18/2018

mssql-ds.xml

@;databasename=@DB_EPIM@;instance=@DB_INSTANCE_NA

ME@</connection-url>









DB_INSTA

NCE_NAME






The Jboss Slave 2 component may be in one of the following subfolders:





<drive>:\Enterworks\EnableServer\jbossSlave2\server\de

fault\conf

login-config.xml



option>



Page 149 of 247 Revised 10/18/2018

login-config.xml


option>



fault\conf



WEB_SERVER_NAME Line 72: webapps.baseUrl=http://@WEB_SERVER_NAME@/

webcm/

WEB_SERVER_NAME Line 73: webservices.baseUrl=http://@WEB_SERVER_NA

ME@:@EPIM_HTTP_PORT@/webcm/


DB_PSWD_ENCRYPTE

D

Line 91: epim.connection.password=@DB_PSWD_ENCRYPT

ED@

DB_HOST_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver:/



DB_PORT Line 92: epim.connection.url=jdbc:jtds:sqlserver:/



DB_EPIM Line 92: epim.connection.url=jdbc:jtds:sqlserver:/


Page 150 of 247 Revised 10/18/2018




DB_INSTANCE_NAME Line 92: epim.connection.url=jdbc:jtds:sqlserver:/




WEB_SERVER_NAME Line 872: fromApp.enable.baseUrl=http://@WEB_SERVER

_NAME@:80/enable


034

APP_SERVER_NAME Line 1287: job.controller.slave.list=@APP_SERVER_NAM

E@:8035, @APP_SERVER_NAME@:8036


3. Modify the WorkFlowHandlerConfig.properties file in the folder:


fault\conf


APP_SERVER_NAME Line 6: integration.epx.url=http://@APP_SERVER_NA

ME@:9040/tm/apps/enable/directCreateWorkI

tem.jsp

4. Modify the file mssql-ds.xml in the folder:


Page 151 of 247 Revised 10/18/2018


fault\deploy

mssql-ds.xml

DB_HOST_

NAME













DB_INSTA

NCE_NAME





7.1.3 Enable Web

The Enable Web component may be installed in one of the following folders (<Enable version> should be replaced with the version number of Enable in use):

<drive>:\Enterworks\EnableWeb

<drive>:\Enterworks\enable

<drive>:\Enterworks\enable<Enable version>

1. Modify the Web.config file in the folder: <drive>:\Enterworks\EnableWeb


Page 152 of 247 Revised 10/18/2018

Web.config

WEB_SERVER_N

AME

Line 27: <add key="PimqlResetCacheUrl"

value="http://@WEB_SERVER_NAME@/enable/resetc

ache.xml" />

WEB_SERVER_N

AME

Line 41: <add key="BaseEpimUrl"

value="http://@WEB_SERVER_NAME@:8090/webcm"

/>

AWSAccessKey Line 57: <add key="AWSAccessKey"

value="@AWSAccessKey@" />

AWSSecretKey Line 58: <add key="AWSSecretKey"

value="@AWSSecretKey@" />

AWSRegion Line 59: <add key="AWSRegion" value="@AWSRegion@" />

AWSBucketNam

e

Line 60: <add key="AWSBucketName"

value="@AWSBucketName@" />

AWSDAMRootFo

lder

Line 61: <add key="AWSDAMRootFolder"

value="@AWSDAMRootFolder@ />

DB_HOST_URL Line 67: <add name="EPIMConnectionString"

connectionString="Data

Source=@DB_HOST_URL@;Initial

Catalog=@DB_EPIM@;Persist Security

Info=True;User

ID=@DB_USER@;Password=@DB_PASS@;MultipleActiv

eResultSets=True"

providerName="System.Data.SqlClient" />


Page 153 of 247 Revised 10/18/2018

Web.config

DB_USER Line 67: <add name="EPIMConnectionString"




Info=True;User


eResultSets=True"


DB_PSWD Line 67: <add name="EPIMConnectionString"




Info=True;User


eResultSets=True"


DB_EPIM Line 67: <add name="EPIMConnectionString"




Info=True;User


eResultSets=True"


7.1.4 PIMQL

The Enable PIMQL component may be installed in folder:

<drive>:\Enterworks\PIMQL

1. Modify the file PimqlRun.exe.config in the folder:

<drive>:\Enterworks\PIMQL


Page 154 of 247 Revised 10/18/2018

PimqlRun.exe.config

WEB_SERVER_N

AME

Line 48: <add key="epim.serverUrl"

value="http://@WEB_SERVER_NAME@:8090/webcm/se

rvices/server"/>

WEB_SERVER_N

AME

Line 51: <add key="BaseEpimUrl" value="http://@WEB_SERVER_NAME@/webcm"/>





Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 155 of 247 Revised 10/18/2018

PimqlRun.exe.config





Info=True;User


eResultSets=True"


DB_HOST_URL Line 60: <add name="EPXConnectionString"



Catalog=@DB_EPX@;Persist Security

Info=True;User


eResultSets=True"


DB_USER Line 60: <add name="EPXConnectionString"




Info=True;User


eResultSets=True"


DB_PSWD Line 60: <add name="EPXConnectionString"




Info=True;User


eResultSets=True"



Page 156 of 247 Revised 10/18/2018

PimqlRun.exe.config

DB_EPX Line 60: <add name="EPXConnectionString"




Info=True;User


eResultSets=True"


7.1.5 Enable Utilities

The Enable Utilities component may be installed in folder:

<drive>:\Enterworks\Utilities or in a separate folder for each utility.

7.1.5.1 DAM Report Utility

The Enable DAM Report Utility component may be installed in one of the following folders:

<drive>:\Enterworks\Utilities\DAMReportUtility

<drive>:\Enterworks\DAMReportUtility

1. Modify the file DAMReportUtility.exe.config in the folder:


DAMReportUtility.exe.config

WEB_SERVER_N

AME


value="http://@WEB_SERVER_NAME@:8090/webcm"/>






Page 157 of 247 Revised 10/18/2018



AWSBucketNam

e



AWSDAMRootFo

lder







Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 158 of 247 Revised 10/18/2018






Info=True;User


eResultSets=True"


7.1.5.2 Monitor DAM Drop Utility


<drive>:\Enterworks\Utilities\MonitorDAMDrop

<drive>:\Enterworks\MonitorDAMDrop

1. Modify the file MonitorDAMDrop.exe.config in the folder:


MonitorDAMDrop.exe.config

WEB_SERVER_N

AME








AWSBucketNam

e




Page 159 of 247 Revised 10/18/2018


AWSDAMRootFo

lder







Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 160 of 247 Revised 10/18/2018

7.1.5.3 Regenerate DAM Variant Utility


<drive>:\Enterworks\Utilities\RegenerateDAMVariant

<drive>:\Enterworks RegenerateDAMVariant

1. Modify the file RegenerateDAMVariant.exe.config in the folder:


RegenerateDAMVariant.exe.config

WEB_SERVER_N

AME








AWSBucketNam

e



AWSDAMRootFo

lder




Page 161 of 247 Revised 10/18/2018






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"


7.1.6 IIS Proxy

The Enable IIS Proxy component may be installed in folder:


Page 162 of 247 Revised 10/18/2018

<drive>:\Enterworks\IISProxy

1. Modify the file workers.properties in the folder:

<drive>:\Enterworks\IISProxy

workers.properties

WEB_SERVER_N

AME

Line 3: worker.epimWorker.host=@WEB_SERVER_NAME@

APP_SERVER_N

AME

Line 6: worker.epxWorker.host=@APP_SERVER_NAME@

7.2 App Server

7.2.1 EPX

The Enable EPX component may be installed in one of the following folders:

<drive>:\Enterworks\EPX

<drive>:\Enterworks\EPX32

1. Modify the file config.properties in the folder

<drive>:\Enterworks\EPX\bin.

config.properties

APP_SERVER_N

AME

Line 32: jboss.context.url=@APP_SERVER_NAME@:9034

APP_SERVER_N

AME

Line 73: soap.server.url=http://@APP_SERVER_NAME@:904

0/soap/servlet/rpcrouter

APP_SERVER_N

AME

Line 83: server.name=EPX_@APP_SERVER_NAME@

WEB_SERVER_N

AME

Line 155: baseURL=http://@WEB_SERVER_NAME@/tm


Page 163 of 247 Revised 10/18/2018

config.properties

WEB_SERVER_N

AME

Line 156: baseHTMLURL=http://@WEB_SERVER_NAME@/tm/html

/

WEB_SERVER_N

AME

Line 157: attachmentsBaseURL=http://@WEB_SERVER_NAME@/

tm/attachments/

WEB_SERVER_N

AME

Line 158: baseVEURL=http://@WEB_SERVER_NAME@/ve

APP_SERVER_N

AME

Line 433: bicmanager.list=@APP_SERVER_NAME@,

APP_SERVER_N

AME

Line 436: bicmanager.@[email protected]

=@ APP_SERVER_NAME @

APP_SERVER_N

AME


tory=<drive>:/Enterworks/EPX/bin/agents/@APP

_SERVER_NAME@/

APP_SERVER_N

AME


leName=<drive>:/Enterworks/logs/EPX/BIC_@APP

[email protected]

APP_SERVER_N

AME

Line 439: bicmanager.@[email protected]=true

APP_SERVER_N

AME

Line 440: bicmanager.@[email protected]=false

APP_SERVER_N

AME

Line 441: bicmanager.@[email protected]=fal

se

APP_SERVER_N

AME

Line 529: control.jndi.host=jnp://@APP_SERVER_NAME@:90

34

APP_SERVER_N

AME

Line 538: #control.jndi.host=@APP_SERVER_NAME@


Page 164 of 247 Revised 10/18/2018

config.properties

WEB_SERVER_N

AME

Line 1005: fromApp.epim.baseUrl=http://@WEB_SERVER_NAME

@:8090/webcm

WEB_SERVER_N

AME

Line 1023: fromApp.enable.baseUrl=http://@WEB_SERVER_NA

ME@/enable

WEB_SERVER_N

AME

Line 1035: fromApp.epx.baseURL=http://@WEB_SERVER_NAME@

/tm

WEB_SERVER_N

AME

Line 1036: fromApp.epx.baseHTMLURL=http://@WEB_SERVER_N

AME@/tm/html/

2. Modify the file esjdbc.properties in the folder

<drive>:\Enterworks\EPX\bin.

esjdbc.properties

APP_SERVER_N

AME

Line 85: server.list=EPX_@APP_SERVER_NAME@,

APP_SERVER_N

AME

Line 87: server.EPX_@[email protected]=EPX_@APP_

SERVER_NAME@

APP_SERVER_N

AME

Line 88: server.EPX_@[email protected]=jdbc:jtds:s

qlserver://@DB_HOST_NAME@:@DB_PORT@;database

name=@DB_EPX@;instance=@DB_INSTANCE_NAME@

DB_HOST_NAME Line 88: server.EPX_@[email protected]=jdbc:jtds:s




Page 165 of 247 Revised 10/18/2018

esjdbc.properties

DB_PORT Line 88: server.EPX_@[email protected]=jdbc:jtds:s



DB_EPX Line 88: server.EPX_@[email protected]=jdbc:jtds:s



DB_INSTANCE_

NAME

Line 88: server.EPX_@[email protected]=jdbc:jtds:s



DB_USER Line 90: server.EPX_@[email protected]=@DB_USER@

DB_PSWD_ENCR

YPTED

Line 91: server.EPX_@[email protected]=@DB_PS

WD_ENCRYPTED@

APP_SERVER_N

AME

Line 92:

server.EPX_@[email protected]=

APP_SERVER_N

AME

Line 93: server.EPX_@[email protected]=3

3. Modify Enterworks.properties in the folder

<drive>:\Enterworks\EPX\bin\conf.

Enterworks.properties

WEB_SERVER_N

AME

Line 15: epim.serverURL=http://@WEB_SERVER_NAME@:8090/

webcm/services/server


Page 166 of 247 Revised 10/18/2018


DB_HOST_NAME Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA

ME@:@DB_PORT@;databasename=@DB_EPIM@;instance

=@DB_INSTANCE_NAME@

DB_PORT Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA


=@DB_INSTANCE_NAME@

DB_EPIM Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA


=@DB_INSTANCE_NAME@

DB_INSTANCE_

NAME

Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA


=@DB_INSTANCE_NAME@

DB_USER Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA


=@DB_INSTANCE_NAME@

DB_PSWD_ENCR

YPTED

Line 46: epim.db.url=jdbc:jtds:sqlserver://@DB_HOST_NA


=@DB_INSTANCE_NAME@

APP_SERVER_N

AME

Line 53: epx.server.name=EPX_@APP_SERVER_NAME@

WEB_SERVER_N

AME

Line 64: epx.viewer.url=http://@WEB_SERVER_NAME@/tm

DB_HOST_NAME Line 79: epx.db.url=jdbc:jtds:sqlserver://@DB_HOST_NAM

E@:@DB_PORT@;databasename=@DB_EPX@;instance=@

DB_INSTANCE_NAME@


Page 167 of 247 Revised 10/18/2018


DB_PORT Line 79: epx.db.url=jdbc:jtds:sqlserver://@DB_HOST_NAM


DB_INSTANCE_NAME@

DB_EPX Line 79: epx.db.url=jdbc:jtds:sqlserver://@DB_HOST_NAM


DB_INSTANCE_NAME@

DB_INSTANCE_

NAME

Line 79: epx.db.url=jdbc:jtds:sqlserver://@DB_HOST_NAM


DB_INSTANCE_NAME@

DB_USER Line 80: epx.db.user=@DB_USER@

DB_PSWD_ENCR

YPTED

Line 81: epx.db.password=@DB_PSWD_ENCRYPTED@

DB_USER Line 82: epim.db.userName=@DB_USER@

DB_PASSWORD Line 83: epim.db.userPassword=@DB_PASSWORD@

WEB_SERVER_N

AME

Line 89: epim.editorUrl=http://@WEB_SERVER_NAME@:8090/

webcm/enable/startItemEditor.jsp

4. Rename folder @APP_SERVER_NAME@ in

<drive>:\Enterworks\EPX\bin\agents to new App server name.

5. Rename file EPX_@[email protected] in

<drive>:\Enterworks\EPX\jboss\server to new App server name.

6. Modify the file EPX_@[email protected] in the

folder <drive>:\Enterworks\EPX\jboss\server.


Page 168 of 247 Revised 10/18/2018

EPX_@[email protected]

APP_SERVER_N

AME

Line 38: <server name="EPX_@APP_SERVER_NAME@">

APP_SERVER_N

AME

Line 48: <binding port="9034"

host="@APP_SERVER_NAME@"/>

APP_SERVER_N

AME



APP_SERVER_N

AME

Line 202: <attribute

name="InvokerLocator">socket://@APP_SERVER_NA

ME@:3873</attribute>

APP_SERVER_N

AME



APP_SERVER_N

AME


name="serverBindAddress">@APP_SERVER_NAME@</a

ttribute>

7. Modify the file jboss-service.xml in the folder

<drive>:\Enterworks\EPX\jboss\server\all\conf.

jboss-service.xml

APP_SERVER_N

AME


name="ServerName">EPX_@APP_SERVER_NAME@</attr

ibute>

8. Modify the file jbossmq-destinations-service.xml in the folder

<drive>:\Enterworks\EPX\jboss\server\all\ deploy-

hasingleton\jms.


Page 169 of 247 Revised 10/18/2018

jbossmq-destinations-service.xml

APP_SERVER_N

AME

Line 16: name="jboss.mq.destination:service=Topic,name

=EPX_@APP_SERVER_NAME@_escontrol">

9. Modify the file jboss-service.xml in the folder

<drive>:\Enterworks\EPX\jboss\server\default\conf.

jboss-service.xml

APP_SERVER_N

AME


name="ServerName">EPX_@APP_SERVER_NAME@</attr

ibute>

10. Modify the file jbossmq-destinations-service.xml in the folder

<drive>:\Enterworks\EPX\jboss\server\default\deploy\jms.

jbossmq-destinations-service.xml

APP_SERVER_N

AME

Line 33: name="jboss.mq.destination:service=Topic,name

=EPX_@APP_SERVER_NAME@_escontrol">

11. Modify the file web.xml in the folder

<drive>:\Enterworks\EPX\tomcat\webapps\bicmanager\WEB-INF.

web.xml

APP_SERVER_NAME

Line 8: <param-value>@BIC.MANAGER.NAME@</param-value>


Page 170 of 247 Revised 10/18/2018

7.2.2 Enable PIM (Slaves)

Enable PIM component may be installed in one of the following folders:


<drive>:\Enterworks\EPIMSlave1

<drive>:\Enterworks\EnableServerSlave1


JBoss Slave 1 component may be in one of the following subfolders:




1. Modify the file login-config.xml in the folder

\Enterworks\EnableServer\jbossSlave1\server\default\conf.

login-config.xml



option>



option>

2. Modify the file sharedConfig.properties in the folder


\conf.


Page 171 of 247 Revised 10/18/2018




ebcm/




DB_PSWD_ENCRYPTE

D


D@















NAME@:80/enable


Page 172 of 247 Revised 10/18/2018



34




3. Modify the file WorkFlowHandlerConfig.properties in the folder


\conf.


APP_SERVER_NAME Line 6: integration.epx.url=http@APP_SERVER_NAME@:

9040/tm/apps/enable/directCreateWorkItem.j

sp

4. Modify the file mssql-ds.xml in the folder


\deploy.

mssql-ds.xml






Page 173 of 247 Revised 10/18/2018

mssql-ds.xml









DB_INSTANCE_N

AME






JBoss Slave 2 component may be in one of the following subfolders:




1. Modify the file login-config.xml in the folder


\conf

login-config.xml



option>



option>


Page 174 of 247 Revised 10/18/2018

2. Modify the file sharedConfig.properties in the folder


\conf




ebcm/




DB_PSWD_ENCRYPTE

D


D@











Page 175 of 247 Revised 10/18/2018







NAME@:80/enable


34




3. Modify the file WorkFlowHandlerConfig.properties in the folder


\conf


APP_SERVER_NAME Line 6: integration.epx.url=http://@APP_SERVER_NAM

E@:9040/tm/apps/enable/directCreateWorkIte

m.jsp

4. Modify the file mssql-ds.xml in the folder


\deploy


Page 176 of 247 Revised 10/18/2018

mssql-ds.xml













DB_INSTANCE_N

AME





7.2.3 Enable Utilities

The Enable Utilities component may be installed in folder:

<drive>:\Enterworks\Utilities

or in a separate folder for each utility

7.2.3.1 DAM Report Utility



<drive>:\Enterworks\DAMReportUtility

1. Modify the file DAMReportUtility.exe.config in the folder:



Page 177 of 247 Revised 10/18/2018


WEB_SERVER_N

AME








AWSBucketNam

e



AWSDAMRootFo

lder







Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 178 of 247 Revised 10/18/2018






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"


7.2.3.2 Monitor DAM Drop Utility



<drive>:\Enterworks\MonitorDAMDrop

1. Modify the file MonitorDAMDrop.exe.config in the folder:



WEB_SERVER_N

AME






Page 179 of 247 Revised 10/18/2018





AWSBucketNam

e



AWSDAMRootFo

lder







Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 180 of 247 Revised 10/18/2018






Info=True;User


eResultSets=True"


7.2.3.3 Regenerate DAM Variant Utility



<drive>:\Enterworks RegenerateDAMVariant

1. Modify the file RegenerateDAMVariant.exe.config in the folder:



WEB_SERVER_N

AME








AWSBucketNam

e




Page 181 of 247 Revised 10/18/2018


AWSDAMRootFo

lder







Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"






Info=True;User


eResultSets=True"



Page 182 of 247 Revised 10/18/2018

7.3 Database Server

7.3.1 Database Update

1. Update reference in EPX database:

UPDATE [epx].[dbo].[S_SERVER] SET

[SERVER_UID]='EPX_@APP_SERVER_NAME@',

[NAME]='EPX_@APP_SERVER_NAME@',

[SOAP_SERVICE_URL]='http://@APP_SERVER_NAME@:9040/soap/serv

let/rpcrouter' WHERE [SERVER_ID]=1;

2. Update references in EPIM database:

DECLARE @nsql NVARCHAR(MAX);

DECLARE @DAMConfigRepoId as bigint;

DECLARE @DAMConfigProfileId as bigint;

DECLARE @DAMConfigKey as bigint;

DECLARE @DAMConfigVal as bigint;

DECLARE @epimURLItemId as bigint;

DECLARE @epimURLVal as varchar(512);

DECLARE @DamAssetURLItemId as bigint;

DECLARE @DamAssetURLVal as varchar(512);

SET @epimURLVal='http://@WEB_SERVER_NAME@/webcm/';

--Change to Amazon S3 Url if using AWS S3

SET @DamAssetURLVal='http://@WEB_SERVER_NAME@/Damroot';

SELECT TOP(1)

@DAMConfigRepoId=MASTER_REPOSITORY_ID,@DAMConfigProfileId=P

ROFILE_ID FROM B_MASTER_REPOSITORY WHERE NAME =

'DAMConfig';

SELECT TOP(1) @DAMConfigKey=FORMAT_ATTR_ID FROM

B_FORMAT_ATTR WHERE PROFILE_ID=@DAMConfigProfileId AND

NAME='Key';

SELECT TOP(1) @DAMConfigVal=FORMAT_ATTR_ID FROM

B_FORMAT_ATTR WHERE PROFILE_ID=@DAMConfigProfileId AND

NAME='Value';


Page 183 of 247 Revised 10/18/2018

SET @nsql = 'SELECT TOP (1) @epimURLItemId=ITEM_ID FROM

EPIM.dbo.B_MASTER_REPOSITORY_ITEM AS bmri WHERE

(REPOSITORY_ID = ' + CAST(@DAMConfigRepoId as VARCHAR) + ')

AND (CAST(ATTR_DATA.query(''data(Item/F_' +

CAST(@DAMConfigKey as VARCHAR) + ')'') AS

varchar(512))=''EPIMURL'')';

EXEC sp_executeSql @nsql, N'@epimURLItemId int

output',@epimURLItemId=@epimURLItemId output

SET @nsql = 'SELECT TOP (1) @DamAssetURLItemId=ITEM_ID FROM

EPIM.dbo.B_MASTER_REPOSITORY_ITEM AS bmri WHERE

(REPOSITORY_ID = ' + CAST(@DAMConfigRepoId as VARCHAR) + ')

AND (CAST(ATTR_DATA.query(''data(Item/F_' +

CAST(@DAMConfigKey as VARCHAR) + ')'') AS

varchar(512))=''DamAssetURL'')';

EXEC sp_executeSql @nsql, N'@DamAssetURLItemId int

output',@DamAssetURLItemId=@DamAssetURLItemId output

SET @nsql = 'UPDATE B_MASTER_REPOSITORY_ITEM set

LAST_UPDATE_DATETIME = getDate(), ATTR_LAST_UPDATE_DATETIME

= getDate(), ' +

'attr_data.modify(''replace value of (/Item/F_' +

CAST(@DAMConfigVal as VARCHAR) +

'/text())[1] with

"' + @DamAssetURLVal + '"'') where

(B_MASTER_REPOSITORY_ITEM.attr_data is not null) ' +

' AND

(B_MASTER_REPOSITORY_ITEM.repository_id = ' +

cast(@DAMConfigRepoId as varchar) + ') ' +

' AND

(B_MASTER_REPOSITORY_ITEM.ITEM_ID=' +

cast(@DamAssetURLItemId as varchar) + ')';

PRINT @nsql;

EXEC (@nsql);

set @nsql = 'update B_SNAPSHOT_'+CAST(@DAMConfigRepoId as

varchar)+' set F_'+CAST(@DAMConfigVal as

varchar)+'='''+@DamAssetURLVal+''' where (ITEM_ID=' +

cast(@DamAssetURLItemId as varchar) + ')';

PRINT @nsql;

EXEC (@nsql);


Page 184 of 247 Revised 10/18/2018

SET @nsql = 'UPDATE B_MASTER_REPOSITORY_ITEM set

LAST_UPDATE_DATETIME = getDate(), ATTR_LAST_UPDATE_DATETIME

= getDate(), ' +

'attr_data.modify(''replace value of (/Item/F_' +

CAST(@DAMConfigVal as VARCHAR) +

'/text())[1] with

"' + @epimURLVal + '"'') where

(B_MASTER_REPOSITORY_ITEM.attr_data is not null) ' +

' AND

(B_MASTER_REPOSITORY_ITEM.repository_id = ' +

cast(@DAMConfigRepoId as varchar) + ') ' +

' AND

(B_MASTER_REPOSITORY_ITEM.ITEM_ID=' + cast(@epimURLItemId

as varchar) + ')';

PRINT @nsql;

EXEC (@nsql);

set @nsql = 'update B_SNAPSHOT_'+CAST(@DAMConfigRepoId as

varchar)+' set F_'+CAST(@DAMConfigVal as

varchar)+'='''+@epimURLVal+''' where (ITEM_ID=' +

cast(@epimURLItemId as varchar) + ')';

PRINT @nsql;

EXEC (@nsql);

8 Installing Channel Readiness

8.1 MongoDB

8.1.1 Installing MongoDB

Install MongoDB Community Server. Later instructions assume this is installed at the default location.

In the following, replace <version> with the appropriate version of MongodB Community Server as per Third-party Software Versions. If text or images do not match the version numbers listed in Third-party Software Versions, use the value given in Third-party Software Versions.


Page 185 of 247 Revised 10/18/2018

1. Open up a web browser and go to the address listed in Third-party Software Versions for

MongoDB.

2. Select the version listed in Third-party Software Versions. If the software version does

not appear in the Current Release tab, open the Previous Releases tab.


Page 186 of 247 Revised 10/18/2018

3. Click Download.

4. Open the installer.


Page 187 of 247 Revised 10/18/2018

5. Click Next.


Page 188 of 247 Revised 10/18/2018

6. Accept the License and click Next.


Page 189 of 247 Revised 10/18/2018

7. Click Custom.

8. Click Browse.


Page 190 of 247 Revised 10/18/2018

9. Select a location on the same drive as the Enterworks install.


Page 191 of 247 Revised 10/18/2018

10. Click Next.


Page 192 of 247 Revised 10/18/2018

11. Click Install.


Page 193 of 247 Revised 10/18/2018

12. Click Finish.

8.1.2 Configuring MongoDB

After installing MongoDB Community Server (see Installing MongoDB):

1. Create a directory to store the MongoDB database; for example: MongoDB.

2. Create the database folder: <drive>:\MongoDB\data

3. Create the folder: <drive>:\MongoDB\logs

4. Create the file: <drive>:\MongoDB\enable_mongoConfig.cfg

In this file add the following text:

systemLog:


Page 194 of 247 Revised 10/18/2018

destination: file

path: <drive>:\MongoDB\logs\mongod.log

storage:

dbPath: <drive>:\MongoDB\data

security:

authorization: enabled

net:

bindIp: 0.0.0.0

- systemLog tells MongoDB where to place the log file.

- storage tells MongoDB where to store the database.

- security tells MongoDB to require authentication if enabled.

- bindIp tells MongoDB where to listen for connections. 0.0.0.0 is for all ipv4

5. Open a command prompt as admin and run the following commands:

cd <drive>:\Program Files\MongoDB\Server\<version>\bin

mongod --port 27017 --dbpath <drive>:\MongoDB\data

6. Open Robo3T.

7. Select Create in the MongoDB Connections window.

8. Enter Enable as the name and click Save.

9. Select the Enable connection and click Connect.

10. Right click on Enable in the tree view on the left side of the window and select Open

Shell.

11. Enter the following command into the shell that opens:

use admin

db.createUser(

{

user: "ewsys",

pwd: "ewsys",


Page 195 of 247 Revised 10/18/2018

roles: [ { role: "readWriteAnyDatabase", db: "admin"

},

{ role: "userAdminAnyDatabase", db: "admin" }

]

}

)

12. Click the green arrow to run the command.

13. Navigate back to the command prompt running MongoDB and stop the process with

CTRL+C.

14. Run the following command in the command prompt.

mongod --install --config

<drive>:\MongoDB\enable_mongoConfig.cfg

To verify that MongoDB installed correctly, check the log file at:

<drive>:\MongoDB\logs\mongod.log

15. Navigate back to Robo3T.

16. Disconnect from Enable.

17. Click the Connect button in the top left of the window.

18. Right click Enable and select Edit.

19. Select the Authentication tab.

20. Click the Perform authentication check box.

21. Enter the following user name and password:

User Name: ewsys

Password : ewsys

22. Click Test. There should be two green circles with check marks to signify the connection

was successful

23. Click Save.

24. Click Connect.

25. Right Click on Enable and select Create Database.

26. Enter channelReadiness for the database name and click Save.

27. Expand the database, right-click on Collections and select Create Collections.


Page 196 of 247 Revised 10/18/2018

28. Enter channels and click Save.

29. Expand the database, right-click on Collections and select Create Collections.

30. Enter channelAnalysis and click Save.

8.2 Robo 3T

8.2.1 Installing Robo 3T

In the following sections, replace <version> with the software version number listed in Third-party Software Versions. In the case that version numbers in the screenshots do not match those in Third-party Software Versions, use the version numbers from Third-party Software Versions.

1. Open up a web browser and go to the web address for Robo 3T in Third-party Software

Versions.

2. Click Download and choose the version specified in Third-party Software Versions.

3. Open the installer.


Page 197 of 247 Revised 10/18/2018

4. Click Next.


Page 198 of 247 Revised 10/18/2018

5. Read the End-User License Agreement and click I Agree.


Page 199 of 247 Revised 10/18/2018

6. Click Next.


Page 200 of 247 Revised 10/18/2018

7. Click Install.


Page 201 of 247 Revised 10/18/2018

8. Click Finish.

8.2.2 Robo 3T Setup

1. Open Robo 3T.


Page 202 of 247 Revised 10/18/2018

2. Click Create.

3. The Connection Settings window will appear.


Page 203 of 247 Revised 10/18/2018

4. Enter Enable for the name.

5. Click Save.

6. Switch to the Authentication tab.


Page 204 of 247 Revised 10/18/2018

7. Check the Perform Authentication checkbox.

8. Enter admin for the database

9. Enter ewsys/ewsys for the user name and password

10. Click Save.

11. The Mongo DB Connections window will appear.


Page 205 of 247 Revised 10/18/2018

12. Select Enable and click Connect.

13. Right click on Enable and click Create Database.

14. Name the database channelReadiness.

15. Click Create.

16. Click on the arrow next to channelReadiness.


Page 206 of 247 Revised 10/18/2018

17. Right click on Collections and select Create Collection.

18. Enter channelAnalysis for the name and click Create.

19. Right click on Collections and select Create Collection.

20. Enter channels for the name and click Create.

21. Click on the arrow next to Collections.

22. Click on the arrow next to channelAnalysis.

23. Right click on Indexes and select Add New Index.

24. Enter channelInfo.channelId_-1 for the name.

25. Enter the following for the key:

{"channelInfo.channelId" : -1,"dateRan" : 1}

26. Click Save.

8.3 Node.js

8.3.1 Installing Node.js

1. Open up a web browser and go to the address specified for Node.js in Third-party

Software Versions.

2. Click LTS and select the installer for your computer.


Page 207 of 247 Revised 10/18/2018

3. Open the Installer.

4. Click Next.


Page 208 of 247 Revised 10/18/2018

5. Accept the license and click Next.

6. Click Next.


Page 209 of 247 Revised 10/18/2018

7. Click Next.


Page 210 of 247 Revised 10/18/2018

8. Click Install.

9. Click Finish.

8.3.2 Configuring Node.js

10. Create a folder called npm-cache in the <drive>:\Program Files\nodejs

folder.

11. Create a folder called etc in the <drive>:\Program Files\nodejs folder.

12. Open <drive>:\Program Files\nodejs\node_modules\npm\npmrc with

a text editor change the first line to: prefix=<drive>:\Program

Files\nodejs

13. Open a command prompt in administrator mode and enter the following commands:

Cd /d <drive>:\"Program Files"\nodejs

npm config --global set prefix “<drive>:\Program

Files\nodejs”


Page 211 of 247 Revised 10/18/2018

npm config --global set cache “<drive>:\Program

Files\nodejs\npm-cache”


Page 212 of 247 Revised 10/18/2018

8.4 Express Server

8.4.1 Setting up the Express Server

1. Download the Channel Readiness Patch.

2. Extract the contents of the file.

3. Copy the enable-mean folder from the Channel Readiness Patch to:

<drive>:/Enterworks

4. Copy the following file and rename it to ewconfig.js

<drive>:\Enterworks\enable-mean\express-micro-

services\conf\ewconfig_sample

5. Open the following files and make the specified changes

<drive>:\Enterworks\enable-mean\express-micro-

services\conf\ewconfig

• Delete the “//” at the beginning of line 5

• Add <drive>: after the first ' and before /Enterworks

• Add “//” at the beginning of line 7.

• If you have a single server setup change jbossMaster to jboss.

• Change Line 46 from false to true.

• Change Line 52 to have a repository id.

• Change Line 55 to have a repository name.

• Change line 103 to:

connectionString :

"mongodb://ewsys:[email protected]:27017/channelReadin

ess?authSource=admin",

6. Open install_services.js in the express-micro-services folder.

a. Change line 7 to:

script: '<drive>:\\Enterworks\\enable-mean\\express-

micro-services\\server.js'

7. Open a new command prompt as an administrator.

8. Type the following commands into the command prompt


Page 213 of 247 Revised 10/18/2018

cd /d <drive>:\Enterworks\enable-mean\express-micro-

services

npm install

9. Open a command prompt as an administrator and type the following command:

cd /d <drive>:\Enterworks\enable-mean\express-micro-

services

Node install_service

10. Open Services and ensure that EnableExpress is running

8.5 Angular

8.5.1 Setting up Angular

1. Open a command prompt as an administrator.

2. Type the following commands into the command prompt:

cd /d <drive>:\Enterworks\enable-mean\angluar-ui\ng

npm install

cd /d

<drive>:\Enterworks\EnableServer\tomcat\webapps\webcm

mklink /d ng <drive>:\Enterworks\enable-mean\angular-

ui\ng

8.6 Confirming Channel Readiness is Installed

For more instructions on creating a Channel Readiness widget/shortcut, see the Enable 9 PIM Administrator’s Manual.

1. Create a channel readiness widget or shortcut.

2. Click Configure.

3. Set the Admin option to Yes and the Inbound option to No.

4. Click Save.

5. Verify that the widget/shortcut displays with the following image:

Widget:


Page 214 of 247 Revised 10/18/2018

Shortcut:

9 Installing AlignTrac

9.1 Erlang

9.1.1 Installing Erlang

Use the version of Erlang listed in Third-party Software Versions. If the version used in the following text and images is different than the one listed in Third-party Software Versions, use the version listed in Third-party Software Versions.

1. Open a web browser and go to the address specified in Third-party Software Versions.

2. Download the binary file for your operating system.



Page 215 of 247 Revised 10/18/2018

4. Select the following components to include in the installation:

• Erlang

• Associations

• Erlang Documentation

5. Click Next.


Page 216 of 247 Revised 10/18/2018

6. If necessary, change the install’s destination folder.

7. Click Next.


Page 217 of 247 Revised 10/18/2018

8. Select the Start Menu folder for the program’s shortcuts, or enter the name of a new

folder.

9. Click Install.


Page 218 of 247 Revised 10/18/2018

10. Once the download is finished click Close.

9.2 RabbitMQ

9.2.1 Installing RabbitMQ

Use the version of RabbitMQ listed in Third-party Software Versions. If the version used in the following text and images is different than the one listed in Third-party Software Versions, use the version listed in Third-party Software Versions.


2. Click LTS and select the installer for your computer.



Page 219 of 247 Revised 10/18/2018


• RabbitMQ Service

• Start Menu

5. Click Next.


Page 220 of 247 Revised 10/18/2018

6. If necessary, change the install’s destination folder.

7. Click Install.


Page 221 of 247 Revised 10/18/2018

8. Click Next.


Page 222 of 247 Revised 10/18/2018

9. Click Finish.

10 Elasticsearch & Auto-Classification

10.1 Erlang

10.1.1 Installing Erlang

Use the version of Erlang listed in Third-party Software Versions. If the version used in the following text and images is different than the one listed in Third-party Software Versions, use the version listed in Third-party Software Versions.

1. Open up a web browser and go to the address specified in Third-party Software

Versions.

2. Download the binary file for your operating system.


Page 223 of 247 Revised 10/18/2018



• Erlang

• Associations

• Erlang Documentation

5. Click Next.


Page 224 of 247 Revised 10/18/2018

6. If necessary, change the destination folder for the installation.

7. Click Next.


Page 225 of 247 Revised 10/18/2018

8. Select the Start Menu folder for the program’s shortcuts or enter the name of a new

folder.

9. Click Install.


Page 226 of 247 Revised 10/18/2018

10. Once the download is finished click Close.

10.2 RabbitMQ

10.2.1 Installing RabbitMQ

Replace <version> with the appropriate software version number, as per Third-party Software Versions. If the version used in the following text or images is different than the one listed in Third-party Software Versions, use the version listed in Third-party Software Versions.

1. Open up a web browser and go to the address specified in Third-party Software

Versions.

2. Select the download for your operating system. These downloads are located under

Downloads on Bintray or Downloads on GitHub.


Page 227 of 247 Revised 10/18/2018



• RabbitMQ Service

• Start Menu

5. Click Next.


Page 228 of 247 Revised 10/18/2018

6. If necessary, change the destination folder for the installation.

7. Click Install.


Page 229 of 247 Revised 10/18/2018

8. Click Next.


Page 230 of 247 Revised 10/18/2018

9. Click Finish.

10.3 Elasticsearch

10.3.1 Establish Java Environment Variable

1. Open a command prompt as an administrator. 2. Run sysdm.cpl.

3. A System Properties window will appear. 4. Click on Advanced to open an Environment Variables window.


Page 231 of 247 Revised 10/18/2018

5. Add a new JAVA_HOME variable if it does not exist. Set its value to:

<drive>:\Enterworks\jdk

10.3.2 Installing Elasticsearch

Use the version of Elasticsearch listed in Third-party Software Versions. If the version used in the following text and images is different than the one listed in Third-party Software Versions, use the version listed in Third-party Software Versions.


2. Download the MSI file.

3. Extract it to <drive>:\Enterworks

4. Open a command prompt in administrator mode and enter the following commands.

cd /d <drive>:\Enterworks\elasticsearch-<version>\bin

Service.bat install


Page 232 of 247 Revised 10/18/2018

5. The Elasticsearch installation page will appear:

6. Select to use a custom installation directory.

7. Set the install destination to:

<drive>:\Enterworks\Elastic\Elasticsearch\<version>.

8. Set the Data directory to:

<drive>:\Enterworks\Elastic\Elasticsearch\data

9. Set the Configuration directory to:

<drive>:\Enterworks\Elastic\Elasticsearch\config

10. Set the Logs directory to:


Page 233 of 247 Revised 10/18/2018

<drive>:\Enterworks\Elastic\Elasticsearch\logs

11. Click Next.

12. Select to install as a service.

13. Select:

• Use Local System Account

• Start the service after this installation is complete

• Start the service when Windows starts (Automatic)

14. Click Next.


Page 234 of 247 Revised 10/18/2018

15. Enter the Cluster name, Node name, and port information.

16. Click Next.


Page 235 of 247 Revised 10/18/2018

17. Select plugins.

18. Click Install to begin installation.

19. Elasticsearch installation will complete.


Page 236 of 247 Revised 10/18/2018

10.3.3 Configure Elasticsearch

1. Open the elasticsearch.yml file located in:


2. Add the following lines to the end of the elasticsearch.yml file: (Replace

<ServerName> with the name or I.P. of the server Elasticsearch is being installed on.)

network.host : <ServerName>

script.inline : true

script.update : true

http.port : 9200

3. Save and close the elasticsearch.yml file.

4. Open the jvm.options file located in:



Page 237 of 247 Revised 10/18/2018

5. Set the following options:

-Xmx to -Xmx5g

-Xms to -Xms5g

-Xss to -Xss4g

6. Save and close the jvm.options file.

7. Open the log4j2.properties file located in:


8. Set the logger.deprecation.level option as follows:

logger.deprecation.level = error

9. Save and close the log4j2.properties file.

10. Restart the Elasticsearch service.

11. Verify that the Elasticsearch server is available by navigating to: (Replace <ServerName>

with the name or I.P. of the server that Elasticsearch is installed on:

http://<ServerName>:9200

12. Information about the Elasticsearch server should be displayed.

11 Windows Authentication

11.1 EPIM

11.1.1 Setting Up Integrated Security with Database (Logging on to Database with Network

Domain Account)

1. The EPIM and EPX databases are set with network domain account as the database

owner.

2. Copy the file ntlmauth.dll from the appropriate architecture directory from

attached zip jtdsjdbc-sso.zip to your installation location, the

<drive>:\Enterworks\JDK\JRE\bin folder.

3. Remove the username and password from all database connection strings and update

connection string to use integrated security:


Page 238 of 247 Revised 10/18/2018

a. Enable Server Files update database settings: comment out username and

password keys, and add instance=USENTLMV2=true; to the JDBC URL:

#epim.connection.username=ewsys

#epim.connection.password=uMb/Xk0BwIA=

epim.connection.url=jdbc:jtds:sqlserver://DBServe

r:1433;databasename=EPIM;instance=USENTLMV2=true;

in following files:

<drive>:\Enterworks\EnableServer\tomcat\webapps\w

ebcm\WEB-INF\classes\sharedConfig.properties

<drive>:\Enterworks\EnableServer\jbossMaster\stan

dalone\configuration\conf\sharedConfig.properties

<drive>:\Enterworks\EnableServer\jbossSlave1\stan




b. EPX in <drive>:\EPX\bin\esjdbc.properties, update database

settings: comment out username and password keys, and add to the JDBC URL:

instance=USENTLMV2=true;

c. In the Enterworks.properties files, update: remove the username and

password, and update JDBC URLs for both EPIM and EPX in following files:

<drive>:\Enterworks\EPX\bin\conf\Enterworks.prope

rties

<drive>:\Enterworks\EnableServer\tomcat\webapps\w

ebcm\WEB-INF\classes\Enterworks.properties

<drive>:\Enterworks\EnableServer\jbossMaster\stan

dalone\configuration\conf\Enterworks.properties





d. For EnableWeb and Enable Utilities: update connection string to remove the

user name and password, and add Trusted_Connection=True; to the url:

<add name="EPIMConnectionString"

connectionString="Data Source= DBServer;Initial

Catalog=EPIM;Persist Security

Info=True;Trusted_Connection=True;MultipleActiveR


Page 239 of 247 Revised 10/18/2018

esultSets=True"


in the following files:

<drive>:\Enterworks\EnableWeb\Web.config

<drive>:\Enterworks\Utilities\DAMReportUtility\DA

MReportUtility.exe.configC:\Enterworks\Utilities\

MonitorDAMDrop\MonitorDAMDrop.exe.config

<drive>:\Enterworks\Utilities\DAMReportUtility\DA

MReportUtility.exe.config

<drive>:\Enterworks\Utilities\RegenerateDAMVarian

t\RegenerateDAMVariant.exe.config

<drive>:\Enterworks\PIMQL\PimqlRun.exe.config

4. Restart services.

12 Microservices

12.1 Microservices Third-party Dependencies

Replace <version> with the version number of the software as per Third-party Software

Versions.

1. RabbitMQ (+ Erlang):

• Erlang <version>

• RabbitMQ <version>

a. cd /d <drive>:\Program Files\RabbitMQ Server\rabbicmq_server-<version>\sbin

b. rabbitmq-plugins.bat enable rabbitmq_management

c. Hit enter twice to see the confirmation screen.

d. Requires rabbit service restart.


Page 240 of 247 Revised 10/18/2018

e. Test the management plugin with browser url:

http://localhost:15672

username = guest

password = guest

2. Elasticsearch - for typeahead and faceted search.

3. MongoDB for Channel Readiness.

4. ImageMagick

5. Ghostscript (used by ImageMagick for Postscript (EPS) files):

12.2 Microservice List

The following is a list of all Enable 9 microservices and a brief description of their functionality.

Microservices Functionality

enable2020-web-server-

service

Main Web server.


Page 241 of 247 Revised 10/18/2018


enable2020-api-go-

service

Main authentication point (JWT) with various utility endpoints.

enable2020-channel-

readiness-service

Channel Readiness Services. Interacts with MongoDB and compiles statistics.

enable2020-epx-broker-

service

Glue service between RabbitMQ and EPX Workflow.

enable2020-es-indexer-

service

Background synchronization of changed SQL Server data with Elasticsearch.

enable2020-es-search-

service

Glue Service between RabbitMQ and Elasticsearch.

enable2020-mq-logger-

service

Receives logging messages from other services and writes log files or writes to MongoDB.

enable2020-webcm-

broker-service

• Glue Service between RabbitMQ and

EnableServer J2EE REST API.

• Manages token authentication.

enable2020-dam-

manager-service

• Main controller processes upload DAM image

files.

• Everything except actual image variant generation

is in here, including writing files to Amazon S3.

Variant generation is performed by

enable2020-dam-magick-service.


Page 242 of 247 Revised 10/18/2018


enable2020-dam-magick-

service

• This service uses ImageMagick (open source, and

available on Linux and Windows servers).

• This service receives binary messages of original

images, then transmits back the generated

variants based on DAMVariant and

DAMVariantSizes repositories.

• This architecture makes actual image processing

horizontally scalable. You can add as many of

these processes as you want when needed. For

instance, if a customer wanted to process a

million images over the weekend, multiple servers

could be provisioned to perform the work, then

scaled back after the initial load was processed.

enable2020-es-manager-

service

Synchronizes data model changes with Elasticsearch index structure.

enable2020-dam-

manager-service

Utility Service that stores/retrieves files transferred via RabbitMQ.

• Cloud (S3) or Physical Disk

• DAM images

• Import/Export data files

12.3 Service Installation Constraints

1. (updated note on S3) Dam Manager must be installed on server with DAMRoot unless files

are stored in S3.

Dam Manager must be installed on server with DAMRoot (until enable2020-file-

service is complete).

2. enable2020-es-manager-service must be on the same server as Elasticsearch

installation.


Page 243 of 247 Revised 10/18/2018

12.4 Basic Installation

1. Install the third-party tools as described in Enable 9 Installation Manual.

2. Verify installation of third-party tools.

A. Ensure you can connect to MongoDB with Robo3T.

B. Enable RabbitMQ management console. Create a username and password.

C. Ensure Elasticsearch is available/active from your browser or Postman with:

GET http://{servername}:9200

The response should be a message such as:

{

"name" : "vPDW8Ym",

"cluster_name" : "elasticsearch",

"cluster_uuid" : "KB6d9BH6Rhe-wimhmpVOuw",

"version" : {

"number" : "5.0.0",

"build_hash" : "253032b",

"build_date" : "2016-10-26T04:37:51.531Z",

"build_snapshot" : false,

"lucene_version" : "6.2.0"

},

"tagline" : "You Know, for Search"

}

3. File structure:

• D:\Enterworks\Enable2020

• D:\Enterworks\Enable2020\Enable2020 (angular application files)

• D:\Enterworks\Enable2020\Services

• D:\Enterworks\Enable2020\bin (locations of microservice .exe files)

• D:\Enterworks\Enable2020\install (location of install generator)


Page 244 of 247 Revised 10/18/2018

4. All services for a given installation have the same prefix. The prefix is added to the front of

the service name. For example, ewapp9-enable2020-web-server. ewapp9 is the

prefix.

The prefix is there as an additional identifier in the event there are multiple microservices of the same type on one server. For instance, for RabbitMQ, the prefix separates a microservice from other instances of the same type of microservice. This prevents them from receiving each other’s messages.

5. Because of the prefix, you can have multiple instances using the same.

6. A .cmd script with the unique list of configuration parameters generates another .cmd

script that creates the Windows Services. There is only one script that needs to be

configured. The create-install-enable2020-services script makes the second

script that configures all the other microservices using the values specified in it.

Here is EWAPP6's make install script:

create-install-enable2020-services ^

-esInstallRoot=c:/enterworks/Elasticsearch-5.0.0 ^

-prefix=ewapp6 ^

-enterworksRoot=D:\Enterworks ^

-esInstallRoot=c:/enterworks/Elasticsearch-5.3.1 ^

-servicesPath=D:\Enterworks\enable2020\services\bin ^

-epimServer=localhost:8090 ^

-rabbitServer=ksampson:[email protected] ^

-esHost=ewapp14:9200 ^

-magickBinPath="C:\Program Files\ImageMagick-7.0.6-

Q16" ^

-enableDbPwd=uMb/Xk0BwIA\= ^

-enableDbPwdDecode=ewsys ^

-enableDbServer=localhost ^

-enableDbName=epim ^

-enableDbUser=ewsys ^

-disableAdmin=true ^

-disableReport=true ^

-disableSystem=true ^

-port=85 ^


Page 245 of 247 Revised 10/18/2018

-cliBuildFolder=d:\Enterworks\enable2020\enable2020-

indus-latest > install-ewapp6.cmd

pause

7. One script will be generated that serves for all services. Modify the generated script to

remove any services that will run on another computer, such as es-manager.

8. Create \enable2020\bin\sessions and \enable2020\bin\downloads.

9. Linux - AWS CentOS.

12.5 Example Add-on Microservice

Enable2020-web-server-service is the main Web server. It has three different ways to add custom integrations.

• Including routes to additional static files (.html).

• Including routes to proxy to an external Web server.

• Including routes to another microservice queue (custom microservices).

They are described in the following sections.

12.5.1 Additional Static Files

You may want to add a custom web component and bring it up in a widget, or add a custom popup from an attribute define button.

Your web files will be treated as part of the same application, and therefore have the same cookies. This means you can include javascript that makes any REST API call.

To do this, place your files in a location that can be reached by the Web server process. Then add an entry in the install script as follows (replace <drive> with the appropriate drive

name):

-customPaths=/custom;<drive>:/Enterworks/custom ^

Each path is defined by two paths, separated by a semicolon. The first entry is the relative path specified in the URL. The second entry is the physical path to the associated folder.

You can supply multiple paths by using a comma separator between each semicolon-delimited pair:


Page 246 of 247 Revised 10/18/2018

-

customPaths=/custom1;<drive>:/Enterworks/custom1,/custom2;D

:/Enterworks/custom2 ^

12.5.2 Proxies

Similar to additional static files, you can point a relative path URL to another Web server.

Again, any javascript running from files served by the proxied server will have access to the REST API. Add an entry in the install script as follows:

-customProxies=/myapp1;myAppServer1:8080

Each proxy is defined by two paths, separated by a semicolon. The first entry is the relative path specified in the URL. The second entry is the URL for the proxy.

Basically, if you refer a widget's custom URL to /myapp1/somefile.html, then somefile.html lives on an external Web server.

The proxy Web server can be written in any language.

There is an example Go Language Web server that can be installed as a Windows service. The example serves static files from a command line configured path. It is located at:

/enable2020-go/service-mains/example/enable2020-example-

web-server-service.go

12.5.3 Custom Microservices

The preferred way to customize and enhance enable2020 is to write a custom microservice that receives messages from RabbitMQ.

Your microservice should define a queue on the same RabbitMQ server. The Web server will capture any request on the custom queue path and send it to your custom queue.

-

customQueues=/custom1;myCustomQueue1,/api/custom2;customQue

ue2

Each microservice is defined by two paths, separated by a semicolon. The first entry is the relative path specified in the URL. The second entry is the RabbitMQ queue name.

It isn't required, but your queue names should be parameterized and follow the same naming convention as the rest of the microservices.

An example of a custom microservice is provided at:

/enable2020-go/service-mains/example/enable2020-example-

micro-service.go


Page 247 of 247 Revised 10/18/2018

Again, the example is written in Golang, mainly because it is easy to install as a Windows service. But you could use any process and language to connect to RabbitMQ and establish a queue worker.

The RabbitMQ documentation web page has examples in eleven languages including Java, JavaScript, Python, C#, and Go. The documentation is available at:

https://www.rabbitmq.com/getstarted.html

The message structure sent from the Web server is basically like an HTTP request and has the following structure:

type EwMicroServiceMsg struct {

Method string

URI string

Body []byte

Headers string

EwToken string // Used for authentication of other

microservices

}

If you POST a JSON document, it will be serialized in the Body. It's up to you to deserialize it.