This space is archived
For current information please use the current ExamSys documentation
XML Lookup
Description
This allows user lookup from XML sources.
Config Options
Config Option | Description |
---|---|
base_url | The base of any urls prepend on urls in other sections |
userlookup | an array of configurations for the userlookup part of the xml import |
modulelookup | an array of configurations for the modulelookup part of the xml import |
restrict | an associative array of fields and contents that need to match if this plugin is to run |
userlookup subarray
Config Sub-Option | Description |
---|---|
url | The url for this userlookup (can be file path etc) |
mandatoryurlfields | An array of what fields in the lookup are required before this is useable |
urlfields | An associative array of get parameter and the corresponding lookup field name |
xmlfields | An associative array of the XML field name and the corresponding lookup field name |
rawxmlfields | An associative array of the XML field name and the corresponding lookup field name to be stored in the raw xml format for later post processing |
oneitemreturned | boolean indication of if only one item should come back from this search |
override | an associative array of the lookup field names that this will override if set to true |
storeprepend | when storing all info in the lookupobject what should this module prepend the field names with |
failfields | an associative array of fields that indicate a failure and where to store this |
modulelookup subarray
Config Sub-Option | Description |
---|---|
url | The url for this userlookup (can be file path etc) |
mandatoryurlfields | An array of what fields in the lookup are required before this is useable |
urlfields | An associative array of get parameter and the corresponding lookup field name |
xmlfields | An associative array of the XML field name and the corresponding lookup field name |
rawxmlfields | An associative array of the XML field name and the corresponding lookup field name to be stored in the raw xml format for later post processing |
oneitemreturned | boolean indication of if only one item should come back from this search |
override | an associative array of the lookup field names that this will override if set to true |
storeprepend | when storing all info in the lookupobject what should this module prepend the field names with |
failfields | an associative array of fields that indicate a failure and where to store this |
filter | The xpath xml filter string needed to filter things |
Callback Sections
This will register and try to use the userlookupxmltranslate callback to do a transcode of the xml (which is parsed straight to it) before processing it