WFEvent

Description

A class that represents a workflow event.

Syntax

public class WFEvent

Constructors

public WFEvent();
public WFEvent(string name);
public WFEvent(string sender, string name);

Namespace and Assembly

RequirementValue

Namespace

Ascentn.Workflow.Base

Assembly

Ascentn.Workflow.WFBase (in Ascentn.Workflow.WFBase.dll)

Properties

PropertyDescription

ActivityInstID
Function:
The unique ID for an activity instance.
Type
string
Accepted Values:
A valid activity instance ID.

AutoStart
Function:
Specifies if the process starts immediately after it is created.
Type
bool
Accepted Values:
  • True - The process instance starts immediately after it is created.
  • False - The process instance does not start immediately after it is created.

clientData
Function:
Specifies the client data, which identifies a client for AgilePoint Server.
Type
string
Accepted Values:
A string that contains the client data.

If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.

CustomAttributes
Function:
Specifies custom attributes in XML format.
Type
NameValue
Accepted Values:
A valid NameValue pair.

Designated
Function:
Gets and sets the flag that determines if the event should be handled by a designated engine.
Type
bool
Accepted Values:
  • True - The event is handled by a designated engine.
  • False - The event is not handled by a designated engine.

Diagnostic
Function:
Gets and sets the flag that determines if the process data will be deleted from the database after the process is completed.
Type
bool
Accepted Values:
  • True - The process data is deleted from the database.
  • False - The process data is not deleted from the database.

EndDate
Function:
Specifies the completion date of delegation.
Type
DateTime
Accepted Values:
A valid DateTime value.

Entries
Function:
Gets the relay time of the event.
Type
int
Accepted Values:
A valid relay time.

Error
Function:
Gets and sets the error message of the event.
Type
string
Accepted Values:
A valid error message.

EventID
Function:
Specifies a unique ID for an event.
Type
string
Accepted Values:
A unique, 32-character ID.

EventName
Function:
Specifies the name of the event.
Type
string
Accepted Values:
A valid event name.

ParamsXml
Function:
Gets and sets the parameters as XML.
Type
string
Accepted Values:
A parameter.

ParentProcInstID
Function:
Specifies parent process instance ID.
Type
string
Accepted Values:
A valid process instance ID.

ProcDefID
Function:
Specifies process template (process definition) ID.
Type
string
Accepted Values:
A valid process definition ID.

ProcInstID
Function:
Specifies the unique ID of a process instance.
Type
string
Accepted Values:
A valid process instance ID

ProcInstName
Function:
A unique process name that is associated with the process definition.
Type
string
Accepted Values:
A unique process instance name up to 1024 characters.

Sender
Function:
Specifies a sender of the event.
Type
string
Accepted Values:
A valid user name.

SentDate
Function:
Specifies a sent date of the event.
Type
DateTime
Accepted Values:
A valid DateTime value.

SourceWorkItemID
Function:
An ID that represents the original, or source, work item.
Type
string
Accepted Values:
A valid, unique 32-character ID.

Status
Function:
The status of the event.
Type
string
Accepted Values:
A valid status.

ThrowAwayInstance
Function:
Specifies the flag that determines if AgilePoint server should clear the process from cache.
Type
bool
Accepted Values:
  • True - AgilePoint Server clears the process from the cache.
  • False - AgilePoint Server does not clear the process from cache.

UserID
Function:
Specifies the user ID.
Type
string
Accepted Values:
A valid user ID.

WorkItemID
Function:
An ID that represents a work item (task).
Type
string
Accepted Values:
A valid, unique 32-byte work item (task) ID.

workObjectID
Function:
An ID for an object, such as a document, that is associated with the process instance.
Type
string
Accepted Values:
A valid, unique 256-character ID.

Even though the field size is 256 characters, in common practice, this will usually return a 32-character GUID.