IBM FileNet P8, Version 5.2.1            

Deploying new objects

The following steps describe deploying new objects; that is, deploying objects that exist in the source environment but that do not currently exist in the destination environment.

  1. Identify the data that is required by the application.

    For this sample scenario, the administrator identifies data to deploy, as listed in Assets to be Deployed. To avoid potential deployment issues, the administrator verifies that each asset in the list is prepared properly. See FileNet® P8 Assets.

  2. Set up the deployment configuration.

    Setting up a deployment for a source and destination environment (source-destination pair) for the first time, the administrator must perform configuration steps that define the relationship between the two environments. For this sample, the source and destination environments are referred to as SourceEnv and DestEnv.

    1. Set up the source environment definition, then define the connection to the source environment, setting the URL of the source Content Platform Engine from which objects are exported. See Create or edit an environment definition and Define the connection to an environment.

      The administrator creates the source environment, which is identified as SourceEnv in the FileNet P8 deployment tree, and then defines a connection to the Content Platform Engine with the SourceOS1 object store. When later created, the half maps for the source environment are displayed under the SourceEnv node in the deployment tree.

    2. Set up the destination environment definition, then define the connection to the destination environment, setting the URL of the destination Content Platform Engine, to which objects are imported. See Create or edit an environment definition and Define the connection to an environment.

      The administrator creates the destination environment, which is identified as DestEnv in the FileNet P8 deployment tree, and then defines a connection to the Content Platform Engine with the DestinationOS1 object store. When later created, the half maps for the destination environment are displayed under the DestEnv node in the deployment tree.

    3. Set up the pair definition. See Create a source-destination pair.

      The administrator creates the source-destination pair, identified as SourceEnv-to-DestEnv in the FileNet P8 deployment tree. When later created, the data maps, used to convert source objects for the destination environment, is displayed under the SourceEnv-to-DestEnv node in the deployment tree.

  3. Export the data from the source environment.
    1. Using FileNet Deployment Manager, create the export manifest file. See Create or update an export manifest.

      The administrator adds the Customer Invoices Folder in the SourceOS1 object store to the export manifest. In the Include Options dialog box for that object, the administrator keeps the default settings. Because all of the objects are filed in the Customer Invoices Folder, or are associated with the objects in that folder, all the other objects are exported by using the include options.

      The administrator saves the export manifest to SourceOS1_ExportManifest.xml.

    2. Using FileNet Deployment Manager, export the source objects that are listed in the export manifest file. Exporting the source objects creates a deployment data set directory of exported objects. See Create deployment data set.

      The administrator runs the operation and specifies SourceOS1_ExportManifest.xmll as the export manifest file, and CE_Create as the deployment data set of exported objects.

    3. Use the administration console to export the queue definition from the isolated region to an XML file.

      Although workflow definitions are stored in the Content Platform Enginerepository, the queues, rosters, logs, user information, system properties, all transferred workflows, running work items, and other configuration information are stored in an isolated workflow system region.

      From the source environment, the administrator saves the exported queue definition to PE_Config.xml.

  4. Create lists of environment-specific data from each environment.
    1. Create an object store half map from the source environment. See Extract an object store half map.

      The administrator retrieves the object store names from the source environment: P8Demo and SourceOS1.

    2. Create a security principal half map from the source environment. See Extract a security principal half map.

      The administrator retrieves security principals from the source environment. Because the LDAP server contains only a small set of groups and users, the administrator retrieves the security principals from the server.

    3. Create an object store half map from the destination environment. See Extract an object store half map.

      The administrator retrieves the object store names from the destination environment: P8Demo and SourceOS1.

    4. Create a security principal half map from the destination environment. See Extract a security principal half map.

      The administrator retrieves security principals from the destination environment. Because the LDAP server contains only a small set of groups and users, the administrator retrieves the security principals from the server.

    5. Edit labels in a half map. Edit the labels in one or more half maps if you must resolve unmapped entries that are displayed in the deployment data set. See Edit labels in a half map.

      For object stores, the administrator maps SourceOS1 to DestinationOS1 because there are no key fields in common, that is, the symbolic names and IDs are different for the two object stores. The administrator enters the label OS1 to map the SourceOS1 and DestinationOS1 entries in the source and destination half maps.

      For security principals, the administrator maps SourceGroupN to DestinationGroupN, and SourceUserN to DestinationUserN. The administrator does not map the source Admin security principal because the key fields in the Admin entries in both environments are the same. The key fields are security ID (SID) and the short name.

  5. Create the data maps that are required to convert environment-specific data between environments.
    1. Create the object store data map. This operation uses the object store half maps to create an object store data map. See Create an object store data map.

      The administrator runs the operation and views the object store map UI, which shows that the source and destination object stores, P8Demo and SourceOS1, are mapped by using matching labels. It also shows that the P8Demo object stores in the source and destination environments are mapped because their symbolic names are the same (matching labels are not required).

    2. Create the security principal data map. This operation uses the security principal half maps to create a security principal map. See Create a security principal data map.

      The administrator runs the operation and views the security principal map UI, which shows that the source and destination LDAP groups and users are mapped by using matching labels, except for the Admin user.

    Restriction: For this sample, there are no unmapped object store or security principal entries. However, for some deployments, the map UIs do show unmapped entries, indicated by the ### characters in the destination entries. You must resolve unmapped entries if they are included in the deployment data set; otherwise, you can ignore them.
  6. Update the environment-specific attributes in the data.
    1. Convert the Content Platform Engine deployment data set. This operation converts the exported objects from the source environment with environment information specific to the destination environment. The converted objects are saved in a deployment data set directory in the destination environment, which is used for the analysis and import operations. See Convert objects for import.

      The administrator runs the operation, specifying CE_Create as the deployment data set of exported objects. For the output directory for the deployment data set of converted objects, the administrator accepts the default directory: P8DeploymentData\Environments\DestEnv\Assets\CE_Create.converted.

  7. Analyze converted objects.

    FileNet Deployment Manager includes the change impact analysis operation, which reports on the potential import errors in the destination environment, on the change impact on the destination environment, and on the estimated size of the imported data. The operation uses a converted deployment data set and connects to a destination environment to do the analysis. Note, however, that the operation provides information only; it does not import exported data, or modify the destination environment.

    You can run this operation on the converted deployment data set for the Content Platform Engine or the workflow system isolated region configuration data file. See About change impact analysis and Analyze objects for import.

    1. Analyze the converted Content Platform Engine deployment data set.

      The administrator accepts the default directory for the deployment data set for converted objects: P8DeploymentData\Environments\DestEnv\Assets\CE_Create.converted.

  8. Import the data to the destination environment.
    1. Use the administration console to import the queue definition. Because the import in this sample scenario creates new objects (as opposed to updating existing objects), it does not matter whether the Update or Merge option is selected.

      The administrator specifies the queue definition configuration file (PE_Config.xml).

    2. Using FileNet Deployment Manager, import converted Content Platform Engine objects. See Import converted objects.
      For importing data in the sample, the administrator sets the following options in the Import Options wizard
      Tip: This is a sample scenario. Other options might be available in the Import Options wizard and some of these options might change.
      :
      • Select Deploy Dataset This option accepts the default deployment data set directory for converted objects: P8DeploymentData\Environments\DestEnv\Assets\CE_Create.converted.
      • Select Storage Policy for Imported Objects This option selects Take the storage policy from the class definition at the destination. For this scenario, the administrator cannot assume that the storage policy in the source exists in the destination, so the administrator chooses the default storage policy from an imported document's destination class definition.
      • Import Security Permissions This option preserves the permissions that are assigned to the source objects.
      • Import Owner This option preserves the owners that are assigned to the source objects.
      • Import Object ID This option preserves the relationships to other exported objects that reference the object that is imported. For most scenarios, you would select this option.
      • Use Original Create/Update Timestamps and Users This option preserves the original time stamp and modifying-user information from the source objects.

        Note For this option to work, the importing user must have privileged write access on the destination object store. (From the Security tab of the object store property sheet in Administration Console for Content Platform Engine, the Modify certain system properties permission must be set.)

      • Update Options This option selects Update if newer. Since only new objects are created in this scenario, any update option works. However, the update option is the best option because the administrator exported the source objects with all associated objects included (as specified in the export manifest). Therefore, if an associated object exists at the destination, like the Document class definition, the import updates the existing object only if the source object is newer.

      The administrator does not use scripts for importing because no special processing is necessary before or after you import each object.

  9. Perform extra configuration.

    Depending on the contents of a deployed data set and the FileNet Deployment Manager import options, you might need to complete extra configuration in the destination environment. For this sample, a workflow definition and the workflow subscription are included in the imported data, necessitating the following steps.

    1. Transfer the workflow definition.

      The sample workflow description (InvoiceWorkflowDefinition) was imported to the Customer Invoices Folder on the DestinationOS1 object store. The administrator transfers InvoiceWorkflowDefinition to the destination server.

    2. Update the workflow subscription. See Update workflow subscriptions.

      The administrator modifies the imported workflow subscription, InvoiceWorkflowSubscription. The administrator selects the transferred InvoiceWorkflowDefinition as the workflow definition for the subscription.



Last updated: March 2016
scenario_create_01.htm

© Copyright IBM Corporation 2016.