SECTION A:  Export Source Shared Services Information with the use of the CSS Import and Export utility.

1) In the Shared Services server machine, find the utility cssimportexport.zip located under:

%HYPERION_HOME%\common\utilities\CSSImportExportUtility.

2). Unzip the file named cssimportexport.zip in the current location.

3) Create two folders one called "files" and another called "logs" under the directory of

%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport

4) Go to the "....CSSImportExportUtility\cssimportexport\importexport\samples" folder of the utility and copy the importexport.properties file to the root folder of the utility, "....CSSImportExportUtility\cssimportexport\importexport".

5) Configure the importexport.properties file:

a. Open the file importexport.properties file under the "....CSSImportExportUtility\cssimportexport\importexport" directory. Each option of the file is fully documented. The file contains three sections, Global, Export and Import section. The Global section defines the Shared Services environment that you want to import from or load into. The Export section defines the export options. Import section defines import options.

b. Configure the location of the CSS file. The URL is the best method to define it. Ensure, that the location displays the correct syntax as in:

importexport.css=http://SERVERNAME:58080/interop/framework/getCSSConfigFile

c. Configure the Shared Services host and port number as follows:

importexport.cmshost=SERVERNAME

importexport.cmsport=58080

d. Configure the administrator account that will be used as the default admin account that has all of the Shared Services privileges to export and load:

importexport.username=admin

e. Configure the password for the administrator account. The password is typed in clear text but the utility will encrypt the password in the file when you execute the utility.

Clear Text

importexport.password=Password

f. Configure the location of the trace log. Ensure to define path locations with the use of forward slashes, similar to Unix path convention. For example:

importexport.trace.events.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\logs\trace.log

g. Configure the location of the error log.

importexport.errors.log.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\logs\errors.log 

h. Configure the file format, in the EXPORT section. In this example, csv format will be used.

export.fileformat=csv

i. Configure the location of the export file. Ensure to include the file extension.

export.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\files\export.csv

j. Accept all other options in the file. This will produce a file that you will need in order to move the provisioning information to a target environment.

k. Do not change the User or Group filter values. This will search all external providers and extract all users and groups. This process can be time-consuming. The external users will be displayed with the default options as both members of native groups and if they are directly provisioned to the applications.

l. Save the file as export_source.properties

 6) Optional: Configure the CSSExport.bat file. If there are available memory resources in the HSS server, then the amount memory can be increased when performing the export. In the example below, 1024m represents 1GB of memory, please do not increase the setting beyond 1024m. 

a. Go to the directory: =%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport 

b. Open the CSSExport.bat file using a text editor such as Notepad

c. Change the following line:

"%JAVA_HOME%\bin\java" -cp %CLASSPATH

com.hyperion.css.exchange.CommandUtility -ef % 1

to

 "%JAVA_HOME%\bin\java" -Xmx 1024m -cp %CLASSPATH%

com.hyperion.css.exchange.CommandUtility -ef % 1

d. Save and close the file.

7) Execute the CSSexport utility.

a. Open a command prompt and change the directory location to:

          %HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport

b. From the command prompt location set in step G2 type the command:

CSSexport export_source.properties

Hit Enter and the operation will execute. The time for completion will vary based on the size of the environment.

 

SECTION B: Prepare the Load File

In this step, you will identify the important parts of the file that was exported, export.csv. You can limit the process for the entire environment or for a particular application. A tool that can be used to edit the export.csv can be Microsoft Excel. After completing the necessary modifications to the export.csv, please ensure to rename the file to a different name such as import.csv.

#user

This is the first section of the file and it contains the native users that are in your environment.
You can use this section to create new native users if you like but for the system transfer its focus will be to copy the necessary native users from our source to target system. Below are the most important fields in this section.

If you are not transferring any specific accounts you can remove their lines, you can remove the whole section. I would recommend deleting the admin, and essadmin (default admin account for Hyperion Essbase) lines because those are usually environment specific.

#group

This section contains the group that are stored in the Native Directory OpenLdap repository. The internal id is also stored in the HSP_GROUPS table in the Hyperion application's relational repository. This section can be very importan if your application utilizes group security.

This section can be edited to remove any groups that you do not want transferred from source to target or you could remove this whole section if you are only using external groups.

 #group_children

When you first export you will have a section for each group defined in #group, it can be combined into one section or left as separate sections. This section will list the users or the groups that belong from each group. Ensure to remove any groups that you do not want to transfer because the users that are listed in this file will overwrite your target system. For example, if you have the same group in both your source and target. Source has 5 users in it and target has 10. When you go to load the group definition it will only have 5 users in it and it will remove the other five. You can add those extra 5 to the file or chose to not load the group definition section.

#Provisioning

Similar to the previous section there will be one definiton for each product-application combination. If you prefer, this section can be combined into a single comprehensive section. When preparing this section for transfer, you will notice that there are certain products that list the server name in it's related provisioning, for example Essbase and BI plus. Hyperion Planning does not use server names, therefore, if the groups and users exist then the import will work fine. The project names and application names must exist in the target environment before loading the file.

The next part of the section has the users and or groups that are provisioned to the application. Ensure to scroll to the right in order to see the full user and group names.

 Under the #provisioning section you can remove the projects and associated applications that are not Hyperion Planning applications. Maintain only the Hyperion Planning application names and corresponding projects.

Since this document is only focusing on Hyperion Planning you could only include the Hyperion Planning applications in your load file because it will assign the necessary Essbase and Business Rules access.

SECTION C: Import Target Shared Services Information

Before proceeding with the import of the provisioning information to the target environment, ensure that you have created a shell of the Planning application with the same name, plan types and plan type names, multi-currency support options, number of years, starting year, and starting period as the Planning application in the source environment.
Also, ensure that the same Project name, which contains the Planning application, exists in the target environment.

In this section, the cssimportexport utility will be used to load are file into the target Shared Services environment.

1) Copy your load file that you prepared in the last section to:
%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\files\import.csv

2) Copy the file
%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\export_source.properties to import_target.properties.

3) Open and edit the GLOBAL section of the import_target.properties file in a text editor such as Notepad.

a. The first option to configure is the location of the css.xml file. The web URL is the easiest and most dynamic method to define it. Here is an example of the correct syntax of the target server:

importexport.css=http://TARGETSERVER:58080/interop/framework/getCSSConfigFile

b. The next part is to define the Shared Services host this will be the same server
as your url above.

importexport.cmshost=TARGETSERVER
Same for the port
importexport.cmsport=58080

c. Define an administrator account I would use the default admin account because it
has all of the necessary Shared Services provisioning to extract and load

importexport.username=admin

d. Define the password. You type the password here in clear text and when you run
the utility it will encrypt the password in the file.

Clear Text
importexport.password=Password
Encrypted
importexport.password={CSS}MRcYv323uzxGr8rFdvQLcA==

e. Define the location of the trace log. When defining logs its important to use the
Unix slash / convention method, for example:

importexport.trace.events.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\logs\trace.log
f. Define the location of the error log.

importexport.errors.log.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\
cssimportexport\importexport\logs\errors.log

4) Edit the IMPORT section in the import_target.properties file. You can ignore the export section of the file and move directly to import.

a. Change the import file format to csv
import.fileformat=csv

b. Define the file that you will be using as your load file. This is the file you first copied in the import section.

import.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\files\import.csv
c. Verify that your update option is set to CREATE/UPDATE. This will update the information if it already exists or create the new user or group.

import.operation=CREATE / UPDATE

d. Specify a failed import operations file.
import.failed.operations.file=%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\logs\failed.csv
e. Save and close the import_target.properties file.

5) Execute the CSSIMPORT utility.

a. Open a windows command prompt and navigate to the following directory:
%HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport

 b. From the above location set in the windows command prompt, type the command:

CSSimport export_target.properties

c. Hit enter.

d. The import process should execute at this point and the time for completion will vary based on the size of your environment. If there are any errors, please refer to the failed.csv file defined under the %HYPERION_HOME%\common\utilities\CSSImportExportUtility\cssimportexport\importexport\logs directory.