ImportUtility

Purpose

Securely import reporting content you export using Cognos commands to a new instance of the Oracle InForm Reporting server.

Location

The Oracle InForm application server folder on the Oracle InForm application server. For example, <Installation_Directory>\InForm\bin.

Usage

ImportUtility [-all | -import | -nopwd | -pfmtr]

Option Parameter
-all
  • Creates a secure staging folder on the Reporting server accessible to system administrators.

    The name of the staging folder is SecureImport_<timestamp>.

  • Creates the import specification object on the Reporting server accessible to system administrators.
  • Imports the content from a password-protected deployment package to the SecureImport_<timestamp> folder and makes it accessible only to system administrators.
  • Copies the imported content to the Public folders on the Reporting server.
  • Deletes the SecureImport_<timestamp> folder, all its content, and the import specification object.
-import
  • Creates a secure staging folder on the Reporting server accessible to system administrators.

    The name of the staging folder is SecureImport_<timestamp>.

  • Creates the import specification object on the Reporting server accessible to system administrators.
  • Imports the content from a password-protected deployment package to the SecureImport_<timestamp>.
  • Deletes the import specification object.
-nopwd
  • Creates a secure staging folder on the Reporting server accessible to system administrators.

    The name of the staging folder is SecureImport_<timestamp>.

  • Creates the import specification object on the Reporting server accessible to system administrators.
  • Imports the deployment package content to the SecureImport_<timestamp> folder and makes it accessible only to system administrators.
  • Copies the imported content to the Public folders on the Reporting server.
  • Deletes the SecureImport_<timestamp> folder, all its content, and the import specification object.
-pfmtr
  • Creates a secure staging folder on the Reporting server accessible to system administrators.

    The name of the staging folder is SecureImport_<timestamp>.

  • Creates the import specification object on the Reporting server accessible to system administrators.
  • Imports the content to the SecureImport_<timestamp> folder.
  • Deletes the import specification object.

Command line prompts

Depending on the option you specify with the ImportUtility, you are prompted for the following parameters:

  • sysadmin_namespace—Cognos system administrator user namespace.
  • sysadmin_uid—User name for the Cognos system administrator.
  • sysadmin_pass—Cognos system administrator password.
  • dispatcher_url—Internal URI that the Oracle InForm server uses to communicate with the Cognos Analytics server.

    This Cognos Analytics parameter is set in the Cognos Analytics Customization for Oracle InForm wizard. The parameter setting is stored in the cogstartup.xml file and corresponds to the Reporting internal URI value on the Admin > System Configuration page of the Oracle InForm application. For example, http://example.com:9300/p2pd/servlet/dispatch.

  • archive_name—Name of the deployment package containing the reporting content you want to import into the Reporting server.
  • archive_pass—Password for the deployment package.

    Note:

    The archive_pass parameter is not required for the -nopwd or the -pfmtr option.
  • cap_namespace—informcap.
  • trial_uid—Owner of the study database schema.
  • trialuser_pwd—Password for the owner of the study database schema.
  • trial_name—Name of the Oracle InForm study.
  • company_code—The organization ID. Optional.

    This parameter is required only for Oracle-hosted studies in a single sign-on environment.

For legacy purposes, you can also pass the parameters by using the /accountparams:"path_to_parameter_file" command option.

When specified, this option includes the path to a text file that contains the values required to run the command. The format of the parameter file is parameter=value. There is a new line for each parameter, and there are no spaces on a line.

Notes

  • The -import and -pfmtr command options should be used to stage custom reports before distributing them to multiple studies.

    To move the content from the staging folder to the study folders and set study-specific permissions, use the pfmtrsetuputil command.

  • The -nopwd and -pfmtr command options are used when you are importing a deployment package that is not password protected.

    These options should be used only when there is no clinical data present in the deployment package.

Example

ImportUtility -all "E\scripts\import.txt"

Parent topic: Command and script reference