EPM Maestro Tutorial: How to install Standalone

Introduction

As you might know, the latest version (v15) of EPM Maestro by AMOSCA uses a Java Web service to expose the new HFM Java based API to EPM Maestro. As a prerequisite, EPM Maestro Java web service must be installed on a EPM server, HFM Web seems to be recommended by the vendor.

However, for various reasons, you might what to keep EPM and third-party products like EPM Maestro strictly separated.

Never used it? Request a 30 day trial here.

What will you learn

After completing this tutorial you will know how to install EPM Maestro standalone successfully. In addition you will get some best practice guidelines. This tutorial doesn't replace the official installation and configuration manual.

Assumptions

I am assuming that you know what EPM Maestro is and what it does. Version 15.3.2.6 of EPM Maestro is used as a referance for writing this tutorial, which was the latest version at the time of writing. %MAESTRO_HOME% which represents the installation folder of EPM Maestro Web Services e.g. C:\AMOSCA\Maeastro\. Default installation of Windows 2012 R2.

Make sure to replace %MAESTRO_HOME% with the actual path!

Additional configuration e.g. SSL and using a Microsoft AD account is out of scope for this tutorial.I kindly refer to the official installation manual.

Prerequisites

The following prerequisites must be in place or downloaded in order to be able to complete this tutorial:

• Network connectivity to HFM Web Server (HTTP) from the server on which we are going to install Maestro Web Services.
• Oracle Java JDK v1.8, which can be downloaded here.
• Payara Server v4.1.x, which can be downloaded here.
• Maestro Copy Jar script, which can be downloaded here.
• reg.properties file from a configured EPM server.
• HFM API from a installed EPM server containing HFM.
• 7-Zip
• Notepad++

Installation

Prepare folder structure

1. Create the folder structure in which we are going to install Maestro Web Services and all it's prerequisites.

# Adjust to match your requirement [STRING]$MEASTRO_HOME="C:\AMOSCA\Maestro"   #-- do not edit below --- $FLDRS = {}.Invoke() $FLDRS.Add("hfmapi\config\foundation\11.1.2.0") | Out-Null $FLDRS.Add("hfmapi\epmsystem1") | Out-Null $FLDRS.Add("hfmapi\EPMSystem11R1") | Out-Null $FLDRS.Add("storage\local\Config") | Out-Null $FLDRS.Add("storage\shared") | Out-Null $FLDRS.Add("deployment") | Out-Null   ForEach($FLDR in $FLDRS){    Write-host "Creating $MEASTRO_HOME\$FLDR"    New-Item -Force -ItemType Directory -Path "$MEASTRO_HOME\$FLDR" | Out-Null }   Remove-Variable -Name FLDRS

Install Oracle Java JDK

1. If Java JDK is not already installed, install it by running the installer.
2. The copy the folder jdk1.8.0_xx, which is typically located in  "C:\Program Files\Java", to the root of %MAESTRO_HOME%. 
3. Rename jdk1.8.0_xx to jdk.
4. Optional: Uninstall the Java JDK from Windows through  "Programs and Features".

Install and configure Paraya Server

1. Extract the contents of the file payara-4.1.x.xxx.x.zip to %MAESTRO_HOME%.
2. Rename the folder "payara41" to "payara".
3. Using Notepad++, edit the file "domain.xml" located in "%MAESTRO_HOME%\payara\glassfish\domains\payaradomain\config\".
4. Find section and change 8080 to 42070 and 8181 to 42071

5. Using Notepad++, edit the file "asenv.bat" located in "%MAESTRO_HOME%\payara\glassfish\config\" and add the AS_JAVA with the value %MAESTRO_HOME%\jdk:

   set AS_JAVA=C:\Amosca\Maestro\jdk

6.  From the command line, start Paraya domain for the first time by executing the commands:

Configuration required for epmmJService

1. Using a web browser, navigate to http://localhost:4848 (assuming default port).
2. In the left pane, navigate to Configurations -> Server-Config -> JVM Settings and add the variables as show:




-DEPM_ORACLE_INSTANCE=%MAESTRO_HOME%\hfmapi\epmsystem1







-DEPM_ORACLE_HOME=%MAESTRO_HOME%\hfmapi\EPMSystem11R1







-DEPM_MAESTRO_LOCAL_STORAGE=%MAESTRO_HOME%\storage\local







-DEPM_MAESTRO_SHARED_STORAGE=%MAESTRO_HOME%\storage\shared




3. Copy the "reg.properties" file from the EPM environment you are going to use Maestro against, which is typically located in "\Oracle\Middleware\user_projects\config\foundation\11.1.2.0", to "%MAESTRO_HOME\hfmapi\config\foundation\11.1.2.0".
4. Make sure that the hostname mentioned in the reg.properties file can be reached from the server we are installing on. 
5. Prepare the script "EPMMaestroJarCopyScript_11124.cmd" downloaded earlier by modifying the values of the following variables to match your EPM environment:

   mwhome = "%EPM_ORACLE_HOME%\..\" :: Redirect to a temporary located, since we install Maestro standalone. destfolder = "C:\temp\hfmapi"

6. Copy the HFM API jar files, collected using the "EPMMaestroJarCopyScript_11124.cmd" script earlier, from a HFM server to "%MAESTRO_HOME%\payara\glassfish\domains\payaradomain\lib"
7.  Restart Paraya Server by executing the commands from the command line:

   cd /d %MAESTRO_HOME%\payara\glassfish\bin asadmin stop-domain payaradomain asadmin start-domain payaradomain

Deploy epmmJService

1. Extract the content of "epmmJService_vxxxxx_xxx" to "%MAESTRO_HOME%\deployment".
2. Deploy epmmJService application by executing the commands from the command line:

cd /d %MAESTRO_HOME%\payara\glassfish\bin asadmin deploy %MAESTRO_HOME%\deployment\epmmJService.war

3. Optional: Delete the folder "MAESTRO_HOME%\deployment" after successful deployment.
4. Stop the Parayadomain domain by executing the commands from the command line: 

cd /d %MAESTRO_HOME%\payara\glassfish\bin asadmin stop-domain payaradomain

Create Windows Service

1. Create a the Windows service by executing the command in the command line:

cd /d %MAESTRO_HOME%\payara\glassfish\bin asadmin create-service --name epmmJservice payaradomain

2. Optional: Add a friendly name to the newly created Windows service (please note the intentional space after the equal character):

sc config epmmJService DisplayName= "EPM Maestro Java Service"

3. Start the newly created Windows service ""EPM Maestro Java Service"

Final Note

By removing versions from folder names it simplifies product and prerequisite upgrades.  The dependencies to an existing EPM installation are only related to the HFM API which is depended on the existence of the reg.properties file (used to query Shared Services Registry Database) and the two environment variables %EPM_ORACLE_HOME% / %EPM_ORACLE_INSTANCE%. The end result is a clean install which is easy to manage.