Version: 3.8.0
Alternative root element in order to import system documents as structure nodes (together with the corresponding structure node documents), roles, users etc.
Nodetype definition and nodetype configuration imports.
Wrapper element for a nodetype data element.
The data of a nodetype definition respectively a nodetype configuration.
The attribute 'specificationMethod' controls whether the data are defined via reference or inline.
A wrapping element to allow multiple Sophora documents to be imported at once.
Container for 'document' elements.
Container for 'documentIdentificationExpression' elements.
The base element for every Sophora XML document.
Every document contains an arbitrary number of 'property'
elements (encapsulated in a 'properties' element) followed
by an arbitrary number of 'childNode' elements (encapsulated
in a 'childNodes' element) and an arbitrary number of referenced
documents (encapsulated in a 'resourceList' element).
The document's properties.
The childnodes of the document.
Documents as resources of this node.
Every document is a node that needs to provide information about
'tags' and its 'structureNode' within the 'fields' element. Furthermore,
it may contain an external Id in the 'externalId' attribute.
The element 'instructions' lists operations/actions that are performed
after importing the document (e.g. creating a proposal).
The attribute 'nodeType' is optional. The node type is only required for
importing new documents.
Metainformation about the document.
This element lists operations/actions that are performed
after importing the document (e.g. creating a proposal).
Each childnode has to have the 'name' attribute filled. The elements 'fields' and
'instructions' are not allowed here.
In addition to the 'name' attribute, you may set the 'remove' attribute to
'true' / '1' or 'false' / '0'. This is relevant if you want to update an existing
document in the repository and merge its childnodes (see 'childNodesUpdateBehaviour.type').
The attribute 'nodeType' is required.
The 'merge' attribute signalizes whether this property should be mergeable.
Formal definition of a UUID string representation
(see RFC 4122).
Enclosing element for 'property' elements.
Enclosing element for meta-information about the document.
The site to import in.
The structure node to import in.
A list of assigned categories. The optional boolean attribute 'remove' can
be used to reset the existing categories.
The Id stem to create the document with.
Determines whether an existing lock for an
imported document should be broken
automatically. If the value is 'false' but the
document is locked in the repository, the import
fails. Possible values are 'true' / '1' or
'false' / '0'. Default is 'false'.
The (optional) attribute 'timeout' defines how long (in minutes) the importer
tries to acquire the lock before force-breaking it (or giving up if 'forceLock'
is 'false'). The user that has locked the document will receive a message to
release the lock every 2 minutes.
Determines whether a new document should be created even if there's
already a document with the same external id. Possible values are 'true' / '1' or
'false' / '0'. Default is 'false'.
Settings for playout channels.
Enclosing element to define operations that are performed after a document has been
imported sucessfully (e.g. creating a proposal).
Operations that change a document's status.
List of proposals that should be created together with this document.
List of sticky notes that should be created/edited/removed together with this document.
An arbitrary number of case insensitiv letters; '-' and '_' are allowed.
An arbitrary number of case insensitiv letters; '-' and '_' are allowed.
Enclosing element for 'category' elements.
Nested categories are separated with a semicolon.
Settings for playout channels.
A list of enabled playout channels.
A list of disabled playout channels.
A list of enabled playout channels. The optional boolean attribute 'remove' can be used to reset
the channels.
An enabled playout channel.
An enabled playout channel. The optional attributes 'startDate' and 'endDate' can be used to
enable the channel during that time only.
A list of disabled playout channels. The optional boolean attribute 'remove' can be used to reset
the channels.
A disabled playout channel.
A disabled playout channel.
Enclosing element for 'proposal' elements. Each of them represents a proposal that
will be created.
Information about the new proposal.
Proposal sections the document is added to.
The originator (username) of the proposal. Can be used to set
a different username than the current import user.
Enclosing element for 'proposalSection' elements.
Enclosing element for 'path' elements.
Enclosing element for 'childnode' elements.
Enclosing element for the update behaviour description tags of the childnodes.
This element defines the update behaviour for childnodes with a certain name (value of
the attribute 'name') whereas the attribute 'behaviour' is mandatory. The optional attribute
'insertPosition' defines at which position the childnode is added. In addition the optional
attribute 'mergeProperty' defines the property that is used as merge id. Finally, the
attribute 'maxNumber' manages the maximum number of childnodes with this name that may exist.
Enclosing element for 'lifecycleActivity' elements which contain an operation about
a document's lifecycle.
Enclosing element for list of 'document' elements that are referenced by the parent
node; e.g. by a property 'ts:reference'.
The mandatory attribute 'name' specifies the name of this property. This element contains
'value' elements. (Skipping value elements makes sense if the property is to be removed or
if the property should be protected or unprotected without changing the value of the property.).
The attribute 'mimetype' is only relevant for binary properties.
The attribute 'autoScale' is only valid for binary image properties.
The 'merge' attribute signalizes whether this property should be mergeable.
This Element allows to specify via xPath expression which repository documents are to be
updated. The text content of this element defines the xPath query expression which is used to make a search against
the repository.
The mandatory attribute 'idString' defines the string which is used as placeholder in the xml
document.
The optional attribute 'minNumberOfResults' (Default: 1) specifies how many results at least are expected by the xPath
expression. If fewer results are found the import will abort with a error message.
The optional attribute 'maxNumberOfResults' (Default: 1) specifies how many results at most are expected by the xPath
expression. If more results are found the import will abort with a error message.
The optional attribute 'numberOfResultsToProcess' (Default: 'unbounded') specifies how many of the found results are used to replace
the 'idString' of the xml document. If this attribute is not set, all results are used.
The optional attribute 'createIfNoDocumentFound' (Default: 'false') specifies whether a document should be newly created if the xPath
expression returns no result.
The mandatory attribute 'type' defines the activity.
The attributes give additional information, if the value of the property is a reference
to another document. In this case the attributes contain the 'site', 'structureNode', 'sophoraId' and 'uuid'
of the referenced document.
Note: These attributes have no impact on the import of the document! The importer ignores the values of
these attributes and is only interested in the (reference) value of the parent "value" element.
Enclosing element for 'stickyNote' elements. Each of them represents a sticky note that
will be created/edited/removed.
Information about the sticky note to add/edit/remove.
Whether to force-break a lock on a document.
The 'timeout' (in minutes) defines how long the importer tries to acquire the
lock before force-breaking it (or giving up if 'forceLock' is 'false').