XML material

Revision as of 09:39, 29 March 2019 by Mligtvoet (talk | contribs) (Creating XML material zip)

XML material

A publication page will usually also contain XML-materials not generated from ART-DECOR, such as schema's, wsdl's, XML-examples and other materials.

Naming scheme for XML material zip for ADRAM

When publicated via ADRAM the expected name for the xml material zip is: <project prefix>-xml-<release dateTtime>.zip. For instance: demo5-xml-20140730T101421.zip

See for an example: http://art-decor.org/demos/demo5/

Creating XML material zip

In most cases it is preferable to start with downloading the schematron runtime .zip containing schematron files.

Next:

  • Unpack the runtime zip
  • Rename the folder from <project prefix>-runtime-<release dateTtime> to <project prefix>-xml-<release dateTtime>

For example: demo5-runtime-20140730T101421 becomes: demo5-xml-20140730T101421

  • Create a new subfolder schematron_xslt and move all content from the unpacked runtime zip (generated schematrons etc) there
  • Add XML examples, schemas and more files you want to include in the zip. See below.
  • Zip the folder to: <project prefix>-xml-<release dateTtime>.zip. Note that preferably the top level folder is included in the zip, so when unzipping you get a folder named: <project prefix>-xml-<release dateTtime>.
  • Place it online through ADRAM.

Layout for XML material

Note that some of these folders will be present in the runtime folder after transformation of a project. Note that not all files and folders are necessarily present, optional items are marked with <optional>.

The layout for creating XML material is described below:

Error creating thumbnail: Unable to save thumbnail to destination
index.html

(optional) The pages contains the description of the folders and materials contained in this set.

Error creating thumbnail: Unable to save thumbnail to destination
cda_xml

(optional) Folder with XML material for 'Clinical Document Architecture' documents.

Error creating thumbnail: Unable to save thumbnail to destination
coreschemas

XML base schemas for the definition of datatypes and vocabularies.

Error creating thumbnail: Unable to save thumbnail to destination
css

Files for markup of HTML pages. They are used for the markup of HTML documentation and HTML rendering of XML messages. This folder also contains javascript files in addition to cascading style sheets (css) files for markup.

Error creating thumbnail: Unable to save thumbnail to destination
schemas

XML schemas containing the definition of XML messages. The XML schemas define the structure of the messages and the cardinality of its constituent elements.

Error creating thumbnail: Unable to save thumbnail to destination
schemas_codeGen

XML schemas that have been transformed to be suited for code generation by copying the transmission wrapper and control act wrapper into the interaction schema. This eliminates double declarations of Message, ControlAct, QueryByParameterPayload and Payload when you generate code e.g. through WSDL. These schemas are functionally equal to the schemas in the schemas folder.

Error creating thumbnail: Unable to save thumbnail to destination
schemas_codeGen_flat

(optional) XML schemas that have been transformed to be self contained and have no more references to other schemas (except in the case of xs:import). These schemas are functionally equal to the schemas in the schemas folder.

Error creating thumbnail: Unable to save thumbnail to destination
schemas_codeGen_LSP

(optional) XML schemas that have been transformed to be suited for the Dutch AORTA ZIM. These schemas are functionally equal to the schemas in the schemas folder with the exception that medical Payload has been obfuscated through xs:any.

Error creating thumbnail: Unable to save thumbnail to destination
schematron

Schematron files for validation of 'business rules'. This concerns requirements in implementation guides that are hard to or impossible to catch in XML Schema definition.

Error creating thumbnail: Unable to save thumbnail to destination
schematron_svrl

(optional) XSLT (stylesheets) files generated from the schematron files. These XSLTs are useful for environments where native Schematron file processing is not possible for validation of the XML messages. SVRL is short for Schematron Validation Reporting Language (see: http://schematron.com) and reports in an XML structure suitable for processing in other logic.

Error creating thumbnail: Unable to save thumbnail to destination
schematron_xslt

(optional) XSLT (stylesheets) files generated from the schematron files. These XSLTs are useful for environments where native Schematron file processing is not possible for validation of the XML messages. These XSLTs report in textual xsl:message. These may be used e.g. for viewing in logging. See SVRL for reports in processable form. (http://schematron.com)

Error creating thumbnail: Unable to save thumbnail to destination
wsdl

(optional) WSDL files with webservice definitions.

Error creating thumbnail: Unable to save thumbnail to destination
xml-project_prefix

XML example messages for the project with prefix project_prefix

Error creating thumbnail: Unable to save thumbnail to destination
xsl

(optional) contains tools for rendering and conversion of certain XML materials