CheckOut Process Definition

Description

This method is used to manage process definition versioning by setting the process definition status to CheckedOut based on a given process definition ID. Only process definitions with the status of Released can transition into the CheckedOut status.

Syntax

public virtual string CheckoutProcDef(string pID)

Parameters

Name	Type	Description
processTemplateID	string	The unique identifier for the process definition to be checked out for modification.

Output

The process definition, in XML format, that has been checked out.

Example

IWFWorkflowService svc = GetWorkflowService();

try
	{
    string processDefinitionID = … // process definition to be checked out
    stringprocessDefinitionXML =
    svc.CheckoutProcDef(processDefinitionID);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage( ex ) );
	}

Supported Versions

3.2.0.4 or higher

Parent topic: Process Definition Methods