Purge Action Parameters

Parameter Description Valid Values Mandatory Default
DeleteRecordVersions Specifies whether records should be deleted.

If this parameter is set to Yes, old record versions are deleted.

Note: To delete record versions, you need to specify DeleteRecordVersions as Y in File Watcher and pass the DeleteRecordVersions parameter in the workflow.
Y

Yes

N

No

No No
EnterpriseName Specifies the enterprise to be purged. The credential specified must belong to the enterprise specified.

If this parameter is not specified, all enterprises are purged.

ALL (Default)

Any enterprise name in the application.

No ALL
MasterCatalog Specifies the repositories from which record versions and historical data is to be purged.
Note: If one or more repositories are specified, purge is limited to history and data of these catalogs only and also restricted to the current enterprise. Enterprise name is required if the repository name is specified. All repositories must belong to ONE enterprise only.
Any valid repository name. No Default is ALL catalogs.
RetentionUnits Specifies the number of days or months from the current date beyond which data will be purged.

The cutoff date should be greater than the current date, that is, RetentionUnits should be greater than 0.

Number greater than 0. No 6
RetentionUOM Specifies the unit of measure for RetentionUnits. MONTH

DAY

No MONTH
RecordsProcessed The number of records purged during the run. Does not include records which are automatically removed due to database referential integrity constraints.      

The parameter, EnterpriseName, does not work with the default DataSet. To specify the enterprise name or a repository of an enterprise in the DataSet, you need to specify a DataSet similar to the one shown below: 

<DataSet type="single">
     <Name>Purge</Name>
     <Credential domain="GLN">
         <Identity>0065064444443</Identity>
     </Credential>
     <Action>Purge</Action>
     <RetentionUOM>DAY</RetentionUOM>
     <RetentionUnits>1</RetentionUnits>
     <EnterpriseName>CorpA</EnterpriseName>
     <MasterCatalog>
          <RevisionID>
               <BaseName>Precedence</BaseName>
          </RevisionID>
     </MasterCatalog>
     <URIInfo scheme="local">
          <Relative>MQ_COMMON_DIR</Relative>
          <URI>/Work/purge</URI>
     </URIInfo>
</DataSet>

Change the values of the following elements as per your requirement:

  • Identity: specify the GLN as specified in Company Profile of your setup.
  • EnterpriseName: specify the name of the enterprise whose data you want to purge.
  • MasterCatalog: specify the name of the repository whose data you want to purge.