Changes between Version 10 and Version 11 of S3XRC/S3XML

Timestamp:

05/03/11 19:28:06 (14 years ago)

Author:

Dominic König

Comment:

--

S3XRC/S3XML

@@ -24 +24 @@
 ||'''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]||
@@ -30 +36 @@
 
 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||''(yes)''**||
+||'''tuid'''||string||a temporary unique identifier for the record||''(yes)''**||
+
+(**) Records will be identified within the input file by their {{{uuid}}}, or, if no {{{uuid}}} is specified, by their {{{tuid}}}. While {{{uuid}}}s would be stored in the database and thus can be used to identify the record even in the database, {{{tuid}}}s will not be stored, but replaced by an internally generated UUID at import. Thus, {{{tuid}}}s cannot be used to update records in the database.
+
 ==== data ====
 ||'''Parent elements'''||[#resource resource]||
@@ -52 +67 @@
 ||'''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*||''(yes)''**||
+||'''tuid'''||string||a temporary identifier for a referenced record in the same source*||''(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>
+}}}
 
 === Example ===