Create a comprehensive set of tailored instructions to document the process for migrating an application from the development environment to other environments such as test or production.
This documentation must include the required tasks, their order of execution, and configuration details and options for migration and deployment of the application. The documentation must also include the roles that are involved in the migration and deployment processes, with information about required system privileges for those participants.
If the documentation is created as a part of the development process, the documentation process can be more efficient and the information can be more detailed. However, this documentation can be refined as the deployment process begins. For example, when an application is migrated and deployed for the first time, the developers might need to work directly with system administrators to collaborate on the security configuration.
Information type | Description |
---|---|
Name and location of packages |
The name and location of the packages that are created by the export operations of the IBM® FileNet® Content Manager tools. Alternatively, information about the required assets so that the export operations can be completed. |
Name and location of component dependencies |
The name and location of any other components that the application depends on that must be deployed before this application. |
Data maps |
The data mapping information, or data conversion information, that is used by FileNet Deployment Manager. Data maps are used to convert the metadata and content of assets that are exported from the source environment to reflect information that is specific to the target environment. |
Configuration information |
The configuration steps that are required to complete deployment of the application or
other assets. The following examples show some of the types of information that is required,
but all system configuration information must be included:
|
Additional information to support variances in the destination environment |
Assets that are managed outside of Content Platform Engine rules or custom services. Special backup considerations, such as assets that are managed with an organization-wide technology. For example, a system that uses IBM Operational Decision Manager might have special backup considerations. |
Post-migration verification plan for the deployed application |
Information about one-time tasks or special tools that are needed to alter existing data to reflect the redeployed application. Additionally included would be procedures to verify that the application behaves as expected. Especially important to verify is the integration with external components that are not available in the development or test environments. |
Information type | Description |
---|---|
Object dependencies |
A dependency exists between two objects when one object references another object. When these objects are imported, the object that is referenced must exist in the object store before the object that references that object is imported. For dependent relationships that are defined by a FileNet P8 application, FileNet Deployment Manager understands the dependencies and ensures that the objects are imported in the correct sequence. |
Folder references, path-based or GUID-based |
Some operations in FileNet Deployment Manager use path-based, rather than globally unique identifier (GUID) based, references to folders. Path-based references are used to reference the parent folder of a folder, the security folder of an object, the containing folder in a referential containment relationship (RCR), or a folder in a system-defined or user-defined property. Migration of these assets must be preceded by the creation or import of the correct folder hierarchy. GUID-based references are often used by other components with metadata that directly references a folder, such as an entry template. Migration of these assets must include the folder that is referenced to ensure stable GUIDs. |
Add-on features |
For an object that requires an add-on feature on the source, that add-on feature must be installed on the destination. The installation on the destination is required so that FileNet Deployment Manager can import the dependent objects. |
Environment-specific information for source and destination |
This environment-specific information includes the following examples:
|
System configuration instructions |
System configuration steps that are required to complete deployment of the assets. For example, the JAAS credentials to access the application server or the database login information to complete a database connection specification often differs between environments. |