Skip to main content

Campaigns

A Campaign groups one or more Rules that must be satisfied by a set of catalog items within a defined time window. Campaigns turn a snapshot evaluation into a time-bounded compliance program with a clear deadline.

A campaign declares:

  • startDate: when the campaign period begins.
  • endDate: the deadline by which all rules should be satisfied.
  • rules[]: one or more Rules, either copied from a Scorecard when the campaign is built from one (once a target level is selected, the matching rules are duplicated onto the campaign) or written directly on the campaign when it is built from scratch. Once on the campaign, the rules are independent of the source scorecard: later changes to the scorecard do not propagate.
  • scope: a target set of items defined as a view reference or a raw query (see Query Language).

The dates define the campaign's time window for reporting and audit purposes; they do not currently drive automatic evaluations (see Evaluation below).

Relationship with Scorecards​

In practice, a campaign is most often built from a Scorecard: you pick an existing scorecard and select a target level — the rules from that level downward are copied onto the campaign. The campaign keeps a link to the scorecard it originated from for audit and navigation, but the copied rules evolve independently from that point on.

It is also possible to create a campaign from scratch by defining rules directly, without referencing a scorecard.

The mental model:

  • A scorecard is the standing compliance ladder for a scope: it answers "where do we sit today?" continuously.
  • A campaign is the time-bounded push to move that scope up the ladder by a deadline.

Evaluation​

A campaign is evaluated on demand: an operator triggers a run from the Catalog Administration, and every configured rule is evaluated against the target item set (the same flow used by a standalone rule run, see Evaluation Criteria). Results are stored on the Campaign item and exposed both via the Catalog API and in the Catalog Administration.

There is no automatic re-evaluation when startDate or endDate is reached, nor when an item in scope changes: each refresh is initiated manually.

Item types involved​

Campaigns interact with a small number of catalog item types:

  • Rules: deterministic conditions evaluated against a context of items; a campaign's rules are either copied from a Scorecard or defined directly on the campaign.
  • Rule-runs: evaluations of a rule against a context of items at a given moment.
  • Scorecards: see Scorecards for the related, complementary concept.

See also​