Changes between Version 3 and Version 4 of S3/S3XML

Timestamp:

07/19/11 07:19:35 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3XML

@@ -63 +63 @@
 
 === Element Descriptions ===
+
+S3XML defines 4 element types:
+
+  - [#s3xml s3xml]
+  - [#resource resource]
+  - [#data data]
+  - [#reference reference]
+
+==== s3xml ====
+||'''Parent elements'''||''none (root element)''||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||''empty''||
+
+The root element.
+
+**Attributes:
+||'''Name'''||'''Type'''||'''Description'''||'''mandatory?'''||
+||'''domain'''||string||the domain name of the data repository||''no''||
+
+==== resource ====
+||'''Parent elements'''||[#s3xml s3xml], [#resource resource], [#reference reference]||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||''empty''||
+
+Represents a record.
+
+**Attributes:
+||'''Name'''||'''Type'''||'''Description'''||'''mandatory?'''||
+||'''name'''||string||the name of the resource, usually the DB table name||''yes''||
+||'''uuid'''||string||a unique identifier for the record||''no''*||
+||'''tuid'''||string||a temporary unique identifier for the record||''no''*||
+
+(*) Records will be identified within the input file by their {{{uuid}}}, or, if no {{{uuid}}} is specified, by their {{{tuid}}}.
+
+The {{{uuid}}} will be stored in the database together with the record. If {{{uuid}}} is present and matches an existing record in the database, then this record will be updated. If there's no match or no {{{uuid}}} specified in the {{{resource}}} element, then the importer will create a new record in the database (and automatically generate a {{{uuid}}} if required).
+
+==== data ====
+||'''Parent elements'''||[#resource resource]||
+||'''Child elements'''||''none (leaf element)''||
+||'''Contents'''||Text||
+
+Represents the value of a single field in the record.
+
+**Attributes:
+||'''Name'''||'''Type'''||'''Description'''||'''mandatory?'''||
+||'''field'''||string||the field name in the record||''yes''||
+||'''value'''||JSON value||the native field value||''no''||
+||'''url'''||URL||the URL to download the contents from*||''no''||
+||'''filename'''||filename||the filename of the attached contents*||''no''||
+
+The text node in the {{{data}}} element provides a human-readable representation of the field value. If this representation is different from the original value in the database, then the original value must be provided by the ''value'' attribute.
+
+(*) If the field is for file upload, a {{{url}}} attribute should be provided to specify the location of the file. The importer will try to download and store the file (file transfer) from that URL (''pull''). It is also possible to send the file with the HTTP request - in this case the {{{filename}}} must be specified instead of {{{url}}} (''push''). The ''push'' variant for uploads is meant for peers which do not support pulling for some reason (e.g. mobile phones). Normal servers would always provide a URL for download in order to allow the consuming site decide which files to download and when (saves bandwidth).
+
+==== reference ====
+||'''Parent elements'''||[#resource resource]||
+||'''Child elements'''||[#resource resource]||
+||'''Contents'''||Text||
+
+Represents a foreign key reference.
+
+**Attributes:
+||'''Name'''||'''Type'''||'''Description'''||'''mandatory?'''||
+||'''field'''||string||the field name in the record||''yes''||
+||'''resource'''||string||the name of the referenced resource, usually the tablename||''yes''||
+||'''uuid'''||string||the unique identifier of the referenced record (foreign key)*||''(yes)''!**||
+||'''tuid'''||string||a temporary identifier for a referenced record (foreign key)*||''(yes)''!**||
+
+(*) Referenced records would always be exported in the same output file. If a referenced record is found in the same input file, then it will be automatically imported.
+
+(!**) Records will be identified within the input file by their {{{uuid}}}, or, if no {{{uuid}}} is specified, by their {{{tuid}}}.
+
+If the referenced record is enclosed in the ''reference'' element, then {{{uuid}}} and {{{tuid}}} can be omitted:
+
+{{{
+<s3xml>
+   <resource name="xxxyyy">
+       <reference field="xy" resource="aaabbb">   <!-- the reference element, uuid/tuid can be omitted if -->
+          <resource name="aaabbb">                <!-- the referenced record is enclosed in the reference -->
+          </resource>
+       </reference>
+   </resource>
+</s3xml>
+}}}
 
 == JSON Format ==