Changes between Version 44 and Version 45 of S3/S3XML

Timestamp:

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

Author:

Dominic König

Comment:

--

S3/S3XML

@@ -289 +289 @@
 ==== resource ====
 ||'''Parent elements'''||[#s3xml s3xml], [#resource resource], [#reference reference]||
-||'''Child elements'''||[#resource resource]||
+||'''Child elements'''||[#resource resource], [#data data], [#field field]||
 ||'''Contents'''||''empty''||
 
@@ -299 +299 @@
 ||'''uuid'''||string||a unique identifier for the record||''no''*||
 ||'''tuid'''||string||a temporary unique identifier for the record||''no''*||
+||'''created_on'''||datetime**||date and time when the record was created||''no''||
+||'''modified_on'''||datetime**||date and time when the record was last updated||''no, default: request date/time''***||
+||'''created_by'''||string||username (email-address) of the user who created the record||''no''||
+||'''modified_by'''||string||username (email-address) of the user who last updated the record||''no''||
+||'''mci'''||integer||master-copy-index****||''no, default: 2''***||
 
 (*) Records will be identified within the input file by their {{{uuid}}}, or, if no {{{uuid}}} is specified, by their {{{tuid}}}.
+(**) as YYYY-MM-DDTHH:mm:ssZ, always UTC
+(***) the last update date/time and mci are required in synchronization
+(****) the master copy index specifies how often a record has been copied across sites, see below
 
 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).
 
+The {{{mci}}} - master-copy-index - indicates how often this record has been copied across sites:
+
+  - when importing a new record the {{{mci}}} value is always *imported* as-is from the source
+  - when updating a record, the {{{mci}}} of the database record remains unchanged
+  - the {{{mci}}} of a record is *exported* as its current database value + 1.
+  - the repository first creating a record sets mci=0 in the database record, which appears as mci=1 in the exported XML.
+  - a copying site then imports mci=1 into its database, which appears as mci=2 in its export XML, and so forth...
+
+The {{{mci}}} can be used to filter records for whether they have been originated at a repository or not. If there's a fixed set of synchronization paths between a number of S3 instances, the {{{mci}}} can be used for conflict resolution. If the {{{mci}}} is not specified, it defaults to 2.
+
+MCI handling is optional for non-synchronizing interfaces.
 ==== data ====
 ||'''Parent elements'''||[#resource resource]||