Verify that the current transition is the correct one for the document. If a document is touched from multiple threads certain race conditions may apply that will cause the lookup of the transition to end up out of sync with the transition action when it is actually executed. In this case the action should do nothing; not even call cpf:success or cpf:failure. Some other CPF thread has already done the work on this document.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  define variable $cpf:document-uri as xs:string external
  define variable $cpf:transition as node() external

  if (cpf:check-transition( $cpf:document-uri, $cpf:transition )) then
     try {
        do-my-work(),
        cpf:success( $cpf:document-uri, $cpf:transition, () )
     } catch ($e) {
        cpf:failure( $cpf:document-uri, $cpf:transition, $cpf:exception, () )
     }
  else ()
  

Fetch a trace of the error that caused the document's processing to fail, if any.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  cpf:document-get-error( "/myDocs/example.xml" )
  

Determine the date and time of the last update to the document's content, if any.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  cpf:document-get-last-updated( "/myDocs/example.xml" )
  

Determine the document's current processing status, if any. The status will be one of "created", "updated", "deleted", "active", or "done".

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  cpf:document-get-processing-status( "/myDocs/example.xml" )
  

Determine the document's current state, if any.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  cpf:document-get-state( "/myDocs/example.xml" )
  

Set the document's error trace to the given value.

In general, applications should not not need to set the error trace of a document. cpf:failure will automatically set this trace, and cpf:success will clear it.

Set the date and time of the document's last update.

In general, applications should only set the update time of a document in the document update action and should set it to the current date and time to ensure consistency of processing.

import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

cpf:document-set-last-updated( "/myDocs/example.xml", 
		               fn:current-dateTime() )
  

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

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.

import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

cpf:document-set-processing-status( "/myDocs/example.xml", 
 		                    "deleted" )
  

Set the document's state to the given state.

Setting a document's state may trigger content processing. If the document is currently being actively processed by the content processing framework, changing its state may have unexpected results. Manually setting the document's state should therefore be done only on documents whose processing status is "done".

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  cpf:document-set-state( "/myDocs/example.xml", 
                          "http://marklogic.com/states/reprocess" )
  

Concludes the state action in failure, advancing the state as defined by the state transition. The state action must call this method to indicate failure, passing the external variables $cpf:document-uri, $cpf:transition, and $cpf:exception as parameters. If the document does not exist, do nothing.

Side effects: Advances the document state to the transition's on-failure state, if any, and marks the document as processed in the current state.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  define variable $cpf:document-uri as xs:string external
  define variable $cpf:transition as node() external
  define variable $cpf:exception as node() external

  cpf:failure( $cpf:document-uri, $cpf:transition, $cpf:exception, () )
  

Concludes the action successfully, advancing the state as defined by the transition. The action must call this method to indicate completion of successful processing, passing the external variables $cpf:document-uri and $cpf:transition as parameters. If the document does not exist, do nothing.

Side effects: Advances the document state to the transition's on-success state, if any, and marks the document as processed in the current state.

  import module namespace cpf = "http://marklogic.com/cpf" 
		  at "/MarkLogic/cpf/cpf.xqy"

  define variable $cpf:document-uri as xs:string external
  define variable $cpf:transition as node() external

  cpf:success( $cpf:document-uri, $cpf:transition, () )