Nuxeo 5

Nuxeo 5 Component
org.nuxeo.ecm.platform.versioning.service.VersioningService

Individual Documentation Coverage

done proportion
66.67 %


A component through whose extension point one can define incrementation
rules for the two version fields defined in uid (by default) schema. The
fields "major_version" and "minor_version" are positive integers
representing logical version of a document (normal format is xx:xx like
01:23).

The rules can specify options to be presented to the user for versions
incrementation like "increment minor", "increment major", "no increment"
etc, or can specify what to be incremented silently (without user direct
interaction) when a document is updated.




Author: Dragos Mihalache

Author: Anahide Tchertchian

Version: 1.0

Location: nuxeo-services/nuxeo-platform-versioning-core/src/main/resources/OSGI-INF/VersioningService.xml

Property defaultMajorVersion

Property defaultMinorVersion

Require

No requirements

Required by

Implementation


Extension Points:

rules


EP 'rules' - one can define rules that will be applied in different cases
when a request for version incrementation appears.

May contain any number of 'docModifier' elements of the form:

        <versioningRuleEdit action="ask_user" lifecycleState="*" name="sampleEditRuleAnyState">
          <includeDocType>File</includeDocType>
          <option default="true" value="no_inc" />
          <option value="inc_minor" />
          <option lifecycleTransition="transition-name" value="inc_major" />
        </versioningRuleEdit>



The <versioningRuleAuto> is applied in the following situations:


  • When a document is being restored - so the version will be automatically
    incremented


  • If there are no versioningRulEdit options defined for user selection


  • properties


    This extension point allows to define which properties should be used to
    set versions given a document type.

    If no property definition is found for the document type, default
    properties set on the service will be used (uid:major_version and
    uid:minor_version).

            <versioningProperties>
              <majorVersion>my:major_version</majorVersion>
              <minorVersion>my:minor_version</minorVersion>
              <documentType>File</documentType>
              <documentType>Note</documentType>
            </versioningProperties>
    





    Has contribution from:

    Last generation: 18:21:25 CEST 11/07/2009