ProjectActivity Class

This object represents a Process Timeline Activity. It is derived from the ProcessTask Class and includes all of its properties, plus the additional properties below.

Properties

PROPERTY NAME

 DATA TYPE

DESCRIPTION

ACTID

 String

The ID of the Project activity

ACTINSTID

 String

The ID of the Activity Instance

ActivityType

 Integer

The type of activity, defined by the enum: public enum ActivityType

Possible Activity Types are as follows:

VALUE

EXPLANATION

0

Not set

1

User: Users are assigned to activity

2

Notify: Notify users

3

Process: A Workflow or Process Timeline is run for this activity

4

Script: A script is run for this activity

5

Custom Task: A Custom Task is run for this activity

6

Meta Data: Used to set the package to this meta data (with some options to copy form instance meta data)

7

Form: Used to attach a form and/or set the current form viewer for this project

8

Branch activity

9

Parent activity

10

End Timeline

11

Wait: Wait for time or condition

ActName

 String

The name of the Project Activity

PRID

 String

The ID of the Project Definition

PRINSTID

 String

The Project Instance ID

Methods

Link

This API will get a Project/Timeline Activity object from the specified instance ID.

Parameters

BP: The bp environment.

ACTID: The ID of the Project Activity to retrieve.

Returns

ProjectActivity: Will return null if the activity instance isn't found.

Example

// Normally not used directly
var oProjectActivity =
    ProjectActivity.GetProjectActivityByACTID (bp, "ACTID");

Link

This API will get a Project/Timeline Activity instance object from the specified instance ID.

Parameters

BP: The bp environment.

ACTINSTID: The ID of the Project Activity instance to retrieve.

Returns

ActivityInstance: Will return null if the activity instance isn't found.

Example

// Normally not used directly
var oProjectActivityInst =
    ProjectActivity.GetProjectActivityByACTINSTID (bp, "ACTINSTID");

Link

This API will get a Project/Timeline Activity object from the specified Name.

Parameters

BP: The bp environment.

ActivityName: The string name of the Project Activity to retrieve.

Returns

ProjectActivity: Will return null if the activity instance isn't found.

Example

// Normally not used directly
var oProjectActivity =
    ProjectActivity.GetProjectActivityByName (bp, "ActivityName");

Link

This API will restart a Timeline Activity.

Parameters

None.

Returns

Returns 'true" if the operation succeeds.

Example

// Restart the Process Task
bool bRestart = CurrentActivity.Restart();

Link

This method enables the Owner Shared Delegate to be changed on a running activity instance.

Parameters

String pActivityName: The activity name to which to set the Delegation Owner(s).

String pNewOwnerUIDs: A comma-separated list of UIDs to set the new owner(s) of the delegation instance.

Returns

Boolean: True if the operation succeeds.

Example

bool success = SetInstanceOwnerDelegate("Activity Name", "UID1,UID2,UID3");