Include Usage
The Include tab displays information on the usage of Includes in the project. The nodes represent the Includes in the project. Expanding an include node displays a list of nodes that represent Include statements in COBOL files that refer to the copybook. The name of the file that contains the Include statement and the statement’s location (line and column numbers) are shown.
To display the Include Usage tab, go to Explore Projects tab and select Include Usage from the Usage in Programs list of analyses to the right of the screen.
The central part of the screen displays the list of attribute filters. By default, all attributes are selected; deselect the ones that you do not want to use. The breadcrumb displays the selected projects, the selected attributes in the set order with the filters set for each attribute.
- * is used to search elements, by adding to it either prefixes or suffixes as in AAA* or *AAA.
- , is used to search multiple elements as in AAA, BBB, CCC.
To limit the number of elements to be returned by the filtering operation, use the fields in the Limit column. The default limit is 50; the maximum limit can be set in the corresponding Usage Settings section from the Preferences dialog. For more information, see Include Usage Settings. The Context column displays the context of the filter operation where relevant. The context of the first attribute filter in the list is the project. The context of any other attribute filter in the list is the attribute above it in the list. To modify the attributes' order in the list, use the green arrow buttons to the left of the attributes list. When the attributes' order changes, the context of the filtering operation changes. To the right of Attribute filters area, the list of projects is displayed.
Use Save to save the current filter configuration. Use Load to load a previously saved filter configuration.
By default, Enable levels limit is selected and the number of elements that are presented in the Results area is limited by the values set in the Limit column. If you deselect this option, the Limit column from the Attribute filters area disappears and the Results area displays all the results of the analysis. Press Apply to apply the selected filters. When the filtering operation is finished, you can use the black arrow button in the upper left corner of Attribute filters area to hide it and maximize the Results area. To see the Include Usage parameters in a separate tab, use the arrow button in the upper right corner of Include Usage tab.
The results of the filtering operation are displayed in the Results area. Use the search field to locate a specific element in the Results tree. Click the adjacent button find only annotated to filter the search results so that only the annotated elements are shown. In the upper right corner of the Results area, the following buttons are available.
Reorder current results, use this button to order the results using a different filter configuration. A dialog window presents the list of filters that were used to perform the initial filtering and you can set them in the desired order.
Expand top 5 levels, click this button to expand the top five levels of the tree.
Collapse all, click this button to fold all the tree branches.
Export Results to CSV File, use this button to export the results together with the used filter configuration.
Place the mouse cursor over a node in the tree to display a tooltip that presents the element category and name. When you select a tree node, the area to the right of the screen is updated to display the graphs, reports, and usage analyses that can be generated for the selected element. Also, the Properties view displays the information available for the selected element.
Node name | Description |
---|---|
Include | Presents a list of the Include files in this project. |
Program category | Lists the types of programs. |
Program | Presents the include files that are used in programs: COBOL, Natural, PL/I, Assembler, ADS. |
Statement type | Presents the statement type and source occurrences of the statement in selected program. |
Include Usage variable filtering
Starting with IBM® AD V5.1.0.8, the Include Usage analysis has been expanded with an extra layer of filtering and has been designed to locate more effectively specific variables from includes inside programs.
The new filtering option is available in the Attribute Filters box. By default, it is automatically unchecked and it needs to be selected to activate it.
Without the Variable filter option, you will be able to see only
. If you want to find a variable, you must search manually in the View Analysis Source box.If the Variable filter is selected, an extra level of information is displayed and contains all variables from the include. You will be able to see
.If you left-click on a specific variable, additional information is displayed in the Variable Usage Properties box and includes the Start Row, which makes it easier to find the target variable. You can also double-click the variable, or right-click and select View Analysis Source, and see the exact row where the variable is located.
- You can use wildcards to enable a broader searching experience.
- After you click on a variable, all available analyses are displayed on the right side.
Include Usage statement filtering
Starting with IBM AD V5.1.0.9, the Include Usage analysis has been expanded with an extra layer of filtering. It has been designed to locate more effectively specific statement types and filter them by using the new graphic user interface.
To navigate to the Statement Type Filter pop-up window, open the Include Usage analysis and click on the All attribute present in the Filter column.
As a result, the Statement Type Filter pop-up window is displayed and contains specific statements that can be selected and filtered to any degree of granulation.
Click on Apply/Refresh to display only the selected statements.
Node pop-up menu
Select a node from the tree in the Results area then right-click to display the pop-up menu. The number of options available depends on the type of node selected. View analysis source and Copy options are available for all nodes. According to the selected node, several Collapse to … Level options might also be available.