Create, view, update, and delete scorecards

Create a scorecard

In Compass, you can create scorecards to measure the health of your components based on your unique requirements.

Creating your own scorecards enables you to:

• define company-wide standards and policies to ensure that all teams are aiming for the same standards

• define team-level standards to ensure they follow their own best practices, in addition to the company-wide standards

Before you begin

• If your site uses a restricted permission policy, you must be the owner of the scorecard you're changing or a product admin.

• Understand the different methods of applying scorecards so that you can apply scorecards using a method that makes sense for your team and the criteria you want to enforce on your components

Create a scorecard from the scorecard library

You can create a scorecard from the scorecard library or from scratch.

To create a scorecard from the scorecard library:

1. In Compass, select Health from the top navigation.
2. Select Create scorecard.
3. Select a library scorecard.
4. Enter the scorecard's Name.
5. To edit the scorecard's application model and criteria, select Edit. Otherwise, select Create.

Library scorecards

The library includes templates for getting started with scorecards, including Software quality starter, Component readiness, and DevOps health. More will be added over time.

Software quality starter

This scorecard helps you get started tracking key software quality metrics. You can add or remove metrics from this scorecard to fit your organization’s goals.

The scorecard has the following criteria and weight for each criterion:

Component readiness

The Component readiness scorecard ensures that component details are ready for development teams to reference in the catalog.

The scorecard has the following criteria and weight for each criterion:

DevOps health

The DevOps health scorecard helps your team track cycle time, deployment frequency, and more to measure your teams’ DevOps health.

The scorecard has the following criteria and weight for each criterion:

Create a scorecard from scratch

To create a scorecard from scratch:

1. In Compass, select Health from the top navigation.
2. Select Create scorecard.
3. Select Create from scratch.
4. Enter the scorecard’s Name and Description.
5. Select an Owner. Start typing a name and select the user from the list.
   • An owner is someone who is an expert in the subject area and can be the point of contact. Adding an owner is optional, but we recommend you add one.
6. Select a Component type.
   • The scorecard becomes available for the components of this type.
7. Choose how you want this scorecard applied:
   • To all components of a selected type
   • Manually to individual components
   • By a component label
8. If you selected to apply the scorecard using a component label, search and select a component label from the dropdown menu that appears.
9. Select Next.
10. Under Criteria, select a criterion from the list and enter a percentage that reflects its importance.
    • You must add at least one criterion. The sum of the percentages for all criteria must be 100%.
11. If you need to add another criterion, select Add criterion. Then select a criterion and enter its percentage.
12. Select Create.

If the scorecard is applied to all components of a selected type, Compass implicitly applies it to all components with a matching component type that you set when you created the scorecard. Scorecards applied via component label are also automatically applied, matching components with that label. A scorecard set to be applied manually can now be applied to individual components from their details page.

Publishing scorecards

All scorecards are created as drafts. To view scorecard drafts, Select Health from the top navigation in Compass and scroll down to the list of scorecards. You can filter by State.

To publish a draft scorecard:

1. Open the scorecard and look for the Publish button at the top right of the screen.
2. Click Publish.

You may see a warning if you have components that aren’t receiving data required for this scorecard. We recommend completing setup before publishing, but you can still publish without completing the data connection if desired.

Any user with the Edit Scorecards permission can publish scorecards. Once a scorecard it published, it cannot be moved back to draft.

Delete a scorecard

You can delete scorecards that you no longer want to use.

To delete a scorecard:

1. In Compass, select Health from the top navigation.
2. Locate the scorecard on the Scorecards page then select Delete on it.
3. Select Delete on the confirmation dialog. The scorecard no longer applies to any associated components and no longer exists in Compass.

Methods of applying scorecards

You choose the method of applying the scorecard when you create a scorecard using the field How should this scorecard be applied?

Scorecards in Compass can be applied using one of the following methods:

All selected type(s) of components

This method allows you to apply scorecards to all components of selected type(s), where Compass implicitly applies it to all components with a matching component type that you set when you created the scorecard.

Use this method to apply organization-wide criteria to components and ensure that all teams are following the same operational best practices.

Individual selected types of components

This method is a manual way to apply scorecards, where a component’s type matches the component type that you set in the scorecard’s settings. These scorecards are not mandatory but are the ones that your organization recommends the teams use for all applicable components.

Use this method to apply criteria defined by cross-product or platform teams, such as SRE, security, or DevOps, to components of a particular type.

By a component label

This method of applying scorecards is based on component labels, where a component’s type and component label matches the component type and label that you set when you created the scorecard. These scorecards are not mandatory across the organization, but you can use them for specific components as per your needs.

Use this method to bulk apply scorecards to components of selected type(s) in a more granular way, or apply using labels that match your team or organization structure, categorization, or specific groups of people.

By a component tier

This method of applying scorecards is based on component tier, where a component's type and tier match the type and tier that you set when you created the scorecard. These scorecards are not mandatory across the organization, but you can use them for specific components as per your needs.

Use this method to bulk apply scorecards to components of selected type(s) in a more granular way, or apply using tiers that match your team's prioritization or importance of component(s).

Use regular expressions in scorecard criteria

Use regular expressions (regex) in scorecard criteria to set up policies that specific links be added to components.

A scorecard criterion with regex validation compares the links of the particular type on a component with the regex you provide. The criterion is met when at least one link or its display text matches the regex.

Example

Suppose you want to set up a policy that every service component has a documentation link to a disaster recovery plan. In that case, you can add a scorecard criterion for the Documentation field with regex as \bdisaster\b.*\brecovery\b. This criterion passes when two separate words — disaster and recovery — case-insensitive, but in that order, are part of a documentation link or its display text.