VALIDATION WARNING:
This schema must be validated in Text View in XML Spy. Bug: type "xs:string" already exists when validated from "Schema Design View".
Primary data schema definition fox component in format:[Application/]ComponentPath where [Application is optional] A module can reference itself a the schema.
Fox component reference in format:
[Application/]ComponentPath where [Application is optional]
Contains all interfaces for a module to describe how database selects, inserts updates, locks and native API calls are processed
A programmatic name. This name will never be presented to the user but is used to identify this module component in a programmtic sense.
Defaults to the value of the name attribute, if not specified.
A human-readable short title. The title may be presented to the user.
Defaults to the value of the title attribute, if not specified.
A short description that clearly states the purpose of the module component. The
description may be presented to the end user, if not specified.
A container for key and data items such as those used in html LOV pulldowns.
The storage location where the map set is to be stored
If the refresh-timeout is expired then the next time a map set is accessed the contents will be reloaded
for background refreshing to be enabled, the minimum refresh-timeout must be 5mins.
Y - a refresh will be performed at intervals specified by the map set refresh element settings.
N - indicates Fox will never refresh or initially populate the map set by executing the child DO command. This means its up to the developer to manually load the map set (possibly in the storage location initialization)
Call a DML interface to process database records. Ins, upd, del, lock are allowed only if the interface conatins a table tag
Specifies the Xpath pathname of context nodes to process.
The interface attribute is the name of the db-interface to use
Insert database records
Update database records
Delete database records
Lock database records for update. Overides di-interface for update tag???
overide table XML search conditions to identify records for processing
override table XML search conditions to identify records for processing indicates an Xpath expression
When purge is entered the source dom node (and all its children) will be removed. So use with care.
Deletes the the source dom node and all its children.
In the case of composite keys the parent node of the last key and allits children are deleted.
For ins or upd modes Indicates dom values should be updated with the results of update. This is useful where triggers modify the values during an update/insert. The DOM elements to be updateed are defined in the primary key tags
Call a API interface to process database records.
Specifies the pathname of context nodes to process.
The interface attribute is the name of the db-interface to use
overides default mode for API
Call a DML interface to query or lock database records.
“match” specifies the pathname of context nodes to process.
The interface attribute is the name of the db-interface to use
ovverides default mode for query
the name of the query within the interface that will be executed for each node matched from the match tag
Lock database records for update.
Used to requery existing records via primary key
Assign a textual or XPath-expression value to a specified target node or nodes list. setTarget assigns nodes that exist only, whereas initTarget creates nodes if they dont exist.
Initialise elements from a named template or from the data schema.
If initialising from the schema, schema elements can make use of the 'default' or 'fixed' value attributes.
The target(s) to initialise, relative to the current attach point. The specified target(s) may exist in the Data DOM, or refer to nodes in the Model DOM (via simple XPath) or may be a user-defined path.
Whether existing targetted nodes are initialised or new nodes are created depends
on the value of the 'method' attribute.
The name of the template, within the module, to call.
Note that all child nodes of the template are used in the initialisation
process and those nodes MUST be in the same XML namespace -
the empty namespace ("") - as the DATA/Model DOM.
The elements from the Model DOM, relative to the specified target node(s),
that are to be initialised under the target node(s).
If the method is 'new' or 'both', the minimum number of target node types
to ensure exist. Nodes may be created in order to bring the total number of
target node types up to the minimum specified.
If the method is 'new' or 'both', the maximum number of target node types
that will exist as a result of the initialise operation. The initialise operation will
never exceed the specified maximum bound when new target node(s) are created.
Depending on the value of the 'new-target-count' attribute, the number of target nodes
may be brought up to the specified maximum bound.
The initialisation method: new, augment or both (the default). The targetted
node(s) are initialised from the specified template or schema elements. The
template or schema elements will be initialised as new children of the targetted
node(s).
If the method is 'new', the 'new-target-count' attribute should be used to specify
the number of new targets required. The 'min-occurs' and 'max-occurs' attributes
may also be specified to bring the number of target node type instances up to
the specified minimum number and up to, but not exceeding, the maximum number.
If the method is 'augment', only existing target nodes will be initialised. Any
child nodes, of the targetted nodes, that do not have any content will be initialised
according to their configured initialisation attributes from the Model DOM.
For the method of 'both', which is the default method, any target nodes that
exist and any required new target node instances (refer to the 'new' and 'augment'
attributes) are initialised.
The default mode. The initialise command may potentially, depending on your
new-target-count, min-occurs or max-occurs attributes, create new instances of
the target node type and augment any existing intances it finds.
The initialise command may potentially, depending on your
new-target-count, min-occurs or max-occurs attributes, create new instances of
the target node type and ONLY initialise those new instances created.
Any existing intances of the target node type will not be initialised by this invocation
on init.
In this mode, the initialise command will only add to any existing intances of the
target node type it finds. Any descendants of existing targets will be recursively
searched and created where they do not yet exist according to the meta-model.
An industry standard if-then-else-if-else like command.
Moves elements from a named location to a new destination.
Copies elements from a named location to another location.
Map-set set operator processing - to be defined JB
Deletes and refreshes the map set from scratch regardless of timeout settings
The message to be logged.
Creates a javascript dialog box on the screen next time the page loads.
Transforms XML with an XSLT style sheet.
The source root element of the data to be transformed. This may refer to a file-type
element, in which case the content of the file (assumed to be XML) is used as
the source.
The source URI which may refer to an entry in the applications resource table, for example "xsl/continuous-usage", a resource within the WAR or EAR deployement
or an external resource on the web.
The resource is assumed to be an XSL Style Sheet for Transformation (XSLT).
The parent element under which the transformed data will be placed.
Generate a fox display and then store the output (HTML) so it can be accessed later.
Note that all database operations are currently performed in a discreet database transaction.
Usage attrs:
- state="state_name", is used to specify the display state to generate display with - when not specified current state is used.
- buffer="state_name|MODULE/buffer_name", is used to specify the starting buffer to generate - when not specified special PAGE is used.
- method="preview", the output is displayed immediately in a pop-up window - feature often used for Print Preview pop-up.
- method="storage-location", the output will be saved using a standard fox storage location. Also need attrs:
-- storage-location="storage_location_name", the name of the storage-location to use.
- method="copy-to", the output (html node) is copied to one or more DOM elements. Also need attrs:
-- copy-to-xpath="xpath", the dom nodes to copy html node to (will create dom node when does not exist).
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- url-xpath="xpath", (formally target="xpath") an element which will be assigned with the full URL string needed to access the output.
-- expires="HH:MM", duration to hold output in fox server for - after this time the url may not return the output - default 00:09.
-- client-cache="HH:MM", tells client browser to cache url page for duration, so repeated url use does not reload from server - default 00:00.
-- scope="SESSION", fixed value - reserved for future use to indicate who can access the url - currently no security restriction if have url.
-- content-type="text/html; charset=UTF-8", fixed value for output encoding mime-type - reserved for future use.
For the MS Excel methods of CSV and XLS, the type of generated cells is derived, by default, from schema mode. If the type of each cell cannot be derived from the schema model, the type and format of generated column cells may be set explicitly using the "type" and "format-spec" attributes of the generate-column specifiers. Otherwise the default generated type of each cell is "string".
- method="preview", the output is displayed immediately in a pop-up window - feature often used for Print Preview pop-up.
- method="storage-location", the output will be saved using a standard fox storage location. Also need attrs:
-- storage-location="storage_location_name", the name of the storage-location to use.
- method="copy-to", the output (html node) is copied to one or more DOM elements. Also need attrs:
-- copy-to-xpath="xpath", the dom nodes to copy html node to (will create dom node when does not exist).
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- url-xpath="xpath", (formally target="xpath") an element which will be assigned with the full URL string needed to access the output.
-- expires="HH:MM", duration to hold output in fox server for - after this time the url may not return the output - default 00:09.
-- client-cache="HH:MM", tells client browser to cache url page for duration, so repeated url use does not reload from server - default 00:00.
-- scope="SESSION", fixed value - reserved for future use to indicate who can access the url - currently no security restriction if have url.
-- content-type="text/html; charset=UTF-8", fixed value for output encoding mime-type - reserved for future use.
state="state_name", is used to specify the display state to generate display with - when not specified current state is used.
buffer="state_name|MODULE/buffer_name", is used to specify the starting buffer to generate - when not specified special PAGE is used.
- method="storage-location", the output will be saved using a standard fox storage location. Also need attrs:
-- storage-location="storage_location_name", the name of the storage-location to use.
- method="copy-to", the output (html node) is copied to one or more DOM elements. Also need attrs:
-- copy-to-xpath="xpath", the dom nodes to copy html node to (will create dom node when does not exist).
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- url-xpath="xpath", (formally target="xpath") an element which will be assigned with the full URL string needed to access the output.
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- expires="HH:MM", duration to hold output in fox server for - after this time the url may not return the output - default 00:09.
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- client-cache="HH:MM", tells client browser to cache url page for duration, so repeated url use does not reload from server - default 00:00.
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- scope="SESSION", fixed value - reserved for future use to indicate who can access the url - currently no security restriction if have url.
- method="url" (formally internal), the output is saved in fox server internally for access later via a URL. Also need attrs:
-- content-type="text/html; charset=UTF-8", fixed value for output encoding mime-type - reserved for future use.
scope="state" to set context for current state only - usually the case. scope="localised" is used only when inside fm:context-localise or fm:for-each blocks.
scope="state" to set context for current state only - usually the case. scope="localised" is used only when inside fm:context-localise or fm:for-each blocks.
scope="state" to clear context for current state only - usually the case. scope="localised" is used only when inside fm:context-localise or fm:for-each blocks.
scope="state" to clear context for current state only - usually the case. scope="localised" is used only when inside fm:context-localise or fm:for-each blocks.
Chamges the current user system-level and object-level privileges.
The defaul for system-level privileges is "*" (all); with the default for object-level privileges set to "" (none).
Comma-Seperated-Values list of system-level privileges.
An XPath expression that identifies the Universal References (URefs) of the items whose object-level priveleges are to be obtained for the current user.
Comma-Seperated-Values list of object-level privileges to check against the urefs identified by the uref-xpath for the current user.
Comma-Seperated-Values list of Universal Reference Types of objects whose object-level priveleges are to be determined for the current user.
The maximum age of the cookie, in seconds. By default, this is set to
-1 to indicate until browser shutdown.
While this can be an XPath expression it must yield a numeric value.
Logs in a portal user. The current FOX session is then owned by the specified user.
The Web User Account Login ID of the user to log in.
The password for the user account specified.
Logs out the current user from the portal.
The user is returned to the Portal Home page.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
Calls a theme in the same or another module, modally or modelessly.
A modal call shares the original browser window. A modeless call launches a new browser window that is a child of the current browser.
A called module must exit a call with the exit-module command.
The name of the module, within the specified application, to call. Defaults
to the current module.
The name of the theme. within the specified application and module, to call.
The type of module call. Must be one of:
modal - the existing browser window will be used to display the call dialog
modeless - a new window (a child of the existing browser) will be used to display
the call dialog. See windowName and windowProperties attributes.
The application mnemonic of the application whose module is to be called. Defaults
to the current application.
An xpath expression that returns a node list which are the parameters of the
module call. These parameters are passed, by value, to the called module.
A comma-separated list of 'name=value' pairs that are additional parameters to
the module call.
Example:
literalParams="type=P,no=6000"
** NOTE: This is an in-progress solution and may change in the future.
The action to be called, in the calling module, upon exit of the called module.
An xpath expression that returns a node list that identifies one or more nodes
in the calling modules data document. Any return values, from the
called module, are subsequently copied to these nodes on return from the module call.
The name of the window, if required by the fox developer.
If specified, any child popup window will have the specified name. If a child with the specifed name
already exists, the same window will be reused. This give the fox developer control
over the number and reuse of child popups.
If not specified, a unique name is generated for any child popup that results from
the module call. This guarantees that a new child window will always appear for the
call, if modeless.
Only applicable to modeless module calls. A comma-separated list of properties
of the child window that will display the module call dialog. These are
javascript properties (see javascript reference manual on 'window'
object) that specifiy the window geometry etc. etc.
Example:
windowProperties="width=200,height=600,resizable,status,toolbar,menubar"
** NOTE: This is an in-progress solution and may change in the future.
Exits the current module call.
This command should be used to physically end a module call that maps to a logical end to some business process or procedure.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
State transition command. Use this command to move between states on your bunsess workflow diagram.
This behaviour of this command is determined by the 'action' attribute:
push:
Adds a new state to the state-call stack.
Note that any previous states still exist on the stack-call stack. Any previous state will be returned to when the state added is subsequently 'popped' off the stack.
pop:
Pops off the state at the top of the state-call stack.
replace:
Replaces the topmost state, on the state-call stack, with the specified state.
Can also be used to replace all states on the state-call stack with the state specified.
Allows Y or N null is treated as a Y
BEST DEFINED A TYPE, as storage location used with different attrs (module/map-set)
Storage location sub-class for files.
A code/script block with bind variables. The code block might be a PL/SQL anonymous block or Java.
Specifies the language of the api call. Initially only PL/SQL is supported
Defrines multiple SQL queries tags to populate DOM. Up to 1 table tag to populate database from DOM and multiple API calls to make native code callouts if required
Provides lock and other processing to populate the database from DOM.
Defines the DOM source for the table tag.
Defines the DOM target for all select tags and/or Defines the DOM source for the table tag. Mandatory for non-singleton selects or if a table tag is present.
Specifies the pathname of context nodes to process in XPath format. The directory portion of this pathname must only navigate through single instance nodes. The base name part can have multiple node instances, all of which will be processed.
The Primary or composite part of the primary key. This refers to the database column name
Overrides the default sql to dom data conversion rules
The FOX dom type that this attribute maps to.
If not entered fox will attempt to resolve the type at runtime (usually string)
this is the default and should normally be specified.
It is put here for descriptive purposes only
This will operate on the node and all sub nodes.
The equivalent sql-data must be able to be cast as an xml type.
CCYYMMDD
CCYYMMDDThh:mm:ss
hh:mm:ss
The sql datatype in the database.
If not entered then FOX will try to determine the datatype at runtime
The default for all sql data.
This is not required to be specified but it included here for completenes.
Note all numeric sql datatypes will also be converted to varchar by default.
If you dont want the default conversion then specify a format mask on the source sql code
Inplies the api datatype will be converted between XMLTYPE and the datadomtype. The datadom data must be able to be cast as XML data for this to work
The column name on the sql table.
Any processing on this table will convert between the datadom-type and the sql-type
FOR-EACH actions execute in context of the target records. The for-each actions can in turn specify further DML or DO-ACTION calls.
FOR-EACH actions execute in context of the target records. The for-each actions can in turn specify further DO ACTION/DML calls
block to be before an insert
block executed after ( an insert
block executed before an update
block executed after an update
block executed before delete
block executed after a delete
Indentifies the database table to lock and/or maintain
a check sum attribute which must match the number of columns included in the DML interface. It is hoped the module specifier computes cols from requirements, rather than counting up elements with {interface}=. attributes in the module specification
Insert priviledge allowed
Update priviledge allowed
Delete priviledge allowed
In addition to the DML match tag and the rec-path match tag this tag specifies extra XML search conditions to further restrict records for processing
In additions to the DML match tag and the rec-path match tag this tag specifies extra XML search conditions to further restrict records for processing
Corresponds to ns in the ns:cols attribute of a fox element definition (to map dom columns to database columns)
Defines query operations to populate the DOM from the database and lock database rows.
Defines the DOM target for all select tags. Mandatory for non-singleton selects.
Specifies the relative path of context nodes to process. When the target name is '.' the query must select only one row. Any missing intermediate target nodes are created automatically even if the query returns no rows.
Required for QUERY AUGMENT and PURGE-SELECTED modes, when the target name is not “.”.
The PRIMARY or composite part of the primary key for the records selected. This refers to a DOM element name
Any oracle SQL statment. Input Bind variables are supported. DOM target data elements are specified as column aliases in the select statement itself or by using the into tag
Specifies input parameters to the SQL query
Specifies the name of the input bind variable.
This can be of the format :1, :2 etc or a name such as :emp_id
The xpath identifying the source node(s).
By default the data is treated as the value of the node.
This can be overridden by the datadom-type such as dom which picks up any child nodes as well
The FOX dom type that this attribute maps to.
If not entered fox will attempt to resolve the type at runtime (usually string)
this is the default and should normally be specified.
It is put here for descriptive purposes only
This will operate on the node and all sub nodes.
The equivalent sql-data must be able to be cast as an xml type.
CCYYMMDD
CCYYMMDDThh:mm:ss
hh:mm:ss
The sql datatype in the database.
If not entered then FOX will try to determine the datatype at runtime
The default for all sql data.
This is not required to be specified but it included here for completenes.
Note all numeric sql datatypes will also be converted to varchar by default.
If you dont want the default conversion then specify a format mask on the source sql code
Inplies the api datatype will be converted between XMLTYPE and the datadomtype. The datadom data must be able to be cast as XML data for this to work
Specifies output parameters from SQL to a dom target
Specifies the name of the column alias in the query.
Use this name when you want to
a) Use an xpath longer than 31 characters (in this case put it in the datadom-location)
b) Want to override the default sql /dom data conversion rules
The xpath identifying the source node(s).
By default the data is treated as the value of the node.
This can be overridden by the datadom-type such as dom which picks up any child nodes as well
The FOX dom type that this attribute maps to.
If not entered fox will attempt to resolve the type at runtime (usually string)
this is the default and should normally be specified.
It is put here for descriptive purposes only
CCYYMMDD
CCYYMMDDThh:mm:ss
hh:mm:ss
This will operate on the node and all sub nodes.
The equivalent sql-data must be able to be cast as an xml type.
The sql datatype in the database.
If not entered then FOX will try to determine the datatype at runtime
The default for all sql data.
This is not required to be specified but it included here for completenes.
Note all numeric sql datatypes will also be converted to varchar by default.
If you dont want the default conversion then specify a format mask on the source sql code
Inplies the api datatype will be converted between XMLTYPE and the datadomtype. The datadom data must be able to be cast as XML data for this to work
Any oracle SQL statment. Input Bind variables are supported. DOM target data elements are specified as column aliases in the select statement itself.
RULE1: select item set here must be a strict superset of queries select item set.
RULE2: query must return exectly one row (or zero if deleted row commmited by another session).
RULE3: the onus is on the developer/architect to get index access correct.
FOR-EACH-FETCH actions execute in context of the target records. The for-each actions can in turn specify further DML or DO-ACTION calls.
After database read and after XML DOM population of target (Y)
After database read and before XML DOM population of target (Y)
This query name must be uniqe for the interface. The name is reference in the run-queryi interface tag
Operation to apply todata at the target record.
Target modes currently are:
Target Mode Key Required Performance
(Default) AUGMENT YES unless . SLOW
PURGE-SELECTED YES unless . SLOW
PURGE-ALL NO EFFICIENT
ADD-TO NO QUICKEST
Cann be overidden at dml mode tag level
Allows a call interface to any language such as as SQL code block. APIs can receive and return DOM elements but locking, integrity and security is the responsibility of the api call and not FOX
An anonymous pl/sql block with bind variables
Specifies input/output parameters for SQL
input/output parameter direction
input from the datadom to the sql api parameter
output from the sql api parameter to the datadom
The xpath identifying the source node(s).
By default the data is treated as the value of the node.
This can be overridden by the datadom-type such as dom which picks up any child nodes as well
The FOX dom type that this attribute maps to.
If not entered fox will attempt to resolve the type at runtime (usually string)
this is the default and should normally be specified.
It is put here for descriptive purposes only
This will operate on the node and all sub nodes.
The equivalent sql-data must be able to be cast as an xml type.
CCYYMMDD
CCYYMMDDThh:mm:ss
hh:mm:ss
The sql datatype in the database.
If not entered then FOX will try to determine the datatype at runtime
The default for all sql data.
This is not required to be specified but it included here for completenes.
Note all numeric sql datatypes will also be converted to varchar by default.
If you dont want the default conversion then specify a format mask on the source sql code
Inplies the api datatype will be converted between XMLTYPE and the datadomtype. The datadom data must be able to be cast as XML data for this to work
This api name must be uniqe for the interface. The name is reference in the run-api interface tag
Operation to apply todata at the target record.
Target modes currently are:
Target Mode Key Required Performance
(Default) AUGMENT YES unless . SLOW
PURGE-SELECTED YES unless . SLOW
PURGE-ALL NO EFFICIENT
ADD-TO NO QUICKEST
Cann be overidden at dml mode tag level
Specifies the language of the api call. Initially only PL/SQL is supported
Complex do command
with verious control structures
Complex do command
with verious control structures
Validates data against schema, optionally creates missing nodes. Adds "error" nodes in context, or on summary target.
Identifies nodes to validate, defaults to current attach point.
This is a list of what should be checked during validation. Validation can be applied several times on the same data, each time with different things being checked. To keep error messages from previous validate calls, use the "clear" attribute. The default is ALL.
Validate number of node occurences within parent , validate immediate data content and nested nodes (depending on deep attribute).
Validate immediate data value, eg. validate-xpath, enumerations, map-sets, etc.
Validate number of sibling nodes (including matched node) with a common name against schema minOccurs and MaxOccurs.
Perform no validation. This can be used in conjunction with "clear" or "init" attributes to initialise validation element structures.
Y indicates missing elements may be created in order to add contextual error messages. The default is Y. When used in conjunction with check="NONE", elements are created according to cardinality rules, but no error messages are created, thus initialising slots for input.
Identifies previous error messages to remove from matched nodes, before validation begins, thus removing previous error messages. If errors are not removed first, multiple error nodes are created (which may be valid, or duplicates in error). Default is NONE.
Locates a node which is used to add summary error message nodes to. Many node contextual errors will result in at least one summary error node being created also. Any one node contextual error must always create one summary error node, so that "boolean(mypath/summary/error)" returns true if any contextual errors were identified. The default summary-target is evaluated from XPATH expression "/*/error-list". An example target might be "../../section-one/issues".
Error processing will stop when this number of errors is reached.
This number includesa any previous uncleared error and works on the whole module not just the current page
Command to remove elements from data tree
[USE WITH CAUTION] The match attribute must be specified and the builder should provide hard XPATH expressions to prevent accidental data loss. For example BAD PRACTICE: "./*" GOOD PRACTICE: "./(cat|dog|mouse)"
XPath expression to target elements to remove. This must be specified and the builder should provide hard XPATH expressions to prevent accidental data loss. For example BAD PRACTICE: "./*" GOOD PRACTICE: "./(cat|dog|mouse)". Empty xpath is not allowed.
Multifunctional pragmatic command to access and interact with Fox Servlet internals.
Dump internal Fox Servlet information to target element. See target attribute.
XPath expression to target one element which will be used to add dump information to. Default element is the current attach point. See dump attribute.
Call an action.
A group of server side include commands.
A storage location or URI based server-side-include and client popup command.
A resource reterieved is sent back to the client as a popup.
The browser client window name. If not specified, will default to
a unique name that is automatically generated for each new window.
The javascript window properties. For example:
menubar=no,resizable=no,scrollbars=no,status=no,toolbar=no,width=600,height=400
A storage-location based server-side-include popup resource attribute group.
The storage location of the LOB or XMLType whose content is to be retrieved
on the server and displayed in a popup on the client.
The filename of the browser popup resource. This might be "mydoc.pdf" to
force the browser to consider the real resource type to be PDF and to
facilitate recognisible file names to a user that might want to "Save As..." the
resource.
This might also prove useful if the content type is not retrieved by the URI or storage
location query and the type is implied from this name.
A URI based server-side-include popup resource attribute group.
A group of attributes used by show-popup to preview generated documents a template.
An group of attributes for launching a popup that displays a record in MATRIX.
Generate command group.
Creates an associated Excel worksheet in the output document.
Represents a column of data in the worksheet.
The column specification includes an expression to populate the column cells.
The name of the worksheet to create. This may be specified as
a simple string, such as name="sheet1", or as an XPATH expression, {expr},
that would yield a simple string value, specified as "string({expr})". Any XPATH
expression is computed relative to the current attachment point.
For example, name="Hello World!" and name="string('Hello World!')" are
identical. Other examples include:
1) name="string(/*/EMP_LIST/EMP/@name)"
2) name="string(./DEPARTMENT[0]/@name)"
3) name="string(concat('Sheet #', count(preceding-sibling::EMP)+1))" would yield
worksheet names (per employee in this case) like "Sheet #1", "Sheet #2" ... "Sheet #n"
A group of attributes that defines the type and format specification of a data element.
The required type of the element. Refer to the 'enumerations' for the
list of values accepted for the type attribute.
Also, if the type is "real" or "integer" you may supply a format specification mask
for the resulting string representation in the output, using the output-format attribute. The format-spec attribute uses the Java DecimalFormat and
SimpleDateFormat fomat models for numbers and dates respectively. These
are available at
http://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.html and http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html
respectively.
The accepted format patterns for the type specified, if parsing as input from a string. Only used when the specified type is "integer" or "real".
The accepted input-format patterns are the Java DecimalFormat and SimpleDateFormat fomat models for numbers and dates, respectively. These
are available at http://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.html and http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html respectively.
The accepted format patterns for the type specified. Only used when the specified type is "integer" or "real".
The format-spec attribute usage differs for the cases where method is CSV and
XLS.
When method is CSV the Java DecimalFormat and SimpleDateFormat fomat models for numbers and dates, respectively, are used. These
are available at http://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.html and http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html respectively. The default format specification for integers is "#" (any number of digits); the default for reals is "0.00" (2 decimal places with zeros always present, rounded if necessary).
When the method is XLS then one of the Excel built-in format model listed below
must be used:
General
0
0.00
#,##0
#,##0.00
($#,##0_);($#,##0)
($#,##0_);[Red]($#,##0)
($#,##0.00);($#,##0.00)
($#,##0.00_);[Red]($#,##0.00)
0%
0.00%
0.00E+00
# ?/?
# ??/??
m/d/yy
d-mmm-yy
d-mmm
mmm-yy
h:mm AM/PM
h:mm:ss AM/PM
h:mm
h:mm:ss
m/d/yy h:mm
(#,##0_);[Red](#,##0)
(#,##0.00_);(#,##0.00)
(#,##0.00_);[Red](#,##0.00)
_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)
_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)
_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)
_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)
mm:ss
[h]:mm:ss
mm:ss.0
##0.0E+0
@
text - Alias for @
One or more space separated record types.
An XPath expression which should return a one-off string, single element or a nodelist whose content is a valid record-type as defined by the matrix-record-type enumeration.
Used to order the results of the search in a SQL-select fashion.
Specify a field to order on and the direction of the ordering: ascending or descending.
The field name(s) of the MATRIX record to return in the search.
The space-separated names of fields of the MATRIX record required. Refer
to the matrix-record-field type.
The path, relative to the matrix-search results-target-path, where the specified
field name(s) will be placed.
The target parent node under which the MATRIX_RECORD search result
records will be placed.
If the target node does not exist it will be created for you.
The maximum number of results that will be returned by the search. The
number of results actually returned depends upon how many results
are left to return from the ofsset position specified, if any.
This is a 'paging' property that can be used to page through results
of the search when coupled with the results-set-offset property.
The zero-based offset (or index) from which search results will be returned. For example, if there are 100 results that match the search criteria and the offset
specified is 10 then the 11th result onwards will be returned.
This is a 'paging' property that can be used to page through results
of the search when coupled with the results-set-size property.
Another example might specify results-set-offset of 20 and results-set-size of
30; in which case results 21 to 50 are returned.
A space separated list of the fields of the MATRIX record to return in the results
set.
Refer to the matrix-record-field definition for a list of the fields.
The method by which results are placed under the specified target.
The mode is always fixed as 'augment': records are effectively merged in
with any existing records under the target path, any other data under the target
IS NOT modified in any way and new records are created if needed.
The email address of the user instigating the search. This is VERY IMPORTANT.
The email address specified must correspond to a registered user in the
portal schema, a registered MATRIX user and a user on the DTI
Human Resources database (people@DTI) and ALL MUST CORRESPOND. If
there are any problems locating the correct MATRIX user by the specified email
address an error will be returned.
MATRIX word-based search methods.
MATRIX number search criterion attribute group.
MATRIX word search criterion group.
MATRIX date search criterion group.
Equality operators accepted by MATRIX.
In-string search operators accepted by MATRIX.
MATRIX number-based search methods.
MATRIX date-based search methods.
An enumeration of the MATRIX record types.
A list of MATRIX record types.
Common field names of a MATRIX record.
The record type. Refer to matrix-record-type for a valid list of the record types.
A list of MATRIX record fields.
The ascending or descending order directions.