Summary: A description of the various search methods available in CAST Imaging.

Current view search

The search option is limited to the current view.

The current view search option allows you to search an item in the Current view and then highlight them in the viewIt can be accessed by clicking the Search icon:

When clicked, the search panel will be displayed, listing all items currently displayed in the view:

Entering a search string will automatically list items that match and are present in the current view - for example, the string "book" has been entered:

Any items you want to highlight in the view can be selected individually, or you can select multiple items, or all items:

Each selected item will be highlighted in the view:

Click to enlarge

All application (global) search options

The "all application" Search option allows you to search across the entire Application:

You can access the search feature as follows:

Custom scope - see User Guide - Custom scope

Search icon in task bar

Right click a node/object - search is limited to the selected node

This option only functions in Level 5:

Object search

Access via Search view menu or Search icon on task bar

The standard search popup will be displayed. To search for an object:

Search only for objects

Enter the string to search for - i.e. the string to match specific object names. You can choose more advanced search options if required:

Regex patternTick this to enable search via a regular expression.
Case sensitiveEnable/disables case sensitive search (disabled by default).
Search by: Name/FullnameSelect as appropriate. The search string will be applied to the options you choose.
Search by positionSelect as appropriate to specify where in the string the match should occur. By default this is set to Start.


From ≥ 2.8.0-funcrel, these filter settings are persistent for the duration of the user session (i.e. until a log out occurs), therefore you will not need to re-enter them when you perform a new search.


Between filters

You can use this option to configure whether you want to filter:

  • On strings (content of Search only for objects) AND specific object types/tags/object properties
  • On strings (content of Search only for objects) OR specific object types/tags/object properties
Select an object type(s)

Choose if you want to limit the search results to specific object types:

This filter is automatically set to use an OR option with tags and object properties.

Search a tag

Choose if you want to search for objects based on the tags that have been added in CAST Imaging (see User Guide - Working with tags for more information about Tags). You can select an AND or OR option:

Properties


Available in ≥ 2.9.0.

This section allows you to perform an object search based on specific object property values that were calculated during the analysis (before the application was imported into CAST Imaging). In the example below, multiple properties have been added using an AND configuration:

  • Match all objects with a Cyclomatic Complexity value equal to 1

AND

  • Match all objects with a Number of code lines value equal to 30

AND

  • Match all objects with an Essential Complexity value equal to 20

You can add new properties using the drop down list - note that the list of properties available to search is controlled by the ADMIN/SUPER ADMIN. See Admin Center - Search panel.

Use the red icon to remove properties that you have already added:

Search results are displayed in the "List of objects" window:

Select a single object or multiple objects to display them in the view (or tick the List of objects option to add all objects to the view). Click Visualize to view the view:

Click to enlarge

Links between any objects selected for visualization will also be shown:

Click to enlarge

  • You can add additional objects/nodes to the Search view in successive searches without losing any existing nodes added to the view.
  • If you need to clear the view you can click the Clear icon located in the Investigate panel - see User Guide - GUI - Investigate panel.

  • Existing nodes that have been added to the Search view can be removed by deselecting the nodes which will already be selected when the search is re-opened (by clicking the Search icon on the toolbar) and then clicking Visualize.

Access via node/object right click

When using the search option via the node/object right click contextual menu whilst in Level 5, the search will be performed as a "selective expand" on the originally selected objects - i.e. results are limited to the children/children,callers,callees/children&callers/children&callees. Therefore, the search box is presented in a slightly different way:

Scope selection:

Results are displayed and handled in the same way as using the Access via Search view menu or Search icon on task bar.

Document search

  • This feature is available in ≥ 2.0.0.
  • Currently documents added to nodes in Level views cannot be searched.

Document search allows you to search for text added using the Document-It feature:

Results are displayed and handled in the same way as using the Access via Search view menu or Search icon on task bar.

Cypher search

Cypher search is a feature that allows you to directly query the Neo4j database using "cypher query" - a specific functional language. You can use the "Cypher" tab in the Search view to run your queries:

The Cypher search option is only enabled for users with the default SUPER ADMIN and ADMIN roles. If you would like to enable it for other users, either modify an existing role to enable the Cypher Search or create a new role specifically for that - see Admin Center - Roles panel:

You need to enable at a minimum the READ and CREATE permissions to perform a query. The Cypher language is powerful and enabling the UPDATE and DELETE permissions will allow users to perform cypher queries which can update or delete existing application data.

Dedicated Document-It document search

When more than six Document-It documents have been added to a view, it is possible to perform a search of all the documents within the view. Use the following icon to access the search facility:

A search box will then be displayed showing all the documents present on the view. Enter a search string to perform the search - searches are actioned on the title, description text and tags:

Clicking an item in the results list will display the corresponding document in the view.



Summary: A description of the various search methods available in CAST Imaging.

Current view search

The search option is limited to the current view.

The current view search option allows you to search an item in the Current view. It can be accessed by clicking the Search icon in the current view.

Click to enlarge

A search dialog will then be displayed, enabling you to enter a search string - any items that match the search string and are present in the current view will be listed:

Selecting one or multiple items - each selected item will be highlighted in the view:

All application (global) search options

The "all application" Search option allows you to search across the entire Application:

You can access the search feature as follows:

Custom scope - see User Guide - Custom scope

Search icon in task bar

Right click a node/object - search is limited to the selected node

This option only functions in Level 5:

Object search

Access via Search view menu or Search icon on task bar

The standard search popup will be displayed. To search for an object:

Search only for objects

Enter the string to search for - i.e. the string to match specific object names. You can choose more advanced search options if required:

Regex patternTick this to enable search via a regular expression.
Case sensitiveEnable/disables case sensitive search (enabled by default).
Search by: Name/FullnameSelect as appropriate. The search string will be applied to the options you choose.
Search by positionSelect as appropriate to specify where in the string the match should occur. By default this is set to Start.


From ≥ 2.8.0-funcrel, these filter settings are persistent for the duration of the user session (i.e. until a log out occurs), therefore you will not need to re-enter them when you perform a new search.


Between filters

You can use this option to configure whether you want to filter:

  • On strings (content of Search only for objects) AND specific object types/tags/object properties
  • On strings (content of Search only for objects) OR specific object types/tags/object properties
Select an object type(s)

Choose if you want to limit the search results to specific object types:

This filter is automatically set to use an OR option with tags and object properties.

Search a tag

Choose if you want to search for objects based on the tags that have been added in CAST Imaging (see User Guide - Working with tags for more information about Tags). You can select an AND or OR option:

Properties


Available in ≥ 2.9.0.

This section allows you to perform an object search based on specific object property values that were calculated during the analysis (before the application was imported into CAST Imaging). In the example below, multiple properties have been added using an AND configuration:

  • Match all objects with a Cyclomatic Complexity value equal to 1

AND

  • Match all objects with a Number of code lines value equal to 30

AND

  • Match all objects with an Essential Complexity value equal to 20

You can add new properties using the drop down list - note that the list of properties available to search is controlled by the ADMIN/SUPER ADMIN. See Admin Center - Search panel.

Use the red icon to remove properties that you have already added:

Search results are displayed in the "List of objects" window:

Select a single object or multiple objects to display them in the view (or tick the List of objects option to add all objects to the view). Click Visualize to view the view:

Click to enlarge

Links between any objects selected for visualization will also be shown:

Click to enlarge

  • You can add additional objects/nodes to the Search view in successive searches without losing any existing nodes added to the view.
  • If you need to clear the view you can click the Clear icon located in the Investigate panel - see User Guide - GUI - Investigate panel.

  • Existing nodes that have been added to the Search view can be removed by deselecting the nodes which will already be selected when the search is re-opened (by clicking the Search icon on the toolbar) and then clicking Visualize.

Access via node/object right click

When using the search option via the node/object right click contextual menu whilst in Level 5, the search will be performed as a "selective expand" on the originally selected objects - i.e. results are limited to the children/children,callers,callees/children&callers/children&callees. Therefore, the search box is presented in a slightly different way:

Scope selection:

Results are displayed and handled in the same way as using the Access via Search view menu or Search icon on task bar.

Document search

  • This feature is available in ≥ 2.0.0.
  • Currently documents added to nodes in Level views cannot be searched.

Document search allows you to search for text added using the Document-It feature:

Results are displayed and handled in the same way as using the Access via Search view menu or Search icon on task bar.

Cypher search

Cypher search is a feature that allows you to directly query the Neo4j database using "cypher query" - a specific functional language. You can use the "Cypher" tab in the Search view to run your queries:

The Cypher search option is only enabled for users with the default SUPER ADMIN and ADMIN roles. If you would like to enable it for other users, either modify an existing role to enable the Cypher Search or create a new role specifically for that - see Admin Center - Roles panel:

You need to enable at a minimum the READ and CREATE permissions to perform a query. The Cypher language is powerful and enabling the UPDATE and DELETE permissions will allow users to perform cypher queries which can update or delete existing application data.

Dedicated Document-It document search

When more than six Document-It documents have been added to a view, it is possible to perform a search of all the documents within the view. Use the following icon to access the search facility:

A search box will then be displayed showing all the documents present on the view. Enter a search string to perform the search - searches are actioned on the title, description text and tags:

Clicking an item in the results list will display the corresponding document in the view.