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

Summary: This glossary defines terminology used within CAST AIP. Note that it does not include terms which are associated with external concepts, or terms generally used globally. Such information should be obtained from related external documentation help system.

A

AEP (Automated Enhancement Points)

AEP is used by default in CAST AIP 8.2.x and above to estimate the size of an application revision.

AFP (Automated Function Points)

Automated Function Points (AFP) is an automatic function points counting solution based on the rules defined by the International Function Point User Group (IFPUG) and the Consortium for IT Software Quality (CISQ). CAST automates the manual counting process by using the structural information retrieved by source code analysis, database structure and transactions.

(CAST) AIP

AIP (Application Intelligence Platform) is an enterprise-grade software measurement and quality analysis solution designed to analyze multi-tiered, multi-technology applications for technical vulnerabilities and adherence to architectural and coding standards and then provide business relevant information to the IT organization through various dashboards and products built with end users in mind.

(CAST) AIC Portal

The CAST AIC Portal is a web application provided as part of CAST AIP and is designed to support the delivery of the application source code by Delivery Manager(s) - when accessed, the CAST AIC Portal will offer the ability to register a new application for analysis as well as the ability to deliver the source code using the CAST Delivery Manager Tool (DMT).

Analysis Unit

A set of source code files to analyze. For Java, this can be an Eclipse Project, or a directory containing Web Server resources (JSP files).

Analysis Service database

An Analysis Service database stores all analysis results: components, diagnosis findings and violations. Assessment results for all Technical Modules are also stored in an Analysis Service:

Alternative legacy/deprecated names: Local, Local Site, Knowledge Base

Application

A union of Analysis Units that defines the scope of source code for analysis.

(CAST) Application Analytics Dashboard

The CAST Application Analytics Dashboard is a web application provided as part of CAST AIP. Its primary usage is for high level investigation of aggregated data stored in the CAST Measurement Service generated during the analysis/snapshot generation process.

Alternative names: AAD

(CAST) Application Engineering Dashboard

The CAST Application Engineering Dashboard is a web application provided as part of CAST AIP. Its primary usage is for low level, detailed investigation of data stored in the CAST Dashboard Service generated during the analysis/snapshot generation process.

Alternative names: AED

(CAST) Architecture Checker

CAST Architecture Checker is a client/server application installed as part of CAST AIP. Its primary usage is to:

  • Create an Architecture Model that reflects a business application or set of applications via the use of Layers and Dependencies between those Layers
  • Define the contents of Layers in terms of objects resulting from a CAST AIP analysis

Once the Architecture Model is defined, it can then be used in the CAST Management Studio. When the application or set of applications is then analyzed in the CAST Management Studio and a Snapshot is subsequently generated, the Architecture Model will be taken into account.

Artifact

An artifact is a component and is used in the context of CAST AIP metrics to indicate the low-level programming elements used to measure application size and complexity.

Assessment Model

A specification of metrics, quality rules, calculation rules and quality criteria to assess source code quality and risks.

Back to top

B

Background Fact

A Background Fact is external data that will enrich the content of the CAST Application Analytics Dashboard and also the legacy CAST Engineering Dashboard. Background Facts can therefore provide additional information in a single interface that is not based on source code analysis but that can be advantageously cross-referenced with quality and quantity information. These metrics are numerical values and they are attached to Modules only. To determine the Background Fact value of an Application, the dashboards will display the sum total of all contained Modules.

Bookmark

A Diagnosis Finding that locates text in a component.

Business Criteria

Business Criteria are strategic quality indicators, either business oriented, or development oriented. They rely on the measurement of compliance with a set of Technical Criteria that assess the impact on the application development business – as Health Factors – or the compliance to development practices – as Rule Compliance. Their grade is based upon the weights of contributing Technical Criteria grades.

Back to top

C

Central or Central Site

See Dashboard Service database.

Compliance Ratio

For a Quality Rule, this is a ratio of Successful Checks (= Total Checks minus Failed Checks) and Total Checks. A Compliance Ratio is transformed into a Grade/Score with 4 thresholds (each pair of thresholds define a linear function).

Component

A code fragment or a schema fragment. Fragments are specific to a programming language or a schema language, and specific to analyzers.

Alternative name: Object

Critical Violation

See Violation.

Back to top

D

Dashboard Service database

The role of the Dashboard Service database is to store:

  • Analysis results (components, violations, diagnosis findings) for each Snapshot
  • Assessment results for each Snapshot
  • Assessment Model for each Snapshot
  • Assessment results at the level of Functional Module and Application
  • The majority of Sizing Results
Alternative legacy/deprecated names: Central or Central Site

Defective Component

A defective component is a Component in violation with a Quality Rule.

(CAST) Delivery Manager Tool

The CAST Delivery Manager Tool is . The CAST Delivery Manager Tool is a standalone application aimed at the person or people responsible for providing source code for analysis (i.e. the Delivery Managers) that entirely manages the discovery, selection, extraction and delivery of source code ready for analysis in the CAST Management Studio.

Alternative names: DMT

Delivery Unit

An organization, such as a contractor or a department, in charge of the delivery of applications. A delivery unit defines the scope of applications for analysis.

Diagnosis Finding

Diagnosis Findings pinpoint statements or properties of the defective component violating a Quality Rule pattern. A Diagnosis Findings can be a Bookmark or a counter. Do not confuse with a Violation.

Diagnosis Procedure

An SQL procedure producing Diagnosis Findings.

Diagnosis Value

A diagnosis value is a specific Diagnosis Finding reported as a value: a counter or a name to reference a source code;

Alternative name: Associated Value

(CAST) Discovery Portal

The CAST Engineering Dashboard is a web application provided as part of CAST AIP (bundled in the same .WAR file as the CAST Engineering Dashboard). Its primary usage is to provide a variety of technical "DNA type" information about a company's applications.

Back to top

E

(CAST) Engineering Dashboard

The CAST Engineering Dashboard is a web application provided as part of CAST AIP (bundled in the same .WAR file as the CAST Discovery Portal). Its primary usage is for low level, detailed investigation of data stored in the CAST Dashboard Service generated during the analysis/snapshot generation process.

EFP (Enhancement Function Points)

EFP is used by default in CAST AIP 8.1.x and all previous releases to estimate the size of an application revision.

(CAST) Enlighten

CAST Enlighten is a client/server application installed as part of CAST AIP. Its primary usage is to display (graphically) the objects that have been identified during a source code analysis and to display the links that these objects have to other objects in the Application.

Extension

It is possible to "extend" CAST AIP with an extension to provide additional analysis and measurement capabilities both for technologies that are not supported "out-of-the-box" and for technologies supported in CAST AIP. Additionally, extensions can simply be any add-on (for example a custom Assessment Model) that has been built by a third-party.

External objects

An external object is created by the CAST analyzer during an analysis (as is the case for standard "objects" resulting from an analysis), however, they are associated to the analyzed project source code in an external way. For example, an external object could be an object that is part of a library and which is called by the analyzed source code, but is not analyzed itself. Often, external objects do not have source code stored in the CAST schemas, the objects are instead simply recorded as existing. An external object often appears as greyed out in the CAST Enlighten Object Browser.

Back to top

F

Failed Checks

Number of defective components for a Quality Rule.

≤ CAST AIP 8.1.x

  • For an Application, this number is the sum of Failed Checks of all Functional Modules defined in the Application, regardless of whether a component belongs to multiple Functional Modules. In the case of overlapping of Functional Modules, this number is therefore an approximation.
  • For a Functional Module, and non-overlapping Analysis Units, this value is the number of defective components

≤ CAST AIP 8.2.x

  • For an Application, Functional Module, and non-overlapping Analysis Units, this value is the number of defective components.

Functional Module

Functional Modules are used in CAST AIP to define a logical break down of Application source code into smaller units. Examples are a user defined module or an automatic module such as a "full content module" or a module generated for an Analysis Unit.

Back to top

G

Generated code

Many technologies supported by CAST AIP for analysis include the ability to produce "auto generated code" from templates or other sources. When this auto generated source code is analyzed by CAST AIP, the following is true:

  • Auto generated code is analyzed to help understand the entire code being analyzed
  • Objects are created from the code and saved in the CAST Analysis Service database (to help trace transactions for example) and these objects are marked as being "generated"
  • Any Quality Rule violations that are caused by these "auto generated" objects are not displayed in the CAST dashboards and they do not contribute to grade calculations
  • "Generated" objects are excluded from any aggregated metrics (for example Lines of Code (LOC))

The method used by CAST AIP to determine whether source code is "auto generated" is specific to each technology.

Back to top

H

Health Factor

Health Factors are business-oriented strategic quality indicators. They rely on the measure of compliance with a set of Technical Criteria that assess the impact on the application development business.

Back to top

K

Knowledge Base

See Analysis Service database.

Back to top

L

LISA (Large Intermediate Storage Area)

A location (i.e. a folder) on your local hard drive that is designated for use by the CAST Management Studio to store miscellaneous files generated during the analysis process.

  • These files will still exist once the analysis is complete.
  • This location is used more particularly in the J2EE and .NET technologies to store data generated when the User Input Data Flow Security Analysis feature is activated.
  • The location must be capable of receiving a large amount of data (several hundred MB).
  • This folder is similar in nature to the Internet Explorer cache.

LTSA (Large Temporary Storage Area)

A location (i.e. a folder) on your local hard drive that is designated for use by the CAST Management Studio to store temporary files generated during the analysis process.

  • These files will be removed once the analysis is complete.
  • This folder is similar in nature to the Windows %TEMP% folder.

Local or Local Site

See Analysis Service database.

Back to top

M

Maintainability Index

Determines the cost and difficulty/ease to maintain an application in the future. Increased maintainability index makes applications cheaper to maintain with more predictable results.

Management Service database

A Management Service database stores configuration options for the CAST Management Studio are related resources.

Alternative legacy/deprecated names: Management, MNGT

Measurement Service database

A Measurement Service database stores consolidated results from one or multiple Dashboard Service databases for use with the CAST Application Analytics Dashboard.

Alternative legacy/deprecated names: Measurement base

(CAST) Management Studio

The CAST Management Studio is a client/server application installed as part of CAST AIP. It is used to manage the entire Application analysis and snapshot generation process.

Metric

Metric (or Diagnostic), analyzed the code name given to the criteria. Metrics will be defined as the basic rules of the code in the analysis of the CAST.

Module

Modules are executable software components or tightly coupled sets of executable software components (one or more), developed and deployed together, that deliver some of the steps needed by an Application to operate. The modules that together make up application code units. CAST scores can be seen as a result of the second unit of analysis within the application.  

Back to top

P

Propagated Risk Index (PRI)

Propagated Risk Index (PRI) is a measurement of the riskiest artifacts or objects of the application along the Health Factors of Robustness, Performance and Security. PRI takes into account the intrinsic risk of the component coupled with the level of use of the given object in the transaction. It systematically helps aggregate risk of the application in a relative manner allowing for identification, prioritization, and ultimately re-mediation of the riskiest objects.*

Back to top

Q

Quality Distribution

A Quality Distribution is an operational quality indicator, designed to assess a component based on the balance of the distribution of an attribute value among objects of the component. They rely on the distribution of tested objects according to one of their properties (e.g.: size) into four categories.

Quality Measure

A Quality Measure is an operational quality indicators, designed to assess a component based on a single measure value.

Quality Rule

A Quality Rules is an operational quality indicator, designed to assess a component based on the compliance to a coding or architecture practice. A Quality Rule is defined for a single (not unified) technology or a set of technologies (unified) and produces a grade between 1.0 (very high risk) and 4.0 (low risk) for an Application or a Functional Module.

Back to top

R

Result

An assessment result of an Application or a Functional Module.

Result Detail

Additional values, indicators, related to a Result:

  • intermediate calculation results
  • breakdown of a measure
  • related quantitative values

Back to top

S

Security Health Factor

Determines the risk of security breaches for an application. Increased security ratings decrease the risk of security threats against the application.

(CAST) Server Manager

CAST Server Manager is a traditional client/server application installed as part of CAST AIP. It is used to install CAST AIP schemas and CAST AIP extensions.

Sizing Measure

A quantitative measure.

Snapshot

A CAST Snapshot is a capture at one moment in time of the status of a set of executable software components (one or more). The scope of a Snapshot depends on the nature of the information that is captured.

Source Code Delivery Folder

Location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Source Code Deployment Folder

Location of the most recent version of the applications' source code for analysis in uncompressed format.

(CAST) Storage Service

The CAST Storage Service is a RDBMS provided as part of CAST AIP and can be used to host the CAST AIP schemas. The CAST Storage Service is a repackaged PostgreSQL RDBMS.

Alternative names: CSS

Back to top

T

Technical Criteria

Technical Criteria are operational quality indicators, designed to assess a technical area. They rely on the measurement of compliance with a set of Quality Rules, Distributions, and Measures that assess a technical domain or area. Their grade is based upon contributing Quality Rules, Quality Distributions and Quality Measures grades.

Technical Debt

Also known as Design Debt is the accumulated amount/cost of rework that will be necessary to correct and/or recover from the deviation between the current design of the system, versus that which is minimally complex yet sufficiently complete to ensure correctness & consistency for timely delivery. This effort grows more than linearly over time as a system becomes bigger and more complex.

Total Checks

Number of components that have been checked for a specific Quality Rule.

Total Quality Index (TQI)

TQI is a Business Criteria Health Factor that aggregates measures from multiple Technical Criteria.

(CAST) Transacation Configuration Center

The CAST Transaction Configuration Center is a client/server application installed as part of CAST AIP. Its primary usage is for calibrating the initial Function Point count made by CAST AIP during an analysis. Calibration includes removing technical and temporary objects from the list of Function Points counted, aggregating and splitting several function points into one and changing the type of the Data or Transactional Functions.

Alternative names: TCC

Transaction Risk Index (TRI) 

TRI is an indicator of the riskiest transactions of the application. The TRI number reflects the cumulative risk of the transaction based on the risk in the individual  objects contributing to the transaction. The TRI is calculated as a function of the rules violated, their weight/criticality, and the frequency of the violation across all objects in the path of the transaction. TRI is a powerful metric to identify, prioritize and ultimately remediate riskiest transactions and their objects.

Back to top

U

Unify

Quality Rule unifying a set of alternative Quality Rules; each alternative Quality Rule is defined for a single technology. For example "7166 - Avoid Artifacts with High Cyclomatic Complexity" gathers all violations of quality rules (666,1118,1652,2296,2646,3138,3654,4148,4780,5134,5580,6186,6618,7112). Note that these rules (flagged with unify=false) are always disabled.

Back to top

V

Violation

A violation identifies a defective component breaking a Quality Rule pattern.

IMPORTANT: For a given component and a given Quality Rule pattern there is 0 or 1 violations. If a component breaks a rule N times, then each occurrence is detailed into the Diagnosis Findings structure with a value counter equal to N, and/or with N values, and/or with N code bookmarks.

Critical Violations, i.e., violations to critical Quality Rules, identify each single occurrence of situations that can jeopardize the application regarding their Robustness, Performance, Security, Transferability, or Changeability. The consequences are so dire that:

  • Each single occurrence are accounted for and made highly visible via specific indicators within CAST dashboards and portals;
  • Poor results for a critical quality rule can not be traded against good results regarding for other quality rules, no matter how many and how good these latter are.

CAST AIP delivers pre-configured sets of critical violations, but these can be adapted to each organization’s context.

Violation Index

Violation Index (VI) assesses the overall quality of an object regarding a health concern (Robustness, Security,…), by a weighted aggregation on the violation it carries.

Violation Pattern

The Violation Pattern is the pattern that is searched for in the Analysis Service content (source code, cartography, etc.) to pinpoint Violations. The Violation Pattern should be described in the description field of the Quality Rule.

Back to top

 

  • No labels