Importing and Exporting Form Definitions

Administrators can use FormDefUtil.cmd (Windows) or FormDefUtil.sh (UNIX) to move form definitions between Oracle Hyperion Planning applications. You can export or import form definitions to or from an XML file, useful for moving from a development to a production environment.

The utility uses a command line interface and is installed in the planning1 directory. For the full path to planning1, see About EPM Oracle Instance.

Note:

XML files for composite forms that were exported in an earlier release cannot be imported into the current release. You must re-extract the XML files after the corresponding Planning applications have been migrated to the current release. XML files for non-composite forms exported in an earlier release can be imported into the current release.

To launch the FormDefUtil utility:

1. Enter the command from the planning1 directory, using this syntax:

   formdefutil [-f:passwordFile]import|exportfilename|formname|-all server name user name application

   Parameter	Purpose	Required?
   [-f:passwordFile]	If an encrypted password file is set up, you can use this option as the first parameter in the command line to run the utility with the full file path and name specified in passwordFile. See Suppressing Password Prompts in Planning Utilities.	No
   import|export	Import or export the form definition.	Yes
   filename|formname|-all	When used with import, specify the XML file containing the form definition. When used with export, specify the form to export to XML. Use -all with import or export to import or export all XML files or form definitions in the current application.	Yes. -all is optional.
   server name	Server name on which the Planning application resides.	Yes
   user name	Administrator's name.	Yes
   application	When used with export, the name of the Planning application containing the form definitions to export. When used with import, the name of the Planning application to which to import the form definition.	Yes

2. If prompted, enter your password.

When you export form definitions, the utility creates an XML file in the current directory and writes errors in a log file. (For information on the location of log files, see About EPM Oracle Instance.) You can copy the utility to any directory and launch it from there to save files to another directory.

Table 6-13 FormDefUtil.cmd Command Examples

Task	Example
Importing one file	FormDefUtil.cmd import c:\EPM_ORACLE_INSTANCE\Planning\planning1\form1.xml localhost admin APP1
Exporting one file	FormDefUtil.cmd export Form1 localhost admin APP1
Exporting all form definitions	FormDefUtil.cmd export -all localhost admin APP1
Import all form definitions	FormDefUtil.cmd import -all localhost admin APP1

Note:

Replace EPM_ORACLE_INSTANCE with the absolute or relative path to the form file on your system. For more information, see About EPM Oracle Instance.