IBM FileNet P8, Version 5.2.1

Import options set files: Examples

The import options set file examples contain code that can be used in specific import scenarios. You can customize this code for use with a similar import action that you need to complete.

The sample files for FileNet® Deployment Manager include one sample file for the import options set file, ImportOptions.xml. However, this sample file does not include code for all possible import scenarios. The following examples contain code that can be used for other common import scenarios. You can use these examples to create custom import options set files for similar import scenarios.

Deployment to support incremental changes

A common use case for FileNet Deployment Manager is migrating a set of updated application assets from one environment and deploying it into another. For example, you can move assets from a development environment to a test environment, or from a test environment into a production environment. This type of incremental update to an application is likely to happen many times over the life cycle of that application as defects are corrected and features are added. See Deploy changes to an existing application for an example of this scenario.

Several key import options work together to enable a series of incremental application asset changes to be applied over time. These import options are configured with the <UpdateOption>, <WorkflowConfigurationOption>, and <UseOriginalTimeStamps> elements. Additionally, the <ImportObjectid> element is used to ensure that the imported object is recognized as the same asset throughout multiple migration and deployment operations. The <CreateOption> element is used to ensure that newly created assets are imported to the destination environment as a part of the incremental changes. In the following example, note the use of the <UpdateOption> element with an UpdateIfNewer value. This value allows for customizations that are made in the destination environment to be retained if they are made after the updated application assets are deployed.

<DeploymentOptions version="5.2.1">
  <ImportOptions>
    <StoragePolicy type="DefaultOnClassOnDestination">
      <ID/>
    </StoragePolicy>
    <CreateOption>CreateAlways</CreateOption>
    <UpdateOption>UpdateIfNewer</UpdateOption>
    <AuditOption>ImportWithAudit</AuditOption>
    <WorkflowConfigurationOption>Merge</WorkflowConfigurationOption>
    <ImportSecurity value="false"/>
    <ImportOwner value="false"/>
    <ImportObjectId value="true"/>
    <ImportRetention value="false"/>
    <RemovePropertyDefinitions value="true"/>
    <UseOriginalTimestamps value="true"/>
    <TransferWorkflows value="true"/>
    <UpdateLocalizedProperties value="false"/>
    <ReportFileName>MyNamingConvention</ReportFileName>
    <Scripts>
    </Scripts>
  </ImportOptions>
</DeploymentOptions>

Deployment to replicate changes without considering previous modifications

Another approach for deploying changes to an existing application is to apply all asset modifications that are made in the source environment to the destination environment, regardless of the state of the asset in the destination environment. This approach ensures that the application in the destination environment matches the application in the source environment.

For example, this approach is recommended when you migrate external assets for an IBM® Case Manager solution by using FileNet Deployment Manager. As in the previous example, the key import options are set by using the <UpdateOption>, <WorkflowConfigurationOption>, <UseOriginalTimeStamps>, <ImportObjectid>, and <CreateOption> elements. However, in the following example, note the differences in the values that are used for <UpdateOption>, <WorkflowConfigurationOption>, and <UseOriginalTimeStamps> elements.

<DeploymentOptions version="5.2.1">
  <ImportOptions>
    <StoragePolicy type="DefaultOnClassOnDestination">
      <ID/>
    </StoragePolicy>
    <CreateOption>CreateAlways</CreateOption>
    <UpdateOption>UpdateAlways</UpdateOption>
    <AuditOption>ImportWithAudit</AuditOption>
    <WorkflowConfigurationOption>Overwrite</WorkflowConfigurationOption>
    <ImportSecurity value="true"/>
    <ImportOwner value="true"/>
    <ImportObjectId value="true"/>
    <ImportRetention value="true"/>
    <RemovePropertyDefinitions value="true"/>
    <UseOriginalTimestamps value="false"/>
    <TransferWorkflows value="true"/>
    <UpdateLocalizedProperties value="false"/>
    <ReportFileName>MyNamingConvention</ReportFileName>
    <Scripts>
    </Scripts>
  </ImportOptions>
</DeploymentOptions>

Deployment that includes import scripts

For a deployment that includes import scripts, 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 paths to the import scripts are included inside the <Scripts> element.

<DeploymentOptions version="5.2.1">
  <ImportOptions>
    <StoragePolicy type="DefaultOnClassOnDestination">
      <ID/>
    </StoragePolicy>
    <CreateOption>CreateAlways</CreateOption>
    <UpdateOption>UpdateIfNewer</UpdateOption>
    <AuditOption>ImportWithAudit</AuditOption>
    <WorkflowConfigurationOption>Merge</WorkflowConfigurationOption>
    <ImportSecurity value="false"/>
    <ImportOwner value="false"/>
    <ImportObjectId value="true"/>
    <ImportRetention value="false"/>
    <RemovePropertyDefinitions value="false"/>
    <UseOriginalTimestamps value="true"/>
    <TransferWorkflows value="false"/>
    <UpdateLocalizedProperties value="false"/>
    <ReportFileName>_Audit20141013</ReportFileName>
    <Scripts>
      <PreImportScript0 value="C:\DeploymentTreeData\Scripts\samplePreImport.js"/>
      <PreSaveScript0 value="C:\DeploymentTreeData\Scripts\samplePreSave.js"/>
      <PreSaveScript1 value="C:\DeploymentTreeData\Scripts\samplePreSaveMore.js"/>
      <PostSaveScript0 value="C:\DeploymentTreeData\Scripts\samplePostSave.js"/>
      <PostImportScript0 value="C:\DeploymentTreeData\Scripts\samplePostImport.js"/>
    </Scripts>
  </ImportOptions>
</DeploymentOptions>