installation guide - epmwareepmware.com/doclibrary/epmware installation guide.pdf · installation...

19
Installation Guide EPMWARE ® Version 1.0 EPMWARE, Inc. Published: August, 2015

Upload: hahanh

Post on 28-Apr-2018

223 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

Installation Guide

EPMWARE ®

Version 1.0

EPMWARE, Inc.

Published: August, 2015

Page 2: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

Information in this document, including URL and other Internet Web site references, is

subject to change without notice. Unless otherwise noted, the example companies,

organizations, products, domain names, e-mail addresses, logos, people, places, and

events depicted herein are fictitious, and no association with any real company,

organization, product, domain name, e-mail address, logo, person, place, or event is

intended or should be inferred. Complying with all applicable copyright laws is the

responsibility of the user. Without limiting the rights under copyright, no part of this

document may be reproduced, stored in or introduced into a retrieval system, or

transmitted in any form or by any means (electronic, mechanical, photocopying,

recording, or otherwise), or for any purpose, without the express written permission of

EPMware Inc. EPMware, Inc. may have patents, patent applications, trademarks,

copyrights, or other intellectual property rights covering subject matter in this document.

Except as expressly provided in any written license agreement from EPMware, Inc., the

furnishing of this document does not give you any license to these patents, trademarks,

copyrights, or other intellectual property.

© 2015 EPMWARE, Inc. All rights reserved.

EPMWARE is a registered trademark of EPMWARE, Inc. in the United States and/or

other countries.

All other trademarks are property of their respective owners.

Page 3: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

Contents

Installation Guide .............................................................................................................. 1

Contents ............................................................................................................................. 3

Introduction ....................................................................................................................... 5

Purpose .............................................................................................................................. 6

Prerequisite Software Installations ................................................................................. 6

Database Installation ........................................................................................................ 6

Prerequisites .................................................................................................................... 6

Create Tablespaces ......................................................................................................... 6

Create New Schema ........................................................................................................ 7

GRANT Tablespace Quota to EW schema ..................................................................... 7

GRANT privileges ............................................................................................................ 7

Create Sleep function ...................................................................................................... 8

Create DB Directories ...................................................................................................... 8

GRANT Socket permission .............................................................................................. 8

GRANT Folder permission............................................................................................... 9

GRANT Email permission ................................................................................................ 9

Install Database Objects................................................................................................. 10

To Install Database Objects .......................................................................................... 10

Install SSH ....................................................................................................................... 10

To Install Cygwin ........................................................................................................... 10

Test SSH Connection .................................................................................................... 12

Install Tomcat Apache .................................................................................................... 12

Install EPMware Application .......................................................................................... 13

Java .war file .................................................................................................................. 13

Windows System Environment Variable ........................................................................ 13

Install EPMware Agent .................................................................................................. 14

Start Apache .................................................................................................................... 16

Set JDBC Properties ....................................................................................................... 17

Page 4: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

EPMware Application Settings ...................................................................................... 17

Global Settings .............................................................................................................. 17

Planning Classic - Generate Password file ................................................................... 18

Page 5: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

5

Introduction

EPMware is a master data management and workflow tool that manages master data

and enforces your organization’s workflow around the everyday processes that surround

your metadata changes. By configuring shared dimensions in EPMware, users request

metadata once and our workflow engine routes the request to obtain approvals and

deploys the metadata to the participating target systems. This allows standardization and

rationalization of your metadata to evolve as your organization develops its master data

strategy. The EPMware dashboard allows users, managers, and application

administrators to monitor the status of metadata requests in real time. Follow a request

from the initial Create stage through its Review, Approve and Deploy stages. A graphical

representation of each request's status in the workflow allows users to identify any

bottlenecks in the metadata request process and determine if an escalation is required.

Seamless integration to Hyperion EPMA, Classic Hyperion Financial Management

(HFM), Classic Essbase and Classic Planning applications allows EPMware to deploy

metadata without manual intervention or file manipulation from an administrator.

Approved metadata is automatically deployed or scheduled for deployment using our built

in scheduler.

One-click import of your target system hierarchies allows users to clearly visualize how

metadata will appear in their production environments. A configurable security module

integrates with your current LDAP or Microsoft Active Directory (MSAD). Build, maintain

and scale task driven workflows. Administrators model, build and maintain fully dynamic

and scalable workflows using the Workflow Builder™. By using a combination of stages

and tasks, Workflow Builder™ enables creation of any number of workflows that visually

define your organization’s business process, and then enforces it. The Workflow

Builder™ includes reusable workflow tasks, rule based validations, exception handling,

email notifications for all workflow stages, custom functions and scripting for limitless

customizations. Centrally manage metadata deployments using the EPMware

deployment module. It manages how and when metadata requests are deployed. Load

metadata on demand or schedule a batch to run during off hours. Deployment metrics for

all your EPM applications are on one page. Monitor in real time as “one time” or batches

are deployed to their respective target applications. Create a recurring calendar for daily,

weekly or monthly metadata deployments. Audit reports log every transaction, sign-off &

deployment. EPMware maintains a complete audit trail of all transactions from request to

deployment. Every transaction can be queried using reports included in the Audit module.

Page 6: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

6

Purpose

The purpose of this document is to provide instructions on installation of EPMware

application components.

● Oracle Database

● Prerequisite Software Components

● EPMware Database Objects

● EPMware Application Server

Prerequisite Software Installations

1. Install Oracle Database 11.X or 12.x Standard or Enterprise Edition

2. Install the latest version of Jython (www.jython.org)

3. Ensure Jython’s bin folder is in the system path. For example: d:\jython\bin (On

4. Windows it should be added as a system environment variable)

5. Ensure Java 1.7.x or above is installed. (www.java.com)

6. Ensure Java is in the system path. (On Windows it should be added to the

system environment variables)

7. Install SSH (See Installing SSH)

8. Install Tomcat Apache Version 8.0.24 (See Installing Tomcat)

Database Installation

Prerequisites

● Oracle database is installed and is running

● Oracle database access as SYS user

Create Tablespaces Create DATA and INDEX tablespaces for EW database objects (tables, indexes and

stored packages etc. using SYSTEM or SYS user.

The following statements are shown as an example. Please consult Database

Page 7: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

7

Administrator for location, size and naming convention of data files associated with

tablespaces.

Execute the following statements as SYS user:

CREATE tablespace EWD DATAFILE

'D:\app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND ON

NEXT 500K MAXSIZE 2048M;

CREATE tablespace EWX DATAFILE

'D:\app\epmadmin\oradata\epm\EWX.dbf' SIZE 10M AUTOEXTEND ON NEXT

500K MAXSIZE 512M;

Create New Schema Execute following statements as SYS user to grant unlimited disk space quota to EW

tablespaces. Unlimited option can be replaced with other values as needed:

CREATE user ew identified by <password>;

GRANT Tablespace Quota to EW schema Login as SYSTEM User and create new user EW as shown below:

alter user ew quota unlimited on EWD;

alter user ew quota unlimited on EWX;

GRANT privileges Execute these statements as SYS user:

grant connect to ew;

grant create table to ew;

grant create sequence to ew;

grant create view to ew;

grant create procedure to ew;

grant create type to ew;

grant execute on dbms_crypto to EW;

grant create job to ew;

Page 8: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

8

Create Sleep function Create Sleep function and provide EXECUTE grant on that function to EW Schema.

Execute these statements as SYS user:

CREATE OR REPLACE PROCEDURE sleep(seconds NUMBER) AS

BEGIN

DBMS_LOCK.SLEEP(seconds);

END;

/

CREATE OR REPLACE public synonym sleep FOR sleep;

GRANT EXECUTE ON sleep TO ew;

Create DB Directories Execute these statements as SYS user.

CREATE OR REPLACE DIRECTORY ew_archive_db_dir AS 'D:\ew\db\data\archive';

CREATE OR REPLACE DIRECTORY ew_stage_db_dir AS 'D:\ew\db\data\stage';

CREATE OR REPLACE DIRECTORY ew_temp_db_dir AS 'D:\ew\db\data\temp';

GRANT READ,WRITE ON DIRECTORY ew_archive_db_dir TO EW;

GRANT READ,WRITE ON DIRECTORY ew_stage_db_dir TO EW;

GRANT READ,WRITE ON DIRECTORY ew_temp_db_dir TO EW;

GRANT Socket permission For every server that needs to be connected by EPMWare application for import or for

deployments, socket permissions need to be granted to EW schema.

For Example:

EPMware application will be communicating with server called “epmware5” from

database API.

Page 9: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

9

Repeat this step for each server that need to be connected to EPMWare:

BEGIN

dbms_java.grant_permission ( 'EW',

'SYS:java.net.SocketPermission', 'epmware5', 'connect,resolve' );

COMMIT;

END;

GRANT Folder permission Grant Read/Write permission to physical folders for following DB Directories:

EW_TEMP_DB_DIR (Example below shows actual physical path for this DB

directory is D:\ew\db\data\temp)

EW_ARCHIVE_DB_DIR (Example below shows actual physical path for this DB

directory is D:\ew\db\data\archive)

EW_STAGE_DB_DIR (Example below shows actual physical path for this DB

directory is D:\ew\db\data\stage)

BEGIN

dbms_java.grant_permission ( 'EW', 'SYS:java.io.FilePermission',

'D:\ew\db\data\temp\-', 'read,write,delete' );

dbms_java.grant_permission ( 'EW', 'SYS:java.io.FilePermission',

'D:\ew\db\data\archive\-', 'read,write,delete' );

dbms_java.grant_permission ( 'EW', 'SYS:java.io.FilePermission',

'D:\ew\db\data\stage\-', 'read,write,delete' );

COMMIT;

END;

GRANT Email permission Replace “localhost” with the SMTP email server name:

BEGIN

dbms_java.grant_permission( 'EW',

'SYS:java.util.PropertyPermission', '*', 'read,write' );

dbms_java.grant_permission( 'EW',

'SYS:java.net.SocketPermission', 'localhost', 'resolve' )

COMMIT;

END;

Page 10: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

10

Install Database Objects

To Install Database Objects 1. Copy EW Database ew_db_install zip file to database server.

2. Unzip the file

3. Run ew_install.bat. This script will expect three parameters. EW Schema

name, Password and N/Y flag to drop all objects under the EW schema. Default

value for the third parameter is N. If Y is passed then all objects from schema

“EW” are removed before loading new schema objects. If schema name is

different from EW then modify ew_drop_objects.sql file.

4. Result of the batch file will be as shown below.

5. Check the ew_driver.log log file for any errors.

Install SSH

If the EPMware application is installed on a Windows server, install cygwin which has

SSHD service. If a Windows server already has ssh service running then skip this part of

the install. For each target application where metadata will be deployed, SSH service

must be running and cygwin must be installed. Download cygwin from www.cygwin.com

and follow instructions on the cygwin site: http://cygwin.com/install.html.

To Install Cygwin

1. Download Cygwin and save the setup.exe file to your Desktop.

2. Run the setup.exe file.

3. Select the defaults for the following options:

Page 11: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

11

a. Install from Internet

b. Install Root Directory: C:\cygwin

c. Install for All Users

4. Specify a folder for the local package directory that is not the Cygwin root folder,

for example, C:\cygwin\packages.

5. Specify the connection method. For example, if the host is connected to the

Internet through a proxy server, specify the proxy server.

6. Select the mirror site from which to download the software.

7. Select the openssh package for installation:

a. Under the Net category, search for openssh

b. Locate the openssh package and click Skip

c. The package is selected

d. Click Next

e. Any unsatisfied dependencies are listed

8. Leave the Select Required Packages option selected and click Next

9. The packages are installed

10. Click Finish

11. Add C:\cygwin64\bin to the PATH environment variable

12. Run ssh-host-config to configure ssh service

13. Use default values

14. Stop cygwin ssh service

Page 12: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

12

15. Open sshd_config file (located at c:\cygwin\etc folder) and add the following

lines

at the end. This will prevent the follwing “Algorithm Negotiation fail” error. This

error will occur only if ssh server side default protocol differs from client side.

KexAlgorithms diffie-hellman-group-exchange-sha1,diffie-hellman-group1-sha1

Test SSH Connection

Run ssh from source server and connect to target server.

For Example:

ssh epmware5

When ran for the first time you will be prompted for a confirmation, enter Yes.

C:\Users\Administrator>ssh epmware5

ssh: connect to host epmware5 port 22: Connection refused

C:\Users\Administrator>ssh epmware5

The authenticity of host 'epmware5 (::1)' can't be established.

ECDSA key fingerprint is

SHA256:LoiCn9lLTASHbrtNpT7pzgrYUMCBftELCUqbRM0qCZ4.

Are you sure you want to continue connecting (yes/no)? yes

Warning: Permanently added 'epmware5' (ECDSA) to the list of known

hosts.

Administrator@epmware5's password:

Administrator@EPMWARE5 ~

$

Install Tomcat Apache

Download Tomcat Apache from http://tomcat.apache.org/download-80.cgi

The latest version supported by EPMWare is 8.0.24

1. Download the zip file (or any other format applicable for the install)

2. Transfer the zip file to the EPMWare application server

3. Unzip the file to target location on the server. For Example: d:\apache-

tomcat-8.0.24

Page 13: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

13

Install EPMware Application

Java .war file Copy epmware.war file to <apache>\webapps folder.

Windows System Environment Variable

To Setup environment variable for JRE_HOME

1. Locate folder where JRE is installed.

2. Go to Control PanelSystemSecurity\System, select Advanced System

Settings.

3. Select Environment Variables button

4. Create New System Variable for JRE_HOME as shown below.

Page 14: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

14

Install EPMware Agent

The Agent files are required to be installed on each server where the EPMware

application either imports or exports metadata directly. These files are placed directly

under the home directory of the SFTP user.

In the example below, the agent files are installed on a Windows server.

Page 15: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

15

SFTP user name: Administrator

SFTP home directory: C:\cygwin64\home\Administrator

EPMware Agent zip file: ew_agent_files.zip

To Install the Agent on the Server

1. Logon to the server where agent need to be installed

2. Go to the home directory of the SFTP user

3. Unzip Agent zip file ew_agent_files.zip directly under the home directory

4. Select home directory of the user to extract zip file. By default it will have

ew_agent_files folder in it which will need to be removed.

Page 16: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

16

5. After extract the folder should look like the following.

Start Apache

From Apache home navigate to bin folder and run startup.bat to start Apache. A DOS

window will open with Apache running.

Page 17: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

17

Set JDBC Properties

Stop Apache service and navigate to <APACHE_HOME>\webapps\epmware\WEB-

INF\classes folder. The folder gets created only after placing epmware.war file and

starting Apache.

Modify fs_system.properties file for JDBC properties:

#JDBC

jdbc.driver=oracle.jdbc.driver.OracleDriver

jdbc.url=jdbc:oracle:thin:ew@//localhost:1521/epm

jdbc.user=ew

jdbc.password=ew123

jdbc.maxPoolSize=40

jdbc.minPoolSize=5

jdbc.initialPoolSize=5

jdbc.maxIdleTime=300

jdbc.maxStatements=200

jdbc.preferredTestQuery=select 1

jdbc.idleConnectionTestPeriod=60

After modifying this file, restart apache server.

EPMware Application Settings

Global Settings Configure Global settings for EPMware applications such as, email settings, application

settings etc.

To navigate to Global settings ConfigurationMiscGlobal.

Setting Type Value Comments

SSH Port Set this to be port used for ssh communication

Default value is 22

Page 18: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

18

Planning Classic - Generate Password file This section is applicable if you have a Planning Classic application and either Auto

Import or direct deployment is enabled. Generation of a password file is required and its

location specified in the Application Configuration Properties Tab.

To Generate a Password File

1. Logon to the Planning Application Server

2. Navigate to folder

D:\Oracle\Middleware\user_projects\epmsystem1\Planning\Plan

ningAppName

3. Run PasswordEncryption.cmd <passwordFile> (specify the full path for

password file)

For Example:

D:\Oracle\Middleware\user_projects\epmsystem1\Planning\planningApp

>PasswordEncryption.cmd d:\ew\app\ew_hp_cl_pwd.txt

Enter password to encrypt:

Password has been encrypted and written to the file

d:\ew\app\ew_hp_cl_pwd.txt successfully!

Note: If the file path is not specified the Password File is generated at the location

where this command is run.

To Reference Password File in EPMware

1. Select application from LOV, select PASSWORD_FILE from the grid and right

click Edit Properties to change the property value.

Note: Specify the filename with the full path in the target application parameter as

shown below.

Page 19: Installation Guide - EPMwareepmware.com/DocLibrary/EPMware Installation Guide.pdf · Installation Guide ... Java .war file ... \app\epmadmin\oradata\epm\EWD.dbf' SIZE 1024M AUTOEXTEND

19