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 OptionDescription
base_urlThe base of any urls prepend on urls in other sections
userlookupan array of configurations for the userlookup part of the xml import
modulelookupan array of configurations for the modulelookup part of the xml import
restrictan associative array of fields and contents that need to match if this plugin is to run

userlookup subarray

Config Sub-OptionDescription
urlThe url for this userlookup (can be file path etc)
mandatoryurlfieldsAn array of what fields in the lookup are required before this is useable
urlfieldsAn associative array of get parameter and the corresponding lookup field name
xmlfieldsAn associative array of the XML field name and the corresponding lookup field name
rawxmlfieldsAn 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
oneitemreturnedboolean indication of if only one item should come back from this search
overridean associative array of the lookup field names that this will override if set to true
storeprependwhen storing all info in the lookupobject what should this module prepend the field names with
failfieldsan associative array of fields that indicate a failure and where to store this

modulelookup subarray

Config Sub-OptionDescription
urlThe url for this userlookup (can be file path etc)
mandatoryurlfieldsAn array of what fields in the lookup are required before this is useable
urlfieldsAn associative array of get parameter and the corresponding lookup field name
xmlfieldsAn associative array of the XML field name and the corresponding lookup field name
rawxmlfieldsAn 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
oneitemreturnedboolean indication of if only one item should come back from this search
overridean associative array of the lookup field names that this will override if set to true
storeprependwhen storing all info in the lookupobject what should this module prepend the field names with
failfieldsan associative array of fields that indicate a failure and where to store this
filterThe 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