The rule for AllChildrenPassed is displayed in the following format when managing advanced rules:

this.AllChildrenPassed(string uiLevel, string uiCode, bool immediateChildrenOnly, bool, thisProgrammeOnly)

You should specify:

• The UI level(s) (that is: the code(s) for the curriculum levels for which outcomes are to be included in the rule calculation)

• The UI codes for which this rule applies, and whether the rule applies to immediate children only, or whether any levels lower than that (for example: grandchildren or great grandchildren)

The thisProgrammeOnly parameter should be set to true if using the qualification code functionality to consider academic history items directly linked to the programme of study via this code.

Examples

The result of this rule is driven by outcomes, so only units that the learner has undertaken in their programme of study must be passed, regardless of how many items are linked at curriculum level or considered.

The rule for AllUIChildrenPassed is displayed in the following format when managing advanced rules:

this.AllUIChildrenPassed(string uiCode, bool immediateChildrenOnly)

You should specify:

• The UI level(s) (that is: the code(s) for the curriculum levels for which outcomes are to be included in the rule calculation)

• The UI codes for which this rule applies

• Whether the rule applies to immediate children only or whether any lower levels (for example: grandchildren or great grandchildren) should be considered

The thisProgrammeOnly parameter should be set to true using the qualification code functionality to restrict consideration to academic history items directly linked to the programme of study via a linked unit offering or linked course, or false if all academic history is to be considered.

Examples

The result of this rule is driven by the curriculum, so a learner must have a passed outcome for each of the children linked to the specified UI code.

The rule for GetNumberOfCreditsFromUILevel is displayed in one of the following formats when managing advanced rules:

• this.GetNumberOfCreditsFromUILevel (string uiLevel, int creditLevel, bool thisLevelOrHigher)

  or

• this.GetNumberOfCreditsFromUILevel (string uiLevel, int creditLevel, bool thisLevelOrHigher, string uiCodes)

You should specify:

• The UI level(s) (that is: the UI level code for the curriculum levels for which outcomes are to be included in the rule calculation)

• The qualification level that should be considered and whether it should be considered in isolation, for the specified level or for higher levels

If required, you can also specify the exact UI codes for which outcomes should be considered.

Examples

The rule for AllUILevelOutcomesArePassed is displayed in one of the following formats when managing advanced rules:

• this.AllUILevelOutcomesArePassed(string uiLevel)
• this.AllUILevelOutcomesArePassed(string uiLevel,string uiCodes)

You should specify the UI level(s) (for example: the UI level code for the curriculum levels for which outcomes are to be included in the rule calculation).

If required, you can also specify the exact UI codes for which outcomes should be considered.

Examples

The rule for Minimum Average Value is displayed in one of the following formats when managing advanced rules:

• this.MinimumAverageValue(string uiLevel,bool includeLowerUILevels,bool thisProgrammeOnly)
• this.MinimumAverageValue(string uiLevel,bool includeLowerUILevels,bool thisProgrammeOnly,string uiCodes)

You should specify:

• The UI level across which the average is to be taken

• Whether the rule applies to only the UI level specified or for lower UI levels in the hierarchy

• An optional ability to list specific UI codes to include in the calculation

The thisProgrammeOnly parameter should be set to true if using the qualification code functionality to consider academic history items directly linked to the programme of study via this code.

Examples

The average value is calculated over the outcomes that have been undertaken by the learner (for example: if five UI codes are listed, of which the learner has taken three, the average value is calculated over the three they have taken).

The rule for WeightedAggregateValue is displayed in one of the following formats when managing advanced rules:

this. WeightedAggregateValue(string uiLevel,string creditsAndWeightingPerCreditLevel)

You should specify:

• The UI levels across which the weighted average is to be taken

• The qualification level, the total number of credits to be considered at that level and the percentage weighting contribution that the result should return for the final calculation result

Note that this rule also includes the following optional parameters:

• When specified, thisLevelOrHigher defines whether to count credits at higher level than specified. If not specified, a value of False is used, so only credits at the specified level are considered.

• When specified, reuseOutcomes defines whether to re-use outcome results to get the weighted average. If not specified, a value of True is used. That is, outcome results can be re-used.

Examples

Each individual unit is also weighed against the total credits per level value using its own credit weighting, and the resulting value then weighted using the weighting values specified in the rule.

LEVEL 5

LEVEL 6

If the rule says:

this.WeightedAggregateValue("5,120,40;6,120,60") >=65

This means that the final value needs to be calculated using 40% of the Level 5 module aggregate and 60% of the Level 6 module aggregate. For example:

• Level 5 - 68.08 * 0.40 = 27.23
• Level 6 - 71.34 * 0.60 = 42.80

The final result is 70.03, so the learner would achieve a pass in this scenario.

The rule for IsPassedValue is displayed in the following format when managing advanced rules:

this.IsPassedValue(string UI Level, Total Credits, Level, Minimum Result in Range, Max result in Range, Only this level or higher)

You should specify:

• The UI level(s) (that is: the code(s) for the curriculum levels for which outcomes are to be included in the rule calculation)

• The total credits to be considered for the rule

• The minimum outcome result of the range

• The maximum result of the range

• The register level

• Whether this rule is for just the set level or the set level and above

Example

This rule calculates the total number of passed components a learner has achieved for a course type - Mandatory, Optional, or Elective. Defined at the award and unit instance level. You can also add parameters to specify whether courses must be completed at a single education level or across multiple levels.

The rule for GetNumberOfUILevelPassed is displayed in one of the following formats when managing advanced rules:

• this.GetNumberOfUILevelPassed(TribalTech.EBS.Modules.AwardsManager.Interface.CourseType.courseType, string uiLevel)

• this.GetNumberOfUILevelPassed(TribalTech.EBS.Modules.AwardsManager.Interface.CourseType.courseType,string uiLevel,int level,bool thisLevelOrHigher)

Examples

This rule calculates the total number of passed components at the Award and unit instance level.

The rule for GetNumberOfUILevelPassed is displayed in one of the following formats when managing advanced rules:

• this.TotalUILevelPassed(string uiLevel)

Example

This rule calculates the number of immediate children, or both immediate and lower-level children, associated with the specified unit instances. You can add parameters to limit or require the number of passes per unit instance, either as a specific value or within a defined range.

The rule for GetNumberPassed is displayed in one of the following formats when managing advanced rules:

• this.GetNumberPassed(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetNumberPassed(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates the number of immediate children, or both immediate and lower-level children, passed for the specified unit instances, excluding credited components. You can add parameters to limit or require the number of passes per unit instance, either as a specific value or within a defined range.

The rule for GetNumberPassedNoCredit is displayed in the following format when managing advanced rules:

• this.GetNumberPassedNoCredit(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates how many individual unit instance formula expressions have been passed from a specified list.

For example, if five unit instances are listed, each with a defined numeric range of required passes, the learner must meet the criteria for at least three of those unit instance formulas to pass the rule.

The rule for GetPassedTotal is displayed in the following formats when managing advanced rules:

• this.GetPassedTotal(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetPassedTotal(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates the total weighting (credit) from immediate children, or from both immediate and lower-level children, of the specified unit instances. You can add parameters to limit or require the total weighting per unit instance, either as a specific value or within a defined range.

The rule for GetNumberWeight is displayed in the following formats when managing advanced rules:

• this.GetNumberWeight(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetNumberWeight(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates the total maximum hours from immediate children, or from both immediate and lower-level children, of the specified unit instances. You can add parameters to limit or require the total hours per unit instance, either as a specific value or within a defined range.

The rule for GetNumberMaximumHours is displayed in the following formats when managing advanced rules:

• this.GetNumberMaximumHours(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetNumberMaximumHours(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates the total theory hours from immediate children, or from both immediate and lower-level children, of the specified unit instances. You can add parameters to limit or require the total hours per unit instance, either as a specific value or within a defined range.

The rule for GetNumberTheoryHours is displayed in the following formats when managing advanced rules:

• this.GetNumberTheoryHours(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetNumberTheoryHours(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

This rule calculates the total practical hours from immediate children, or from both immediate and lower-level children, of the specified unit instances. You can add parameters to limit or require the total hours per unit instance, either as a specific value or within a defined range.

The rule for GetNumberPracticalHours is displayed in the following formats when managing advanced rules:

• this.GetNumberPracticalHours(string minmaxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly)

• this.GetNumberPracticalHours(string min,maxOutcomesPerUiPairs,bool immediateChildrenOnly,bool thisProgrammeOnly, bool includeAllOutcomes)

Note that this rule also includes the following optional parameters:

• The min and max parameters enable you to specify minimum and maximum restriction values. These parameters can be used together, or separately, to define either an upper or lower limit for components.

• When thisProgramme is set to true, components from any programme of study within the same qualification genre, identified by the qualification code, are considered. This is useful in scenarios such as top-up qualifications, where the top-up programme may not be directly linked to the original foundation degree, but components from previous study still need to be included.

• When includeAllOutcomes is set to true, all components in a learner’s academic history are considered, regardless of which programme of study they are associated with in the curriculum structure.

Examples

The rule for GetNumberOfCreditsAtLevel is displayed in one of the following formats when managing advanced rules:

this.GetNumberOfCreditsAtLevel(Y, true) >= X

Replace the Y with the required level and the X with the number of credits.

Where you enter 'true' in the parameter after the Y value, this includes all credits at Level Y and above.

Where you enter false in the parameter after the Y value, this only includes credits at Level Y but not any credits at a higher level.

Examples

The rule for GetNumberOfCreditsFromUnitStandards is displayed in one of the following formats when managing advanced rules:

this.GetNumberOfCreditsFromUnitStandards("Course code list", Y, true) >= X

Replace the course code list with a comma delimited set of course codes to which the unit standard outcomes are linked, the Y with the required level and X with the number of credits.

Where you enter 'true' in the parameter after the Y value, this includes all NZQA credits at Level Y and above.

Where you enter false in the parameter after the Y value, this only includes NZQA credits at Level Y but not any NZQA credits at a higher level.

Example

This rule calculates the total credit value a learner has achieved for either a specific education level or across the specified level and any higher levels. The calculation applies to components marked as mandatory, optional, or elective for the course type defined against the award.

The rule for GetNumberOfCreditsAtLevelForCourseType is displayed in the following format when managing advanced rules:

• this.GetNumberOfCreditsAtLevelForCourseType(intcreditLevel,boolthisLevelOrHigher,TribalTech.EBS.Modules.AwardsManager.Interface.CourseType.courseType)

Examples

This rule calculates the total number of credits a learner has earned at one or more education levels for programmes of study that aren't directly related to their current programme.

The rule for GetNumberOfCreditsFromOtherProgrammes is displayed in the following formats when managing advanced rules:

• this.GetNumberOfCreditsFromOtherProgrammes(int level,bool thisLevelOrHigher)

• this.GetNumberOfCreditsFromOtherProgrammes()

Examples

This rule calculates the total number of courses a learner has passed at one or more education levels for programmes of study that aren't directly related to their current programme.

The rule for GetNumberOfCoursesFromOtherProgrammes is displayed in the following formats when managing advanced rules:

• this.GetNumberOfCoursesFromOtherProgrammes(int level,bool thisLevelOrHigher)

• this.GetNumberOfCoursesFromOtherProgrammes()

Examples

This rule calculates the total value of practical hours from all contributing course-type components at one or more education levels. These components may come directly from the current programme of study or include components from programmes not directly linked to it.

The rule for GetPracticalHours is displayed in the following format when managing advanced rules:

• this.GetPracticalHours(bool includeOtherProgrammes,int creditLevel,bool thisLevelOrHigher)

Examples

This rule calculates the total value of theory hours from all contributing course-type components at one or more education levels. These components may come directly from the current programme of study or include components from programmes not directly linked to it.

The rule for GetTheoryHours is displayed in the following format when managing advanced rules:

• this.GetTheoryHours(bool includeOtherProgrammes,int creditLevel,bool thisLevelOrHigher)

Examples

This rule calculates the total number of credits a learner has earned at one or more education levels for programmes of study completed at another organisation.

The rule for GetNumberOfCreditsFromAnotherOrganization is displayed in the following format when managing advanced rules:

• this.GetNumberOfCreditsFromAnotherOrganization()

Examples