WFAgileWorkDescriptor

Description

An abstract class of WFAgileWorkDescriptor Custom properties format: [Prefix]:[Assembly Information]:[Class Name]:[Parameter].

Syntax

public class WFAgileWorkDescriptor : WFManualActivityDefinition, IWFProcessDefinitionReference

Constructors

public WFAgileWorkDescriptor();

Namespace and Assembly

RequirementValue

Namespace

Ascentn.Workflow.Base

Assembly

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

Properties

PropertyDescription

AssemblyName

Function:
Gets and sets the full name of the assembly.
Type
string
Accepted Values:
A valid assembly name.

AutoComplete

Function:
Gets and sets the flag that determines whether the work item is automatically marked as completed.
Type
bool
Accepted Values:
  • True - The work item is completed automatically.
  • False - The work item is not completed automatically.

ClassName

Function:
Gets and sets the class name, including the namespace.
Type
string
Accepted Values:
A valid class name.

CustomProperties

Function:
Specifies the custom properties. This member supports the AgilePoint Framework infrastructure and does not intend to use directly from your code.
Type
string
Accepted Values:
A valid custom properties.

Description

Function:
A description of the activity.
Type
string
Accepted Values:
A string that can contain spaces and special characters.

DisplayName

Function:
Gets and sets the display name of the activity.
Type
string
Accepted Values:
A valid activity display name.

ExpectedDuration

Function:
Specifies an expected time duration of the activity.
Type
WFTimeDuration
Accepted Values:
A valid WFTimeDuration object.

ID

Function:
Specifies the activity ID.
Type
WFTimeDuration
Accepted Values:
A valid activity ID.

IncomingActivities

Function:
Gets the interfaces for all the incoming activities.
Type
WFTimeDuration
Accepted Values:
A valid WFTimeDuration object.

IncomingEmail

Function:
Specifies an email template that used for an email notification after the start of the activity.
Type
string
Accepted Values:
A valid email template.

IncomingMailTemplate

Function:
Specifies an email template that used for an email notification after the start of the activity.
Type
string
Accepted Values:
A valid email template.

Index

Function:
Specifies the ordering index of the activity.
Type
int
Accepted Values:
An integer.

Item

Function:
Specifies the value associated with the specified parameter name.
Type
object
Accepted Values:
A valid Types object.

MaxParticipant

Function:
Specifies the maximum participants for the activity.
Type
int
Accepted Values:
An integer.

Name

Function:
The name of an item, such as a property or attribute in a name/value pair.
Type
string
Accepted Values:
A valid name.

Optional

Function:
Gets and sets the flag to indicate if the activity is optional.
Type
bool
Accepted Values:
  • True - The activity is optional.
  • False - The activity is not optional.

OutgoingActivities

Function:
Gets the interfaces for all the outgoing activities.
Type
string
Accepted Values:
A valid interface.

OutgoingEmail

Function:
Specifies an email template that used for email notification after the completion of an activity.
Type
string
Accepted Values:
A valid email template.

OutgoingMailTemplate

Function:
Specifies an email template to use for email notification when leaving the activity.
Type
string
Accepted Values:
A valid email template.

Participant

Function:
Specifies the participant of the activity.
Type
string
Accepted Values:
A valid user name.

Participants

Function:
Specifies the participants of the activity.
Type
string
Accepted Values:
A valid multiple user names separated with a semicolon (;).

Process

Function:
Gets the interface class and sets the process definition.
Type
string
Accepted Values:
A valid process definition.

ReassigningEmail

Function:
Specifies the email template that used for an email notification when task is reassigned.
Type
string
Accepted Values:
A valid email template.

ReassigningMailTemplate

Function:
Specifies the email template for task reassignment.
Type
string
Accepted Values:
A valid email template.

RemindingEmail

Function:
Specifies an email template that used for reminding email notification.
Type
string
Accepted Values:
A valid email template.

RemindingMailAtBusinessTime

Function:
Gets and sets the flag that determines whether reminding an email must send in business time.
Type
bool
Accepted Values:
  • True - Reminding emails are sent using business time.
  • False - Reminding email are sent using real time.

RemindingMailFrequency

Function:
Specifies the frequency of reminding an email notification.
Type
int
Accepted Values:
An integer.

RemindingMailStartTime

Function:
Specifies the start time in minutes of reminding an email notification before the task expires.
Type
int
Accepted Values:
An integer.

RemindingMailTemplate

Function:
Specifies the email template for task reminder emails.
Type
int
Accepted Values:
A valid email template.

ReuseParticipant

Function:
Gets and sets the flag that determines whether the participants must remain the same when the activity activated more than one time.
Type
bool
Accepted Values:
  • True - The participants remains the same when the activity activated more than one time.
  • False - The participants do not remain the same when the activity activated more than one time.

TimeoutActivities

Function:
Gets the interfaces for all the timeout activities.
Type
string
Accepted Values:
A valid interface.

TimeoutEmail

Function:
Specifies the email template to use for email notification when task is Overdue.
Type
string
Accepted Values:
A valid email template.

TimeoutMailTemplate

Function:
Specifies an email template that used for email notification when the activity is overdue.
Type
string
Accepted Values:
A valid email template.

WaitAllIncoming

Function:
Gets and sets the flag to determine whether the activity must wait until all predecessor activities complete.
Type
string
Accepted Values:
  • True - The activity waits until all predecessor activities complete.
  • False - The activity starts without waiting for predecessor activities complete.

WaitWorkPerformed

Function:
Specifies whether the activity must be marked as completed by the application before proceeding.
Type
bool
Accepted Values:
  • True - The activity must complete before proceeding.
  • False - The activity can proceed without waiting.

WorkPerformer

Function:
Specifies the WorkPerfomer/job of the manual activity.
Type
string
Accepted Values:
A valid WorkPerfomer/job name.

WorkToPerform

Function:
Represents the task that performed by the participants of the activity.
Type
string
Accepted Values:
A valid work to perform name.