Process behind Hyperion Shared Services back-up and files involved in it….


As promised šŸ˜‰ I’m going to discuss about the process behind and the files involved in Hyperion Shared Services back-up.

The files that need to be backed up are.
  • Shared Services application server configuration files
  • OpenLDAP database configuration file
  • All OpenLDAP data and log files
Hyperion Shared Services comes with in-build tools for taking the backup. You can use backup.bat file supplied with Hyperion Shared Services, this file is located under %HYPERION HOME%productsFoundationserverscripts
Run command %HYPERION HOME%productsFoundationserverscriptsbackup.bat backup_location

How it works

      Shared Services application server configuration files

Backup script will search the deployments folder in HYPERION_HOME directory for the existence of Tomcat5/Websphere6/Weblogic9/Oracle10g directories. If it finds one such directory, then the script will create a folder (Tomcat5 or Websphere6 or Weblogic9 or Oracle10g) under backup_location. Shared Services application server configuration files from %HYPERION_HOME%deploymentsTomcat5 or Websphere6 or Weblogic9 or Oracle10gSharedServices9config are copied to the corresponding folder(backup_loactionTomcat5 or Websphere6 or Weblogic9 or Oracle10g)

      Which files are copied

      Domain.xml
      CSS.xml
      slide.properties
      WorkflowEngine.properties
      scheduler.properties
      manage_data.properties

      Domain.xml

      This file contains the
  • Information about Shared Services relational database. (username, password).
  • Information about CSSConfig file path.
  • Information about cache-refresh-interval setting. (Used to refresh the group cache for external directories)
      CSS.xml

      This file contains the information about external directories. From Hyperion version 11            code line, most of the information is stored in the HIT Registry; so do take a backup of Shared Services relational tables.

      slide.properties

      Apache slide configuration file. The path to Domain.xml file is defined in this file.

      WorkflowEngine.properties

      CMS integration and SMTP server definition is stored here

      scheduler.properties

      This contains the information about Quartz scheduler.

      manage_data.properties

      This file contains the information about Shared Services port number and Server name.

      OpenLDAP database configuration file

      slapd.conf file is copied from %HYPERION HOME%productsFoundationopenLDAP to backup_location/openLDAP folder.


This is the configuration file for the openLDAP database (i.e. this is the configuration file by which Hyperion Shared Services LDAP server is configured). You’ll find the most important information about Hyperion Shared Services openLDAP database here.

suffix             “dc=css,dc=hyperion,dc=com”
rootdn                       “cn=root,dc=css,dc=hyperion,dc=com”
directory      G:/Hyperion/products/Foundation/openLDAP/var/openldap-data

      All OpenLDAP data and log files

      Shared Services openLDAP uses Berkeley database as  its back-end database (slapf.conf file is configured to use bdb as database) to store user/group information. The database files are stored  under %HYPERION_HOME%productsFoundationopenLDAPvaropenldap-data.

      All the files ending with .bdb from the openldap-data folder is copied to backup_location/datafiles and the log files from openldap-data is copied to backup_location/logfiles.

This is done by calling runDBArchiveData.bat (this bat file is called by backup.bat)

A check point is created using db_checkpoint.exe. More on checkpoint creation.

After checkpoint creation, db_archive.exe is used with -s switch to get a list of all database files (with .bdb extension) (output is passed to a temp.txt)

%HYPERION_HOME%productsFoundationopenLDAPbdbbindb_archive.exe -s

Using windows “for” loop all the files listed in temp.txt is copied to backup_location/datafiles

After database files are backed up db_archive is used with -l switch to get a list of all log files (output is passed to a temp.txt)

%HYPERION_HOME%productsFoundationopenLDAPbdbbindb_archive.exe -l

Using windows “for” loop all the files listed in temp.txt is copied to backup_location/logfiles


So that was about Shared Services backup process and the files involved in it. I’ll try to cover more on Hyperion Shared Services openLDAP in the coming posts.


About Celvin Kattookaran

I’m an EPM Consultant, my primary focus is on Hyperion Planning and Essbase. Some of you from Hyperion Support team might recognize me or have seen my support articles, I was with the WebAnalysis Support Team. I'm an Independent Consultant with ā€œIntekgrate Corporationā€ based out of Aurora office. I’m from God’s Own Country (Kerala, India), lived in all southern states of India, Istanbul and Johannesburg (and of course United States). I’m core gamer :) and an avid reader. I was awarded Oracle ACE Director for my contributions towards EPM community.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

0 thoughts on “Process behind Hyperion Shared Services back-up and files involved in it….