CoreMedia Content Server Manual, Version 7.5.45-10
3.14.2.3. Cleaners | 3.14.2.3.2. Clean Versions

Run Clean Versions using the following command line:

usage: cm cleanversions -u <user> <other options> [--simulate]
          [--export]
          [--directory <directory>]
          [--export-to-subdirs <mode>]
          [--keep-number <n>]
          [--keep-days <d>]
          [--published-only | --unpublished-only]
          [--approved-only | --unapproved-only]
          [ -R ] [ -l <limit> ] [ <id1>... | -I <id1>... |
            -t <path1>... | -cq <query1>... ]

          - OR -

       cm cleanversions -u <user> <other options> [--simulate]
          [--export]
          [--directory <directory>]
          [--export-to-subdirs <mode>]
          --selector-class <classname>
          [--selector-param <name1:value1>]
          [ -R ] [ -l <limit> ] [ <id1>... | -I <id1>... |
            -t <path1>... | -cq <query1>... ]

available options:

 -ao,--approved-only             clean approved versions only
 -c,--cache <arg>                size of cache (in bytes)
                                 (default=64MB)
 -cq,--contentquery <query>      query/queries to select contents
 -d,--domain <domain name>       domain for login
                                 (default=<builtin>)
 -dir,--directory <arg>          directory where document shall be
                                 exported <default=destroy>
 -es,--export-to-subdirs <arg>   structure of export
                                 subdirectories
                                 (default=creationDate). One of
                                 [base|creationDate|
                                  modificationDate|exportDate]
 -I,--id <id>                    id(s) to select content objects
 -kd,--keep-days <arg>           minimum number of days after last
                                 modification <default=7>
 -kn,--keep-number <arg>         minimum Number of versions to
                                 keep (default=1)
 -l,--limit <limit>              limits the number of content objects
                                 to select, negative for unlimited
                                 which is also the default
 -lc,--selector-class <arg>      custom VersionSelector
                                 implementation class
 -lp,--selector-param <arg>      custom VersionSelector parameter
 -p,--password <password>        password for login
 -po,--published-only            clean published versions only
 -R,--recyclebin                 include contents from recycle bin
 -s,--simulate                   simulation mode where no versions
                                 will be destroyed
 -t,--path <path>                path(s) to select content objects
 -u,--user <user name>           user for login (required)
 -uao,--unapproved-only          clean unapproved versions only
 -upo,--unpublished-only         clean unpublished versions only
 -url <ior url>                  url to connect to
 -v,--verbose                    enables verbose output
 -x,--export                     export destroyed versions as xml

Clean Versions is applied to every content selected via the content selection parameters. If folders are selected the clean operation is performed recursively on every content item inside.

No matter which versions you select by command line arguments or by custom VersionSelector (see below), some versions will never be cleaned up, which are:

	Note
	For information about the UAPI query syntax see Section 5.5, “Query Service” in CoreMedia Unified API Developer Manual.

Example for calling Clean Version to simulate the cleaning of all content items beneath the root folder but the last two versions:

cm cleanversions -u admin -p admin --simulate
    --keep-number 2 --keep-days 0 --path /

Example for calling Clean Version on all documents despite the /Home folder:

cm cleanversions -u admin -p admin
    -cq "TYPE Document_ : NOT BELOW PATH '/Home'"

Example for calling Clean Version to delete all versions below the folders /Pictures, /Articles and in the recycle bin that are older than 10 days compared to the last modification date but keep at least 3 versions:

cm cleanversions -u admin -p admin --keep-number 3
     --keep-days 10 --recyclebin --path /Pictures /Articles

Example for calling Clean Version to delete all versions below the root folder that are older than 7 days compared to the last modification date (default value) and that are published or approved:

cm cleanversions -u admin -p admin --published-only --approved-only
     --path /

Example for calling Clean Version using a custom VersionSelector on resource with id "135"

cm cleanversions -u admin -p admin 
   --selector-class my.package.TestVersionSelector 
   --selector-param "some parameter" 135 

Performance and Workload Sharing

This tool is implemented as a remote client, and needs to load each visited content item from the content server. This causes network traffic, and puts considerable load on the server, which means that cleaning will not be fast. To avoid obstruction of the regular editorial work, the tool should be run during off-hours (at night, for instance). The workload should be partitioned so that each cleaning run finishes after a sensible time. Try running the clean versions every night and always give it a different folder to work on.

Custom VersionSelectors for cleaning

Using the Unified API it is possible to write your own selector mechanism for selecting content item versions to be cleaned. Given a list of versions of a single content item, the selector returns all versions to be destroyed. The behavior of your class may be adjusted using command line arguments, which are passed to its constructor.

	Note
	Keep in mind, that a custom version selector replaces the default selection, it does not extend it.

The named class must be a public class implementing com.coremedia.cotopaxi.util.VersionSelector. It must either define a public no-args constructor, or a public constructor with only one argument of type java.lang.String. In the latter case, a String containing an additional parameter will be passed to the constructor. The simplest example of a customized predicate:

package my.package;

import com.coremedia.cotopaxi.util.VersionSelector;
import com.coremedia.cap.common.CapException;
import com.coremedia.cap.content.Version;
import java.util.ArrayList;
import java.util.List;

public class TestVersionSelector implements VersionSelector {

  public TestVersionSelector(String parameter) {
    System.out.println("Parameter: "+parameter);
  }

  public List selectVersions(List versions) throws CapException {

    List result = new ArrayList();
    for( int x=0; x<versions.size(); x++ ) {

      Version version = (Version) versions.get(x);
      result.add(version);
    }
    return result;
  }
}