Page tree
Skip to end of metadata
Go to start of metadata

Summary: this section explains how to manage Dynamic Links.

Introduction

When an analysis is run the authenticity of some links that have been identified between objects cannot be absolutely determined by CAST - these links are known as "dynamic links". Often these "unverified links" systematically occur or have no meaning for the specific technology you are working with. This screen displays:

  • a summary of the dynamic links detected in the most recent analysis
  • detailed information about each link
  • the ability to manually review (see below) each unverified link to state whether the link is correct or false

Reviewing Dynamic Links forms an important part of the analysis validation process and is explained in more detail in Advanced onboarding - validate Dynamic Links.

Available options

Click to enlarge

The Summary section provides a basic overview of the status of Dynamic Links in the Application as a result of the most recent source code analysis:

Not ReviewedNumber of links that need to be reviewed manually (see below). This means that AIP Console does not know whether the link is real or not and therefore you should review the code that creates the link to determine its status and then either validate or ignore it.
Ignored / Validated

Number of links that:

  • have already been validated as correct (Validated)
  • have already been ignored as invalid/false (Ignored)

Validation/ignore can occur through a variety of methods:

Use this button to download the list of Dynamic Links in this section in CSV format.

Clicking a row in the table will take you direct to the Manual Review section with a filter applied to match the contents of the row.

The Details section provides more information about the links listed in the Summary section:

Source Type

Lists the object type that contains the code for the "source" of the link. Typically these are Methods and Constructors, but can be others.

Target TypeLists the object type that is the target of the source object. Typically these are database object types, but can be others.
Status

Indicates the status of the link as explained in the Summary section above.

  • Not Reviewed
  • Ignored
  • Validated
LinksIndicates the total number of links that exist between the source and target object type. The total number of links reported in the Summary link (Not Reviewed + Validated) will equal the total number of links in this column.

Use this button to download the list of Dynamic Links in this section in CSV format.

Clicking a row in the table will take you direct to the Manual Review section with a filter applied to match the contents of the row.

This button opens a new window where you can manually review each link. By default the window will show all links that need to be reviewed - i.e. all links that are still considered to be "unverified":

Click to enlarge

Links can, however, be in one of three states:

  • Validated: links are in this state when they have already been manually or automatically validated as correct or true. By default Validated links are not displayed in the GUI - you will need to specifically select the Validated check box to display them.
  • Ignored: links are in this state they have already been manually or automatically reviewed as invalid or false. By default Ignored links are not displayed in the GUI - you will need to specifically select the Validated check box to display them.
  • To review: links displayed in this state when you open the Dynamic Link Manager after the completion of an analysis - these links must be reviewed.

Allows you to discard or apply the review status on your links.

Filters the display of Dynamic Links. By default only To Review is selected, displaying only those links that are unverified and need to be manually reviewed. You can select a combination of any of the options to display the type of links you need.

Note that the Reference Finder filter will display any links that have been created via a Reference Finder rule.

This option is not available if at least one link is selected in the list. Instead a radio button offering three choices is displayed - this is the action required to review the link:



 Use this button to download the list of Dynamic Links in this section in CSV format.

 Allows you to choose the columns that are displayed in the table. By default all are displayed:

Provides options for further filtering the display of links. The filtering is based on simple text strings - therefore entering "com" in the Source Object field and applying the filter will only display objects whose name contains the word "com":

Click to enlarge

  • Use the Reset button to remove all filters
  • Use the Apply Filters button to apply the filters you have added.

The tick boxes enable you to perform review actions on single or multiple links at a time.
Source ObjectLists the name of the object that contains the code for the "source" of the link.
Source TypeLists the type of source object - i.e. Method, Constructor, table etc.
Target ObjectLists the name of the object that is the target of the link in the source object.
Target TypeLists the type of source object - i.e. Method, Constructor, table etc.
LinkLists the type of link between the two objects.
Status

Current status:

  • Validated: links are in this state when they have already been manually or automatically validated as correct or true. By default Validated links are not displayed in the GUI - you will need to specifically select the Validated check box to display them.
  • Ignored: links are in this state they have already been manually or automatically reviewed as invalid or false. By default Ignored links are not displayed in the GUI - you will need to specifically select the Validated check box to display them.
  • Not reviewed: links displayed in this state when you open the Dynamic Link Manager after the completion of an analysis - these links must be reviewed.

Enables you to view the code of the link to help you decide whether the link is correct and needs to be marked as valid, or whether the link is invalid and needs to be marked as ignored:

Validate/Ignore/To Do radio buttons

These radio buttons allow you to choose what to do with the link after reviewing its code. Select the appropriate option for the link and then click Apply in the top right corner to confirm the choice. You can use the check boxes to review multiple links:

Click to enlarge

The process of reviewing Dynamic Links is as follows:

  • Ensure that the filter is set to To Review:

  • Tick the link you want to review:

  • If necessary, click the View Code button to help you decided if the link is correct and needs to be marked as valid, or whether the link is invalid and needs to be marked as ignored:

  • Click the appropriate radio button to either Validate (as correct) or Ignore (as false) the link)

Ignore Dynamic Links when:

  • Source code uses a logger information message
  • Basic text displayed in a message box or a frame

Validate Dynamic Links when:

  • code uses a manipulation of SQL queries

  • code uses a direct call from a business layer to a database table or function

  • code links a client part and a server part of an application

  • Finally click the Apply button in the bottom right corner to confirm the change in status of the link, then close the window:

  • The Summary/Details screen will then update to reflect your changes.

Changes made

Any changes made in the Summary of Dynamic Links page (e.g. reviewing Dynamic Links and applying the changes) will cause a banner to appear at the top:

This indicates that the changes you have made will impact your analysis results and therefore that the data that is used for the Architecture Studio, Transaction configuration and upload to CAST Imaging will not be up-to-date. Clicking the Update button in the banner will run a special step called Prepare analysis data that should complete relatively quickly (more quickly than a full analysis or snapshot) and ensures that the data used by the Architecture Studio, Transaction configuration and upload to CAST Imaging is up-to-date based on the changes you have made. 

This step is always actioned when you either run an analysis (without a snapshot) or generate a new snapshot. When the Prepare analysis data step is complete, the banner will no longer be displayed.

  • No labels