C# Class K2Field.Helpers.Core.K2Helper

Inheritance: IDisposable

Private Properties

Property	Type	Description

Method	Description
ActionWorklistItem ( string serialNumber, string action ) : void	Actions a worklist item
Dispose ( ) : void
K2Helper ( string K2ServerName ) : System	Creates an instance of this class, will use the standard ports for Management and Workflow client connections
K2Helper ( string K2ServerName, uint WorkflowClientPort, uint WorkflowManagementServerPort ) : System	Creates an instance of the class with overrides for the workflow client and management server ports
K2Helper ( string K2ServerName, uint WorkflowClientPort, uint WorkflowManagementServerPort, string SecurityLabelName ) : System	Creates an instance of the class with overrides for the workflow client and management server ports and security label
SmartObjectClient ( ) : K2SmartObjectClient	SmartObject Client
StartK2Process ( string processName, string folio ) : int	Starts a K2 process with process data fields.
StartK2Process ( string processName, string folio, CoreDataField>.Dictionary inputs ) : int	Starts a K2 process with process data fields.
StartK2Process ( string processName, string folio, object>.Dictionary inputs ) : int	Starts a K2 process with process data fields.
WorkflowClient ( ) : K2WorkflowClient	Workflow Client
WorkflowServer ( ) : WorkflowManagementServer	Workflow Management Server

Actions a worklist item

public ActionWorklistItem ( string serialNumber, string action ) : void
serialNumber	string	Serial number of the worklist item
action	string	Action to execute
return	void

public Dispose ( ) : void
return	void

Creates an instance of this class, will use the standard ports for Management and Workflow client connections

public K2Helper ( string K2ServerName ) : System
K2ServerName	string	K2 server name
return	System

Creates an instance of the class with overrides for the workflow client and management server ports

public K2Helper ( string K2ServerName, uint WorkflowClientPort, uint WorkflowManagementServerPort ) : System
K2ServerName	string	k2 server name
WorkflowClientPort	uint	Workflow client port
WorkflowManagementServerPort	uint	Management serverport
return	System

Creates an instance of the class with overrides for the workflow client and management server ports and security label

public K2Helper ( string K2ServerName, uint WorkflowClientPort, uint WorkflowManagementServerPort, string SecurityLabelName ) : System
K2ServerName	string	k2 server name
WorkflowClientPort	uint	Workflow client port
WorkflowManagementServerPort	uint	Management serverport
SecurityLabelName	string	security label
return	System

SmartObject Client

public SmartObjectClient ( ) : K2SmartObjectClient
return	K2SmartObjectClient

Starts a K2 process with process data fields.

public StartK2Process ( string processName, string folio ) : int
processName	string	Process Name
folio	string	Folio
return	int

Starts a K2 process with process data fields.

public StartK2Process ( string processName, string folio, CoreDataField>.Dictionary inputs ) : int
processName	string	Process Name
folio	string	Folio
inputs	CoreDataField>.Dictionary	Datafield to start the process with
return	int

Starts a K2 process with process data fields.

public StartK2Process ( string processName, string folio, object>.Dictionary inputs ) : int
processName	string	Process Name
folio	string	Folio
inputs	object>.Dictionary	Datafield to start the process with
return	int

Workflow Client

public WorkflowClient ( ) : K2WorkflowClient
return	K2WorkflowClient

Workflow Management Server

public WorkflowServer ( ) : WorkflowManagementServer
return	WorkflowManagementServer