ExportMigrationFiles

Purpose

Exports the InForm study and related configurations for migration.

Creates the database dump(s) as named on the database server in the given location, creating logs and export files in the specified log folder.

Note: The ExportMigrationFiles command copies the InForm Publisher configuration, if it is present.

Location

<Drive:>\OracleHS\InstallSupport

Usage

ExportMigrationFiles [connection string] /prompt [log options]
ExportMigrationFiles [connection string] /accountparams:[paramfile] [log options]

Where:

Parameter	Description
connection-string	Database TNS Instance Name
paramfile	Path to text file containing the list of parameters.
log options	Optional parameters for specifying the log file name and/or location. The log file defaults to being named ExportMigrationFiles.log. The log file path defaults to the current working directory. Options: /LogFile:[filespec] filespec = fully qualified name and path for created log file. If a relative path is given, it is based from the current working folder. Overrides the logfile-path to be the resolved path to the given filespec. Overrides the logfile-name to be the resolved name of the given filespec. Do not specify this if either of the other logging options are specified. /LogFilePath:[pathspec] pathspec = fully qualified path to create the log file in. If a relative path is given, it is based from the current working folder. Overrides the logfile-path to be the resolved path to the given pathspec. Does not change logfile-name. /LogFileName:[filename] filespec = Filename for the log file. Overrides the logfile-name for the log file. Does not change logfile-path.

Parameter

Description

connection-string

Database TNS Instance Name

paramfile

Path to text file containing the list of parameters.

log options

Optional parameters for specifying the log file name and/or location.

The log file defaults to being named ExportMigrationFiles.log.

The log file path defaults to the current working directory.

Options:

/LogFile:[filespec]
- filespec = fully qualified name and path for created log file. If a relative path is given, it is based from the current working folder.
- Overrides the logfile-path to be the resolved path to the given filespec.
- Overrides the logfile-name to be the resolved name of the given filespec.
- Do not specify this if either of the other logging options are specified.
/LogFilePath:[pathspec]
- pathspec = fully qualified path to create the log file in. If a relative path is given, it is based from the current working folder.
- Overrides the logfile-path to be the resolved path to the given pathspec.
- Does not change logfile-name.
/LogFileName:[filename]
- filespec = Filename for the log file.
- Overrides the logfile-name for the log file.
- Does not change logfile-path.

Command line prompts

You are prompted for the following parameters:

InForm Database Adminstrator User Name—Name of the InForm Database Administrator User (for example, pfdbadmin).
InForm Database Administrator User Password—Password for the InForm Database Administrator User.
Trial Schema Owner User ID—Trial database schema owner user ID.
Trial Schema Owner User Password—Trial database schema owner's password for the study.
Database Dump File Directory Path—Location on the InForm Database Server where the dump file(s) are to be created. Must conform to the Database Servers path format (such as, path separators are \ on Windows, / on Linux).
Note: The physical path must exist before you run the ExportMigrationFiles command.
Trial Database Dump Name—File name for the Trial Schema Database Dump that is being created. If not specified, it will be defaulted to <trial-schema-owner-id>.dmp.

Parameter file contents

When using a parameter file, the path to a text file is given. The format of the parameter file is parameter=value, with each value on a separate line, and no spaces between the parameter name, =, and value.

The parameter file must contain the following parameters:

Pfdbadmin_user—Name of the InForm database administrator (for example, pfdbadmin).
Pdbadmin_user_pass—Password for the InForm database administrator user.
Trial_user—Trial/Schema Owner User ID for the study to export.
Trial_user_pass—Password for the Trial/Schema Owner User for the study to export.
Dump_file_dir_path—Location on the Database Server where the import dump file(s) are located.

The parameter file may contain the following parameters:

Dump_file_name—Trial Schema dump filename. If not specified, uses the default of [trial_user].dmp.
Schemas—Comma delimited list of integration and/or additional schemas to be exported with the trial schema. Additional schemas are specified by their Schema Owner User ID and are exported with the fixed name [schema-owner-user-id].dmp to the same dump_file_dir_path that the trial schema is exported to.
Note: The Database Administrator user must have the rights necessary to export any schemas listed.

Note: Do not include spaces in the dump file name or the directory path to the dump file.

Example

ExportMigrationFiles trial1 /prompt
ExportMigrationFiles trial1 /accountparams:exportparams.txt
ExportMigrationFiles trial1 /prompt /logfilepath:c:\trialexport
ExportMigrationFiles trial1 /accountparams:exportparams.txt /logfilepath:c:\trialexport

Notes

The following logs are created in the log files path:

ExportMigrationFiles.log—The file contains the output of the actions performed by the ExportMigrationFiles.cmd file.
ExportDB.log—Log generated during the trial schema database export.
INF-19122_DetectMnemonicLength.log—Output from the Mnemonic Length validation script.

Exported files will be located in a subdirectory of the log files path named ExportFiles. This folder contains the files that will need to be copied to the target Application Server for the Migration. The Export files created in this folder are:

InFormRegistryBackup.txt—Exported InForm registry
pfadmin_view_service.txt—Text file containing the information for the servers and studies running on the InForm Application Server.
ImportParametersTemplate.txt—Example import parameters file with most entries filled in. Requires editing prior to use.
There are at a minimum four (4) lines that will need to be edited, all at the top of the file, replacing the bracketed descriptions with the actual settings:
- trial_user_pass=[trial_user_pass]
- pfdbapid=[pfdbapid]
- dump_file_dir_path=[dump_file_dir_path]
- deployment_backup_folder=[deployment_backup_folder]
Other settings in the file may be edited, including the trial name, server name, and so on.
InFormPublisher.config—InForm Publisher Configuration file. Only included if InForm Publisher is configured.
nepWslc.txt—InForm Publisher Configuration Key file. Only included if InForm Publisher is configured.

The database dump files must be copied from the source database server to the target database server, and placed in the dump_file_dir_path specified in the import parameters. These files must all have permissions set such that they are readable by all users.

Note: If error messages indicating that the system cannot find the paths specified for the System Product Locale and the System Study Locale appear, disregard the messages and continue with the migration.