Created by James Hurrell, last modified on Sep 01, 2020
  • 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 IdDescriptionModeConstraintsParametersConfiguration sampleOutputResult sample
APPLICATION_SCHEMAGives the name of the schema containing the application.ApplicationCAST-RestAPI 1.8.0NoneTEXT;APPLICATION_SCHEMAName 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

NoneTEXT;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_FUNCTIONSGive the unadjusted data function metric value for the applicationApplicationCAST-RestAPI 1.8.0NoneTEXT;METRIC_AFP_DFResult of metric 10203 for application

METRIC_AFP_TFGive the unadjusted transactional function metric value for the applicationApplicationCAST-RestAPI 1.8.0NoneTEXT;METRIC_AFP_TFResult of metric 10204 for application

APPLICATION_NAMEGive the name of the applicationApplicationCAST-RestAPI 1.8.0NoneTEXT;APPLICATION_NAMEName of the application

APPLICATION_QUALITY_TYPEQuality Application Category (thresholds for categories can be adjusted in RG settings)ApplicationCAST-RestAPI 1.8.0NoneTEXT;APPLICATION_QUALITY_TYPEvery low/low/medium/good

APPLICATION_RULE or APPLICATION_METRICGive the value of a specific metric for the applicationApplicationCAST-RestAPI 1.8.0
  • ID or SZID or BFID :
    • ID for QualityRuleId or TechnicalCriterionId or BusinessCriterionId
    • SZID forSizing Measure Id
    • BFID for Background Fact Id
  • SNAPSHOT : PREVIOUS or CURRENT (CURRENT is the default)
  • FORMAT (if SZID or BFID) : N0 or N2 (N0 no decimal, N2 for decimal)

TEXT;APPLICATION_METRIC;SZID=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 for sizing measure or background fact, Grade for Quality measure

APPLICATION_SIZE_TYPESize application category (thresholds for categories can be adjusted in RG settings)ApplicationCAST-RestAPI 1.8.0NoneTEXT;APPLICATION_SIZE_TYPEsmall/medium/large/extre marge

CAST_VERSIONVersion of CAIP used for the applicationApplicationCAST-RestAPI 1.8.0NoneTEXT;CAST_VERSION3 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

  • PARAMS=SZ a SZ b, (SZ for sizing measure, QR for quality rule, BF for background fact)
  • EXPR=a/b, (operators can be +, -, *, / , (, ) )
    • a=MetricId, (sample 67011 – all critical violations)
    • b=MetricId, (sample 10202 – Total AFP)
  • FORMAT=N0 (N2 by default, if nothing or erroneous format is set),
  • SNAPSHOT = CURRENT|PREVIOUS with CURRENT by default (or if erroneous or nothing is set) to get the custom expression for the current snapshot or the previous one 
TEXT;CUSTOM_EXPRESSION;PARAMS=SZ a SZ b,EXPR=a/b,a=67011,b=10202,FORMAT=N2Evaluation of the expression calculated with the results of the metrics for the application

METRIC_EFP_ADDEDAdded EFP metric valueApplication

Only available if Enhancement Function Points mode is selected.

n/a if Automated Enhancement Points mode selected.

CAST-RestAPI 1.8.0

NoneTEXT;METRIC_EFP_ADDEDResult of metric 10300

METRIC_EFPAggregated EFP metric valueApplication

Only available if Enhancement Function Points mode is selected.

n/a if Automated Enhancement Points mode selected.

CAST-RestAPI 1.8.0

NoneTEXT;METRIC_EFPSum of results from metrics 10300, 10310 and 10320 (added + deleted + modified function points)

METRIC_EFP_DELETEDDeleted EFP metric valueApplication

Only available if Enhancement Function Points mode is selected.

n/a if Automated Enhancement Points mode selected.

CAST-RestAPI 1.8.0

NoneTEXT;METRIC_EFP_DELETEDResult of metric 10320

METRIC_EFP_MODIFIEDModified EFP metric valueApplication

Only available if Enhancement Function Points mode is selected.

n/a if Automated Enhancement Points mode selected.

CAST-RestAPI 1.8.0

NoneTEXT;METRIC_EFP_MODIFIEDResult of metric 10310

METRIC_EVOLUTION

New in 1.15.0

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

  • ID= can be quality indicator id (BC, TC or QR), or sizing measure, or background fact. Mandatory parameter
  • FORMAT=ABSOLUTE or PERCENT to get the variation either direct value, either percentage. Default is percent. (optional)
  • MODULE=name of the module for which you want the metric evolution (optional)
  • TECHNO=name of the technology for which you want the metric evolution (optional)

If no module and no technology this is the value for the application that is taken.
Variation in percent = (current - previous) / previous
Variation in absolute = current - previous

Evolution of TQI for the application in percentage :
TEXT;METRIC_EVOLUTION;ID=60017

Evolution of Number of code lines in absolute for module MyModule:
TEXT;METRIC_EVOLUTION;ID=10151,FORMAT=ABSOLUTE,MODULE=MyModule

Evolution of TQI of technology JEE in percentage:
TEXT;METRIC_EVOLUTION;ID=60017,TECHNO=JEE



RULE_FAILED_CHECKSNumber of failed checks in the application for a specific ruleApplicationCAST-RestAPI 1.8.0
  • RULID=quality rule Id,
  • SNAPSHOT=CURRENT|PREVIOUS (CURRENT by default)
TEXT;RULE_FAILED_CHECKSvalue for the specified snapshot (current or previous)

RULE_FAILED_ON_TOTAL_CHECKSNumber of failed checks / Number of total checks in the application for a specific ruleApplicationCAST-RestAPI 1.8.0
  • RULID=quality rule Id,
  • SNAPSHOT=CURRENT|PREVIOUS (CURRENT by default)
TEXT;RULE_FAILED_ON_TOTAL_CHECKSvalues for the specified snapshot (current or previous)

LAST_SNAPSHOT_DATE or TO_SNAPSHOT_DATEDate of current snapshotApplicationCAST-RestAPI 1.8.0NoneTEXT;LAST_SNAPSHOT_DATEdate in local format (the one that is selected in the RG settings)

LAST_SNAPSHOT_VERSIONVersion of current snapshotApplicationCAST-RestAPI 1.8.0NoneTEXT;LAST_SNAPSHOT_VERSIONcurrent version name

PF_CATEGORY_NAMECategory used to filter the list of applications in portfolioPortfolioCAST-RestAPI 1.8.0NoneTEXT;PF_CATEGORY_NAMEcategory used, All if no category selected

PF_CRITICAL_VIOLATIONSNumber of Critical Violations in portfolioPortfolioCAST-RestAPI 1.8.0
  • BCID=N where N is the metric id of an healt factor (60017 ie TQI by default)
TEXT;PF_CRITICAL_VIOLATIONSsum 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

  • PARAMS=SZ a SZ b, (SZ for sizing measure, QR for quality rule, BF for background fact)
  • EXPR=b/a, (operators can be +, -, *, / , (, ) )
  • a=67011,
  • b=67010,
  • AGGREGATOR=SUM|AVERAGE (for portfolio component, to aggregate results of all applications for the custom expression, AVERAGE by default or if erroneous format is set)
  • FORMAT=N0 (N2 by default, if nothing or erroneous format is set),

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=SUMsum or average of the evaluated expression for selected applications

PF_#APPLICATIONSNumber of selected applicationPortfolioCAST-RestAPI 1.8.0NoneTEXT;PF_#APPLICATIONSValue

PF_TAG_NAMETag name of the selected categoryPortfolioCAST-RestAPI 1.8.0NoneTEXT;PF_TAG_NAMEtag name used in the selected category, All if no category selected

PREVIOUS_SNAPSHOT_DATE or FROM_SNAPSHOT_DATEDate of the previous snapshot selectedApplication

A previous snapshot should have been selected

CAST-RestAPI 1.8.0

NoneTEXT;PREVIOUS_SNAPSHOT_DATEdate in local format (the one that is selected in the RG settings)

PREVIOUS_SNAPSHOT_VERSIONVersion of the previous snapshot selectedApplication

A previous snapshot should have been selected

CAST-RestAPI 1.8.0

NoneTEXT;PREVIOUS_SNAPSHOT_VERSIONprevious version name

REPGEN_VERSION or EMP_VERSIONReport Generator version used to create the reportApplicationNoNoneTEXT;REPGEN_VERSION4 digits version

SYSTEM_NAMEName of the system containing the applicationApplication

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

NoneTEXT;SYSTEM_NAMEName

PF_TECHDEBT_VS_AFPTechnical debt ratio per AFPPortfolioCAST-RestAPI 1.8.0NoneTEXT;PF_TECHDEBT_VS_AFPratio of the sum of applications results for metric 68001 by the sum of application results for metric 10506

PF_TECHDEBT_VS_LOCTechnical debt ratio per LOCPortfolioCAST-RestAPI 1.8.0NoneTEXT;PF_TECHDEBT_VS_LOCratio of the sum of applications results for metric 68001 by the sum of application results for metric 10501

METRIC_TECHNICAL_DEBTTechnical debt resultApplicationCAST-RestAPI 1.8.0NoneTEXT;METRIC_TECHNICAL_DEBTresult of metric 68001 for application with registered currency symbol

DF_TF_TOTAL_FUNCTIONSAutomated IFPUG function points estimationApplicationCAST-RestAPI 1.8.0NoneTEXT;DF_TF_TOTAL_FUNCTIONSresult of metric 10202 for application

TODAY_DATEDate of the day when the report is generatedApplicationCAST-RestAPI 1.8.0NoneTEXT;TODAY_DATEdate in local format (the one that is selected in the RG settings)

RULE_TOTAL_CHECKSTotal checks of the specified quality ruleApplicationCAST-RestAPI 1.8.0
  • RULID=quality rule Id,
  • SNAPSHOT=CURRENT|PREVIOUS (CURRENT by default)
TEXT;RULE_TOTAL_CHECKSvalue for the specified snapshot (current or previous)