Created by James Hurrell on Sep 01, 2020

Need CAST-RestAPI minimum version 1.10.0 when using quality standards mapping (minimal version 20181030), 1.8.0 otherwise

On this page:

Generic Tables for Application Mode

Axis and Values

AxisValues
SNAPSHOTSCURRENT, PREVIOUS, EVOL, EVOL_PERCENT, ALL
METRICS<ID>, HEALTH_FACTOR, BUSINESS_CRITERIA, TECHNICAL_CRITERIA, QUALITY_RULES, CRITICAL_QUALITY_RULES, FUNCTIONAL_WEIGHT, TECHNICAL_SIZING, VIOLATION, CRITICAL_VIOLATION, TECHNICAL_DEBT, RUN_TIME, <STANDARD_TAG_NAME> (1)
MODULES<NAME>, ALL
TECHNOLOGIES<NAME>, ALL
VIOLATIONS (2)TOTAL, ADDED, REMOVED, ALL
CRITICAL_VIOLATIONS (2)TOTAL, ADDED, REMOVED, ALL
CUSTOM_EXPRESSIONS<EXPRESSIONS>(3) Updated in 1.17


  • (1): The selection of metrics by standard quality tag name should only be used for an application where the extension Quality Standards Mapping is installed. If not, no metrics will be selected and the table will be empty.
  • (2): To get results on violations or critical violations on a specific metric, add the axis "METRICS=M" where M is a metric id referenced in the Assessment Model.
  • (3): in this axis, you can configure custom expressions as we do in the other components based on (cf sample 12)
    • CUSTOM_EXPRESSIONS=a/b|c/d=a/b|(c+d)/2, (operators can be +, -, *, / , (, ) ), list of custom expressions separated by |
    • PARAMS=SZ a SZ b QR c QR d, (SZ for sizing measure or category - since 1.17, QR for quality rule, BF for background fact) 
    • a=MetricId, (sample 67211 – all violations)
    • b=MetricId, (sample 10151 – number of code lines)
    • c = MetricId, 60013 for Robustness
    • d = MetricId, 60014 for Efficiency
    • FORMAT=N0 | N2 (N2 by default, if nothing or erroneous format is set), the first format is associated to the first custom expression,...

Table Structure

  • COL 1: (1st axis of information, mandatory)
  • COL 11: (2nd axis of information, optional)
  • ROW 1: (1st axis of information, mandatory)
  • ROW 11: (2nd axis of information, optional)

COL1 value 1- COL11 value1COL1 value1 - COL11 value2COL1 value2 - COL11 value 1COL1 value2 - COL11 value 2
ROW1 value 1



ROW11 value 1



ROW11 value 2



ROW1 value 2



ROW11 value 1



ROW11 value 2



Alt Text configuration

TABLE;GENERIC_TABLE;COL1=A,COL11=B,ROW1=C,ROW11=D,A=a,B=b,C=c|d,D=e|f|g
  • where A,B,C and D are one of the axis above
  • and a, b, c, d, e, f, g is one or multiple tags of the axis

Notes

  • No space can be left on the configuration (except if your module or technology contains it).
  • MODULES: if no information filled, then default value is "ALL"
  • TECHNOLOGIES: if no information filled, then default value is "ALL"
  • SNAPSHOTS: When a snapshot is displayed in a table, we display "Snapshot Name -Snapshot version".  if no information filled, then default value is "ALL"
  • VIOLATIONS: if no information filled, then default value is "ALL"
  • CRITICAL_VIOLATIONS: if no information filled, then default value is "ALL"
  • METRICS: if no information filled, then default value is "HEALTH_FACTOR"

Samples

SAMPLE 1

Simple table to get Efficiency, TQI, Robustness scores for current snapshot only

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=SNAPSHOTS,METRICS=60014|60017|60013,SNAPSHOTS=CURRENT

SAMPLE 2

Simple table to get Efficiency, TQI, Robustness scores for current and previous snapshot

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=SNAPSHOTS,METRICS=60014|60017|60013,SNAPSHOTS=CURRENT|PREVIOUS

SAMPLE 3

Simple table to get all Health Factors scores for current and previous snapshot and their evolution 

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=SNAPSHOTS,METRICS=HEALTH_FACTOR,SNAPSHOTS=ALL 

SAMPLE 4

Table to get all Health Factors scores to benchmark modules for current and then previous snapshot

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=SNAPSHOTS,ROW11=MODULES,METRICS=HEALTH_FACTOR,SNAPSHOTS=CURRENT|PREVIOUS,MODULES=ALL

SAMPLE 5

Table to get all Health Factors scores to monitor modules regarding current and previous snapshot

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=MODULES,ROW11=SNAPSHOTS,METRICS=HEALTH_FACTOR,SNAPSHOTS=CURRENT|PREVIOUS,MODULES=ALL

SAMPLE 6

Table to get all Health Factors critical violations numbers with risk introduced regarding previous snapshot

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=CRITICAL_VIOLATIONS,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS =ALL,SNAPSHOTS=CURRENT

SAMPLE 7

Table to benchmark module on Health Factors critical violations numbers with risk introduced regarding previous snapshot

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=CRITICAL_VIOLATIONS,ROW11=MODULES,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS =ALL,MODULES=ALL,SNAPSHOTS=CURRENT

SAMPLE 8

Table to monitor technologies on added and removed critical violations for Health Factors

TABLE;GENERIC_TABLE;COL1=METRICS,ROW1=TECHNOLOGIES,ROW11=CRITICAL_VIOLATIONS,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS =ADDED|REMOVED,TECHNOLOGIES=ALL,SNAPSHOTS=CURRENT

SAMPLE 9

Table to monitor sizing information regarding previous snapshot

TABLE;GENERIC_TABLE;COL1=SNAPSHOTS,ROW1=METRICS,METRICS=TECHNICAL_SIZING,SNAPSHOTS=CURRENT|PREVIOUS

SAMPLE 10

Table to monitor specific sizing metrics with evolution regarding previous snapshot

TABLE;GENERIC_TABLE;COL1=SNAPSHOTS,ROW1=METRICS,METRICS=10151|10107|10152|10154|10161,SNAPSHOTS=ALL

SAMPLE 11

Table to monitor quality standard violations evolution

TABLE;GENERIC_TABLE;COL1=VIOLATIONS,ROW1=METRICS,METRICS=CWE,VIOLATIONS=ALL
The selection of metrics by standard quality tag name should only be used for an application where the extension Quality Standards Mapping is installed. If not, no metrics will be selected and the table will be empty.

SAMPLE 12

Table to monitor custom expressions. The following configuration will give for each module the avarage grade of 2 business criteria and a ratio between sizing metrics

TABLE;GENERIC_TABLE;COL1=CUSTOM_EXPRESSIONS,ROW1=MODULES,SNAPSHOTS=CURRENT,CUSTOM_EXPRESSIONS=(a+b)/2|c/d,PARAMS=QR a QR b SZ c SZ d,a=60013,b=60014,c=67211,d=10151,MODULES=ALL

Generic Graph for Application Mode

The Graph component is built based on a table structure. The idea is to fill data into the table of the graph to populate it automatically. The table structure is the same as the Generic table component.

Axis and Values

AxisValues
SNAPSHOTSCURRENT, PREVIOUS, EVOL, EVOL_PERCENT, ALL
METRICS<ID>, HEALTH_FACTOR, BUSINESS_CRITERIA, TECHNICAL_CRITERIA, QUALITY_RULES, CRITICAL_QUALITY_RULES, FUNCTIONAL_WEIGHT, TECHNICAL_SIZING, VIOLATION, CRITICAL_VIOLATION, TECHNICAL_DEBT, RUN_TIME, <STANDARD_TAG_NAME> (1)
MODULES<NAME>, ALL
TECHNOLOGIES<NAME>, ALL
VIOLATIONS (2)TOTAL, ADDED, REMOVED, ALL
CRITICAL_VIOLATIONS (2)TOTAL, ADDED, REMOVED, ALL
CUSTOM_EXPRESSIONS<EXPRESSIONS>(3) Updated in 1.17


  • (1): The selection of metrics by standard quality tag name should only be used for an application where the extension Quality Standards Mapping is installed. If not, no metrics will be selected and the graph will be empty.
  • (2): To get results on violations or critical violations on a specific metric, add the axis "METRICS=M" where M is a metric id referenced in the Assessment Model (see stacked bar sample)
  • (3): in this axis, you can configure custom expressions as we do in the other components based on
    • CUSTOM_EXPRESSIONS=a/b|c/d=a/b|(c+d)/2, (operators can be +, -, *, / , (, ) ), list of custom expressions separated by |
    • PARAMS=SZ a SZ b QR c QR d, (SZ for sizing measure or category - since 1.17, QR for quality rule, BF for background fact)
    • a=MetricId, (sample 67211 – all violations)
    • b=MetricId, (sample 10151 – number of code lines)
    • c = MetricId, 60013 for Robustness
    • d = MetricId, 60014 for Efficiency
    • FORMAT=N0 | N2 (N2 by default, if nothing or erroneous format is set), the first format is associated to the first custom expression,...

Table Structure

  • COL 1: (1st axis of information, mandatory)
  • COL 11: (2nd axis of information, optional)
  • ROW 1: (1st axis of information, mandatory)
  • ROW 11: (2nd axis of information, optional)

COL1 value 1- COL11 value1COL1 value1 - COL11 value2COL1 value2 - COL11 value 1COL1 value2 - COL11 value 2
ROW1 value 1



ROW11 value 1



ROW11 value 2



ROW1 value 2



ROW11 value 1



ROW11 value 2



Alt Text configuration

TABLE;GENERIC_TABLE;COL1=A,COL11=B,ROW1=C,ROW11=D,A=a,B=b,C=c|d,D=e|f|g
  • where A,B,C and D are one of the axis above
  • and a, b, c, d, e, f, g is one or multiple tags of the axis

Notes

  • No space can be left on the configuration (except if your module or technology contains it).
  • MODULES: if no information filled, then default value is "ALL"
  • TECHNOLOGIES: if no information filled, then default value is "ALL"
  • SNAPSHOTS: When a snapshot is displayed in a table, we display "Snapshot Name -Snapshot version".  if no information filled, then default value is "ALL"
  • VIOLATIONS: if no information filled, then default value is "ALL"
  • CRITICAL_VIOLATIONS: if no information filled, then default value is "ALL"
  • METRICS: if no information filled, then default value is "HEALTH_FACTOR"

Samples

SAMPLE 1 - clustered column graph

GRAPH;GENERIC_GRAPH;COL1=SNAPSHOTS,ROW1=METRICS,METRICS=HEALTH_FACTOR,SNAPSHOTS=CURRENT|PREVIOUS

SAMPLE 2 - clustered column graph

GRAPH;GENERIC_GRAPH;COL1=METRICS,ROW1=MODULES,METRICS=HEALTH_FACTOR


SAMPLE 3 - Stacked Bar

GRAPH;GENERIC_GRAPH;COL1=CRITICAL_VIOLATIONS,ROW1=MODULES,MODULES=ALL,CRITICAL_VIOLATIONS=ALL,METRICS=60017

SAMPLE 4 - Stacked Bar sample A with Standard Quality Rules

GRAPH;GENERIC_GRAPH;COL1=VIOLATIONS,ROW1=METRICS,VIOLATIONS=ALL,METRICS=CWE;
The selection of metrics by standard quality tag name should only be used for an application where the extension Quality Standards Mapping is installed. If not, no metrics will be selected and the graph will be empty.

SAMPLE 5 - Stacked Bar sample B

GRAPH;GENERIC_GRAPH;COL1=CRITICAL_VIOLATIONS,ROW1=METRICS,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS=ADDED|REMOVED

SAMPLE 6 - Radar chart

GRAPH;GENERIC_GRAPH;COL1=SNAPSHOTS,ROW1=METRICS,METRICS=60013|60014|60016,SNAPSHOTS=CURRENT|PREVIOUS

SAMPLE 7 - Pie chart

GRAPH;GENERIC_GRAPH;ROW1=TECHNOLOGIES,COL1=METRICS,TECHNOLOGIES=ALL,METRICS=10151

GRAPH;GENERIC_GRAPH;ROW1=MODULES,COL1=METRICS,MODULES=ALL,METRICS=10151

Generic Tables for Portfolio Mode

Axis and Values

AxisValues
METRICS<ID>, HEALTH_FACTOR, BUSINESS_CRITERIA, TECHNICAL_CRITERIA, QUALITY_RULES, CRITICAL_QUALITY_RULES, FUNCTIONAL_WEIGHT, TECHNICAL_SIZING, VIOLATION, CRITICAL_VIOLATION, TECHNICAL_DEBT, RUN_TIME
APPLICATIONS<NAME>, ALL, EACH
TECHNOLOGIES<NAME>, EACH
VIOLATIONS (1)TOTAL, ADDED, REMOVED, ALL
CRITICAL_VIOLATIONS (1)TOTAL, ADDED, REMOVED, ALL
CUSTOM_EXPRESSIONS<EXPRESSIONS>(2)


(1): To get results on violations or critical violations on a specific metric, add the axis "METRICS=M" where M is a metric id referenced in the Assessment Model.

(2): in this axis, you can configure custom expressions as we do in the other components based on

  • CUSTOM_EXPRESSIONS=a/b|c/d=a/b|(c+d)/2, (operators can be +, -, *, / , (, ) ), list of custom expressions separated by |
  • PARAMS=SZ a SZ b QR c QR d, (SZ for sizing measure, QR for quality rule, BF for background fact)
  • a=MetricId, (sample 67211 – all violations)
  • b=MetricId, (sample 10151 – number of code lines)
  • c = MetricId, 60013 for Robustness
  • d = MetricId, 60014 for Efficiency
  • FORMAT=N0 | N2 (N2 by default, if nothing or erroneous format is set), the first format is associated to the first custom expression,...

Table Structure

  • COL 1: (1st axis of information, mandatory)
  • COL 11: (2nd axis of information, optional)
  • ROW 1: (1st axis of information, mandatory)
  • ROW 11: (2nd axis of information, optional)

COL1 value 1- COL11 value1COL1 value1 - COL11 value2COL1 value2 - COL11 value 1COL1 value2 - COL11 value 2
ROW1 value 1



ROW11 value 1



ROW11 value 2



ROW1 value 2



ROW11 value 1



ROW11 value 2



Alt Text configuration

TABLE;GENERIC_TABLE;COL1=A,COL11=B,ROW1=C,ROW11=D,A=a,B=b,C=c|d,D=e|f|g,AGGREGATORS=SUM|AVERAGE
  • where A,B,C and D are one of the axis above
  • and a, b, c, d, e, f, g is one or multiple tags of the axis

  • AGGREGATORS : AVERAGE or SUM for each item in METRICS list (optional, only needed if default selection does not fit, cf Notes)

Notes

  • No space can be left on the configuration (except if your application name or technology contains it).
  • APPLICATIONS: if no information filled, then default value is "ALL"
  • VIOLATIONS: if no information filled, then default value is "ALL"
  • CRITICAL_VIOLATIONS: if no information filled, then default value is "ALL"
  • METRICS: if no information filled, then default value is "HEALTH_FACTOR". a parameter AGGREGATORS should be added, containing the list of AGGREGATORS (must be AVG or SUM) corresponding to the list of METRICS. For example, if METRICS=60017|68001|66024 then AGGREGATORS=AVERAGE|SUM|AVERAGE. For groups, you can precise METRICS=HEALTH_FACTOR|TECHNICAL_SIZING then AGGREGATORS=AVERAGE|SUM. By default if no information filled, AVERAGE will be affected for quality indicators and SUM for sizing or background facts metrics
  • TECHNOLOGIES: if no information filled, then default value is "EACH"

Samples

SAMPLE 1

Table to get all Health Factors scores to benchmark applications results (for last snaphot of each app)

TABLE;PF_GENERIC_TABLE;ROW1= APPLICATIONS,COL1=METRICS,METRICS=HEALTH_FACTOR, APPLICATIONS=EACH

SAMPLE 2

Table to get critical violations results (total and delta) between last and previous snapshot of each application

TABLE;PF_GENERIC_TABLE;ROW1=APPLICATIONS, COL1=CRITICAL_VIOLATIONS,CRITICAL_VIOLATIONS =ALL,APPLICATIONS=EACH

SAMPLE 3

Table to benchmark applications for added critical violations by Health Factor between last and previous snapshot of each app

TABLE;PF_GENERIC_TABLE;COL1=METRICS,ROW1=CRITICAL_VIOLATIONS,ROW11=APPLICATIONS,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS =ADDED,APPLICATIONS=EACH

SAMPLE 4

Table to benchmark sizing information at portfolio level regarding last snapshot results of each applications in the scope

TABLE;PF_GENERIC_TABLE;COL1=APPLICATIONS,ROW1=METRICS,METRICS=TECHNICAL_SIZING, APPLICATIONS=ALL,AGGREGATORS=SUM

SAMPLE 5

Table to monitor specific sizing metrics for each technology

TABLE;PF_GENERIC_TABLE;COL1=TECHNOLOGIES,ROW1=METRICS,METRICS=10151|10107|10152|10154|10161,AGGREGATORS=SUM,TECHNOLOGIES=EACH

SAMPLE 6

Table to monitor technologies results by Health Factor for last snapshot of each app

TABLE;PF_GENERIC_TABLE;COL1=METRICS,ROW1=TECHNOLOGIES,METRICS=HEALTH_FACTOR,TECHNOLOGIES=EACH

SAMPLE 7

Table to get specific metrics (here Lines of Code) by application and by technology

TABLE;PF_GENERIC_TABLE;COL1=TECHNOLOGIES,ROW1=APPLICATIONS,TECHNOLOGIES=EACH,APPLICATIONS=EACH,METRICS=10151

SAMPLE 8

Table to get specific custom expressions by application

TABLE;PF_GENERIC_TABLE;COL1=CUSTOM_EXPRESSIONS,ROW1=APPLICATIONS,APPLICATIONS=EACH,CUSTOM_EXPRESSIONS=a/b|(c+d)/2,PARAMS=SZ a SZ b QR c QR d,a=67211,b=10151,c=60012,d=60013

Generic Graph for Portfolio Mode

A Graph component is built based on a table structure. The idea is to fill data into the table of the graph to populate it automatically. The table structure is the same as the Generic table component.

Axis and Values

AxisValues
METRICS<ID>, HEALTH_FACTOR, BUSINESS_CRITERIA, TECHNICAL_CRITERIA, QUALITY_RULES, CRITICAL_QUALITY_RULES, FUNCTIONAL_WEIGHT, TECHNICAL_SIZING, VIOLATION, CRITICAL_VIOLATION, TECHNICAL_DEBT, RUN_TIME
APPLICATIONS<NAME>, ALL, EACH
TECHNOLOGIES<NAME>, EACH
VIOLATIONS (1)TOTAL, ADDED, REMOVED, ALL
CRITICAL_VIOLATIONS (1)TOTAL, ADDED, REMOVED, ALL
CUSTOM_EXPRESSIONS<EXPRESSIONS>(2)

(1): To get results on violations or critical violations on a specific metric, add the axis "METRICS=M" where M is a metric id referenced in the Assessment Model.

(2): in this axis, you can configure custom expressions as we do in the other components based on

  • CUSTOM_EXPRESSIONS=a/b|c/d=a/b|(c+d)/2, (operators can be +, -, *, / , (, ) ), list of custom expressions separated by |
  • PARAMS=SZ a SZ b QR c QR d, (SZ for sizing measure, QR for quality rule, BF for background fact)
  • a=MetricId, (sample 67211 – all violations)
  • b=MetricId, (sample 10151 – number of code lines)
  • c = MetricId, 60013 for Robustness
  • d = MetricId, 60014 for Efficiency
  • FORMAT=N0 | N2 (N2 by default, if nothing or erroneous format is set), the first format is associated to the first custom expression,...

Table Structure

  • COL 1: (1st axis of information, mandatory)
  • COL 11: (2nd axis of information, optional)
  • ROW 1: (1st axis of information, mandatory)
  • ROW 11: (2nd axis of information, optional)

COL1 value 1- COL11 value1COL1 value1 - COL11 value2COL1 value2 - COL11 value 1COL1 value2 - COL11 value 2
ROW1 value 1



ROW11 value 1



ROW11 value 2



ROW1 value 2



ROW11 value 1



ROW11 value 2



Alt Text configuration

TABLE;GENERIC_TABLE;COL1=A,COL11=B,ROW1=C,ROW11=D,A=a,B=b,C=c|d,D=e|f|g,AGGREGATORS=SUM|AVERAGE
  •  where A,B,C and D are one of the axis above
  • and a, b, c, d, e, f, g is one or multiple tags of the axis

  • AGGREGATORS : AVERAGE or SUM for each item in METRICS list (optional, only needed if default selection does not fit, cf Notes)

Notes

  • No space can be left on the configuration (except if your application name or technology contains it).
  • APPLICATIONS: if no information filled, then default value is "ALL"
  • VIOLATIONS: if no information filled, then default value is "ALL"
  • CRITICAL_VIOLATIONS: if no information filled, then default value is "ALL"
  • METRICS: if no information filled, then default value is "HEALTH_FACTOR“. a parameter AGGREGATORS should be added, containing the list of AGGREGATORS (must be AVG or SUM) corresponding to the list of METRICS. For example, if METRICS=60017|68001|66024 then AGGREGATORS=AVERAGE|SUM|AVERAGE. For groups, you can precise METRICS=HEALTH_FACTOR|TECHNICAL_SIZING then AGGREGATORS=AVERAGE|SUM. By default if no information filled, AVERAGE will be affected for quality indicators and SUM for sizing or background facts metrics
  • TECHNOLOGIES: if no information filled, then default value is "EACH"

Samples

SAMPLE 1 - Clustered column graph

GRAPH;PF_GENERIC_GRAPH;COL1=METRICS,ROW1=APPLICATIONS,METRICS=60016

SAMPLE 2 - Clustered column graph

GRAPH;PF_GENERIC_GRAPH;COL1=METRICS,ROW1=TECHNOLOGIES,METRICS=10151|60017,AGGREGATORS=SUM|AVERAGE,TECHNOLOGIES=EACH

SAMPLE 3 - Stacked Bar

GRAPH;PF_GENERIC_GRAPH;COL1=CRITICAL_VIOLATIONS,ROW1=APPLICATIONS,APPLICATIONS=EACH,CRITICAL_VIOLATIONS=ALL,METRICS=60017

SAMPLE 4 - Stacked Bar

GRAPH;PF_GENERIC_GRAPH;COL1=CRITICAL_VIOLATIONS,ROW1=METRICS,METRICS=HEALTH_FACTOR,CRITICAL_VIOLATIONS=ADDED|REMOVED

SAMPLE 5 - Radar chart

GRAPH;PF_GENERIC_GRAPH;COL1=APPLICATIONS,ROW1=METRICS,METRICS=60013|60014|60016,AGGREGATORS=AVERAGE,APPLICATIONS=EACH

SAMPLE 6 - Pie chart

GRAPH;PF_GENERIC_GRAPH;ROW1=TECHNOLOGIES,COL1=METRICS,TECHNOLOGIES=EACH,METRICS=10151,AGGREGATORS=SUM