by Niambh Scullion, Andrey Zhereshchin, Shanthi Shanmugam, Shankar Sreedhara and John Gleeson.
This article provides you with a high-level overview of the CĂșram Analysis Documentation Tool (CAD) tool. It is based on training material on the CAD tool developed by Shanthi Shanmugam, Shankar Sreedhara and John Gleeson who are part of the IBM Watson Health, GHHS Implementations team based in Canada. Shanthi, Shankar and John have extensive expertise and technical experience in CĂșram Social Program Management Platform, and they work closely with Social Program Management customers to design and deliver projects to obtain their business goals and achieve better outcomes for both their employees and citizens. The IBM Watson Health GHHS Implementations team regularly produce and maintain training materials, presentations and technical assets to complement and customize the existing CĂșram Social Program Management product documentation and features for our customers.
Why use the CAD Tool?
The IBM CĂșram Analysis Documentation Tool (CAD) tool helps users have a better understanding of the business functions of the CĂșram Social Program Management application and the underlying metadata within the application. In addition to accessing application metadata, users can also view the interactions between the various components that make up the application.
If you are performing business analysis, involved in training staff, or you are a tester assessing a change to the application, the IBM CAD tool will give you a holistic view of the application in an intuitive and user friendly way. It is worth noting that the CAD tool can be used by technical teams too; Architects, Developers, DBAs and Business Intelligence can access all the technical implementation details, and they can quickly see all the relationships between the components.
I routinely provide training on CAD within Product Development and one of the questions that is often asked of me, is when would I use the CAD tool as part of my day-to-day job? My response has always been, if you need to gain some more functional understanding of the CĂșram Social Program Management application, then you need to consider using the CAD tool to help you. Below are some examples of when our customers use the CAD tool as part of their day-to-day:
- You need to assess a new release of IBM CĂșram Social Program Management to learn about new functionality that has been delivered.
- As a business analyst, you are performing fit-gap analysis on a new feature request.
- How would a change affect an IEG Script?
- Assessing the impact of an upcoming legislation change. What, if any, evidence needs to be updated to make the change, or tested to verify the change?
- Is there out-of-the-box functionality available to meet my current requirements?
- What would I need to customize to help meet the organizationâs requirements?
- As a tester, you may need to assess the new feature request to understand the impact of the change.
- As a business or technical user, you need to assess a release of IBM CĂșram Social Program Management with respect to upgrading to that version.
- As a business or technical user, you need to assess the existing system to understand both out-of-the-box and customized system functionality for training and documentation purposes.
- Application Views and Tabs
- Database Tables
- Page Information
- Domain Definitions
- Code Tables
- Message Files
- Application Properties
- Rule Sets
- Dynamic Evidences
- IEG Scripts
- Datastore Schemas
- Page Flows
- Description of database table
- Interactive visualization of the foreign key relationships between the entities. If you click the diagram, you can manipulate the diagram by moving it or you can zoom in (see figure 5)
- Model details such as the location of model file and the location of the entity
- Database attributes, foreign keys and indices.
- List of available operations
- List of pages that use the entity
This blog post is the first in a series of blog posts. In this first post, I will bring you through a high-level overview of the CAD tool. For the next article in the series, we will take a closer look at using CAD to understand the impact of a legislation change. The third blog post will look at using the CAD tool to assess an IEG page. The final article will show you how the CAD tool can be used to make an upgrade easier.
The CAD tool provides information about the following application artifacts:
You can access each of the areas from the home page and the side navigation bar (see figure 1).
You may not know exactly what you are looking for, so the generic search functionality is very useful. You can search for one, or all of the artifacts provided (the pages or code tables); when âAllâ is selected, the system searches against all artifact types for the specified term. The search functionally supports phrases, so performing a search like “Change of Circumstances”(see figure 2) will return all the artifacts that contain the phrase âChange of Circumstancesâ. Phrase searches need to be surrounded by double quotes.
The number of search results are matched against each artifact type and allow the user to view the results for an artifact type. Users can further narrow the search results by entering a filter criterion (see figure 3).
Application views and tabs
When a user logs into the CĂșram Social Program Management application they are presented with a view that is specific to their role. This view is known as an application view. The CAD tool displays a list of all configured application views used to support different user roles within the CĂșram Social Program Management application (see figure 4).
The list functionality within the CAD tool allows filtering, and you can narrow down the search by filtering the list by inputting a term into the text area above the list. The filtering applies to all lists within the CAD tool.
When an application view is selected, CAD displays a list of all tabs for that application view. Users can then select a tab to view tab information such as Navigation bar, page actions and page details.
When a user clicks on the âDatabase Tableâ link or icon, all database tables in the application are listed. Users can select a table to view additional information such as:
When a user selects the Page Information link or icon, the user is presented with a list of all the Pages within the IBM CĂșram Application. Displays a list of all pages available within the CĂșram Social Program Management application. The CAD tool provides some contextual information about the page, like what component the page resides in, the page name and title. When users click on the page, they are presented with a page description, a page preview, a page flow diagram, field information, a list of links from the page, messages displayed on the page, workflows that are invoked from the page and any related entities that are updated as a result of a Save.
Domain definitions are datatypes such as a ‘String’ or an ‘Integer’, that can be used by a page. When a user clicks on a domain definition, they are presented with information about the domain definition, entity attributes that use the domain definition, and finally a list of all the pages that use the domain definition.
Code tables are used to define values that should be displayed in a dropdown. When a user clicks on a Code table link or an icon, all code tables in the application are listed.
Users can then select a code table to access information about the code tables such as Code Table items and the list of pages where they are used.
CĂșram supports two types of messages – information and error messages. Messages are displayed to a user of the CĂșram Social Program Management application to inform them an action needs to be done, or an error has occurred. Messages are stored in message files.
When a user selects the Message Files link or icon, the user is presented with a list of all the message files within the CĂșram Social Program Management application. When the user clicks on a message file, you are presented with all the messages within the file. Each message can be expanded, and you can view the list of pages that will display the message.
Application Properties are configurable parameters used in CĂșram Social Program Management application for changing the application behavior and allows configuration based on the business requirements.
The application properties list lists all application properties within the application. You can filter the list to narrow down your search, you can also expand each property to display a localized version of the property description.
Workflows are used in CĂșram Social Program Management application to define processes to achieve certain business goals and are defined in the administration workspace. When a user clicks on the Workflows link or icon, a list of all workflows is displayed. A workflow can be selected to view more information such as:
It also includes a list of all Batch and Deferred Processes that can potentially trigger the Workflow.
CĂșram Rules are used in many types of calculations and for displaying results in CĂșram Social Program Management applications. They are commonly used to implement legislation and policies. When a user selects the Rule Sets link or icon, the user is presented with a list of all the rule sets within the IBM CĂșram Application. When a user clicks in to a ruleset, they are presented with information about the rule set, a list of rule classes in the rule sets, and if any of the attributes propagated by a Dynamic Evidence instance, this is listed. We will provide a deeper dive on this in a future article.
Dynamic evidence is used in the CĂșram application to capture information supplied by participants which can be used for assessment or eligibility determination. When the user selects the Dynamic Evidence link or icon, they are presented with a list of all the Dynamic Evidence instances configured within the application. Dynamic Evidence is versioned by effective dating it from a specific date. When a user expands a Dynamic Evidence list entry they can access previous versions of the evidence instance. When a user selects an evidence, if that evidence has a relationship (via parent/child) with another evidence, that evidence is presented. You can also click that evidence and view the evidence. The Create Page and View Page previews contain a page preview of how the dynamic evidence appears when a case worker is creating and viewing an evidence. To view the preview, expand the toggle on the header.
The Dynamic Evidence page also lists any rulesets that it propagates information to provides information on the cases that it is configured on to and how the evidence is shared across the cases. If ruleset or case information is not present on a page the evidence is not configured on a case or used by the rules.
IEG scripts are used in CĂșram to gather information interactively by displaying a script of questions that a user can provide answers to. An IEG Script is composed of multiple pages and based how a user answers a question the pages can be displayed. When the user selects the IEG Script link or icon, they are presented with a list of all the IEG Scripts configured within the application. When the user clicks on the IEG Script link or icon, the user is presented with information about that script. The user can access the datastore configured with the script. A visualization of the page flow is also present (see figure 6). This is a very useful tool, and once you click on the diagram it will be come interactive. You can move items around in the diagram, hovering over an item you will see high level information about the element, whether itâs a page name or a condition.
The CAD tool lists all the pages configured in the script, expanding the toggle beside the page name you can get more information on the page. You see what are the display conditions it needs to be met, you can see any display conditions per question and persistence information in the datastore.
The Datastore stores data collected from citizens during online screening and intake of applications (IEG scripts). When the user clicks on the Datastore link or icon, they are presented with a list of all the Datastores configured within the application. When you click on a Datastore item, you get information about the datastore schema itself. You can expand all the datastore items to access all the attributes associated with the datastore.
Page flows are a feature that allows a user to visualise various feature flows within the application. This is useful if you want to visualise how a process works within the application. When you select the Page Flows link or icon, the user is presented with a list of configured application views used to support different user roles within the system. This means that users can view a page flow within the context of a specific user.
When the user clicks on the page flow, they are presented with a list of pages that invoke some sort of action. You can see the name of the page, and we give you information about when the page is accessed, whether thatâs a shortcut or on a main tab, or a navigation item. We also try and give some context to the location of the item by providing the name of the navigation item in the list. Some flows will also have sub flows, for example in figure 7, a when a case worker is using the Verifications feature, there may be a number of sub actions that can be achieved. If you expand the toggle, you can see all sub actions listed.
Once you click on an Action link you are presented with the flow of the page. As with all diagrams, they are interactive, and when you click on the diagram you can move the content around to make it easier to view.
For the next article in the series, we will take a closer look at using CAD to understand the impact of a legislation change. The third blog post will look at using the CAD tool to assess an IEG page. The final article will show you how the CAD tool can be used to make an upgrade easier.
Thanks for reading!