wm.tn.doc:changeStatus
Changes the user status for a document.
Input Parameters
bizdoc | Object The document for which you want to change the status. The document must be an instance of com.wm.app.tn.doc.BizDocEnvelope. |
docID | String The internal document ID of the document. |
newUserStatus | String (optional) The new user status for the document. |
Output Parameters
updateCount | String The number of documents that the service updated. The following values indicate: 1 - The service changed the status of the document. 0 - The service did not change the status of the document. |
Usage Notes
This service updates the version of the document in memory and the version in the database if the document was saved.
An alternative to
wm.tn.doc:changeStatus is the
wm.tn.doc:updateSystemAttributes service. You can use the
updateSystemAttributes service to change the user status. If the pre-processing actions indicate that the document attributes are to be saved to the database, the
updateSystemAttributes service writes the changes to the database and creates a detailed record of the change in the
Trading Networks Activity Log.
In earlier version of
Trading Networks, this service provided the ability to modify the document's processing (system) status. The process (system) status is reserved for internal use only by
Trading Networks and should
not be modified by an application. This service has been change to only allow for modification of the user status.