Outcomes - Custom Processing Parameters

1 Overview

An outcome has a number of custom parameters for various parts of the bxp engine that can be included.

Main Menu > Form Management > Form - Outcome Manager > Outcome - Edit > Choose the form > Choose the outcome > Data Management >

2 MetaData Programs

MetaData parameters

These are the ability to execute a MetaData program.

Each program is split by [--Z--]

Each parameter is split by [--Y--]

The first parameter must be the Program Id. All subsequent parameters within the [--Z--] represent (parameter field, value) pairs to pass to the program.

The structure of this parameter string is handled using the "Modify" button available to the right of the field.

3 Custom Processing Parameters

Custom Processing parameters

These are prescribed data functions. Multiple functions can be put in here separated by [ [--a--]]

Within each function each parameter being separated by [ [--b--]]

The current implemented functions are:

• eCourse
• Gamification
• Gamification2
• Lister

3.1 Lister

Data : Lister[ [--b--]]intClient_Id[ [--b--]]Title[ [--b--]]Description[ [--b--]]Date[ [--b--]]Category[ [--b--]]Id1[ [--b--]]Id2[ [--b--]]Id3[ [--b--]]Id4[ [--b--]]eCourse[ [--a--]]

• Parameter(0) - Function, should always be Lister
• Parameter(1) - Id of user the listee is going to
• Parameter(2) - Title of the listee
• Parameter(3) - Description for the listee (Notes)
• Parameter(4) - Deadline date
• Parameter(5) - Category
• Parameter(6) - Linker 1 Id
• Parameter(7) - Linker 2 Id
• Parameter(8) - Linker 3 Id
• Parameter(9) - Linker 4 Id
• Parameter(10) - eCourse Link

Replacements supported:

• Supports --strCDA_X_field_y_Z-- notation replacement
• intClient_Id is the Id of the current user, must have -- notation

3.2 Gamification

Data : Gamification[ [--b--]]SchemeId[ [--b--]]Points[ [--b--]]Title[ [--b--]]Data[ [--b--]]Private[ [--a--]]

• Parameter(0) - Function, should always be Gamification
• Parameter(1) - Scheme Id
• Parameter(2) - Points
• Parameter(3) - Scheme Title
• Parameter(4) - Data
• Parameter(5) - Public/Private

The points can be a number or, using the -- notation CDA field in the record.

3.3 Gamification2

Data : Gamification2[ [--b--]]SchemeId[ [--b--]]Points[ [--b--]]Title[ [--b--]]Data[ [--b--]]Private[ [--a--]]

• Parameter(0) - Function, should always be Gamification2
• Parameter(1) - Scheme Id
• Parameter(2) - Points
• Parameter(3) - Scheme Title
• Parameter(4) - Data
• Parameter(5) - Public/Private
• Parameter(6) - Field
• Parameter(7) - Value
• Parameter(8) - Condition

The points can be a number or, using the -- notation CDA field in the record.

For the conditions not all combinations are possible. N/P, stands for a Not Possible combination.

Matching	Numeric	Date	Text
Exact match	Yes	Yes	Yes
Like	N/P	N/P	Yes
Starts with	Yes	Yes	Yes
Ends with	Yes	Yes	Yes
Greater Than	Yes	Yes	N/P
Less Than	Yes	Yes	N/P
Not (Exact match)	Yes	Yes	Yes
Not Like	N/P	N/P	Yes

3.4 eCourse

Data : eCourse[ [--b--]]Engine[ [--b--]]Type[ [--b--]]BookId[ [--b--]]ChapterId[ [--b--]]PageId[ [--a--]]

• Parameter(0) - Function, should always be eCourse
• Parameter(1) - Engine, for control
• Parameter(2) - Type, must be Read or Edit
• Parameter(3) - Book Id to be accessed
• Parameter(4) - Chapter Id to be accessed
• Parameter(5) - Page Id to be accessed

Engine must have one of a number of keywords

• All: Logging of this outcome unlocks the eCourse
• Pass: If an Examination or Quality Assurance type form is "Passed", the eCourse unlocks

Type: Edit will also give Read permissions

• If only a book Id is given Book level access will be granted
• If a Book and Chapter Id are given, then Chapter level access will be granted.
• If a Book, Chapter and Page Id are given, then Page level access will be granted.

Permission is only give to the user logging the record.

As this is a security event it will automatically add to the AuditLog as "Form eCourse Unlock"