MigrateDocument Method

Connection MigrateDocument Method

BlueCielo Meridian Connection API 2013 Reference Guide | BlueCielo ECM Solutions

Converts a document currently in document type workflow to a state in a workflow definition. This method is only supported when Work Isolation Mode is turned off and the document itself is not released. It can also be used to make a transition (reroute) from one state to another within the same workflow definition and to make a transition to the Released state either by revoking the workflow (if it is in the beginning state) or by releasing the document if it is in an end state.

Namespace: ICMeridianAPI
Assembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 1.0.6.0 (1.0.6.0)

Syntax

C++

Copy to Clipboard Print

public void MigrateDocument(
	string vaultidentifier,
	string docid,
	string wfdef,
	string wfstate = "",
	string comments = "",
	Object todopersons = null,
	string transition = ""
)

public void MigrateDocument(
	string vaultidentifier,
	string docid,
	string wfdef,
	string wfstate = "",
	string comments = "",
	Object todopersons = null,
	string transition = ""
)

Public Sub MigrateDocument ( _
	vaultidentifier As String, _
	docid As String, _
	wfdef As String, _
	Optional wfstate As String = "", _
	Optional comments As String = "", _
	Optional todopersons As Object = Nothing, _
	Optional transition As String = "" _
)

Public Sub MigrateDocument ( _
	vaultidentifier As String, _
	docid As String, _
	wfdef As String, _
	Optional wfstate As String = "", _
	Optional comments As String = "", _
	Optional todopersons As Object = Nothing, _
	Optional transition As String = "" _
)

public:
void MigrateDocument(
	String^ vaultidentifier, 
	String^ docid, 
	String^ wfdef, 
	String^ wfstate = L"", 
	String^ comments = L"", 
	Object^ todopersons = nullptr, 
	String^ transition = L""
)

public:
void MigrateDocument(
	String^ vaultidentifier, 
	String^ docid, 
	String^ wfdef, 
	String^ wfstate = L"", 
	String^ comments = L"", 
	Object^ todopersons = nullptr, 
	String^ transition = L""
)

Parameters

vaultidentifier: Type: System String
The vault in which the document resides.

docid: Type: System String
The unique identifier of the document inside the vault.

wfdef: Type: System String
The internal name of the advanced document workflow definition to which this document should be converted.

wfstate (Optional): Type: System String
The internal name of the workflow state in the definition the document should be set to as current workflow state.

comments (Optional): Type: System String
Optional string. Comment to be written in the comment log of the file.

todopersons (Optional): Type: System Object
Optional. An array of strings each representing a todo person

transition (Optional): Type: System String
Optional. Name of the transition to be executed.

Remarks

If workflow target state is not specified, then the requested TRANSITION of the requested workflow definition is attempted to be executed.