WorkElement

Description

Package: com.ibm.rpm.wbs.containers

Extends: RPMObject

Usage

This class cannot be used to directly create an object. It is extended to create Milestone, Task, and AggregateNode. AggregateNode includes GenericProject (Project, Proposal, and WorkOrganization), as well as WorkProduct, SummaryTask, and Deliverable.

Supported API Calls

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. WorkElement Field Description
Field Detail
actualDate

Type: WbsScheduleDate

Default value: N/A (derived value)

Description: The actual date for this WorkElement.

The actual duration in hours/days, of actual work hours, actual duration in minutes, and actual start and finish dates of the WorkElement.

WorkElements that contain sub-elements:

  • If at least one of the sub-element’s actualDate.startDate has a value, then the earliest actualDate.startDate date rolls up to the parent WorkElement’s actualDate.startDate.
  • If all subelements have an actualDate.finishDate, then the latest actualDate.finishDate rolls up to the parent WorkElement’s actualDate.finishDate.
Field validation description:
  • All actualDate fields are read-only for projects, work organizations, proposals, deliverables, work products, and summary tasks.
  • All actualDate fields are set to read-only once resourceRoleAssignment contains a value, at which point the fields are based on timesheet entries.
  • Fields actualDate.startDate and actualDate.durationInMinutes are the only editable fields. All others are always read-only.
  • The actualDate fields are not editable until planDate.startDate contains a value and planDate.durationInMinutes is larger than 0.
  • The actualDate.durationInMinutes field is not editable until actualDate.startDate contains a value.
  • The actualDate.startDate field cannot be edited if actualDate.durationInMinutes=planDate.durationInMinutes.
  • The actualDate.durationInMinutes field must be <= than the planDate.durationInMinutes field.

Additional field security restrictions: N/A

asset

Type: Asset

Default value: N/A

Description: Asset for this WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

assetCode

Type: AssetFinancialCategory

Default value: The AssetFinancialCategory containing the name field with the value "1".

Description: The work element’s asset code.

Field validation description: N/A

Additional field security restrictions: N/A

attributeAssignments

Type: AttributeAssignment[]

Default value: N/A

Description: The attributes assigned to the work element.

Field validation description: N/A

Additional field security restrictions: N/A

baselineDate

Type: WbsScheduleDate

Default value: N/A (derived value)

Description: The baseline duration in hours and/or days, baseline work hours, baseline duration in minutes, and baseline start and finish dates of the WorkElement.

Values copied from planDate fields or from proposedDate fields if planDate is null.

The baselineDate is overwritten when a new baseline is saved.

Field validation description: This field is read-only.

Additional field security restrictions: N/A

containingProject

Type: WorkElement

Default value: N/A

Description: The WorkElement’s containing Project.

Field validation description: N/A

Additional field security restrictions: N/A

customFieldAssignments

Type: CustomFieldAssignment[]

Default value: N/A

Description: List of CustomFieldAssignment containers.

Field validation description: N/A

Additional field security restrictions: N/A

dependencies

Type: ElementDependency[]

Default value: N/A

Description: List of ElementDependency containers .

Field validation description: N/A

Additional field security restrictions: N/A

documentFolder

Type: DocumentFolder

Default value: N/A

Description: The documents that belong to the WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

estimatedFinishDate

Type: dateTime

Default value: N/A

Description: The estimated finish date.

Field validation description: estimatedFinishDate must be greater than or equal to estimatedStartDate.

Additional field security restrictions: N/A

estimatedStartDate

Type: dateTime

Default value: The current date.

Description: The estimated start date

Field validation description: estimatedStartDate must be less than or equal to estimatedFinishDate.

Additional field security restrictions: N/A

expectedDate

Type: WbsScheduleDate

Default value: N/A

Description: The expected duration in hours and/or days, expected work hours, expected duration in minutes, and expected start and finish dates of the WorkElement.

Overwritten by planDate fields once they are entered.

Field validation description: This fields is read-only.

Additional field security restrictions: N/A

externalID

Type: string

Default value: N/A

Description:

Field validation description: Limit 50 characters.

Additional field security restrictions: N/A

forecastDate

Type: WbsScheduleDate

Default value: N/A (derived value)

Description: The forecast duration in hours and/or days, forecast work hours, forecast duration in minutes, and forecast start and finish dates of the WorkElement.

Field validation description:
  • All forecastDate fields set to read-only once resourceRoleAssignment contains a value, at which point the fields are calculated.
  • Field forecastDate.durationInMinutes is the only editable forecastDate field. All others are always read-only.
  • This field is read-only for proposals, work organizations, projects, deliverables, work products, and summary tasks.
  • The forecastDate.durationInMinutes field is editable only when actualDate.startDate has a value but actualDate.durationInMinutes is not equal to planDate.durationInMinutes
  • The forecastDate.durationInMinutes field must be greater than or equal to the actualDate.durationInMinutes field if it exists.
  • When the forecastDate.durationInMinutes field is entered, the value is copied to the planDate.durationInMinutes field and the planDate.finishDate is adjusted accordingly.

Additional field security restrictions: N/A

initialBaselineDate

Type: WbsScheduleDate

Default value: N/A (derived value)

Description: Initial baseline duration in hours and/or days, initial baseline work hours, initial baseline duration in minutes, and initial baseline start and finish dates of the WorkElement.

Values copied from planDate fields or from proposedDate fields if planDate is null.

Once the initialBaselineDate is set, it is never modified.

Field validation description: This field is read-only.

Additional field security restrictions: N/A

lastModifiedDate

Type: dateTime

Default value: N/A

Description: Date last modified.

Field validation description: N/A

Additional field security restrictions: N/A

minutesPerDay

Type: int

Default value: N/A

Description: Minutes per day.

Field validation description: N/A

Additional field security restrictions: N/A

name

Type: string

Default value: N/A

Description: The name of the element being created.

Field validation description:

Limit 240 characters for Proposals, Projects, and WorkOrganizations.

Limit 255 characters for Deliverables, Work Products, Summary Tasks, Milestones, and Tasks.

This field is mandatory.

Additional field security restrictions: N/A

planDate

Type: WbsScheduleDate

Default value: N/A

Description: The plan duration in hours and/or days, plan work hours, plan duration in minutes, and plan start and finish dates of the WorkElement.

WorkElements that contain sub-elements:
  • The parent WorkElement’s planDate.startDate is based on the earliest planDate.startDate from sub-elements.
  • The parent WorkElement’s planDate.finishDate is based on the latest planDate.finishDate from sub-elements.
Field validation description: N/A
  • This field is read-only for projects, work organizations, proposals, deliverables, work products, and summary tasks. The planDate fields are overwritten when proposedDate fields are copied to planDate fields.
  • All planDate fields are set to read-only once resourceRoleAssignment contains a value.
  • Fields planDate.startDate and planDate.durationInMinutes are the only editable fields. All others are always read-only.
  • The planDate fields are edited when forecastDate fields are entered. Refer to the description of field forecastDate for details.
  • The planDate.durationInMinutes field is not editable until planDate.startDate contains a value.
  • Once planDate.startDate contains a value, it can be changed but not cleared.
  • Field planDate.finishDate is calculated based on the project calendar if planDate.startDate and planDate.durationInMinutes contain values.
  • Once a resource is assigned to the WorkElement, the planDate is modified based on resource availability (see TaskAssignment). Must copy proposed to plan for the modification to occur.
  • All planDate fields read-only once actualDate.startDate contains a value.
  • Once they are entered, actualDate fields are copied to planDate fields.

Additional field security restrictions: N/A

previousBaselineDate

Type: WbsScheduleDate

Default value: N/A (derived value)

Description: The previous baseline duration in hours and/or days, previous baseline work hours, previous baseline duration in minutes, and previous baseline start and finish dates of the WorkElement.

Values copied from baselineDate fields when the second and subsequent baselines are saved.

Field validation description: This field is read-only.

Additional field security restrictions: N/A

proposedDate

Type: WbsScheduleDate

Default value: The expectedDate copied to proposedDate (derived value).

Description: The proposed duration in hours and/or days, proposed work hours, proposed duration in minutes, and proposed start and finish dates of the WorkElement.

Field validation description:
  • This field is read-only for projects, proposals, work organizations, deliverables, work products, and summary tasks.
  • All proposedDate fields are set to read-only once planDate.startDate is set or once resourceRoleAssignment contains a value.
  • Fields proposedDate.startDate and proposedDate.durationInMinutes are the only editable fields. All others are always read-only.
  • Field proposedDate.finishDate calculated based on the project calendar.
  • The proposedDate.startDate field cannot be cleared.
  • All proposedDate fields are cleared once the planDate is entered.

Additional field security restrictions: N/A

rank

Type: int

Default value: 500

Description: The ranking of the WorkElement.

Field validation description: The value range is 0 - 1000.

Additional field security restrictions: N/A

referenceNumber

Type: string

Default value: N/A

Description:

Field validation description:

Limit 19 characters for a Project or a Proposal.

Limit 50 characters for all other elements.

Additional field security restrictions: N/A

resourceTaskAssignments

Type: ResourceTaskAssignment[]

Default value: N/A

Description: List of ResourceTasks assigned to this WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

rtfAssignments

Type: RtfAssignments[]

Default value: N/A

Description: List of RtfAssignments for this WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

scopeElement

Type: ScopeElement

Default value: N/A

Description: The ScopeElement associated with the WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

state

Type: DatafieldState

Default value: For Proposals, Projects, and WorkOrganizations, the State containing the name field with the value "1".

For Deliverables, WorkProducts, and SummaryTasks, the DeliverableState containing the name field with the value "1".

For Milestones and Tasks, the TaskState containing the name field with the value "1".

Description: The state of the WorkElement.

Field validation description:

For Proposals, Projects, and WorkOrganizations, state must be an instance of State.

For Deliverables WorkProducts, and SummaryTasks, state must be an instance of DeliverableState.

For Tasks and Milestones, state must be an instance of TaskState.

Additional field security restrictions: N/A

statusUpdates

Type: StatusUpdates[]

Default value: N/A

Description: List of StatusUpdates for this WorkElement

Field validation description: N/A

Additional field security restrictions: N/A

timeCode1

Type: TimeCode

Default value: N/A

Description: The first of two time codes associated with the WorkElement.

Field validation description: timeCode1 must belong to Time Codes I category.

Additional field security restrictions: N/A

timeCode2

Type: TimeCode

Default value: N/A

Description: The second of two time codes associated with the WorkElement.

Field validation description: timeCode2 must belong to Time Codes II category.

Additional field security restrictions: N/A

timeCodeAssignments

Type: TimeCodeAssignment[]

Default value: N/A

Description: List of TimeCodeAssignment containers.

Field validation description: N/A

Additional field security restrictions: N/A

wbsFinancials

Type: WBSFinancial[]

Default value: N/A

Description: List of WBSFinancials for this WorkElement.

Field validation description: N/A

Additional field security restrictions: N/A

Inherited Fields

Click on object for list of inherited fields:

From RPMObject

Related Objects

N/A