IBM FileNet P8, Version 5.2.1
Import options set files: Usage and syntax for import options elements
The import options elements used in the import options set file control the import process for converted objects into the destination environment.
Usage for import options elements
The import options elements must appear either as child elements of the <ImportDeployDataSet> element in a deployment operation file, or in a separate file. To specify the location of a separate import options set file, include the <OptionSetPath> child element within the <ImportDeployDataSet> element of the deployment operation file. For more information about usage of the <OptionSetPath> child element, see Deployment operation files.
When using the ImportDeployDataSet deployment operation, the preferred method to provide import
options is to use a separate import options set file. The use of a separate file enables the import
options to be shared between users or between instances of import operations that are automated by
using the command-line interface. When placed into a separate import options set file, the import
options must be contained by the <ImportOptions> element. The <ImportOptions> element is
contained within the <DeploymentOptions> element. The following example shows the general
structure of an import options set file, with most of the import options
removed:
<DeploymentOptions version="5.2.1">
<ImportOptions>
<StoragePolicy type="DefaultOnClassOnDestination">
<ID/>
</StoragePolicy>
...
</ImportOptions>
</DeploymentOptions>The import options can be wholly or partially specified in the deployment operation file or the
import options set file. When an import option appears in both the deployment operation file and the
import options set file, the value in the deployment operation file takes precedence. This behavior
enables a programmer to include import options in the deployment operation file that temporarily
override the import options in the import options set file. In the following example of an
ImportDeployDataSet deployment operation, the <OptionSetPath> element provides an import options
set file to use, the ImportOptionSet.xml file. However, when this
ImportDeployDataSet deployment operation runs, any value that is set for the <AuditOption>
element in the ImportOptionSet.xml file is overridden by the <AuditOption>
value in the deployment operation file. In the example, the import action uses the audit only mode,
and does not import the
data.
<ImportDeployDataSet>
<Environment>MyDestination</Environment>
<DeployDataSet>C:\P8DeploymentData521\Environments\MyDestination\Assets\ApplicationAssets.converted</DeployDataSet>
<OptionSetPath>C:\P8DeploymentData521\ImportOptionSet.xml</OptionSetPath>
<AuditOption>AuditOnly</AuditOption>
<ReportFileName>_AuditAssetsV4</ReportFileName>
</ImportDeployDataSet>Syntax for import options elements
The following table shows the syntax and descriptions for the XML elements that represent the
import options.
| Syntax | Description |
|---|---|
|
Controls whether an audit file is captured and whether the import operation commits changes to the destination environment.
|
|
Controls whether assets are created.
|
|
Controls whether to delete the audit files that are being written when the import operation encounters an exception that would cause the operation to end.
|
|
Controls whether existing IDs for imported objects are used.
|
|
Controls whether owner information for the object in the deployment data set is used.
|
|
Controls whether the retention date from the source object is used on the imported object.
|
|
Controls whether security permission lists for imported objects are used.
|
|
Controls whether property definitions are removed from the updated class definitions.
|
|
Controls the file names of the audit files. This element takes a string value. It is used when the <AuditOption> element has a value of AuditOnly or ImportWithAudit. The audit files are saved with file extensions of .xau or .xao and are located with the converted deployment data set that is used during the ImportDeployDataSet operation. The default value for the file name string is _default. |
|
Controls the storage policy to use at the destination for storing the imported content.
|
|
Controls whether to transfer the workflow definition into the destination workflow system.
|
|
Controls whether to deploy only the localized display name and descriptive text property values, not the object, to the destination environment.
|
|
Controls the action that occurs if an object exists in the destination object store.
|
|
Controls whether certain source system property values are preserved during import.
|
|
Controls whether the workflow system configuration is imported by using a merge or overwrite strategy.
|
|
Controls whether JavaScript scripts are used to
complete custom operations. These custom operations can occur before the import process begins,
before and after an object is saved to the destination object store, and after the import process
completes. The run type for each script, the order in which it runs, and the fully qualified path to
the script must be provided. The run type and order is provided as a child element of the
<Scripts> element, and the fully qualified path is provided as a value in the value attribute.
The following list shows the run types:
The order is a numeral that represents the order in which multiple scripts of the same run type will run. For example, the script that is identified as PreSaveScript0 will run before the script that is identified as PreSaveScript1. |
Note to self: Contradictory information in IBM Style says no tagging on XML (i.e., no code related tagging), so used <u> to tag defaults in syntax below. But, <option> and <option importance="default"> tags are available for code tagging. So, to tag or not to tag on this XML? See 1st row for difference in tagging with <option> element.