schemas.ves.ves-1.0.xsd Maven / Gradle / Ivy
This XML Schema is used to describe "Validation Execution Sets" as used by the phive validation library.
Version history:
* 2024-05-16 - v1.0.0-RC1
* Initial version
This group defines the layout and the constraints of coordinates
The group ID is something like a company or project ID
The artifact specifies something relative to a group. It must be unique within a group.
The version number of an artifact within a group. This MUST follow the semantic versioning principle.
The namespace prefix to define.
The empty prefix is the default namespace mapping.
The namespace URI bound to the prefix
Must be true if this namespace definition overwrites a previously defined one
(MUST be either by prefix or by URI but NEVER both)
At least one namespace declaration must be present.
group, artifact, version
The resource type that defines the file extension for the resource.
Error level 'information' meaning no error anymore
Error level 'warning' meaning a non-serious thing and validation may continue
Error level 'error' meaning a serious problem occurred and validation is considered failed
ID of the error who's error level is to be modified
The adopted error level to assign to all found issues with the provided ID
Optional prefix to be added to the respective error text
Optional suffix to be added to the respective error text
This element allows to overwrite the error level of certain errors (make them more severe or less severe)
Defines a "requires" dependency to a different VES
If this attribute is true, the execution of the validation must stop here,
and the rules provided in this VES should not be executed at all.
The target resource to redirect to.
The namespace URI to rewrite
The target resource to redirect to.
The system ID to rewrite
Contains a single catalog item to rewrite includes by namespace URI
Contains a single catalog item to rewrite includes by system ID
Defines the type of the precondition used.
At least the value 'xpath' must be supported, to interpret the precondition as an XPath expression evaluating to a boolean.
Defines all the fields and constrains to deal with XML Schema validation artefacts.
Coordinates of the artefacts that contain the main XML Schema definitions.
Allowed types are: xsd, zip
In case the referenced resource is a container (like zip), than this element
defines the "root" XML schema that must include all the other required
XML schemas with relative paths!
Contains optional catalog entries required for resolution of referenced XML schemas during runtime execution
Optional precondition that MUST be fulfilled to execute this validation artefact on an XML instance
Represents a single key-value-pair input parameter for Schematron/XSLT
Coordinates of the artefacts that contain the main Schematron definitions.
Allowed types are: sch, xslt
The Schematron engine to be used for executing validations of this type.
This setting is only needed for type 'sch'.
Optional precondition that MUST be fulfilled to execute this validation artefact on an XML instance
All the namespaces referenced by the XML schema and the proposed prefixes.
Note: XML Schemas without namespace URI are NOT supported.
Optional input parameters for executing the Schematron validation
Optional output customization settings
Must be in the form "D96A" or "D01B".
Must be in the form 1 to 4.
The EDIFACT Directory version to use
The EDIFACT message type, like 'DESADV'
The EDIFACT syntax version to be used. If none is provided, no special checks will be performed
Subsets to use. Order of elements must be from "broadest" to "most specific".
Optional input parameters for executing the Schematron validation
Contains information about a single license
The SPDX ID of the license if applicable.
See: https://spdx.org/licenses/
The structured VESID of the VES
The display name of this VES
Optional date when the validation artefact was published or released
Contains the license(s) under which this artefact is published.
If more then one license is present, it means that the user has to choose one of these licenses.
An optional reference to an existing validation artefact (VES) that must be executed prior to this validation artefact.
The supported list of validation artefact types is hard coded, as the requirements are very specific.
Newly added validation languages require an update to this XML Schema.
Only one XML Schema per VES makes sense.
Use the "zip" approach if the schema consists of multiple files.
Multiple independent Schematrons can be applied on top of each other.
Currently one set of rules for Edifact is sufficient.
The root element of the Validation Execution Set (VES) definition.
A VES is always immutable. The immutable part of a VES is contained in the "ves-status-x.y" XSD.
The structured VESID of the replacement VES. Must have the same type as the source VES.
The content of this element needs to be the human readable description of what was changed.
That should be human readable text in English language.
Note: history items are immutable and MUST NOT be altered later at any costs.
The date and time when the change was published
Who is responsible for the change
An optional code for the activity that was performed.
No default code list exists at the time of creation.
Contains the details of the status changes
The structured VESID of the VES
The date and time (incl. time zone), when this status document was modified last.
This can never be in the future.
The optional point in time, when the validation artefact becomes mandatory.
This element SHOULD contain timezone information.
If this element is missing, it means the validation artefact is valid "since forever".
This field is theoretically mutable.
The optional point in time, until when the validation artefact may be used.
This element SHOULD contain timezone information.
If this element is missing, it means the validation artefact is valid "until eternity".
This element provides the possibility to explicitly mark this object as "deprecated" and
no longer usable.
This element provides the possibility to provide the reason for deprecation.
The content should be provided in English language only. As free text.
In case the element coordinates are deprecated, use this resource instead.
This is primarily intended as a hint to the validation user to make sure he's using
the correct validation rules.
If this artefact is deprecated and a later version exists, the latest version is
always considered the appropriate replacement.
However if group ID or artefact ID changed, it needs to be explicitly provided here
as a replacement VESID.
This element allows the editor to provide information about the different status changes.
The root element of the Validation Execution Set (VES) status definition.