MarkLogic 9 Product Documentation
cpf.documentSetProcessingStatus

cpf.documentSetProcessingStatus(
   doc as String,
   processing-status as String
) as null

Summary

Set the document's processing status to the given value.

Parameters
doc The URI of the document.
processing-status The new processing status, one of "created", "updated", "deleted", "active", or "done".

Usage Notes

In general, applications should not not need to set the processing status of a document. If the document is currently being actively processed by the content processing framework, changing its processing status may have unexpected results. Manually setting the document's processing status should therefore be done only on documents whose processing status is "done". Setting the document's processing status to "updated" can be a means of triggering reprocessing; setting it to "deleted" can be a means of providing a soft-delete capability.

Example

const cpf = require('/MarkLogic/cpf/cpf');

declareUpdate();
cpf.documentSetProcessingStatus('/myDocs/example.xml', 'deleted');
   
Powered by MarkLogic Server | Terms of Use | Privacy Policy