Federation

• Engine: SQL (Django model / relational table)
• App: reference
• Table/Collection: reference_federation
• Verbose name: federation

Federation(created, last_edit_time, last_edit_by, is_dirty, organisation, hostname, has_dashboard, licence_period_notes, licence_year_end_day, licence_year_end_month, stats_season_start_month, renewal_window_days, membership_joining_window_days, membership_discount_day, membership_discount_month, membership_discount_amount, is_dob_public, is_club_membership_public, uses_season_bibs, has_license, buy_license, buy_license_bulk, second_claim_is_pending_transfer, highlight_expired_club_memberships, shows_ngb_licence_sync, splits_lapsed_club_members, affiliated_club_label, equality_privacy_notice, equality_consent_text, stats_user, cascading_age_groups, affiliation_licencing, affiliation_license_amount, issue_national_ids, national_id_pattern, use_team_entries, next_national_id, next_season_bib, show_external_club_id, show_athlete_list, show_clubs_list, show_coaches, show_facilities, show_rankings, show_standards, show_regions, show_series, show_stats, show_country_clubs, is_national_id_public, disclaimer, currency, require_social_security_id, language, home_country, contact_email, contact_message, create_role_on_club_membership, register_with_fed_on_signup, include_all_org_types_in_club_list, anyone_can_create_competitions, invoice_number, unattached_club_code, verify_licences, terms_and_conditions, terms_and_conditions_link)

Field	Type	Column/Key	Null/Default	PK	Choices	Notes
created	DateTimeField	created	null		—	—
last_edit_time	DateTimeField	last_edit_time	null		—	—
last_edit_by	CharField	last_edit_by	null		—	—
is_dirty	BooleanField	is_dirty	dflt=True		—	—
organisation	OneToOneField → Organisation	organisation_id	—	PK	—	—
hostname	CharField	hostname	—		—	—
has_dashboard	BooleanField	has_dashboard	dflt=False		—	—
licence_period_notes	CharField	licence_period_notes	—		—	—
licence_year_end_day	IntegerField	licence_year_end_day	null/dflt=31		—	—
licence_year_end_month	IntegerField	licence_year_end_month	null/dflt=12		—	—
stats_season_start_month	IntegerField	stats_season_start_month	null		—	Month (1-12) the stats/rankings season starts on the 1st of;…
renewal_window_days	IntegerField	renewal_window_days	null/dflt=45		—	—
membership_joining_window_days	IntegerField	membership_joining_window_days	dflt=0		—	New members joining this many days or fewer before the membe…
membership_discount_day	IntegerField	membership_discount_day	null		—	—
membership_discount_month	IntegerField	membership_discount_month	null		—	—
membership_discount_amount	DecimalField	membership_discount_amount	dflt=0.00		—	Amount to adjust price by (.e.g -5.00). Only applies if lice…
is_dob_public	BooleanField	is_dob_public	dflt=False		—	—
is_club_membership_public	BooleanField	is_club_membership_public	dflt=True		—	—
uses_season_bibs	BooleanField	uses_season_bibs	dflt=False		—	—
has_license	BooleanField	has_license	dflt=True		—	—
buy_license	BooleanField	buy_license	dflt=False		—	—
buy_license_bulk	BooleanField	buy_license_bulk	dflt=False		—	Club can pay to renew licences en masse
second_claim_is_pending_transfer	BooleanField	second_claim_is_pending_transfer	dflt=True		—	In club member lists, second-claim members are highlighted a…
highlight_expired_club_memberships	BooleanField	highlight_expired_club_memberships	dflt=False		—	In club member lists, flag members whose club membership has…
shows_ngb_licence_sync	BooleanField	shows_ngb_licence_sync	dflt=True		—	In member lists of British clubs, offer a button to sync eac…
splits_lapsed_club_members	BooleanField	splits_lapsed_club_members	dflt=False		—	Club member lists include members whose club membership has …
affiliated_club_label	CharField	affiliated_club_label	—		—	For federations whose clubs sit alongside an athlete's home …
equality_privacy_notice	TextField	equality_privacy_notice	—		—	Shown above the optional equality and inclusion questions on…
equality_consent_text	CharField	equality_consent_text	—		—	The consent box an athlete must tick to save their equality …
stats_user	BooleanField	stats_user	dflt=False		—	—
cascading_age_groups	BooleanField	cascading_age_groups	dflt=False		—	In stats/rankings, an age-group filter is inclusive: under-a…
affiliation_licencing	BooleanField	affiliation_licencing	dflt=False		—	Allow affiliated clubs to pay for licence
affiliation_license_amount	DecimalField	affiliation_license_amount	dflt=0.00		—	How much to charge?
issue_national_ids	BooleanField	issue_national_ids	dflt=False		—	Issue an autogenerated national id to new lilcensees?
national_id_pattern	CharField	national_id_pattern	—		—	Pattern for formatting national Ids
use_team_entries	BooleanField	use_team_entries	dflt=False		—	In the sense that Estonia, Malta and Cyprus do
next_national_id	IntegerField	next_national_id	dflt=0		—	Licence number to issue to next new athlete
next_season_bib	IntegerField	next_season_bib	dflt=0		—	Bib to issue to next new athlete
show_external_club_id	BooleanField	show_external_club_id	dflt=False		—	If set, we will store and display the national system's club…
show_athlete_list	BooleanField	show_athlete_list	dflt=True		—	Display list of registered athletes?
show_clubs_list	BooleanField	show_clubs_list	dflt=True		—	Display list of clubs?
show_coaches	BooleanField	show_coaches	dflt=True		—	Display coach information?
show_facilities	BooleanField	show_facilities	dflt=True		—	Display tracks and stadia in country?
show_rankings	BooleanField	show_rankings	dflt=True		—	Enable Tilastopaja rankings screens?
show_standards	BooleanField	show_standards	dflt=True		—	Show levels (e.g. Master of Sport BLR)?
show_regions	BooleanField	show_regions	dflt=False		—	Display the Regions navigation menu on the front page
show_series	BooleanField	show_series	dflt=False		—	Display the Series navigation menu on the front page
show_stats	BooleanField	show_stats	dflt=False		—	Display the Stats navigation menu on the front page?
show_country_clubs	BooleanField	show_country_clubs	dflt=False		—	Clubs list to show all clubs in the country not just those a…
is_national_id_public	BooleanField	is_national_id_public	dflt=False		—	Show the athlete's national id on public athlete pages, the …
disclaimer	IntegerField	disclaimer	null		—	Requires athletes to sign this disclaimer before renewing
currency	CharField	currency	—		—	—
require_social_security_id	BooleanField	require_social_security_id	dflt=False		—	—
language	CharField	language	—		—	—
home_country	CharField	home_country	—		ENG: England; WAL: Wales; SCO: Scotland; NIR: Northern Ireland	Filter this federation's competitions etc to related records…
contact_email	CharField	contact_email	—		—	This email will be displayed on the federation home page.
contact_message	CharField	contact_message	—		—	Text to be displayed infront of the email.
create_role_on_club_membership	BooleanField	create_role_on_club_membership	dflt=False		—	When a user completes a membership with a club under this fe…
register_with_fed_on_signup	BooleanField	register_with_fed_on_signup	dflt=False		—	When someone signsup and activates an account on fed site th…
include_all_org_types_in_club_list	BooleanField	include_all_org_types_in_club_list	dflt=False		—	Show all org types in listing.
anyone_can_create_competitions	BooleanField	anyone_can_create_competitions	dflt=False		—	Any logged-in user on this site can create a competition in …
invoice_number	IntegerField	invoice_number	null		—	What is the next invoice number.
unattached_club_code	CharField	unattached_club_code	—		—	Which club will store athletes who do not belong to any club…
verify_licences	BooleanField	verify_licences	dflt=False		—	Verify someone before they are licenced. (they still can pay…
terms_and_conditions	TextField	terms_and_conditions	null		—	What terms and conditions should be shown before payment?
terms_and_conditions_link	CharField	terms_and_conditions_link	null		—	Provide a link to terms and conditions.

Field names link to their fuller explanation below.

Field details

Click a field name in the table above to jump to its explanation. Fields with no help text yet show a prompt, and are the ones to improve by adding a help_text on the model field, then regenerating.

created

• Engine: SQL
• Type: DateTimeField
• Column/Key: created
• nullable

No help text yet — add a help_text on the model field and regenerate to fill this in.

last_edit_time

• Engine: SQL
• Type: DateTimeField
• Column/Key: last_edit_time
• nullable

No help text yet — add a help_text on the model field and regenerate to fill this in.

last_edit_by

• Engine: SQL
• Type: CharField
• Column/Key: last_edit_by
• nullable

No help text yet — add a help_text on the model field and regenerate to fill this in.

is_dirty

• Engine: SQL
• Type: BooleanField
• Column/Key: is_dirty
• default = True

No help text yet — add a help_text on the model field and regenerate to fill this in.

organisation

• Engine: SQL
• Type: OneToOneField → Organisation
• Column/Key: organisation_id
• primary key

No help text yet — add a help_text on the model field and regenerate to fill this in.

hostname

• Engine: SQL
• Type: CharField
• Column/Key: hostname

No help text yet — add a help_text on the model field and regenerate to fill this in.

has_dashboard

• Engine: SQL
• Type: BooleanField
• Column/Key: has_dashboard
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

licence_period_notes

• Engine: SQL
• Type: CharField
• Column/Key: licence_period_notes

No help text yet — add a help_text on the model field and regenerate to fill this in.

licence_year_end_day

• Engine: SQL
• Type: IntegerField
• Column/Key: licence_year_end_day
• nullable; default = 31

No help text yet — add a help_text on the model field and regenerate to fill this in.

licence_year_end_month

• Engine: SQL
• Type: IntegerField
• Column/Key: licence_year_end_month
• nullable; default = 12

No help text yet — add a help_text on the model field and regenerate to fill this in.

stats_season_start_month

• Engine: SQL
• Type: IntegerField
• Column/Key: stats_season_start_month
• nullable

Month (1-12) the stats/rankings season starts on the 1st of; blank = calendar year (e.g. 10 for an Oct-Sep season).

renewal_window_days

• Engine: SQL
• Type: IntegerField
• Column/Key: renewal_window_days
• nullable; default = 45

No help text yet — add a help_text on the model field and regenerate to fill this in.

membership_joining_window_days

• Engine: SQL
• Type: IntegerField
• Column/Key: membership_joining_window_days
• default = 0

New members joining this many days or fewer before the membership year end are taken to be joining for the FOLLOWING membership year (same idea as the renewal window, but for joins). 0 = no joining window - fall back to the renewal-window rules.

membership_discount_day

• Engine: SQL
• Type: IntegerField
• Column/Key: membership_discount_day
• nullable

No help text yet — add a help_text on the model field and regenerate to fill this in.

membership_discount_month

• Engine: SQL
• Type: IntegerField
• Column/Key: membership_discount_month
• nullable

No help text yet — add a help_text on the model field and regenerate to fill this in.

membership_discount_amount

• Engine: SQL
• Type: DecimalField
• Column/Key: membership_discount_amount
• default = 0.00

Amount to adjust price by (.e.g -5.00). Only applies if licencing before Membership Discount day/month

is_dob_public

• Engine: SQL
• Type: BooleanField
• Column/Key: is_dob_public
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

is_club_membership_public

• Engine: SQL
• Type: BooleanField
• Column/Key: is_club_membership_public
• default = True

No help text yet — add a help_text on the model field and regenerate to fill this in.

uses_season_bibs

• Engine: SQL
• Type: BooleanField
• Column/Key: uses_season_bibs
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

has_license

• Engine: SQL
• Type: BooleanField
• Column/Key: has_license
• default = True

No help text yet — add a help_text on the model field and regenerate to fill this in.

buy_license

• Engine: SQL
• Type: BooleanField
• Column/Key: buy_license
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

buy_license_bulk

• Engine: SQL
• Type: BooleanField
• Column/Key: buy_license_bulk
• default = False

Club can pay to renew licences en masse

second_claim_is_pending_transfer

• Engine: SQL
• Type: BooleanField
• Column/Key: second_claim_is_pending_transfer
• default = True

In club member lists, second-claim members are highlighted and offered a transfer instead of a licence request. Turn off where a second claim is normal, e.g. university clubs

highlight_expired_club_memberships

• Engine: SQL
• Type: BooleanField
• Column/Key: highlight_expired_club_memberships
• default = False

In club member lists, flag members whose club membership has lapsed

shows_ngb_licence_sync

• Engine: SQL
• Type: BooleanField
• Column/Key: shows_ngb_licence_sync
• default = True

In member lists of British clubs, offer a button to sync each athlete's EA/WA/NIA/SA licence

splits_lapsed_club_members

• Engine: SQL
• Type: BooleanField
• Column/Key: splits_lapsed_club_members
• default = False

Club member lists include members whose club membership has lapsed, in a separate 'Lapsed Club Members' table

affiliated_club_label

• Engine: SQL
• Type: CharField
• Column/Key: affiliated_club_label

For federations whose clubs sit alongside an athlete's home club, e.g. 'University' or 'Area Club'. If set, athlete pages get a row with this label listing the athlete's current memberships of this federation's affiliated clubs. Leave blank for no row

equality_privacy_notice

• Engine: SQL
• Type: TextField
• Column/Key: equality_privacy_notice

Shown above the optional equality and inclusion questions on athlete profiles. A blank line starts a new paragraph; web addresses become links

equality_consent_text

• Engine: SQL
• Type: CharField
• Column/Key: equality_consent_text

The consent box an athlete must tick to save their equality answers. Leave blank for a standard wording

stats_user

• Engine: SQL
• Type: BooleanField
• Column/Key: stats_user
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

cascading_age_groups

• Engine: SQL
• Type: BooleanField
• Column/Key: cascading_age_groups
• default = False

In stats/rankings, an age-group filter is inclusive: under-age groups also match younger groups (U16 marks show under U18), masters groups also match older groups (V55 marks show under V50)

affiliation_licencing

• Engine: SQL
• Type: BooleanField
• Column/Key: affiliation_licencing
• default = False

Allow affiliated clubs to pay for licence

affiliation_license_amount

• Engine: SQL
• Type: DecimalField
• Column/Key: affiliation_license_amount
• default = 0.00

How much to charge?

issue_national_ids

• Engine: SQL
• Type: BooleanField
• Column/Key: issue_national_ids
• default = False

Issue an autogenerated national id to new lilcensees?

national_id_pattern

• Engine: SQL
• Type: CharField
• Column/Key: national_id_pattern

Pattern for formatting national Ids

use_team_entries

• Engine: SQL
• Type: BooleanField
• Column/Key: use_team_entries
• default = False

In the sense that Estonia, Malta and Cyprus do

next_national_id

• Engine: SQL
• Type: IntegerField
• Column/Key: next_national_id
• default = 0

Licence number to issue to next new athlete

next_season_bib

• Engine: SQL
• Type: IntegerField
• Column/Key: next_season_bib
• default = 0

Bib to issue to next new athlete

show_external_club_id

• Engine: SQL
• Type: BooleanField
• Column/Key: show_external_club_id
• default = False

If set, we will store and display the national system's club ID

show_athlete_list

• Engine: SQL
• Type: BooleanField
• Column/Key: show_athlete_list
• default = True

Display list of registered athletes?

show_clubs_list

• Engine: SQL
• Type: BooleanField
• Column/Key: show_clubs_list
• default = True

Display list of clubs?

show_coaches

• Engine: SQL
• Type: BooleanField
• Column/Key: show_coaches
• default = True

Display coach information?

show_facilities

• Engine: SQL
• Type: BooleanField
• Column/Key: show_facilities
• default = True

Display tracks and stadia in country?

show_rankings

• Engine: SQL
• Type: BooleanField
• Column/Key: show_rankings
• default = True

Enable Tilastopaja rankings screens?

show_standards

• Engine: SQL
• Type: BooleanField
• Column/Key: show_standards
• default = True

Show levels (e.g. Master of Sport BLR)?

show_regions

• Engine: SQL
• Type: BooleanField
• Column/Key: show_regions
• default = False

Display the Regions navigation menu on the front page

show_series

• Engine: SQL
• Type: BooleanField
• Column/Key: show_series
• default = False

Display the Series navigation menu on the front page

show_stats

• Engine: SQL
• Type: BooleanField
• Column/Key: show_stats
• default = False

Display the Stats navigation menu on the front page?

show_country_clubs

• Engine: SQL
• Type: BooleanField
• Column/Key: show_country_clubs
• default = False

Clubs list to show all clubs in the country not just those affilicated with the federation.

is_national_id_public

• Engine: SQL
• Type: BooleanField
• Column/Key: is_national_id_public
• default = False

Show the athlete's national id on public athlete pages, the athlete list and the athlete download

disclaimer

• Engine: SQL
• Type: IntegerField
• Column/Key: disclaimer
• nullable

Requires athletes to sign this disclaimer before renewing

currency

• Engine: SQL
• Type: CharField
• Column/Key: currency

No help text yet — add a help_text on the model field and regenerate to fill this in.

require_social_security_id

• Engine: SQL
• Type: BooleanField
• Column/Key: require_social_security_id
• default = False

No help text yet — add a help_text on the model field and regenerate to fill this in.

language

• Engine: SQL
• Type: CharField
• Column/Key: language

No help text yet — add a help_text on the model field and regenerate to fill this in.

home_country

• Engine: SQL
• Type: CharField
• Column/Key: home_country
• choices: ENG: England; WAL: Wales; SCO: Scotland; NIR: Northern Ireland

Filter this federation's competitions etc to related records tagged with the included value. GBR only!

contact_email

• Engine: SQL
• Type: CharField
• Column/Key: contact_email

This email will be displayed on the federation home page.

contact_message

• Engine: SQL
• Type: CharField
• Column/Key: contact_message

Text to be displayed infront of the email.

create_role_on_club_membership

• Engine: SQL
• Type: BooleanField
• Column/Key: create_role_on_club_membership
• default = False

When a user completes a membership with a club under this federation, it should also create a federation registration role.

register_with_fed_on_signup

• Engine: SQL
• Type: BooleanField
• Column/Key: register_with_fed_on_signup
• default = False

When someone signsup and activates an account on fed site then immediately create fed role.

include_all_org_types_in_club_list

• Engine: SQL
• Type: BooleanField
• Column/Key: include_all_org_types_in_club_list
• default = False

Show all org types in listing.

anyone_can_create_competitions

• Engine: SQL
• Type: BooleanField
• Column/Key: anyone_can_create_competitions
• default = False

Any logged-in user on this site can create a competition in this country without approval.

invoice_number

• Engine: SQL
• Type: IntegerField
• Column/Key: invoice_number
• nullable

What is the next invoice number.

unattached_club_code

• Engine: SQL
• Type: CharField
• Column/Key: unattached_club_code

Which club will store athletes who do not belong to any club?

verify_licences

• Engine: SQL
• Type: BooleanField
• Column/Key: verify_licences
• default = False

Verify someone before they are licenced. (they still can pay for licence but are not fully licenced)

terms_and_conditions

• Engine: SQL
• Type: TextField
• Column/Key: terms_and_conditions
• nullable

What terms and conditions should be shown before payment?

terms_and_conditions_link

• Engine: SQL
• Type: CharField
• Column/Key: terms_and_conditions_link
• nullable

Provide a link to terms and conditions.

Generated by docs_models management command for SQL.