IBM FileNet P8, Version 5.2.1

Import options set files

The import options set file contains the import options that are used by the ImportDeployDataSet operation. The use of this file ensures that the import options for multiple operations are consistent. The import options set file can also be shared between users or between instances of operations that run from the command-line interface.

Import options set files and the FileNet Deployment Manager graphical user interface

As with the deployment operation file, both the graphical user interface and the command-line interface of FileNet® Deployment Manager use the import options set file. In the graphical user interface, you configure import options in the import wizard, and the wizard prompts you to save a copy of the import options as an import options set file in a location of your choosing. In addition, as the import deployment operation runs, FileNet Deployment Manager saves the instance of the import options that are used in the deployment operation as an import options set file. This XML file is saved in the time-stamped subfolders of the Temp folder of the deployment tree with the other generated deployment files for that instance. These files provide a historical reference that you can use to view the details for one instance of a deployment operation.

For example, if the name provided for the import options set file in the import wizard is my_import_options.xml and the import operation occurred at 3:30 p.m. on 14 May 2014, the file is placed in a Temp subfolder that is named Run.2014.14.05.15.30.00. The path to this import options set file is deployment_tree/Temp/Run.2014.14.05.15.30.00/my_import_options.xml, where deployment_tree is the path for the deployment tree. For more information about deployment trees, see Deployment trees in FileNet Deployment Manager.

Import options set files and the FileNet Deployment Manager command-line interface

The FileNet Deployment Manager command-line interface also uses the import options set file as input to the ImportDeployDataSet deployment operation file to complete that deployment operation. In general, when you use an import options set file with the command-line interface, the preferred method is to customize an existing import options set file that was generated by the graphical user interface. However, that is not the only option. Use one of the following options to create a custom import options set file:

In the time-stamped subfolders in the deployment_tree/Temp deployment tree path, find an import options set file that was generated by the FileNet Deployment Manager graphical user interface when it completed an import operation. The file names can vary because they are user-supplied from the graphical user interface, but they are saved as XML files. Use this XML file as a template for the custom file.
Use one of the import options set files that was saved as you supplied the import options in the import wizard as a template for the custom file. If you choose this option, you might want to check for an equivalent import options set file in the Temp subfolder of the deployment tree. This check is recommended because the file that saves from the import wizard is saved when the options are supplied in the wizard, but the version of the file that is in the Temp subfolder is generated when the import operation runs. You can use the other files in the Temp subfolder to help determine the success or failure of the import operation.
Generate the FileNet Deployment Manager sample files. Use the sample ImportOptions.xml file as a template for the custom file. The sample files include the XSD schema description files that are used by FileNet Deployment Manager to ensure the validity of its input files. For more information about sample file creation, see Creating sample files.
Use one of the examples for an import options set file as a template for the custom file. The examples that are included in the documentation include code for common import scenarios. For more information, see Import options set files: Examples.