CMS - CAST Management Studio - How To on Documentation - V2

CMS - Add a version

Mon, 01 Jan 0001 00:00:00 +0000

Add a Version

A Version specifies the version name/number and Date of Release for any source code you want to deliver. It is used to manage successive iterations of source code. New Versions are created when the Application’s source code changes and you want to measure these changes.

CAST recommends that the addition of Versions is left to the Delivery Managers (using the CAST Delivery Manager Tool via the CAST AIC Portal). However, if you (as the CAST AI Administrator) need to package source code, then you can add Versions as instructed below:

CMS - Add database server

Mon, 01 Jan 0001 00:00:00 +0000

Add database server

By default the Services view will display database servers and associated services automatically using the information defined during the installation process using CAST Server Manager - see the CAST Installation Guide for more information.

However, you can add further database servers for accessing additional Analysis/Dashboard/Messurement services installed on them as described below.

To add a new database server:

You can either:
- Click one of the Add icons () located on the menu bar of the Services view (click the button that corresponds to the type of Database Server that you would like to add)
- Right click whitespace in the Services view and select the appropriate Add new <database_server_type>
- Use the dropdown menu icon () located on the menu bar of the Services view
A component called My <server_type> will then be displayed in the view:

CMS - Assign Applications to Systems

Mon, 01 Jan 0001 00:00:00 +0000

Assign Applications to Systems

The CAST Engineering Dashboard displays results in a hierarchical list of entities:

Corporate > System > Application > Module

If you are working with a Dashboard Service that was installed as part of a “combined” installation, then a default System will be created for you (My System) and all Applications that use the Dashboard Service will be assigned to that System.

It is possible to add additional System entities to a Dashboard Service if you want, for example, Application A to belong to System 1 and Application B to belong to System 2. This is achieved in the Dashboard Service editor (Portfolio tab).

CMS - Backup an Application

Mon, 01 Jan 0001 00:00:00 +0000

Backup an Application

This option should only be used if you are requested to send an Application Backup to Support or you need to test an Application on other Management Service (i.e. a different CAST Management Studio environment).

This option enables you to backup an Application to file.

To use the option:

In the Applications view, right click an Application and select Backup Application
A Windows Save As dialog box will be displayed enabling you to choose the location and name of the .CastAppbck archive file that will contain the backup
The backup will then proceed.
The resulting .CastAppbck file will be a compressed archive.

What is backed up?

The backup process will make a carbon copy of the Application. This means two things:

CMS - CAST Management Studio logging

Mon, 01 Jan 0001 00:00:00 +0000

CAST Management Studio logging

The CAST Management Studio contains provides logging mechanisms for various features. All available log files are described below:


Log name	Usage	Default location	Notes
Error log	Captures all the warnings and errors logged by the CAST Management Studio.	%TEMP%\CAST\CAST<version_number>CAST-MSXX.log.txt	XX refers to a randomly generated number. See Log view for more information.
Summary log	Captures interaction with the CAST Analysis Service and the Dashboard Service.	%TEMP%\CAST\CAST<version_number>\ CAST_MainTask_SummaryLog_.txt	N/A
Snapshot Generation log	Captures detailed information about the Snapshot Generation process.	%TEMP%\CAST\CAST<version_number>DssEngine..log.txt
CAST System View update log	Captures detailed information about the update of the CAST System Views - generated only when you generate a snapshot.	%TEMP%\CAST\CAST<version_number>RunCSV-.castlog
Analysis log	Captures detailed information about the source code Analysis process.	%TEMP%\CAST\CAST<version_number><Unique_Application_ID>\ <DMT_Package>_.castlog
Delivery Manager Tool log	Captures detailed information from the Delivery Manager Tool	%TEMP%\CAST\CAST<version_number><Unique_Application_ID>\

Notes

CMS - Change Operator and Guest passwords (CSS only)

Mon, 01 Jan 0001 00:00:00 +0000

Note

Note that in CAST AIP ≥ 8.3.12, the Server Security tab has been removed, as such, it is no longer possible to change the operator and guest user passwords for the associated CAST Storage Service.

Change Operator and Guest passwords (CSS only)

This section provides details about how you can change the passwords for the default Operator and Guest users when working in a CAST Storage Service environment (CSS).

CMS - Clean up Analysis Units

Mon, 01 Jan 0001 00:00:00 +0000

Clean up Analysis Units

This option will remove all inactive Analysis Units and associated projects from the parent Application. You can access the option by:

Selecting the Clean up Analysis Units option from the Current Version tab in the Application editor:
Right clicking the associated Application in the Application editor and selecting Current Version > Clean up Analysis Units option
In the Command Line Interface (CLI).

Which Analysis Units will be removed?

Analysis Units that will be removed by this action are those in which the Analyze Analysis Unit optionhas been unchecked. You can find out more about this option in the Analysis Unit editor:

CMS - Configuring the Background Facts upload file

Mon, 01 Jan 0001 00:00:00 +0000

Configuring the Background Facts upload file

Optionally, you can upload external data that will enrich the content of the CAST Health Dashboard and also the legacy CAST Engineering Dashboard. External data is either a Background Fact, or a Business Value Metric. This can be done BEFORE you generate a snapshot, or AFTER you generate a snapshot.

Background Facts can provide additional information in a single interface that is not based on source code analysis but that can advantageously be cross-referenced with quality and quantity information. You can declare new and update existing Background Facts (e.g., set up the unit in which Effort is uploaded, set up the currency of Cost information). These metrics are numerical values and they are attached to Modules only. To determine the Background Fact value of an Application, the dashboard will display the sum total of all contained Modules.

CMS - Create a new Quality Rule

Mon, 01 Jan 0001 00:00:00 +0000

Create a new Quality Rule

In order to create a new Quality Rule, you need to:

Ensure that you are working in Expert mode (use the drop down option on the toolbar, or change the mode in the Preferences)
Ensure that you have at least one Assessment Model in the Assessment Models view
Double click the appropriate Assessment Model in the Assessment Models view and work in the Assessment Models editor

Principles

Before you begin, take some time to read the following:

CMS - Define a User Defined Module

Mon, 01 Jan 0001 00:00:00 +0000

Define a User Defined Module

User Defined Modules are used extensively in the CAST Engineering Dashboard as a means to configure analysis content into meaningful groups or sets - indeed objects cannot be seen in the CAST Engineering Dashboard if they are not part of a Module (whether Automatic or User Defined). As such the editor provides a means to set up an Object Filter on your analysis results source code (using the Technology, Analysis Units, Object Types and Object Names filter criteria) in order to define the content you require. See Modules tab and User Defined Module editor

CMS - Delete source code from a Version/Delete a Version

Mon, 01 Jan 0001 00:00:00 +0000

Delete source code from a Version/Delete a Version

In the CAST Management Studio, it is possible to delete source code from a Version and delete a Version:

Delete source code from a Version
Delete a version

Delete source code from a version

When you use this option:

only the extracted source code in the Delivery folder is deleted. This frees up disk space - the primary goal of the option.
the Version will be moved to the Delivery without source code section and will be made read only
log and configuration files will remain in the Delivery folder
you can open the Version in the CAST Delivery Manager Tool, but you cannot edit it or re-package source code.

Note if you action this option, you can immediately reverse the decision using the Undo option available on the toolbar. In this situation, the extracted source code will no longer exist in the Delivery folder (see Preferences - Platform Settings) so you will need to package it again - if the source code has subsequently changed, CAST recommends creating a new Version instead.

CMS - Dependencies - refine a target

Mon, 01 Jan 0001 00:00:00 +0000

Dependencies - refine a target

CAST may have, for example, created a default dependency Rule (see Dependencies - Rules tab) between the VB Technology in your Application and the MS SQL Server Technology in your Application. In some situations, this dependency will be too broad, and may give rise to the creation of multiple false links between the Source and Target.

If this is is the case, you can “refine” the Target so that only specific components (for example only SQL Tables) are considered as the Target, rather than the source code in an Analysis Unit or in an entire Technology within an Application.

CMS - Dependencies - using Reference Patterns

Mon, 01 Jan 0001 00:00:00 +0000

Dependencies - using Reference Patterns

The CAST Management Studio includes a built in feature called Reference Patterns - their usage is explained in more detail in Reference Pattern tab (part of the Technology editors). This page explains how to create a new Reference Pattern and how to test and use it.

Add a new Reference Pattern

You must be working in Expert mode
Open the required Technology editor - choose the Technology type that will form the Source Technology (see Dependencies - Rules tab for more information)
Select the Reference Pattern tab
Click the button to add a new Reference Pattern - the Reference Pattern dialog box will then be displayed - in the example below, we have chosen Visual Basic as the Technology type:

CMS - Discover

Mon, 01 Jan 0001 00:00:00 +0000

Discover

The Discover option can be used:

immediately after having added a database server
or when additional services have been installed to an existing database server via CAST Server Manager

The Discover option will connect to the associated database server (using the credentials configured either by CAST Server Manager during a combined installation or in the Database server editor in the case of a newly added database server) and check the services that have been installed on it (i.e. CAST Analysis and Dashboard Services):

CMS - Drop Analysis Results

Mon, 01 Jan 0001 00:00:00 +0000

Drop Analysis Results

The Drop Analysis Results option enables you to clean up your Analysis Service of any analysis results associated with the current Application.

Using the option

Open the Application whose Analysis Results you want to remove
Select the Execute tab
Click the Drop Analysis Results option:

A warning dialog will be displayed:

Click OK to proceed with the drop action.
All objects related to analyses in the current Application will then be removed from the parent Analysis Service.

Notes - The action functions on an Application basis, therefore only objects related to the Application from which the option was launched will be removed from the Analysis Service.

CMS - Dynamic Link Manager filter rules

Mon, 01 Jan 0001 00:00:00 +0000

Dynamic Link Manager filter rules

CAST provides the Dynamic Link Manager to process unverified links (links that have been identified between objects but their authenticity cannot be absolutely determined by CAST) that have been identified during an analysis and then saved to the Analysis Service.

However, in some circumstances, a large amount of unverified links can be generated during an analysis and often these unverified links systematically occur or have no meaning for the specific technology you are working with. In this case, it can be very time consuming to process the links manually in the Dynamic Link Manager.

CMS - External Link engine parametrization

Mon, 01 Jan 0001 00:00:00 +0000

External Link engine parametrization

CMS - Filter rules - Bookmark based

Mon, 01 Jan 0001 00:00:00 +0000

Filter rules - Bookmark based

As described in Dynamic Link Manager filter rules, filters can refer to the source code from where the link is going (i.e. the bookmark) using a Regular Expression string:

- the text before the link, from the first column of the same line
- the text after the link, to the last column of the same line
- the whole text, including the left part and the right part

This can be explained using the following image:

CMS - Filter rules - Metamodel based

Mon, 01 Jan 0001 00:00:00 +0000

Filter rules - Metamodel based

As described in Dynamic Link Manager filter rules, filters can refer to CAST metamodel types:

You can specify one or multiple names as follows:

Single type: <calleeType names=“MyType1”/>
Single type: <calleeType names=“MyType1|MyType2|MyType3”/>

The type expected here corresponds to the metamodel type name, NOT its description.

CMS - Filter rules - Regular Expression based

Mon, 01 Jan 0001 00:00:00 +0000

Filter rules - Regular Expression based

As described in Dynamic Link Manager filter rules, filters can be Regular Expression based to filter on the Caller/Callee object’s Name of Full Name. Regular Expressions must be in .NET format as described here. You can use the following “cheat sheet” to get you started:


\b	Start at a word boundary.
(\w+)	Match one or more word characters. Together, they form a group that can be referred to as \1.
\s	Match a white-space character.
\1	Match the substring that is equal to the group named \1.
\b	Match a word boundary.
\s*	Look for zero or more occurrences of a white-space character.
[-+]?	Look for zero or one occurrence of either a positive sign or a negative sign.
([0-9]{0,3}(,[0-9]{3})*(.[0-9]+)?)	The outer parentheses around this expression define it as a capturing group or a subexpression. If a match is found, information about this part of the matching string can be retrieved from the second Group object in the GroupCollection object returned by the Match.Groups property. (The first element in the collection represents the entire match.)
[0-9]{0,3}	Look for zero to three occurrences of the decimal digits 0 through 9.
(,[0-9]{3})*	Look for zero or more occurrences of a group separator followed by three decimal digits.
.	Look for a single occurrence of the decimal separator.
[0-9]+	Look for one or more decimal digits.
(.[0-9]+)?	Look for zero or one occurrence of the decimal separator followed by at least one decimal digit.

Escaping special characters

Note that certain special characters used in Regular Expressions may need escaping with a back slash (), for example:

CMS - Generate a Report

Mon, 01 Jan 0001 00:00:00 +0000

Generate a Report

The Generate Report option enables you to create a simple HTML based report about the objects saved in the CAST Dashboard Service following a snapshot generation.

Accessing the option

In the Application editor click the button in the Execute tab.
In the Dashboard Service editor click the button in the Snapshots tab.

Wizard

When accessed, a wizard will be displayed enabling you to chose the HTML report options:


HSQ file	This field defines the .HSQ template file for your report. By default, the CAST Management Studio will select the most appropriate predefined HSQ template, however, you can use the Browse button to select a different template if necessary.
HTML report file	This field defines the HTML file that will be used to save the report. By default, the CAST Management Studio will select a file stored in a sub-folder of your %TEMP% folder. You can use the Browse button to select a different output file if necessary.

Results

When you click the Finish button in the above wizard, the report generation process will begin. The resulting report will then be automatically displayed in your default web browser:

CMS - Generate a Snapshot

Mon, 01 Jan 0001 00:00:00 +0000

Generate a Snapshot

This option enables you to create data that can be exploited in the CAST Dashboard. The action will generate a Snapshot on an Application basis, depending where you launch the action from - i.e. for multiple Applications if launched outside the Application editor and for the current Application if launched from within the Application editor.

Launching

You can launch this option from various locations:

Application editor > click the Execute tab and then select the Take a snapshot of the application option
Applications view > Right click the Application and select Execute > Take a snapshot of the application
Services view > Right click the Dashboard Service and select Snapshots > Take a snapshot for each application
Dashboard Service editor > Use the Take a snapshot for each application option in the Snapshots tab

Notes

CMS - How to enable the XXL Quality Rules using the Table Size Folder

Mon, 01 Jan 0001 00:00:00 +0000

How to enable the XXL Quality Rules using the Table Size Folder

XXL table Quality Rules are performance related Quality Rules that help detect incorrect or poorly performing SQL queries running on XXL tables.

XXL tables can be defined as extremely large tables, containing a large amount of data. The threshold that determines when a table is considered to contain a large amount of data can be configured by the user using the Assessment Models editor (Contextual Parameters tab)- the default is 100,000.

CMS - Import an Application Backup

Mon, 01 Jan 0001 00:00:00 +0000

Import an Application Backup

This option should only be used if you need to test an Application on other Management Service (i.e. a different CAST Management Studio environment).

If you have used the Backup an Application action, you may need to import the backup into the CAST Management Studio:

To do so:

In the Applications view, right click white space and select Import an Application backup
A Windows Open dialog box will be displayed enabling you to choose the .CastAppbck archive file that will contain the backup
The import will then proceed.

Note the following:

CMS - Manage an Application

Mon, 01 Jan 0001 00:00:00 +0000

Manage an Application

When you first launch the CAST Management Studio (assuming you have not migrated from a previous CAST AIP release), no Applications will be visible in the Applications view. Before you can do anything in the CAST Management Studio (analyze source code, generate snapshots etc.), you must first import an Application from the Delivery folder that has been created by the Application owner (in the CAST AIC Portal) and populated with a Version (including source code packages).

CMS - Manage Snapshots

Mon, 01 Jan 0001 00:00:00 +0000

Manage Snapshots

This option will simply launch the CAST ADG Admin end-user application with the focus on the Snapshot Definition dialog box, enabling you to manage existing snapshots if required. There is no need to enter a username/password combination, this is entered automatically and transparently for you.

You can launch this option from the Dashboard Service editor using the Manage Snapshots option:

The Snapshot Definition dialog box will then be displayed:

CMS - Manage the License Key

Mon, 01 Jan 0001 00:00:00 +0000

Manage the License Key

Background

CAST products function on a global license key basis and before you can use any of the end-user applications (such as CAST Enlighten or CAST Report Center) this key must be entered and registered in the CAST Analysis Service and Dashboard Service. This can all be done via the CAST Management Studio interface - see Launching the CAST Management Studio.

Registering a new License Key

To register a new License Key should your current key have expired:

CMS - Managing analysis order

Mon, 01 Jan 0001 00:00:00 +0000

Managing analysis order

The order in which Analysis Units (within a single Version) are analyzed is determined automatically by the CAST Management Studio according to the Dependency Rules that exist between items in the Application (e.g.: Technologies and Analysis Units).

See Dependencies tab for more information about Dependency Rules.

CMS - Objects that are shared in the Analysis Service

Mon, 01 Jan 0001 00:00:00 +0000

Objects that are shared in the Analysis Service

In some cases, two or more Analysis Units may share objects and components in the Analysis Service that belong to the same analyzed project, or two or more analyzed projects may share components or objects in the Analysis Service

Some technologies support sharing, others do not. This page lists various technologies and provides an explanation of how they handle object sharing in the Analysis Service.

CMS - Regular Expressions

Mon, 01 Jan 0001 00:00:00 +0000

Regular Expressions

This section provides an overview of how to create Regular Expressions for use with some CAST features that allow their use - for example the Text Replacement feature for .NET and J2EE. CAST currently uses the Boost (Perl) based Regular Expression “engine”.

The text below is an edited version of the Regex++ Library’s regular expression syntax documentation. The original text can be found at http://www.boost.org/doc/libs/1_41_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html.

Perl Regular Expression Syntax

In Perl regular expressions, all characters match themselves, except for the following special characters: . , [, {, }, (, ) , , *, +, ? , |, ^, $ .

CMS - Remove

Mon, 01 Jan 0001 00:00:00 +0000

Remove

Use this option to delete an item.

Please note that you may be prompted about any items that are associated to the item you want to delete. Make sure that you are aware that deleting a parent item will also delete the child item.

CMS - Reviewing Dynamic Links

Mon, 01 Jan 0001 00:00:00 +0000

Reviewing Dynamic Links

The CAST Management Studio has a feature (the Dynamic Link Manager) that enables you to review “dynamic links” between objects following an analysis (as part of a Snapshot or as a standalone analysis). Dynamic links are links that have been identified between objects (usually based on search strings - see Dependencies - Rules tab) and saved to the Analysis Service but their authenticity cannot be absolutely determined by CAST.

Using the Dynamic Link Manager you can consult the code that constitutes the link between the objects and you can then choose to either:

CMS - Run analysis only

Mon, 01 Jan 0001 00:00:00 +0000

Run analysis only

The Run analysis only option enables you to start the process of source code analysis of all Analysis Units in the Application without having to generate a Snapshot. This can be useful if you are simply exploiting the results in CAST Enlighten (for example).

You can launch this option from various locations:

Applications view > Right click the Application and select Execute > Analysis > Run analysis only

CMS - Sample Background Facts file

Mon, 01 Jan 0001 00:00:00 +0000

<DSS_IN_OBJECTS>
<OBJECT_NAME>Research and Dev</OBJECT_NAME>
<OBJECT_TYPE_ID>20100</OBJECT_TYPE_ID>
<OBJECT_ID>1</OBJECT_ID>
<OBJECT_DESCRIPTION>Main dev team</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>Research and Dev</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>

<DSS_IN_OBJECTS>
<OBJECT_NAME>Paris</OBJECT_NAME>
<OBJECT_TYPE_ID>20101</OBJECT_TYPE_ID>
<OBJECT_ID>2</OBJECT_ID>
<OBJECT_DESCRIPTION>Paris team</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>Paris</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>
<DSS_IN_OBJECTS>
<OBJECT_NAME>London</OBJECT_NAME>
<OBJECT_TYPE_ID>20101</OBJECT_TYPE_ID>
<OBJECT_ID>3</OBJECT_ID>
<OBJECT_DESCRIPTION>London team</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>London</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>

<DSS_IN_OBJECTS>
<OBJECT_NAME>John</OBJECT_NAME>
<OBJECT_TYPE_ID>20102</OBJECT_TYPE_ID>
<OBJECT_ID>4</OBJECT_ID>
<OBJECT_DESCRIPTION>John Smith</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>John Smith</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>
<DSS_IN_OBJECTS>
<OBJECT_NAME>David</OBJECT_NAME>
<OBJECT_TYPE_ID>20102</OBJECT_TYPE_ID>
<OBJECT_ID>5</OBJECT_ID>
<OBJECT_DESCRIPTION>David White</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>David White</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>
<DSS_IN_OBJECTS>
<OBJECT_NAME>Mark</OBJECT_NAME>
<OBJECT_TYPE_ID>20102</OBJECT_TYPE_ID>
<OBJECT_ID>6</OBJECT_ID>
<OBJECT_DESCRIPTION>Mark Davies</OBJECT_DESCRIPTION>
<OBJECT_FULL_NAME>Mark Davies</OBJECT_FULL_NAME>
</DSS_IN_OBJECTS>

<DSS_IN_OBJECTS>
    <OBJECT_NAME>Demo-Java Analyzer</OBJECT_NAME>
    <OBJECT_TYPE_ID>20000</OBJECT_TYPE_ID>
    <OBJECT_ID>10</OBJECT_ID>
</DSS_IN_OBJECTS>
<DSS_IN_OBJECTS>
    <OBJECT_NAME>Demo-C++ Analyzer</OBJECT_NAME>
    <OBJECT_TYPE_ID>20000</OBJECT_TYPE_ID>
    <OBJECT_ID>11</OBJECT_ID>
</DSS_IN_OBJECTS>
<DSS_IN_OBJECTS>
    <OBJECT_NAME>CWMM-T-SQL Analyzer</OBJECT_NAME>
    <OBJECT_TYPE_ID>20000</OBJECT_TYPE_ID>
    <OBJECT_ID>12</OBJECT_ID>
</DSS_IN_OBJECTS>

CMS - Sample SAP SQLTABLESIZE file

Mon, 01 Jan 0001 00:00:00 +0000

CMS - Save All

Mon, 01 Jan 0001 00:00:00 +0000

Save All

The Save All option is used to update the CAST Management Studio database (the Management Service) following changes made in the CAST Management Studio.

If you create (for example) a new Architecture Model, but do not use the Save All option prior to closing the CAST Management Studio, when you next launch the CAST Management Studio, the newly created item will no longer exist.

Please consider this option as a way to record the current state of the Graphical User Interface.

CMS - Stop Managing an Application

Mon, 01 Jan 0001 00:00:00 +0000

Stop Managing an Application

This option enables you to “remove” an Application from the CAST Management Studio, in other words if you no longer want to manage it. When you stop managing an Application you can choose whether you want to also:

remove any associated snapshots from the Dashboard Service or Measurement Service
remove all analysis result data from the Analysis Service
remove any deployed source code stored in the Source Code Deployment Folder

Remember that when you stop managing an Application it and its configuration settings will NOT be removed from the Source Code Delivery Folder, as such you can use the Manage an Application action to start working with the Application once again.

CMS - Synchronize

Mon, 01 Jan 0001 00:00:00 +0000

Synchronize

The Synchronize option is used to manually update the Analysis Service and/or the Dashboard Service following changes made in the CAST Management Studio. For example, you may have managed an Application and are now ready to run your analysis. Before you do so, you can use the synchronize option so that the associated services are updated with your new content.

You can invoke the Synchronize option from various locations:

Services view

In the Services view right click the Analysis or Dashboard Service you want to update and select Synchronize

Analysis Service editor/Dashboard Service editor

In the Analysis Service editor or the Dashboard Service editor, select the Synchronize option as shown below:

CMS - Test connection

Mon, 01 Jan 0001 00:00:00 +0000

Test connection

If you want to test the connection from the CAST Management Studio to your the database server hosting your Management/Analysis/Dashboard Services (in case of connection issues, or when you have added a database server) then you can do so from the Services view or from the Database server editor:

Services view

Right click the database server you want to test
Select Connection > Test Connection from the shortcut menu

Database Server editor

Click the Test Connection option:

CMS - Upload Source Code for viewing in CAST Dashboard

Mon, 01 Jan 0001 00:00:00 +0000

Upload Source Code for viewing in CAST Dashboard

This option forces the CAST Management Studio to make source code for analyzed projects available for viewing in the CAST Engineering Dashboard.

Once the option has been executed, the source code will be visible in the CAST Engineering Dashboard. The purpose is to make sure that each dashboard will display the most up-to-date information about the source code as possible.

You can access the option from various locations:

CMS - Using the Command Line Interface (CLI)

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: This section of documentation provides an explanation of how to run analyses, generate snapshots and run other CAST Management Studio tasks in an automated and repeatable way.

Prerequisites

Before you can starting using the CAST Management Studio CLI, you must ensure that you meet the following requirements:


✅	An installation of CAST AIP is required - either a Full Installation or a All Application Intelligence Platform Applications installation which must be located on the machine you wish to run the CLI from.

How does it work?

The CAST Management Studio CLI includes multiple command arguments to perform various different actions including:

CMS - Using the Dynamic Link Manager to review links

Mon, 01 Jan 0001 00:00:00 +0000

Using the Dynamic Link Manager to review links

The main purpose of the Dynamic Link Manager is for manually reviewing the status of links whose authenticity cannot be absolutely determined by CAST. This can be achieved using the GUI (see Reviewing Dynamic Links for more information about accessing the Dynamic Link Manager).

Links can be in three states:

To be reviewed: links are in this state when you open the Dynamic Link Manager after the completion of an analysis.
Ignored: links are in this state when you have ticked them after examination (and it proves to be incorrect or false). By default Ignored links are not displayed in the GUI - toggle the Hide Reviewed Links button to view them.
Validated: links are in this state when you have marked them as Validated after examination (and it proves to be correct). By default Validated links are not displayed in the GUI - toggle the Hide Reviewed Links button to view them.

Note that you can close the Dynamic Links Manager in the middle of a review session and changes will persist.

CMS - Using the globallysharedsettings.ini file

Mon, 01 Jan 0001 00:00:00 +0000

Using the globallysharedsettings.ini file

This page describes how to add various parameters to the GloballySharedSettings.ini file (located in the following locations after installing CAST Products):

Windows XP/2003 > %ALLUSERSPROFILE%\Application Data\CAST\CAST<Version_Number>
Windows Vista/7/2008 > %ALLUSERSPROFILE%\CAST\CAST<Version_Number>

These parameters add supplementary features to the CAST Management Studio and especially useful if you are using the Command Line Interface (CLI):

General
ASP
C++
J2EE EJB
J2EE
.NET

General - Activating / deactivating the Inference Engine

Certain analyzers provide an Inference Engine to compute run time type information in order to simulate program behaviour during execution of the analyzer and thus identify additional links that would not otherwise be “discovered” using standard analysis techniques. This technology detects a reference to an object wherever its name is mentioned, regardless of the context in which this reference occurs.

CMS - Using the Import/Export feature

Mon, 01 Jan 0001 00:00:00 +0000

Using the Import/Export feature

This feature enables you to import/export all user created items or a set of items to/from file. The goal is to allow the exchange of CAST Management Studio configuration information between, for example, a staging and production environment.

Note that you can also use the Command Line Interface to Import and Export.
The Import/Export option does not include Applications - please see Backup an Application and Import an Application Backup for more information.

CMS - Verify

Mon, 01 Jan 0001 00:00:00 +0000

Verify

This option will carry out a verification check on all or individual components (depending where the option is launched from). This means that the CAST Management Studio will check that all dependent items are present - for instance a User Defined Module should have one Object Filter.

In addition the validation check will also take into account the external context - for instance, for components that rely on files, a check will be made to ensure that the files exist and are valid (e.g.: Layers and Definition Rules files in the Architecture Model editor).

CMS - View analysis log

Mon, 01 Jan 0001 00:00:00 +0000

View analysis log

On completion of an analysis or a snapshot generation, a log window will be displayed. To review the Analysis Log, navigate to each analysis execution item and then click it. A link to a .castlog file will be highlighted as shown below:

Clicking the link to the .castlog file will display the log in the Log Viewer. Messages are displayed in the Log Viewer in a single row with various pieces of information in a variety of columns:

CMS - Working with Execution Units

Mon, 01 Jan 0001 00:00:00 +0000

Working with Execution Units

Execution Units are an expert level feature of the CAST Management Studio that represent how auto-generated Analysis Units (i.e source code and configuration details) are analyzed. Depending on a variety of factors, multiple Analysis Units may be grouped together into one Execution Unit, or one Execution Unit may be created for each Analysis Unit.

Their objectives are as follows:

to improve analysis performance - i.e. by grouping multiple Analysis Units together in one “analysis execution,” analysis time can be improved
to reduce the risk of an analysis crashing - an Execution Unit has an upper limit on the amount of source code that can be analyzed in one “analysis execution” (this differs per Technology) and this limit is designed to prevent an analysis crashing due to an out of memory error
to ensure links between Analysis Units are not missed, particularly links determined by the CAST Inference Engine (see individual Technology editors for more information about the Inference Engine).

How do they work?

The contents of an Execution Unit (i.e. which Analysis Units are grouped together) are determined automatically by the CAST Management Studio using internal algorithms specific to each technology type and information (source code size, dependencies between projects) identified during the source code “discovery” process in the CAST Delivery Manager Tool. For the most part, you should let the CAST Management Studio manage Execution Units - however, it is possible to configure them yourself if you find that the automatic management strategy provided by the CAST Management Studio is not providing an optimum result. This is done by:

CMS - CAST Management Studio - How To on Documentation - V2

CMS - Add a version

Add a Version

CMS - Add database server

Add database server

CMS - Assign Applications to Systems

Assign Applications to Systems

CMS - Backup an Application

Backup an Application

What is backed up?

CMS - CAST Management Studio logging

CAST Management Studio logging

CMS - Change Operator and Guest passwords (CSS only)

Change Operator and Guest passwords (CSS only)

CMS - Clean up Analysis Units

Clean up Analysis Units

Which Analysis Units will be removed?

CMS - Configuring the Background Facts upload file

Configuring the Background Facts upload file

CMS - Create a new Quality Rule

Create a new Quality Rule

Principles

CMS - Define a User Defined Module

Define a User Defined Module

CMS - Delete source code from a Version/Delete a Version

Delete source code from a Version/Delete a Version

Delete source code from a version

CMS - Dependencies - refine a target

Dependencies - refine a target

CMS - Dependencies - using Reference Patterns

Dependencies - using Reference Patterns

Add a new Reference Pattern

CMS - Discover

Discover

CMS - Drop Analysis Results

Drop Analysis Results

Using the option

CMS - Dynamic Link Manager filter rules

Dynamic Link Manager filter rules

CMS - External Link engine parametrization

External Link engine parametrization

CMS - Filter rules - Bookmark based

Filter rules - Bookmark based

CMS - Filter rules - Metamodel based

Filter rules - Metamodel based

See Also

CMS - Filter rules - Regular Expression based

Filter rules - Regular Expression based

Escaping special characters

CMS - Generate a Report

Generate a Report

Accessing the option

Wizard

Results

CMS - Generate a Snapshot

Generate a Snapshot

Launching

CMS - How to enable the XXL Quality Rules using the Table Size Folder

How to enable the XXL Quality Rules using the Table Size Folder

CMS - Import an Application Backup

Import an Application Backup

CMS - Manage an Application

Manage an Application

CMS - Manage Snapshots

Manage Snapshots

CMS - Manage the License Key

Manage the License Key

Background

Registering a new License Key

CMS - Managing analysis order

Managing analysis order

CMS - Objects that are shared in the Analysis Service

Objects that are shared in the Analysis Service

CMS - Regular Expressions

Regular Expressions

Perl Regular Expression Syntax

CMS - Remove

Remove

See Also

CMS - Reviewing Dynamic Links