ConnectionMigrateDocument Method |
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: ICMeridianAPIAssembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 4.0.8.0 (4.0.8.0)
Syntaxpublic 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:
void MigrateDocument(
String^ vaultidentifier,
String^ docid,
String^ wfdef,
String^ wfstate = L"",
String^ comments = L"",
Object^ todopersons = nullptr,
String^ transition = L""
)
member MigrateDocument :
vaultidentifier : string *
docid : string *
wfdef : string *
?wfstate : string *
?comments : string *
?todopersons : Object *
?transition : string
(* Defaults:
let _wfstate = defaultArg wfstate ""
let _comments = defaultArg comments ""
let _todopersons = defaultArg todopersons null
let _transition = defaultArg transition ""
*)
-> unit
Parameters
- vaultidentifier
- Type: SystemString
The vault in which the document resides. - docid
- Type: SystemString
The unique identifier of the document inside the vault. - wfdef
- Type: SystemString
The internal name of the advanced document workflow definition to which this document
should be converted. - wfstate (Optional)
- Type: SystemString
The internal name of the workflow state in the definition the document should be set to as
current workflow state. - comments (Optional)
- Type: SystemString
Optional string. Comment to be written in the comment log of the file. - todopersons (Optional)
- Type: SystemObject
Optional. An array of strings each representing a todo person - transition (Optional)
- Type: SystemString
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.
See Also