Difference between revisions of "Outcomes - Custom Processing Parameters"
From All n One's bxp software Wixi
Philip Lacey (talk | contribs) |
Philip Lacey (talk | contribs) |
||
| Line 19: | Line 19: | ||
| − | These are prescribed data functions. Multiple functions can be put in here separated by [-- | + | These are prescribed data functions. Multiple functions can be put in here separated by [ [--a--]] |
| − | Within each function each parameter being separated by [-- | + | Within each function each parameter being separated by [ [--b--]] |
| Line 35: | Line 35: | ||
| − | Data : ''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--]]'' |
| Line 60: | Line 60: | ||
| − | Data : ''Gamification[-- | + | Data : ''Gamification[ [--b--]]SchemeId[ [--b--]]Points[ [--b--]]Title[ [--b--]]Data[ [--b--]]Private[ [--a--]]'' |
| Line 75: | Line 75: | ||
| − | Data : ''eCourse[-- | + | Data : ''eCourse[ [--b--]]Engine[ [--b--]]Type[ [--b--]]BookId[ [--b--]]ChapterId[ [--b--]]PageId[ [--a--]]'' |
Revision as of 08:42, 23 August 2015
Contents
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
These are the ability to execute a MetaData program.
3 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:
- Lister
- Gamification
- eCourse
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) - Title
- Parameter(4) - Data
- Parameter(5) - Public/Private
3.3 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.
