Create a Scorecard

Use Scorecards to establish best practices, track migration, promote accountability among teams, enforce standardization across entities, or define maturity standards. This page explains how to create a Scorecard from the Cortex UI. For instructions on creating Scorecards via GitOps, see Scorecards as code. You can also work with Scorecards via the Cortex API. Learn about reviewing, evaluating, and taking action on failed rules in Review and evaluate Scorecards.

​

Common Scorecard use cases

For information about common use cases and examples, see Scorecard examples.

​

How to create Scorecards

​

Prerequisites

• To create a Scorecard, you must have the admin or manager role, or you must have a custom role that includes the permission Edit Scorecards.
• Scorecards evaluate entities, so before using Scorecards, make sure you have entities in your catalogs.
• Make sure you have set up any integrations you want to write rules against.

​

Step 1: Configure the basic Scorecard fields

When you create a new Scorecard, you can choose from the following options:

• Use a Scorecard template
• Start from scratch

​

Option 1: Use a template

Cortex offers the following templates:

Scorecard templates

• Empty Scorecard with Gold/Silver/Bronze levels pre-configured
• Onboarding Scorecard
• DRIVE Framework
• DORA Operational Readiness
• Production Readiness
• Service Maturity
• AI Readiness
• AI Maturity
• AI Governance
• Code Quality
• Security Scorecard
• Vulnerability Management
• Incident Preparedness
• Incident Response Performance
• SOC 2 Compliance
• Secrets Management
• Ownership Verification
• Entity Verification
• Eng Intelligence metrics
• Velocity Scorecard
• JavaScript Best Practices
• Kubernetes Deployment Baseline
• Minimum Postgres version for Aurora
• Minimum version for ElastiCache for Redis
• Minimum Lambda runtime versions
• Deprecations

Expand the tile below to learn how to create a Scorecard from a template.

Create Scorecard from template

To create a Scorecard using a template:

1. On the Scorecards page in Cortex, click Create Scorecard.
2. Click Scorecard template.
3. Click the template you want to use, then at the bottom of the page, click Continue.
   • You will be redirected to a page that shows the default configuration for your Scorecard, including the integrations used by the Scorecard and the template’s levels and rules. You will be able to modify the Scorecard on the next page.
4. Click Continue at the bottom of the Scorecard default configuration page.
5. Configure the basic fields for your Scorecard:
   • Name: Enter a descriptive name for your Scorecard.
   • Identifier: Enter a unique identifier for your Scorecard.
   • Description: Enter a description for your Scorecard.
   • Evaluation window: By default, Scorecards are evaluated every 4 hours. If you would like to evaluate Scorecards less frequently, you can override the evaluation window and enter a new number.
     • If a Scorecard is evaluating such a large number of entities that it cannot complete the evaluation in a 4-hour window without invoking rate limits, then a longer evaluation window is recommended.
     • You will also be able to manually trigger an evaluation when needed.
   • Enable notifications: Choose whether to enable notifications.
     • If notifications are enabled, users who own entities being evaluated by this Scorecard will receive alerts when there are relevant updates on the Scorecard and any corresponding initiatives.
     • Notify when scores drop: When enabled, you will be notified any time a score drops from the last time the Scorecard was evaluated.
   • Enable exemptions: Choose whether to enable Scorecard exemptions. If not set, it defaults to true.
     • See Scorecard rule exemptions for more information.
   • Enable auto-approval exemptions: Choose whether to enable auto-approving of Scorecard rule exemptions. If not set, it defaults to false.
   • Enable user-specific notifications: Add a field to allow your users to notify a specific user to approve a rule exemption request rather than all Admins.
     • If this field is enabled, Scorecard notifications will also be enabled automatically.
6. Select whether to apply this Scorecard to specific entities.
   • You can choose to include or exclude specific entity types.
   • Click Advanced options to see additional options for refining entity selection. You can include or exclude groups, and you can include a CQL expression to make your entity type selection.
     • When including a CQL expression, you will have the option to test the query against specified entities to verify that it works as expected.

If you want to use all of the default rules from the template, you can skip ahead to Step 4: Save the Scorecard. If you want to add any rules or levels, follow the next steps.

​

Option 2: Start from scratch

Create Scorecard from scratch

1. On the Scorecards page in Cortex, click Start from scratch, then at the bottom of the page, click Continue.
2. Configure the basic fields for your Scorecard:
   • Name: Enter a descriptive name for your Scorecard.
   • Identifier: Enter a unique identifier for your Scorecard.
   • Description: Enter a description for your Scorecard.
   • Evaluation window: By default, Scorecards are evaluated every 4 hours. If you would like to evaluate Scorecards less frequently, you can override the evaluation window and enter a new number.
     • If a Scorecard is evaluating such a large number of entities that it cannot complete the evaluation in a 4-hour window without invoking rate limits, then a longer evaluation window is recommended.
   • Enable notifications: Choose whether to enable notifications.
     • If notifications are enabled, users who own entities being evaluated by this Scorecard will receive alerts when there are relevant updates on the Scorecard and any corresponding initiatives.
     • Notify when scores drop: When enabled, you will be notified any time a score drops from the last time the Scorecard was evaluated.
   • Enable exemptions: Choose whether allow users to request rule exemptions for evaluated entities. If not set, it defaults to enabled.
     • See Scorecard rule exemptions for more information.
   • Enable auto-approval exemptions: If exemptions are allowed, choose whether to enable auto-approval of Scorecard rule exemptions. If not set, it defaults to disabled.
3. Next to “Apply to specific entities,” select whether to apply this Scorecard to specific entities:
   • Selection type and Entity types: Choose to include or exclude specific entity types. By default, the Scorecard will apply to all entities of the selected type(s).
   • Click Advanced options to see additional options for refining entity selection. You can include or exclude groups. For example, if you’re creating a services-based Scorecard, you might choose to include those that belong in a “tier 1 services” group.
     • You can also include a CQL expression to make your entity type selection.

Advanced filtering only works with data that exist within Cortex, like entity groups, owners, and other custom data, but does not extend to third-party integrations.

See the next section for steps on choosing a scoring type and writing rules.

​

Step 2: Add levels

When you create a Scorecard, there are two options to set up your Scorecard’s evaluation:

• Level progression
  • Establish progressive levels as you add rules to make it obvious which set of rules are the highest priority. Levels allow you to set up a gamified system to encourage developers to make progress toward goals and improve entities’ performance.
    • Set your minimum requirements within the lowest level, and add increasingly higher priority rules to subsequent levels.
    • For an example demonstrating how levels work, see Guides > Measure DORA progress.
• Point-based rules
  • Use points to assign weighted values to each rule you add to a Scorecard.
    • You can use point-based rules to set minimum requirements while also encouraging teams to add more metadata. For example, you could assign 1 point for adding a single runbook to an entity, and another point for adding additional runbooks:
    

​

Add a level

To add a level to a Scorecard:

1. While creating your Scorecard, in the “Define evaluation rules” section, click Add level.
2. In the modal, configure your level:
   • Color: Click the star icon to select a color for this level.
   • Name: Enter a name that represents this level.
     • You might choose to go with classic levels names, such as Bronze, Silver, and Gold, or you can choose something more unique to your organization.
     • Levels are designed to inspire progress on important goals, so consider level names that will motivate your team members.
   • Description: Enter a description for the level.
3. Click Add level.

You can add more levels to the Scorecard, or you can move on to the next step and add rules to each level.

​

Reorder levels

To reorder levels in a Scorecard:

You can reorder levels while creating or editing your Scorecard, if the Scorecard has more than one level. Click the arrows on the right side to reorder them:

​

Step 3: Create a rule

There are two methods for building a rule:

• Using the form builder
• Via the CQL editor

The form is the fastest option, as you can choose from pre-configured rules for each integration. The CQL editor is best when writing complex rules or accessing data from multiple sources. Expand the tiles below for instructions on each option. You can repeat the steps above to continue adding rules to your Scorecard. You cannot duplicate a rule across levels, since developers will have already completed that task earlier. It is common, however, to have similar rules with different thresholds if you want developers to progress in stages. For example, a base level might require that the P50 latency for API requests is under 5 seconds, while a higher level may required that the same P50 is under 2 seconds.

​

Step 4: Save the Scorecard

After you have finished adding levels and rules to your Scorecard, you are ready to save it as a draft or publish it.

1. Choose whether to keep your Scorecard in draft form, visible only to users with permission to configure Scorecards. To keep it in draft form, enable the toggle next to Save as draft.
   • If you choose to keep your Scorecard in draft status, it will not appear in reports or send notifications.
   • If you choose to publish your Scorecard, it will be visible to all users who have the View Scorecards permission. Notifications, if enabled, will be triggered.
2. Click Create Scorecard.

After you save the Scorecard, it will automatically evaluate all the entities that apply based on the rules you have configured, and you will be redirected to the Scorecard’s page in Cortex.

​

Edit a Scorecard

If you have not disabled UI editing, then you can edit a Scorecard in the Cortex UI. You can edit the name, description, levels, rules, draft status, filter criteria, and the entity’s being evaluated by the Scorecard. You cannot edit a Scorecard’s unique identifier. You must have the Edit Scorecard permission. To edit:

1. Navigate to the Scorecard in Cortex.
2. Click Edit in the upper right corner of the Scorecard page:
3. Make changes to your Scorecard, then at the bottom of the page, click Save Scorecard.

Any time you edit and save your Scorecard, Cortex will automatically begin reevaluating the relevant entities to reflect your changes.

​

View Scorecards list

Click Scorecards in the main nav in Cortex. All of your organization’s Scorecards are listed under All.

​

Next steps

After you have established Scorecards, there are different steps you can take to continuously improve:

• Evaluate progress and take action: Review the Scorecard via reports or by using Cortex MCP, identify trends, and figure out how to take action on the issues you’ve identified. Learn more in Review and evaluate Scorecards.
• Target goals with Initiatives: If you have failing rules, or if you have rules that are a higher priority, you can start using Initiatives to drive progress across the organization. Initiatives allow you to prioritize specific rules within a Scorecard and set deadlines for team members to accomplish tasks. Learn more below.

​

Create Initiative from Scorecard

Initiatives allow you to prioritize specific rules and set deadlines, making sure your team members complete higher priority tasks on time. In a level-based Scorecard, you can set an Initiative that asks your team to complete all rules within a level by a certain date. You can create an Initiative while viewing a Scorecard. Note that the Scorecard must be published - i.e., not in draft mode - in order to create an Initiative for it.

1. In the upper right corner, click +Create initiative.
2. Configure the Initiative form.
   • For detailed instructions and examples, see the Initiatives documentation.

You can also create an Initiative while viewing reports for the Scorecard under its Reports tab.