To set up the sample client environment:

1. Optional: If you are not running on the same machine on which Oracle Enterprise Performance Management Workspace, Fusion Edition is installed, copy the folder EPM_ORACLE_HOME/products/Profitability/samples/wsclient to the machine on which the sample is to be accessed.

2. Copy the following files from the source folders listed below to the wsclient folder:

   Table 2. Required Files for Sample Client

   Source Folder	File Name
   EPM_ORACLE_HOME/../user_projects/domains/EPMSystem/config/fmwconfig	jps-config.xml
   EPM_ORACLE_HOME/../user_projects/domains/EPMSystem/config/fmwconfig	<<Associated keystore file.XXXX.jks>>
   If you are using file-based security, EPM_ORACLE_HOME/../user_projects/domains/EPMSystem/config/fmwconfig	cwallet.sso

3. Edit the hpm_ws_client.properties file to reflect your local settings:

   # Full Path of the jps-config.xml file in use.
   jps.config.file=C:/wsclient/jps-config.xml
   
   #WSS Recipient key alias name used.
   wss.recipient.key.alias=adminalias
   
   # WSS Credential Store Framework key used.
   wss.csf.key=epmpcm.credentials
   
   # HPCM WSDL URL which is to be accessed. Eg: http://localhost:19000/profitability/ProfitabilityService?WSDL (or) {DRIVE_LETTER}:/{FILE_PATH}/FILE_NAME.wsdl
   hpcm.wsdl.url=http://localhost:19000/profitability/ProfitabilityService?WSDL
   
   # Delimiter used to separate String literals in paramters
   string.delimiter=_

4. Optional: If you are not running on the same machine on which the Oracle Enterprise Performance Management Workspace, Fusion Edition is installed, download and install JDeveloper 11.1.1.3 locally to obtain the appropriate JAVA_HOME and MIDDLEWARE_HOME folders.

5. From a command or shell window, set the following environment variables:

   Table 3. Sample Client Environment Variables

   Environment Variable	Location
   JAVA_HOME	Location in which Java Development Kit 1.6.0_18 or higher is available: For Windows, enter SET JAVA_HOME=C:/Oracle/Middleware/jdk160_18 For UNIX, enter export JAVA_HOME=/usr/c/Oracle/Middleware/jdk160_18
   MIDDLEWARE_HOME	Location in which Oracle Middleware home is installed. For Windows, enter SET MIDDLEWARE_HOME=C:/Oracle/Middleware For UNIX, enter export MIDDLEWARE_HOME=/usr/c/Oracle/Middleware

6. In the command window, go to C:\wsclient, and then enter the following command:

   hpm_ws_client.bat -help

   A list of all available functions is displayed.

7. Use the format and operations specified in the sample client file to build your custom script. See Using the Sample Client File.

  To use the sample client file:

1. In the command window, go to C:\wsclient. See Setting Up the Sample Client Environment.

2. Enter the following command:

   hpm_ws_client.bat - help

   The list of all available functions is displayed.

   Table 4. Oracle Web Services Operations for Profitability and Cost Management

   Operation	Description
   getApplications	List all existing Profitability and Cost Management applications.
   getPOVs	List all existing POVs for a selected application.
   getStages	List all existing stages for a selected application.
   copyPovData	Copy POV data from a source POV combination to a destination POV combination. See
   deleteApplication	Delete an existing Profitability and Cost Management application. See
   deployCube	Deploy the database (cube) for a selected application.
   getTaskflowStatusByProcessName	Obtain the current status of the job process name. The following valid status values are listed: New Active Stopped Done
   runImportConfiguration	Import from selected staging tables into the Oracle Hyperion Profitability and Cost Management, Fusion Edition application.
   processCalcScriptOptions	Initiate the selected actions for a selected Application Name, POV and Layer. The following options are available: Clear All Clear Calculated Generate Calculate Transfer data after calculation.
   processGenealogyExecutionPaths	Generate the selected contribution paths for genealogy for a selected application.

3. Select the operation to be performed, and enter the command in the following format:

   hpm_ws_client.bat - help operation_name

   For example, to obtain the usage details of getPovs operation, enter the command in the following format:

   hpm_ws_client.bat - help getPovs

4. To use the sample client file to perform an operation, enter the command in the following format:

   hpm_ws_client.bat operation_name <<parameters>>

   • Example 1: List All Applications

     For example, to obtain a list of all available applications, enter the command:

     hpm_ws_client.bat getApplications

   • Example 2: List All POVs

     For example, to obtain a list of all POVs for a given application, enter the command:

     hpm_ws_client.bat getPovs <<application name>>

  To recompile the source code:

1. Open a command or shell window to specify the location of the common.components.home folder.

   This folder is defined as MIDDLEWARE_HOME/oracle_common, where MIDDLEWARE_HOME is set as follows:

   • For Windows: SET MIDDLEWARE_HOME=C:/Oracle/Middleware

   • For UNIX: export MIDDLEWARE_HOME=/usr/c/Oracle/Middleware

2. Pass the folder location to Ant, using one of the following methods:

   • As a command line parameter. For example:

     ant -Dcommon.components.home=C:/Oracle/Middleware/oracle_common

   • In the build.properties file, open the file for editing and uncomment the definition of the common.components.home variable. For example:

     common.components.home=C:/Oracle/Middleware/oracle_common

3. Recompile the source code.