portfolio-overview

Cleans the data produced by the given job with the given set of job arguments on the selected targets.

Usage

cmri report-data portfolio-overview

Return Format

The result will be returned as a JSON object. It takes the following format:

{
    "<vault>:<project>:<system>": {
        "<language 1>": {
            "st.system.size.file_count": 426,
            "st.system.size.line_count": 46008.0,
            .
            .
            .
        },
        "<language 2>": {
            "st.system.size.file_count": 2610,
            "st.system.size.line_count": 943263.0,
            "st.system.portfolio_overview.overall_score": 25.082796159461612,
            .
            .
            .
        }
    }
}

Output Fields

name	description

name	description
st.system.size.file_count	The number of files within a system/language combo
st.system.size.line_count	The number of lines of code within the files of a system/language combo
st.system.portfolio_overview.overall_score	A value representing Silverthread’s assessed Software Quality Index
st.system.portfolio_overview.complexity_score	A value representing Silverthread’s assessed Code Quality
st.system.portfolio_overview.cyclicality_score	A value representing Silverthread’s assessed Cyclicality
st.system.portfolio_overview.modularity_score	A value representing Silverthread’s assessed Modularity
st.system.portfolio_overview.maintainabilty_score	A value representing Silverthread’s assessed Maintainability
st.system.portfolio_overview.agility_score	A value representing Silverthread’s assessed Agility
st.system.portfolio_overview.risk_score	A value representing Silverthread’s assessed Risk
st.system.portfolio_overview.duplication_pct	A percentage value representing the amount of duplicated code within the system
st.system.portfolio_overview.removable_duplication_pct	A percentage value representing the amount of duplicated code that can be removed from the system on refactor
st.system.portfolio_overview.high_complexity_file_count	The number of files deemed to have high complexity
st.system.portfolio_overview.high_complexity_file_pct	A percentage value representing the number of high complexity files compared to all files
st.system.portfolio_overview.medium_complexity_file_count	The number of files deemed to have medium complexity
st.system.portfolio_overview.largest_core_size	The number of files within the largest core
st.system.portfolio_overview.critical_core_count	The number of cores deemed ‘critical’ by Silverthread
st.system.portfolio_overview.emerging_core_count	The number of codes deemed ‘emerging’ by Silverthread
st.system.portfolio_overview.files_impacted_by_single_change_count	The number of files that could potentially be affected by a single code change due to the core size
st.system.type.language	The primary language within the system, being used for grouping and scoring
st.system.name.name	The assigned name of the system
st.system.portfolio_overview.sub_portfolio_name	Subportfolios are a more niche concept within portfolios. This will likely default to “Sub-Portfolio 1”
st.system.portfolio_overview.loc_inside_cores_pct	A percentage value representing the lines of code which fall within a core
st.system.portfolio_overview.course_of_action_type	One of ['Maintain', ‘Monitor', 'Act']. This is Silverthread’s recommendation based on the assessed overall_score