WorkflowDocumentInstance Data Type

Official Content
This documentation is valid for:

Description

This object represents a document instance.

Properties

Property Type Access Description
Id WorkflowDocumentInstanceId  Read Identifier
Version WorkflowVersion  Read Version
Name WorkflowDescription  Read/ Write Name
Created DateTime Read Date and time of creation
Updated DateTime Read Date and time of last update
Comments WorkflowComment  Read/ Write Comments
State WorkflowDocumentInstanceState  Read State
CheckedOutBy WorkflowUser Read The user that has locked the document
CheckedOutAt DateTime Read Date and time when the document was locked
DocumentDefinition WorkflowDocumentDefinition Read Document Definition
DocumentDefinitionId WorkflowDocumentDefinitionId Read Document Definition Identifier
Author WorkflowUser Read Author
Error WorkflowError Read Error
DigitalSignature WorkflowDigitalSignature Read Digital Signature
Versions WorkflowDocumentInstance (Collection) Read Document Instance Versions
ExtendedAttributes WorkflowAttribute (Collection) Read List of extended attributes

Methods

  •  Read

This method allows recovering a document.

Read (user, workitem, targetDirectory): character

Name Type Movement Description
 user WorkflowUser Input User who want to access the document
workitem WorkflowWorkitem (opcional) Input Allows to register the workitem between the operation
targetDirectory Character (opcional) Input Directory where the document will be copied

 

  • CheckIn

 This method allows logging into a previously locked document and check in the right to Write.

CheckIn (user, workitem, file)

Name Type Movement Description
user WorkflowUser Input User that want to check in the document
workitem WorkflowWorkitem Input Allows to register the workitem between the operation
file Character Input Complete path to the document

 

  • CheckOut

This method allows recovering a document check out the right to Write.

CheckOut (workitem, targetDirectory): file

Name Type Movement Description
user WorkflowUser Input User that wants to recover and block the document
workitem WorkflowWorkitem Input Allows to register the workitem between the operation
targetDirectory Character Input Directory to copy the document

 

  • UndoCheckOut

This method allows undoing the check out on the right to Write that was previously done to a document.

UndoCheckOut (user)

Name Type Movement Description
user WorkflowUser Input User the wants to unblock the document

 

  • Load

This method allows to load a document instance from its id and version

Load (id,version)

Name Type Movement Description
id WorkflowDocumentInstanceId Input Workflow document instance id
version WorkflowVersion Input Workflow version id

 

  • Share

This method allows to share a document instance with another process instance.

Share(processinstance)

Name Type Movement Description
processinstance WorkflowProcessInstance Input Process Instance to share the document

 

  • Remove

This method allows to remove the user document.

Remove (user)

Name Type Movement Description
user WorkflowUser Input User´s document to be removed.
  • AddAttribute

 This method allows to add an attribute

Addattribute (attribute)

 

Name Type Movement Description
attribute WorkflowAttribute Input Attribute to be added.

 

     
  • RemoveAttribute
  •  

 This method allows to remove an attribute

Removeattribute (attribute)

 

Name Type Movement Description
attribute WorkflowAttribute Input Attribute to be removed.

 

See Also





Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.