Run a campaign

A campaign follows one or more rules across your components until a deadline, and shows what still fails. Use it for a clean-up with a date: "every component documented by the end of the year".

Before you start

You need to be an administrator, and the rule you want to follow must exist as an assessment (Create a compass).

🚩 Create the campaign

1. In Administration, under INTELLIGENCE, click Compass, then the Campaigns tab.

2. Click Create Campaign (or Create my first campaign on an empty list).

3. Details: fill in the form, then click Next.

   Field	What to write	Example
   Name	The name of the campaign	Docs by year end
   Owner	The team in charge	platform-team
   Description	The goal	Every component documented.
   Start Date	The first day
   End Date	The deadline	2026-12-31

4. Checks: in Datasource, choose Catalog. In Checks, choose the rule to follow, for example Has documentation. Click Next.

5. Filters: choose the components concerned (Entity Kind, Entity Type, Owner (optional)). Click Next.

6. Milestones: click Add Milestone, then give it a Name, a Target value (%) and a Due Date. Click Next.

7. Notifications: tick when Astrolabe must notify: when the campaign starts, when it ends, when it is cancelled, when a milestone is reached. Click Next.

8. Review: read the summary, then click Save.

The campaign appears on the Campaigns tab with its status Active, the days left, a progress bar, the number of checks and of components.

👀 Follow it

1. Open the Compass page (the link of a compass score, see See the scores of all components), then the Campaigns tab.

2. Click the campaign. You see Progress, Days Left, Components, Checks Completed, Completion Rate, the Checks, a Timeline and the table of Components.

✅ That's it!

Next: Add the Compass card to your dashboard.