Result view of a server reference search
This view displays the results of the reference search that was requested for the selected instance or file. This search was started from the
or choice of the instance or file contextual menu. It was run directly on the Rational Team Concert™ server.The view title and its associated tooltip display the name and project of the instance that was the origin of the search.
The instances that are found by the search are preceded by the icon that represents their entity type. This entity type can be viewed in the tooltip that is associated with each instance.
References of an instance
- The super references: the instances that reference the current instance,
- The subreferences: the instances that are referenced by the current instance.
The composition links include the free references. Free references are links that are set when the name of a target instance is entered in some text fields of a source instance. The target instance is not necessarily defined. In this case, it is preceded by the icon of the entity that is entered in the input field but this icon is grayed.
For explanations, see The free references.
References of a generated file
If you started the subreference search from a generated file (.cbl file of a Program, Screen, or Server in the Pacbase facet), the result view displays the instances that were involved in the file generation.
- The design instance that constituted the entry point to generate the COBOL file.
- The instances that are called in micropatterns. The Data Elements that are called in micropatterns WF, WE, WI, and WS are then displayed.
- The Data Elements that are inserted manually in the code of the PROCEDURE DIVISION. The number of usages of each Data Element in the COBOL file is indicated with usage(n), where n is the number of usages of the Data Element.
Possible actions on the references
- Open the instance in its design editor in a read-only mode. The editor displays the same information as it would if the instance was present in the local workspace. You can navigate through the instances. For example, you can open the editor of a Data Element from the CE Lines tab of a Segment.
- Open the instance in another editor in a read-only mode. You can also open it in its COBOL editor in a read-only mode if it contains a COBOL description.
- Open the design editor of a calling instance and highlight the reference
links to a called instance (Pacbase facet). To open the
editor, select the choices Previous match or Next
match. If the calling instance and the called instance are linked by only one reference
link, the two choices are equivalent. However, if the instances are linked by several reference
links, you use these choices to browse forward or backward among the links of this couple of
instances and open the corresponding links in that order. If the design editor of the calling instance is already opened when the reference search is started, the choices Previous match and Next match first open the editor on the link that was detected in the active tab. Links are displayed according to their order in the editor. Only the links that are present in the instance design are explored. Moreover, only the following reference links are displayed:
- Segment: CELine,
- Data Structure: LSLine,
- Communication Monitor Dialog: CPLine, and CPLineParameter,
- Dialog: CPLine, CPLineParameter, and CSLine,
- Server Dialog: CPLine, CPLineParameter, and CSLine,
- Program: CPLine, CPLineParameter, and CDLine,
- Report: CELine,
- Screen: CPLine, CPLineParameter, CELine et CSLine,
- Server: CPLine, CPLineParameter, and CSLine.
- Show the history of the instance. This choice opens the History view where the change history of the instance is displayed.
- Load the artifacts. Only the instances from which you have selected this choice are loaded into the local workspace.
- Load the required artifacts. You can select this choice from
one of the following line types:
- One or more design files. If the design file is a Program, Screen, or Server instance, a dialog
box asks you whether you want to load the associated generated source file. This file is not
required but its loading makes the product easier to use.
A specific loading wizard opens. It displays the selected files and their required artifacts that were detected by following the subreference links. All these files are loaded into the local workspace, where they constitute a consistent set of data.
- One or more source files or maps (for Screens). The links are automatically explored to find all the required artifacts. All these artifacts are loaded into the local workspace.
For explanations, see Loading the local workspace.
- One or more design files. If the design file is a Program, Screen, or Server instance, a dialog
box asks you whether you want to load the associated generated source file. This file is not
required but its loading makes the product easier to use.
- Load the required projects for this instance. You can then limit the number of the components to be loaded into your local workspace in order to be able to work on the instance.
- Search for its own super references or subreferences that are then in turn displayed in the Server References view.
Toolbar
- Open the design editor of a calling instance with Previous match (
) and Next match (
).These actions are also available from the contextual menu. Therefore, they are explained with the other choices of the contextual menu.
- Cancel the current search (
icon).
- View the previous reference searches (
icon). Click the arrow associated with the icon to display a menu that contains the following elements:
- The previous instances from which you requested a reference search. Select one of these instances to see its references in the view.
- The History choice. This choice
opens a window that shows the previous instances from which you requested
a reference search. From this window, you can complete the following
actions:
- Select an instance and display its references (Open or Open in new view) or remove this instance from the history (Remove),
- Change the number of instances that are displayed in the history (10 is the default) by clicking the Configure link.
- The Clear History choice, to remove all the previous searches from the history.
- Export the query result (
) in a CSV format that can be used in a spreadsheet program.
- Switch from the super references to the subreferences of
the current instance (
).
- Switch from the subreferences to the super references of
the current instance (
).
- Modify the way that the instances are shown in this view. Click
the triangle (View menu) and select one of
the following choices:
- Sort to specify a new sort criterion. This new criterion is then automatically saved and associated with this view until you change it again.
- Display to display more information
for each instance line in the tree. To remove some additional information
from the line, select it again in the menu. This new criterion is
then automatically saved and associated with this view until you change
it again.Note: The relation, which is a type of additional information, is the name of the link between the source instance and the target instance. If the source instance calls the same target instance in different tabs, then a relation is displayed for each tab. For example, if a Screen calls the same Data Element in the -CE Lines and the -CS Lines, two relations are displayed, with the names of the two tabs. However, if the source instance calls the same target instance several times in the same tab, only one relation is displayed. In this case, the occurrence number of the relation is displayed in parentheses, next to the relation name.
Filters to exclude some entity types from the search results. A wizard opens with all the entity types that you can exclude. If you want to display only some entity types, you must select all the entity types by clicking Select all and clear the types to be kept.
Example: In the Pacbase facet, you can list the child Data Elements of a parent Data Element. To do so, you must first search for the subreferences of the parent Data Element. Then, you must filter the results by selecting, in the filters wizard, all the entity types except the Data Elements.
You can filter the results by selecting a project in the Context field and by clicking one of the buttons that represent a hierarchic view of the projects in the design build path. Context only is selected by default. It means that only the instances that are found in the selected project are displayed. However, you can select another hierarchy (upper, lower, or whole) to display the instances that are found in the selected project and in the projects that are hierarchically higher or lower, or in all the projects of the hierarchy.