Change impact analysis

The change impact analysis operation validates the converted deployment data set file with the destination environment. This operation provides information only; it does not actually import data, or modifies the destination environment in any way.

Validation logic

Avoiding errors

To avoid "class not found" errors during the validation of a group of objects, import the metadata information (class and property definitions) of the objects first, and then validate the objects themselves as a separate step. If you import the metadata of the objects first, the change impact analysis report information, such as estimated object size, is more accurate and potential errors are avoided.

Controlling validation errors

Because a change impact analysis operation might process a data set containing hundreds of thousands of exported objects, the potential number of analysis failures that are processed and reported can slow your progress when you diagnose reported errors. You can specify the number of analysis failures that trigger a termination of the analysis operation when you run the Analyze operation. The default value for this limit is 100. Setting this value to zero indicates that no limit is assigned and the analysis operation is to proceed without regard to the number of analysis failures. See Analyze objects for import for instructions.

Validation of workflow definitions

Workflow definitions are stored in the Content Platform Engine object store, and can be included in the deployment data set exported from the source environment.

Because a Content Platform Engine import does not handle data directly, any problems discovered validating the data that a workflow definition references does not prevent the workflow definition itself from being imported. However, if the data that a workflow definition references is invalid, it can prevent the workflow definition from functioning properly.

Validation of workflow system data

Estimated sizing logic

In addition to validating the data intended for import, estimated size information is collected for this data, which is based on a file system-independent and database-independent analysis. The analysis uses a standardized size for each particular data type. For each data type, the number of occurrences is multiplied by the standard size to compute the estimated size. You can use this information for capacity planning before you perform the import operation.

The standardized sizes that are used for each data type are shown in the Data types and standardized sizes table. If you need more accurate size information, specific to the environment or database, you can use the change impact analysis report information for the number of occurrences for each data type, and perform the size calculation for the environment by using your own tools.

If an object to be imported has content elements, the content file path is obtained, and the file size information is then retrieved from the file system. The content size of an object is computed as the sum of the content file sizes.

Categories of size information

The size information in the analysis report is presented per object, class, and data type:

• Object

  Includes the property names of each object, the data type of each property, the number of occurrences for each data type, and the estimated size for each data type.

  This information can be useful for troubleshooting sizing issues, particularly when a class has many instances and a small subset of these objects contribute most of the size data (they have large amounts of content or BLOB values).

• Class

  Includes the property names of each class, the data type of each property, the number of occurrences for each data type, and the estimated size for each data type.

• Data type

  Includes the data type names, the number of occurrences for each data type, and the estimated size for the data type.

Objects that are sized as zero

An object can be reported as having an estimated size of zero when the set of data that is being analyzed contains objects of a class that does not exist in the destination environment. In this case, FileNet Deployment Manager is unable to retrieve the class information necessary to estimate the size of the objects and the estimated size for these objects is reported as zero.

You can produce actual size estimate for these types of objects, by performing the following steps:

1. Export the applicable metadata from the source environment for the classes that are missing in the destination environment.
2. Import this exported metadata into the destination environment. The missing classes are now present in the destination environment.
3. Export the object instances that were previously reported as having an estimated size of zero.
4. Analyze the set of data that contains these objects.

Data types and standardized sizes

The standardized sizes that are used for the data types are described in the following table.

Data type	Standardized size
SingletonBinary	Size is based on the literal sum of byte[] size.
SingletonBoolean	Size is 1 byte (actual size is 1 bit, but 1 byte is used to simplify computation).
SingletonDateTime	Size is 4 bytes (based on the IBM® DB2® date/time data type storage size).
SingletonFloat64	Size is 8 bytes.
SingletonId	Size is 16 bytes. Each value is a GUID.
SingletonInteger32	Size is 4 bytes.
SingletonString	Size is the string length, which is multiplied by 2 to account for 2-byte Unicode characters.
SingletonObject	Size is either 16 bytes or 32 bytes. An object-valued property is identified by an ID of 16 bytes (equivalent to a SingletonId). Because an object-valued property that is an external reference also has an extra ID for the external object store, the size is 32 bytes (equivalent to two SingletonId values).
Permission	Size is 16 bytes. The permissions list of each object is referenced by an ID (equivalent to a SingletonId). This ID is a pointer from the main database table to a shared security descriptor instance. The shared security descriptor table entries are not used in the sizing computation. This information also applies to TemplatePermission and DefaultInstancePermission.
ListOfBinary ListOfBoolean ListOfDateTime ListOfFloat64 ListOfId ListOfInteger32 ListOfString ListOfObject	The sizes for all the List data types are based on the corresponding Singleton value (for example, ListOfBinary uses the SingletonBinary size value). This Singleton value is multiplied by the number of items in the list. Each item in the list also has extra storage size of 36 bytes (16 bytes for the Parent ID + 16 bytes for the Property Definition ID + 4 bytes for the ordinal value).
Content	Size is the sum of all the physical content file sizes. The content file path is obtained, and the file size information is retrieved from the file system.
NULL	Size is 1 byte, based on the IBM DB2 storage size for a null column.

Analysis results

The change impact analysis facility writes the results of the operation to one or more XML files, and transforms it to an HTML-formatted main report for viewing from a web browser. The report that is produced displays the validation results based on whether the source is a Content Platform Engine deployment data set or a workflow system data file.

Summary report for a Content Platform Engine deployment data set

By default, the analysis operation generates a main summary report that includes the information in the following table.

Information	Description
Report Generated On	Timestamp indicating when the operation was performed.
Report Location	The fully qualified path where the main report file is located.
Passed Assets Report Directory	The fully qualified path where the passed assets report files are located.
Deployment Tree Used	The deployment tree and the source-destination pair on which the analysis was performed.
deployment data set Used	The fully qualified path for the deployment data set file that is used.
Pair Name Analyzed	The name that is assigned to the source and destination environment pair that is used for the analysis operation.
Overall Analysis Status	The result of the analysis operation. The analysis operation reports a failure if any of the analyzed objects fail the analysis. The analysis operation continues to process objects in the event of an object failure.
Import Update Option Used	The action the Import operation performs if an imported object exists in the destination object store. This action can be as follows: Update if newer: Updates the object only if the instance in the import data set is newer than the instance at the destination, which is based on the LastModifiedDate property Always Update: Always updates the object if it exists at the destination Never Update: Does not update the object if it exists at the destination The import option that you select for the analysis must be the same as the import option that you used for the actual import; otherwise, the analysis results are not relevant to the import operation.
Total # of Objects Analyzed	The total number of objects that are included in the analysis operation.
Total # of Failures	The total number of objects that fail the analysis operation.
Total # of Objects that would be created during import	The total number of new objects that would be added to the destination environment.
Total # of Objects that would be updated during import	The total number of existing objects that would be updated in the destination environment.
Total # of Objects that would be skipped during import	The total number of existing objects in the destination environment that would be unaffected (skipped) by the import operation. Destination environment objects are skipped by the analysis operation only if you select the import analysis option "Only update an object if the instance in the import data set is newer than the one at the destination", and the destination object has a LastModifiedDate property value that is newer than that value on the source object.
Total Estimated Size	An estimate of the total size for all objects to be imported.

Additionally, the main report contains class statistics, size estimates by class and by data type, and detailed information about the objects that fail analysis.

The class statistics are based on the information in the following table.

Information	Description
Class Name	The name of each class that contains objects that are analyzed for this import operation.
Count	The number of objects that are analyzed for each identified class.
Number of Object Creates	The total number of new objects of the identified class that would be added to the destination environment.
Number of Object Updates	The total number of existing objects of the identified class that would be updated in the destination environment.
Number of Object Skips	The total number of existing objects of the identified class in the destination environment that would be unaffected (skipped) by the import operation.
Estimated Size	An estimate of the total size of all objects analyzed for the identified class.

The size estimates by class are based on the information in the following table.

Information	Description
Class Name	The name of each class that contains objects that are analyzed for this import operation.
Property Name	The class property name.
Type	The data type for the property value.
Number of Occurrences	The total number of occurrences of this class property that would be updated in the destination environment.
Estimated Size	An estimate of the total size of all occurrences of the property for the identified class.

The size estimates by data type are based on the information in the following table.

Information	Description
Data type	The data types identified.
Number of Occurrences	The total number of occurrences of this data type that would be updated in the destination environment.
Estimated Size	An estimate of the total size of all the occurrences of the data type.

The information for the objects that fail analysis includes the information in the following table.

Information	Description
Name	The name of the object included in the analysis operation.
Class	The class of the object identified.
ID	The GUID for the object identified.
Analysis Status	The result of the analysis operation on the object identified. The result is either "Passed" or "Failed".
Import Operation	The analyzed result of importing the identified object. The value that is displayed is determined by the import analysis option you selected for the analysis operation. This value can be as follows: Update The import results in an update to the existing object in the destination environment. Create The import results in a new object that is created in the destination environment. Skip The import operation skips (does not affect) the referenced object because the object exists in the destination environment and the value of the LastModifiedDate property of the source object is not newer than the object of the destination object.
Estimated Size	A size estimate for the identified object. The object size estimate is based on the size of the exported data, and not the space that is required to store the data in the destination environment.
Comments	Information about the analysis results for the identified object.

Detailed reports for a Content Platform Engine deployment data set

In addition to the summary report, detailed information about the assets that failed analysis is available in the Assets that Failed Analysis section of the main report file. For assets that passed analysis, detailed information is stored in one or more files that are contained in a subdirectory with the same name that you assigned to the analysis report file (minus the .xml extension). Each passed asset report file can contain up to 2000 asset listings.

To view detailed information for a particular object that passed analysis, follow these steps:

1. When you set the options for the change impact analysis operation, select the Include details for all objects in report check box in the Change Impact Report Options dialog box. However, regardless of whether you choose to create a detailed or a summary report, the same data is saved to disk; only the generated HTML in the main report changes.
2. Using Windows Explorer Search, search the passed assets directory for the name or ID of the object and determine the XML file to which it belongs.
3. Open the XML file from the search results in a web browser, or go to the Assets that Passed Analysis section of the main report and click the report that contains the object that you want to view.
4. In the asset report that passed, search for the ID or name of the object that you would like to view.
5. To view more information, including an estimated size breakdown for each property of an object, open the XML file in a text editor instead of a web browser and search for the ID or name of the object that you would like to view.

Summary report for a workflow system data file

By default, the analysis operation generates a summary report that includes the information in the following table.

Information	Description
Report Generated On	Timestamp indicating when the operation was performed.
Report Location	The fully qualified path where the main report file is located.
Deployment Tree Used	The deployment tree and the source-destination pair on which the analysis was performed.
Workflow System Configuration Used	The fully qualified path for the workflow system data file used.
Destination Environment Analyzed	The name that is assigned to the source and destination environment pair that is used for the analysis operation.
Overall Analysis Status	The result of the analysis operation. The analysis operation fails if any of the object imports fail. An import operation also fails if any of the object imports fail.
Total # of Objects Analyzed	The total number of objects that are included in the analysis operation.
Total # of Failures	The total number of objects that fail the analysis operation.

Additionally, the summary report contains class statistics.

The class statistics are based on the information in the following table.

Information	Description
Class Name	The name of each class that has instantiated objects analyzed for this import operation.
Count	The number of analyzed objects that are instantiated from each class.

Detailed report for a workflow system data file

You can generate a detailed report that supplements the summary information with more information about the objects that are intended for import.

Information is provided for the objects that passed the analysis operation and for objects that failed the analysis (in separate tables). The information categories correspond to those categories presented for the objects that fail analysis. However, because size information is not applicable, reports do not include it.

The information for the objects that failed analysis includes the information in the following table.

Information	Description
Name	The name of the object included in the analysis operation.
Class	The class of the object identified.
ID	The GUID for the object identified.
Analysis Status	The result of the analysis operation on the object identified. The result is either "Passed" or "Failed".
Comments	Information about the analysis results for the identified object.