Module:Affiliate Indicators

Module documentation

It is NOT recommended to edit this module directly. Please visit the WAD Portal and submit affiliate indicators programs via the OOUI forms (by clicking on "Submit affiliate indicators" button).

This module holds the Affiliates Indicators data submitted by M&E staff.

Usage[edit]

Each entry looks like this:

	{
		unique_id = 'ntgu5059jvf',
		affiliate_code = 'ZA',
		group_name = 'Wikimedia South Africa',
		start_date = '01/12/2020',
		end_date = '31/12/2020',
		no_of_donations = '7',
		donation_renewal_rate = '8',
		index_score_donor_satisfaction = '7',
		members_reported = '8',
		membership_duration = '7',
		net_members_yoy = '7',
		index_score_member_satisfaction = '7',
		pp_score = '8',
		net_no_of_partners_yoy = '7',
		index_score_partner_satisfaction = '7',
		revenue_reliability = '7',
		budget_surpluses = '8',
		overhead_cost_total_budget = '7',
		liquid_months = '8',
		programs_in_reporting_month = '8',
		average_program_frequencies = '7',
		program_success_rate = '6',
		membership_to_program_threshold = '7',
		no_of_partnerships = '7',
		average_age_of_partnerships = '7',
		affiliate_satisfaction_level = '8',
		prevalence_services_to_members = '7',
		board_level_role_understanding = '6',
		board_diversity_index = '7',
		board_training_opportunities = '8',
		employee_training_plan_available = 'Yes',
		level_role_understanding_members = '6',
		dos_stamp = '2020-12-08T23:10:43.034Z',
	},

Syntax[edit]

First, a note on the general syntax: editing these entries is comparable to editing templates on Wikipedia such as infoboxes, but with a few key differences:

Each "block" is wrapped in curly brackets, with a comma following each entry, as you can see above.
To add a new entry, add a block like above below the last entry, but before the final } on the bottom of the module that closes off the whole thing.
Each value after the equals sign has to be surrounded in single quote marks. Here we use single-quotes instead of double quotes. If, however, you want to use an apostrophe, you will need to escape it with a backslash. For example: Wikimedia\'s mission is to make knowledge available to everyone.
dm_structure is a special key that takes as value and array and this in Lua is done with curly braces {} and it's comma separated to distinct the values from one another.
Indenting is not strictly necessary but it does look nice.

Parameters[edit]

unique_id is used to distinguish programs per affiliate health indicator. This is unique for each health indicator submitted
affiliate_code: unique affiliate code related to the affiliate.
group_name is the group name of the affiliate e.g. Wikimedia South Africa.
start_date: state date of the affiliate indicator that is being submitted.
end_date: end date of the affiliate health indicator being submitted.
no_of_donations: number of donations received by the affiliate.
donation_renewal_rate: donation renewal rate for the related health indicator.
index_score_donor_satisfaction: index score donation satisfaction.
members_reported: members reported by the affiliate.
membership_duration: member duration
net_members_yoy: net members year on year reported by the affiliate.
index_score_member_satisfaction: index score member satisfaction.
pp_score: program to partner score.
net_no_of_partners_yoy: net number of partners year on year.
index_score_partner_satisfaction: index score of partnership satisfaction.
revenue_reliability: revenue reliability.
budget_surpluses: any budget surpluses related to the affiliate.
overhead_cost_total_budget: over head cost of total budget if available.
liquid_months: liquid months.
programs_in_reporting_month: programs reported in the set months.
average_program_frequencies: average programs frequencies.
program_success_rate: rate of success of programs run by the affiliate.
membership_to_program_threshold: membership to program threshold.
no_of_partnerships: no of partnership reported by the affiliate.
average_age_of_partnerships: the average age of each partnership/partnerships reported by the affiliate
affiliate_satisfaction_level: affiliate satisfaction level.
prevalence_services_to_members: prevalence services to member ratio.
board_level_role_understanding: level in which the board roles are being understood
board_diversity_index: board diversity index.
board_training_opportunities: board training opportunities if available.
employee_training_plan_available: employee training plan(s) available.
level_role_understanding_members: level at which members understand their role in the affiliate.
dos_stamp: date of submission time stamp.

Translation[edit]

The strings of text presented on the Affiliate Health Indicators Form are stored in Template:i18n/Reports and can be translated through the Translate interface.

Note that this module stores English versions. To update English text, you should update this module directly.

Even if you are editing this module by hand, there is no need to update Template:i18n/Reports by hand, (however, if you see that Template:i18n/Reports needs to be marked for translation, you are welcome to do so!)

return {
}