# Class: ProcessInstance

## tibco.objectapi.pm.ProcessInstance

#### new ProcessInstance()

Type to describe a process instance. Constructs a new ProcessInstance.

The following features are supported:

- `Process QName`
- `Id`
- `State`
- `Start Time`
- `Completion Time`
- `Priority`
- `Waiting Work Count`
- `Parent Process ID`
- `User ID`
- `Originator Name`
- `Failed Activity Name`
- `Activity Fault Name`
- `Activity Fault Data`
- `Custom Attributes`

### Members

#### activityFaultData :string

Activity fault data. This property holds the value of the 'Activity Fault Data' attribute.

##### Type:

- string

#### activityFaultName :string

Activity fault name. This property holds the value of the 'Activity Fault Name' attribute.

##### Type:

- string

#### completionTime :Date

Date/time the process instance reached one of the terminal states. This property holds the value of the 'Completion Time' attribute.

##### Type:

- Date

#### customAttributes :tibco.objectapi.pm.CustomAttributesType

List of user-defined attributes. This property holds the value of the 'Custom Attributes' containment reference.

##### Type:

- tibco.objectapi.pm.CustomAttributesType

#### failedActivityName :string

Name of the failed activity. This property holds the value of the 'Failed Activity Name' attribute.

##### Type:

- string

#### id :string

Unique ID assigned to the process instance. This property holds the value of the 'Id' attribute.

##### Type:

- string

#### originatorName :string

username who sent the request that results in the creation of the process instance. This property holds the value of the 'Originator Name' attribute.

##### Type:

- string

#### parentProcessID :string

Unique ID of the parent process instance, in cases where the process instance was created via a sub-process call. This property holds the value of the 'Parent Process ID' attribute.

##### Type:

- string

#### priority :number

Priority of the process instance, used to schedule its execution. This property holds the value of the 'Priority' attribute.

##### Type:

- number

#### processQName :tibco.objectapi.pm.QualifiedProcessName

Fully qualified name of the process template from which the process instance was created. This property holds the value of the 'Process QName' containment reference.

##### Type:

- tibco.objectapi.pm.QualifiedProcessName

#### startTime :Date

Date/time when the process instance first became active. This property holds the value of the 'Start Time' attribute.

##### Type:

- Date

#### state :string

Current state of the process instance - for example ACTIVE or SUSPENDED. For a complete list of the possible states and their meanings, see the Openspace User's Guide or Workspace User's Guide. This property holds the value of the 'State' attribute.

##### Type:

- string

#### userID :string

ID of the user who sent the request that results in the creation of the process instance. This ID is determined from the user/security-context. This property holds the value of the 'User ID' attribute.

##### Type:

- string

#### waitingWorkCount :number

Count of the number of user task instances waiting for a response from Business Resource Management (BRM). This indirectly provides a count of the number of outstanding work items associated with the process instance. This property holds the value of the 'Waiting Work Count' attribute.

##### Type:

- number