- The Constraint column shows whether the component will retrieve data for an "engineering" (AED) or "analytics" domain (AAD), and whether an extension needs to be installed in order to generate results (and if we need a specific version or RestAPI). The CAST-RestAPI version indicated is the minimal version of the RESTAPI needed by this component.
- Due to backward compatibility, some components can have two different IDs, but the result will be the same.
- The Mode column shows whether the component is targeted at an Application or a Portfolio or an Application - the relevant option should be chosen in Report Generator (see image below). CAST recommends always selecting an Application when the target domain is "engineering" and when using Application mode, as it will avoid empty results (this is because in an "analytics" domain, violations and components does not exist for an application).
| Component Id | Description | Mode | Constraints | Parameters | Configuration sample | Output | Result sample |
|---|---|---|---|---|---|---|---|
| APPLICATION_SCHEMA | Gives the name of the schema containing the application. | Application | CAST-RestAPI 1.8.0 | None | TEXT;APPLICATION_SCHEMA | Name of the schema containing the application |
|
DASHBOARD_SERVICE_URL or MEASUREMENT_ADG_WEBSITE | Gives the url of the application associated site in the analytics service. | Application | Information only available in an analytics service. CAST-RestAPI 1.8.0 | None | TEXT;DASHBOARD_SERVICE_URL | Url of the site associated to the application in analytics service. n/a if no associated site |
|
| METRIC_AFP_DF or DATA_FUNCTIONS | Give the unadjusted data function metric value for the application | Application | CAST-RestAPI 1.8.0 | None | TEXT;METRIC_AFP_DF | Result of metric 10203 for application |
|
| METRIC_AFP_TF | Give the unadjusted transactional function metric value for the application | Application | CAST-RestAPI 1.8.0 | None | TEXT;METRIC_AFP_TF | Result of metric 10204 for application |
|
| APPLICATION_NAME | Give the name of the application | Application | CAST-RestAPI 1.8.0 | None | TEXT;APPLICATION_NAME | Name of the application |
|
| APPLICATION_QUALITY_TYPE | Quality Application Category (thresholds for categories can be adjusted in RG settings) | Application | CAST-RestAPI 1.8.0 | None | TEXT;APPLICATION_QUALITY_TYPE | very low/low/medium/good |
|
APPLICATION_RULE or APPLICATION_METRIC
| Give the value of a specific metric for the application | Application | CAST-RestAPI 1.8.0 |
Either ID, either PARAMS and EXPR for custom expression should be specified. If no module and no technology this is the value for the application that is taken. | TEXT;APPLICATION_METRIC;ID=10151,FORMAT=N0,SNAPSHOT=PREVIOUS => value of number of code lines for the previous snapshot with no decimal TEXT;APPLICATION_METRIC;ID=60017 => current grade of TQI value of number of code lines for module : value of number of very large artifacts for technology : value of sum of number of very large and large artifacts for application : | Value for sizing measure or background fact or category, Grade for Quality measure or complexity distribution |
|
| APPLICATION_SIZE_TYPE | Size application category (thresholds for categories can be adjusted in RG settings) | Application | CAST-RestAPI 1.8.0 | None | TEXT;APPLICATION_SIZE_TYPE | small/medium/large/extre marge |
|
| CAST_VERSION | Version of CAIP used for the application | Application | CAST-RestAPI 1.8.0 | None | TEXT;CAST_VERSION | 3 digit version of central schema |
|
CUSTOM_EXPRESSION | Custom expression You are not limited in the number of parameters to be used in your expression (a, b, c, d…) | Application | Don’t put blank char in the definition of parameters (,a=67011,b=67010,c=…) CAST-RestAPI 1.8.0 |
| TEXT;CUSTOM_EXPRESSION;PARAMS=SZ a SZ b,EXPR=a/b,a=67011,b=10202,FORMAT=N2 Number of High and Very high cyclomatic complexity objects : | Evaluation of the expression calculated with the results of the metrics for the application |
|
| METRIC_EFP_ADDED | Added EFP metric value | Application | Only available if Enhancement Function Points mode is selected. n/a if Automated Enhancement Points mode selected. CAST-RestAPI 1.8.0 | None | TEXT;METRIC_EFP_ADDED | Result of metric 10300 |
|
| METRIC_EFP | Aggregated EFP metric value | Application | Only available if Enhancement Function Points mode is selected. n/a if Automated Enhancement Points mode selected. CAST-RestAPI 1.8.0 | None | TEXT;METRIC_EFP | Sum of results from metrics 10300, 10310 and 10320 (added + deleted + modified function points) |
|
| METRIC_EFP_DELETED | Deleted EFP metric value | Application | Only available if Enhancement Function Points mode is selected. n/a if Automated Enhancement Points mode selected. CAST-RestAPI 1.8.0 | None | TEXT;METRIC_EFP_DELETED | Result of metric 10320 |
|
| METRIC_EFP_MODIFIED | Modified EFP metric value | Application | Only available if Enhancement Function Points mode is selected. n/a if Automated Enhancement Points mode selected. CAST-RestAPI 1.8.0 | None | TEXT;METRIC_EFP_MODIFIED | Result of metric 10310 |
|
METRIC_EVOLUTION | This component display the evolution of a metric, in percentage or in absolute, for the application, or for a module or a technology if specified. | Application | You should have a current and a previous snapshot selected to get a result. CAST-RestAPI 1.8.0 |
New in 1.17.0 :
Either ID, either PARAMS and EXPR for custom expression should be specified. If no module and no technology this is the value for the application that is taken. | Evolution of TQI for the application in percentage : Evolution of Number of code lines in absolute for module MyModule: Evolution of TQI of technology JEE in percentage: Evolution of the number of large size artifacts: Evolution of the sum of number of very large and large size artifacts in percentage: | The evolution of specified metric or custom expression |
|
| RULE_FAILED_CHECKS | Number of failed checks in the application for a specific rule | Application | CAST-RestAPI 1.8.0 |
| TEXT;RULE_FAILED_CHECKS | value for the specified snapshot (current or previous) |
|
| RULE_FAILED_ON_TOTAL_CHECKS | Number of failed checks / Number of total checks in the application for a specific rule | Application | CAST-RestAPI 1.8.0 |
| TEXT;RULE_FAILED_ON_TOTAL_CHECKS | values for the specified snapshot (current or previous) |
|
| LAST_SNAPSHOT_DATE or TO_SNAPSHOT_DATE | Date of current snapshot | Application | CAST-RestAPI 1.8.0 | None | TEXT;LAST_SNAPSHOT_DATE | date in local format (the one that is selected in the RG settings) |
|
| LAST_SNAPSHOT_VERSION | Version of current snapshot | Application | CAST-RestAPI 1.8.0 | None | TEXT;LAST_SNAPSHOT_VERSION | current version name |
|
| PF_CATEGORY_NAME | Category used to filter the list of applications in portfolio | Portfolio | CAST-RestAPI 1.8.0 | None | TEXT;PF_CATEGORY_NAME | category used, All if no category selected |
|
| PF_CRITICAL_VIOLATIONS | Number of Critical Violations in portfolio | Portfolio | CAST-RestAPI 1.8.0 |
| TEXT;PF_CRITICAL_VIOLATIONS | sum of critical violations of selected applications |
|
PF_CUSTOM_EXPRESSION | Custom expression You can have as number of parameters as you want (theorical limit is 16383…). | Portfolio | Don’t put blank char in the definition of parameters (,a=67011,b=67010,c=…) CAST-RestAPI 1.8.0 |
The format of return value is explained here : https://msdn.microsoft.com/en-us/library/dwhawy9k.aspx, with examples for double here : https://msdn.microsoft.com/en-us/library/kfsatb94.aspx ), only N format is interesting here : N: -195,489,100.84 N0: -195,489,101 N1: -195,489,100.8 N2: -195,489,100.84 | TEXT;PF_CUSTOM_EXPRESSION;PARAMS=SZ a SZ b,EXPR=a/b,a=67010,b=67011,FORMAT=N2,AGGREGATOR=SUM | sum or average of the evaluated expression for selected applications |
|
| PF_#APPLICATIONS | Number of selected application | Portfolio | CAST-RestAPI 1.8.0 | None | TEXT;PF_#APPLICATIONS | Value |
|
| PF_TAG_NAME | Tag name of the selected category | Portfolio | CAST-RestAPI 1.8.0 | None | TEXT;PF_TAG_NAME | tag name used in the selected category, All if no category selected |
|
| PREVIOUS_SNAPSHOT_DATE or FROM_SNAPSHOT_DATE | Date of the previous snapshot selected | Application | A previous snapshot should have been selected CAST-RestAPI 1.8.0 | None | TEXT;PREVIOUS_SNAPSHOT_DATE | date in local format (the one that is selected in the RG settings) |
|
| PREVIOUS_SNAPSHOT_VERSION | Version of the previous snapshot selected | Application | A previous snapshot should have been selected CAST-RestAPI 1.8.0 | None | TEXT;PREVIOUS_SNAPSHOT_VERSION | previous version name |
|
| REPGEN_VERSION or EMP_VERSION | Report Generator version used to create the report | Application | No | None | TEXT;REPGEN_VERSION | 4 digits version |
|
| SYSTEM_NAME | Name of the system containing the application | Application | Only relevant on engineering databases. There is no real system on analytics database, just a fake one called “All Applications”. CAST-RestAPI 1.8.0 | None | TEXT;SYSTEM_NAME | Name |
|
PF_TECHDEBT_VS_AFP Deprecated (old Cast formula for Technical Debt) | Technical debt ratio per AFP | Portfolio | CAST-RestAPI 1.8.0 | None | TEXT;PF_TECHDEBT_VS_AFP | ratio of the sum of applications results for metric 68001 by the sum of application results for metric 10506 |
|
PF_OMG_TECHDEBT_VS_AFP | OMG Technical Debt ratio per AFP | Portfolio | CAST-RESTAPI 2.3.1 |
| TEXT;PF_OMG_TECHDEBT_VS_AFP TEXT;PF_OMG_TECHDEBT_VS_AFP;ID=ISO TEXT;PF_OMG_TECHDEBT_VS_AFP;ID=CISQ TEXT;PF_OMG_TECHDEBT_VS_AFP;ID=AIP | Display the total of OMG technical debt per AFP in Days |
|
PF_TECHDEBT_VS_LOC Deprecated (old Cast formula for Technical Debt) | Technical debt ratio per LOC | Portfolio | CAST-RestAPI 1.8.0 | None | TEXT;PF_TECHDEBT_VS_LOC | ratio of the sum of applications results for metric 68001 by the sum of application results for metric 10501 |
|
PF_OMG_TECHDEBT_VS_KLOC | OMG Technical Debt ratio per KLOC | Portfolio | CAST-RESTAPI 2.3.1 |
| TEXT;PF_OMG_TECHDEBT_VS_KLOC TEXT;PF_OMG_TECHDEBT_VS_KLOC;ID=ISO TEXT;PF_OMG_TECHDEBT_VS_KLOC;ID=CISQ TEXT;PF_OMG_TECHDEBT_VS_KLOC;ID=AIP | Display the total of OMG technical debt per KLOC in Days |
|
METRIC_TECHNICAL_DEBT Deprecated (old Cast formula for Technical Debt) | Technical debt result | Application | CAST-RestAPI 1.8.0 | None | TEXT;METRIC_TECHNICAL_DEBT | result of metric 68001 for application with registered currency symbol |
|
OMG_TECHNICAL_DEBT | OMG technical debt result | Application | CAST-RESTAPI 2.3.1 |
| TEXT;OMG_TECHNICAL_DEBT TEXT;OMG_TECHNICAL_DEBT;ID=ISO,SNAPSHOT=CURRENT TEXT;OMG_TECHNICAL_DEBT;ID=ISO,SNAPSHOT=PREVIOUS TEXT;OMG_TECHNICAL_DEBT;ID=AIP,SNAPSHOT=CURRENT TEXT;OMG_TECHNICAL_DEBT;ID=AIP,SNAPSHOT=PREVIOUS TEXT;OMG_TECHNICAL_DEBT;ID=CISQ,SNAPSHOT=CURRENT TEXT;OMG_TECHNICAL_DEBT;ID=CISQ,SNAPSHOT=PREVIOUS | result of omg technical debt total for selected index |
|
| DF_TF_TOTAL_FUNCTIONS | Automated IFPUG function points estimation | Application | CAST-RestAPI 1.8.0 | None | TEXT;DF_TF_TOTAL_FUNCTIONS | result of metric 10202 for application |
|
| TODAY_DATE | Date of the day when the report is generated | Application | CAST-RestAPI 1.8.0 | None | TEXT;TODAY_DATE | date in local format (the one that is selected in the RG settings) |
|
| RULE_TOTAL_CHECKS | Total checks of the specified quality rule | Application | CAST-RestAPI 1.8.0 |
| TEXT;RULE_TOTAL_CHECKS | value for the specified snapshot (current or previous) |
|
Notes for OMG Technical Debt Use
ISO option is the recommended technical debt to be used. Requires installation of OMG Technical Debt Measure (>2.0.0 funcrel) and ISO-5055 Index extensions during analysis
CISQ option required installation of OMG Technical Debt Measure and CISQ Index extensions during analysis. Scope of rules is reduced
