Skip to main content

Introduction to Policies

Policies determine how the various Competition Factory engines function and can shape the way that results are returned. Policies can be attached to the tournamentRecord, events, or to drawDefinitions within an event. They can also be passed directly into some factory methods; e.g. a Participant Policy can be passed into a method which returns particpipants and filter out attributes which are not to be displayed.

The structure of a policyDefinitions object is as follows:

{
  [policyType]: {      // e.g. 'seeding' or 'avoidance'
    policyName: 'name'  // for 'seeding' can be the provider of the policy, e.g. 'ITF' or 'USTA'
    ...attributes       // attributes relevant to the policyType
  },
  [anotherPolicyType]: {
    policyName: 'name'
    ...attributes
  },
}

Policy Types​

  • Avoidance Policy: Can be attached to drawDefinitions to specify the attriubutes by which participants should be separated
  • Participant Policy Enables participant details to be filtered to respect privacy concerns
  • Position Actions Policy: Determines valid actions for positions in a draw structure
  • MatchUp Actions Policy: Determines valid actions for matchUps (substitutions, penalties, referree, scheduling)
  • Seeding Policy: Sets seeding pattern and thresholds for number of seeds allowed for draw sizes
  • Scheduling Policy: Defines average and rest/recovery times for matchUpFormats, categoryNames, and categoryTypes
  • Round Robin Tally Policy: Configures calculations which determine participant finishing positions
  • Feed Policy: Determining the the patterns which direct participants into consolation feed rounds
  • Progression Policy: Configuration related to participant progression, e.g. automatic qualifier placement, double-exit effects
  • Round Naming Policy: Specifies how rounds of draw structures should be named
  • Scoring Policy: Restricts available matchUpFormats, defines a default and conditions for "ready to score"
  • Voluntary Consolation Policy: Specifies { winsLimit, finishingRoundLimit } for voluntary consolation eligibility
  • Competitive Bands: Determines thresholds for ROUTINE and COMPETITIVE matches in getCompetitiveProfile
  • Draws Policy: Configures either global or draw-type-specific drawTypeCoercion