element <tns:synchronization> (global)
Namespace:
Type:
Content:
complex, 4 elements
Defined:
globally in common-1.xsd; see XML source
Used:
XML Representation Summary
<tns:synchronization>
   
Content: 
tns:enabled?, tns:correlation?, tns:confirmation?, tns:reaction*
</tns:synchronization>
Content model elements (4):
tns:confirmation (in tns:synchronization), tns:correlation (in tns:synchronization), tns:enabled (type xsd:boolean), tns:reaction (in tns:synchronization)
Included in content model of elements (2):
tns:resource, tns:resource (type tns:ResourceType)
Known Usage Locations
XML Source (see within schema source)
<xsd:element name="synchronization" type="tns:SynchronizationType"/>
Content Element Detail (all declarations; 4/4)
tns:confirmation
Type:
tns:ExpressionType, complex content
Defined:
locally within tns:SynchronizationType complexType
Confirmation expression. The arguments are an account and a candidate owner (user). The confirmation expressions should return true if the user should be owner of the account. It should return false if the user cannot be owner of the account. The evaluation of the confirmation expression may be relativelly inefficient, as it will only be run for candidate entries returned by correlation expression. The expression variables should be set as follows: $user - the candidate user object (one of the results of correlation expression) $account - the changed account object
XML Source (see within schema source)
<xsd:element minOccurs="0" name="confirmation" type="c:ExpressionType">
<xsd:annotation>
<xsd:documentation>
Confirmation expression. The arguments are an
account and
a candidate owner (user). The
confirmation
expressions
should return true if the user should be owner of the
account. It
should return false if
the user cannot be
owner
of the account.

The
evaluation of the confirmation expression may be
relativelly
inefficient, as it will only be run for
candidate entries returned
by correlation expression.

The expression
variables should be set as
follows:
$user - the candidate
user object (one of the results of
correlation expression)
$account - the changed account object
</xsd:documentation>
</xsd:annotation>
</xsd:element>

tns:correlation
Type:
tns:QueryType, complex content
Defined:
locally within tns:SynchronizationType complexType
Correlation expression. It should return a list of candadate user entries that may be owners of a particular account. Correlation is an rough but an efficient way how to relate the account to a user. The correlation expression is in fact just a search filter. If correlation search returns more that one entries, confirmation expression will be executed for each of them.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="correlation" type="c:QueryType">
<xsd:annotation>
<xsd:documentation>
Correlation expression. It should return a list
of
candadate user entries that may be owners of a
particular
account.

Correlation is an rough but an efficient way how to
relate
the account to a user. The correlation
expression
is in fact just a
search filter. If correlation search
returns more that one entries,
confirmation
expression
will be
executed for each of them.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

tns:enabled
Type:
xsd:boolean, simple content
Default:
"true"
Defined:
locally within tns:SynchronizationType complexType
Flag indicating if the synchronization is enabled. If it is not, the synchronization process will be suspended. If enabled, the synchronization should pull in even the changes that were done during disabled synchronization (limitations may apply, such as the legth of history logs on the resource). Disabling synchronization means that it will not be executed automatically (e.g. polling resource in regular intervals). The synchronization may still be executed explicitly (manually), even if it is disabled. If this flag is not present, but a valid synchronization setup is found (which usually means valid "synchrnization" element), the synchronization is assumed to be enabled. This flag is meant to act as a tool to temprarily disable synchronizatoin without loosing the configuration and and state.
XML Source (see within schema source)
<xsd:element default="true" minOccurs="0" name="enabled" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Flag indicating if the synchronization is
enabled. If it
is not, the synchronization process will
be
suspended.
If enabled, the synchronization should pull in even the
changes that were done during disabled
synchronization
(limitations
may apply, such as the legth of history
logs on the resource).

Disabling synchronization
means that it will not
be
executed
automatically (e.g. polling resource in regular
intervals). The
synchronization
may still be executed
explicitly
(manually), even if
it is disabled.

If this flag is not present, but a valid
synchronization
setup is found (which usually
means valid
"synchrnization"
element), the synchronization is assumed
to be
enabled.
This flag is meant to act as a tool to
temprarily disable
synchronizatoin without loosing the
configuration and
and state.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

tns:reaction
Type:
anonymous complexType, complex content
Defined:
locally within tns:SynchronizationType complexType
Reaction to a synchronization situation. Situation identifier must be unique in this set (i.e. a situation definition may occur only once for each situation). If there is no definition for a particular situation, there will be no reaction ("do nothing"). The set of situation reactions is considered to be unordered.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="reaction">
<xsd:annotation>
<xsd:documentation>
Reaction to a synchronization situation.
Situation identifier must be unique in this set (i.e.
a
situation
definition may occur only once for each
situation).
If there is no
definition for a particular situation,
there will be no
reaction
("do nothing").
The set of situation reactions is considered to be
unordered.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" ref="tns:description"/>
<xsd:element name="situation" type="tns:SynchronizationSituationType">
<xsd:annotation>
<xsd:documentation>
Defines a particular synchronization
situation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="action">
<xsd:annotation>
<xsd:documentation>
Defines an action to take when a situation is
encountered.
If there is no action for a
particular
situation,
there will be no reaction ("do nothing").
There may be sevaral
actions defined here.
In such
case all the actions
will be
executed
in the order as they are defined here.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" processContents="lax">
<xsd:annotation>
<xsd:documentation>
Action parameters.
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:any>
</xsd:sequence>
<xsd:attribute name="ref" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
Action identifier (URL)
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

This XML schema documentation has been generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high-quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-quality XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support > 400 template parameters, which work the same as "options" of ordinary doc-generators. The parameters are organized in nested groups, which form a parameter tree. Most of them have their default values calculated dynamically from a few primary parameters. So, you'll never need to specify all of them. That will give you swift and effective control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To select only the initial, imported, included, redefined XML schemas to be documented or only those directly specified by name.
  • To include only XML schema components specified by name.
  • To document local element components both globally and locally (similar to attributes).
  • To allow/suppress unification of local elements by type.
  • To enable/disable reproducing of namespace prefixes.
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in a signle-file form as both HTML and incredible quality RTF output.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To remove this very advertisement text!
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML (Full Edition) and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for "DocFlex/XML SDK" will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note that by purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the results of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To purchase a license, please follow this link: http://www.filigris.com/shop/