Written by Des McCann and James Darcy
The IBM CÃºram Analysis Documentation (CAD) tool, which you can download from Fix Central, is designed to help you perform a fit-gap analysis. For more information about the CAD tool, see Introduction to the IBM CÃºram Analysis Documentation Tool. In addition to using the tool to analyse documentation, you can use the tool for fine-grained technical analysis of metadata and functional changes between two IBM CÃºram Social Program Management application versions. This comparison is beneficial when you want to decide what version of IBM CÃºram Social Program Management to upgrade to because you can see an immediate, high-level overview of the changes. In this article, we look at the CAD tool resources that you can use to make comparisons.
The inventory directory structure
The CAD tool produces a text-based inventory of the metadata and functions of the CÃºram Social Program Management application. Figure 1 outlines a sample of the inventory directory structure. Note: The full process to generate inventory is outside the scope of this article, but you can find all the details in the documentation that is included in the CAD installation package.
| |— codetables
| |— datastore
| |— domains
| |— dynamicevidence
| |— entities
| | |— attributes
| | |— foreignkeys
| | |— indices
| |— ieg
| |— messages
| |— pages
| |— rules
Figure 1 – Sample output inventory directory structure.
The CAD tool generates a text-based inventory in a
CAD_HOME/Diff folder. You can use a standard file-comparison tool to compare the text-based inventory in the
CAD_HOME/Diff folder against a similar inventory from another application version. You can retain a copy of the text inventory for future technical analysis of metadata and functional changes between application versions.
CAD_HOME/Diff folder, there is a sub folder for each artifact type: pages, entities, domains, code tables, and others. Within these folders, there is a file for each individual artifact â€“ for example, one file per application page. That file contains a technical inventory of the page â€“ its ID, fields (and their types), actions, links, and more.
The entity inventory content is further split into three subfolders, one each for information about attributes, foreign keys, and indexes. These items are separated to facilitate separate analysis.
For example, it is useful that you can identify what entity attributes changed without having to filter out index or foreign key changes. The individual subfolders can then be compared to focus on just one specific type of change. (For a full list of details, see the Content Overview section of the tool documentation that is included in the installation package.)
The entity inventory content is primarily technical. For example, the content favors the use of technical IDs over business labels and it does not include the kind of descriptive business information that is found in the corresponding CÃºram Analysis Documentation. This is because the technical information is more stable over time when it is compared to descriptive content and, so, is better suited for use in a file comparison tool.
You can use the CAD toolâ€™s comparison information to identify new artifacts or existing artifacts that changed between application versions. So, when you are planning an upgrade you can see an immediate, high-level overview of the changes.
Disclaimer: All CÃºram Analysis Documentation materials should be used with consideration. IBM accepts no liability for ensuring that they are suitable for your specific requirements. The CÃºram Analysis Documentation Generator and the content it produces are provided as-is and as such support services are discretionary and subject to availability. For example, IBM does not provide formal fixes for CÃºram Analysis Documentation materials, nor do those materials account for changes in any base application iFixes.