com.ibm.rpm.wbs.containers
TaskAssignment

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.timesheet.containers.GenericTaskAssignment
   extended bycom.ibm.rpm.wbs.containers.TaskAssignment

TaskAssignment
Extends: com.ibm.rpm.timesheet.containers.GenericTaskAssignment
Child objects: None

Related scope: com.ibm.rpm.wbs.scope.TaskAssignmentScope

data associated with a resource or a profile that is assigned to a Wbs element, as described in the ResourceTaskAssignment container documention. A TaskAssignment must be created and deleted through its parent ResourceTaskAssignment, but it can be loaded and updated independently.

Parent is mandatory, allowed parent type is ResourceTaskAssignment.

The checkout mode type is: Parent

Delete restrictions: This object can't be deleted.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Related code samples :

Java

C#

Field Summary
xsd:dateTime actualFinishDate
    The actual finish date of the task assignment, it is set to the date the resource completes his or her portion of the task.
xsd:dateTime actualStartDate
    The actual start date of the task assignment, it is set once the resource starts the task.
xsd:double actualWork
    The actual amount of work required to complete the task. This value is derived from the resource's timesheet.

This field is editable for all assigned resources once there is a timesheet entry for any of the assigned resources.

xsd:dateTime assignmentFinishDate
    The finish date of the assignment.

If the assignmentStartDate is modified to be larger than the current assignmentFinishDate, the assignmentFinishDate is modified to become the assignmentStartDate plus the planned days of duration of the task if it exists (WorkElement.planDate). If the planDate does not exist, the proposed days of duration (WorkElement.proposedDate) field is used.

DateType assignmentFinishDateType
    The type of date associated with the assignment finish date.
xsd:dateTime assignmentStartDate
    The start date of the assignment. Once it has a value, the actualStartDate is copied into assignmentStartDate.
DateType assignmentStartDateType
    The type of date associated with the assignment start date.
xsd:dateTime baselineFinishDate
    The baseline finish date
xsd:dateTime baselineStartDate
    The baselines start date
xsd:double baselineWork
    Affected work.
xsd:boolean billable
    Whether or not the task assignment is billable.
xsd:dateTime calculatedLeveledFinishDate
    The leveled finish date
xsd:dateTime calculatedLeveledStartDate
    The leveled start date
xsd:double calculatedLeveledWork
    The amount of work performed.
xsd:boolean complete
    Determines whether the task has been completed or not. For example, percentageComplete is 100.
Contract contract
    The contract related to the task assignment.
ChargeCode costLaborCode
    The Expense or Capital labor code for the resource assignment.
xsd:double costPerHour
    The resource's regular cost rate.
FinancialCategory costType
    The type of cost of the task.
xsd:int daysOfDelay
    The number of days the task is delayed.
xsd:boolean defaultLabor
    Once the defaultLabor code is set to true for a resource assignment, the next time the resource is assigned in this project, the labor codes from the assignment will be used as default .
xsd:double EETCHours
    Estimated Effort to Complete. The Estimated Effort to Complete. This field is calculated based on the actualWork field, it is the remaining number of hours to completion .((lastScheduleWork * number of work hours per calendar day) - actualWork).
xsd:dateTime expectedFinishDate
    The date at which the resource is expected to finish the task, based on the resource's calendar.
xsd:dateTime expectedStartDate
    The date at which the task is expected to be started.

If the task's planned or proposed start date (WorkElement.planDate or WorkElement.proposedDate) is modified, the value is copied into the expectedStartDate field.

xsd:double expectedWork
    The expected work from the WorkElement for a resource assignment.
xsd:dateTime forecastFinishDate
    The forecasted finish date.
xsd:dateTime forecastStartDate
    The forecasted start date
xsd:double lastScheduleWork
    Work in days at last schedule. Recalculated when EETCHours is modified: (EETCHours + actualHours) /hours per calendar day.
xsd:double percentageComplete
   

The percentage of completion of the task.

Calculated field: 100 - (EETCHours / (lastScheduleWork * hours in calendar day) * 100)

xsd:int percentageDurationComplete
    The percentage duration completed of the task.
xsd:int percentageRateAdjustment
    The percentage adjustment of regular selling rate.

If the sellingRatePerHour is modified, the percentageRateAdjustment is modified to reflect the percentage adjustment from the selling rate per hour defined in the resource's profile (ResourceRates.sellingRatePerHour).

If the percentageRateAdjustment is modified, the sellingRatePerHour is re-calculated to reflect the percentage adjustment.

xsd:double percentageWork
    Work percentage complete.

Field is Calculated: 100 - (EETCHours / (lastScheduleWork * hours in calendar day) * 100)

This field becomes editable for all task resources once actualStartDate exists for a resource.

xsd:double plannedDurationHours
    Planned hours of duration.
xsd:double proposedDurationHours
    The proposed duration time in hours.
xsd:double remainingHours
    The number of remaining hours to complete the task.

This field is calculated based on the actualWork field which represents the remaining number of hours to completion ((lastScheduleWork * number of work hours per calendar day) - actualWork) .

When EETCHours is overwritten, remainingHours takes on its value.

ChargeCode revenueLaborCode
    The Billable Benefit labor code for the assignment.
xsd:double sellingRatePerHour
    The resource's regular selling rate per hour.
xsd:double specialCostPerHour
    The resource's special (overtime) cost rate.
xsd:double specialSellingRatePerHour
    The resource's special (overtime) selling rate.
xsd:double unitsPercentage
    The quantity of a resource assigned to the task. When this field is modified, this forces recalculation of the number of hours to be worked per day on this task (SummaryTimesheet[]).
xsd:double workSchedule
    Scheduled work.

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.
xsd:boolean shownInTimesheet
    Whether or not the task assignment is shown in the Web UI timesheet view.

Field Detail

actualFinishDate


xsd:dateTime  actualFinishDate
The actual finish date of the task assignment, it is set to the date the resource completes his or her portion of the task.

Read-only behavior: The value of this field is read only.


actualStartDate


xsd:dateTime  actualStartDate
The actual start date of the task assignment, it is set once the resource starts the task.

Read-only behavior: The value of this field is read only.


actualWork


xsd:double  actualWork
The actual amount of work required to complete the task. This value is derived from the resource's timesheet.

This field is editable for all assigned resources once there is a timesheet entry for any of the assigned resources.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9000.00.

Validation: The year, month and day values will be used by this field.


assignmentFinishDate


xsd:dateTime  assignmentFinishDate
The finish date of the assignment.

If the assignmentStartDate is modified to be larger than the current assignmentFinishDate, the assignmentFinishDate is modified to become the assignmentStartDate plus the planned days of duration of the task if it exists (WorkElement.planDate). If the planDate does not exist, the proposed days of duration (WorkElement.proposedDate) field is used.

Read-only behavior: The value of this field is read only.


assignmentFinishDateType


DateType assignmentFinishDateType
The type of date associated with the assignment finish date.

Relationship: This field is a reference relationship.


assignmentStartDate


xsd:dateTime  assignmentStartDate
The start date of the assignment. Once it has a value, the actualStartDate is copied into assignmentStartDate.

Validation: The year, month and day values will be used by this field.


assignmentStartDateType


DateType assignmentStartDateType
The type of date associated with the assignment start date.

Relationship: This field is a reference relationship.


baselineFinishDate


xsd:dateTime  baselineFinishDate
The baseline finish date

Read-only behavior: The value of this field is read only.


baselineStartDate


xsd:dateTime  baselineStartDate
The baselines start date

Read-only behavior: The value of this field is read only.


baselineWork


xsd:double  baselineWork
Affected work.

Read-only behavior: The value of this field is read only.


billable


xsd:boolean  billable
Whether or not the task assignment is billable.

Default value: This default value is true.


calculatedLeveledFinishDate


xsd:dateTime  calculatedLeveledFinishDate
The leveled finish date

Read-only behavior: The value of this field is read only.


calculatedLeveledStartDate


xsd:dateTime  calculatedLeveledStartDate
The leveled start date

Read-only behavior: The value of this field is read only.


calculatedLeveledWork


xsd:double  calculatedLeveledWork
The amount of work performed.

Read-only behavior: The value of this field is read only.


complete


xsd:boolean  complete
Determines whether the task has been completed or not. For example, percentageComplete is 100.

Read-only behavior: The value of this field is read only.


contract


Contract contract
The contract related to the task assignment.

Scoping: This field will be used by the API if the scope field contract is enabled.

Relationship: This field is a reference relationship.


costLaborCode


ChargeCode costLaborCode
The Expense or Capital labor code for the resource assignment.

Scoping: This field will be used by the API if the scope field costLaborCode is enabled.

Relationship: This field is a reference relationship.


costPerHour


xsd:double  costPerHour
The resource's regular cost rate.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.


costType


FinancialCategory costType
The type of cost of the task.

Relationship: This field is a reference relationship.


daysOfDelay


xsd:int  daysOfDelay
The number of days the task is delayed.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 2000.


defaultLabor


xsd:boolean  defaultLabor
Once the defaultLabor code is set to true for a resource assignment, the next time the resource is assigned in this project, the labor codes from the assignment will be used as default .

Default value: This default value is false.

Validation: The year, month and day values will be used by this field.


EETCHours


xsd:double  EETCHours
Estimated Effort to Complete. The Estimated Effort to Complete. This field is calculated based on the actualWork field, it is the remaining number of hours to completion .((lastScheduleWork * number of work hours per calendar day) - actualWork).

Null value: This field cannot be zero if actualStartDate is null.


expectedFinishDate


xsd:dateTime  expectedFinishDate
The date at which the resource is expected to finish the task, based on the resource's calendar.

Read-only behavior: The value of this field is read only.

Validation: The year, month and day values will be used by this field.


expectedStartDate


xsd:dateTime  expectedStartDate
The date at which the task is expected to be started.

If the task's planned or proposed start date (WorkElement.planDate or WorkElement.proposedDate) is modified, the value is copied into the expectedStartDate field.

Read-only behavior: The value of this field is read only.


expectedWork


xsd:double  expectedWork
The expected work from the WorkElement for a resource assignment.

Read-only behavior: The value of this field is read only.


forecastFinishDate


xsd:dateTime  forecastFinishDate
The forecasted finish date.

Read-only behavior: The value of this field is read only.

Validation: The year, month and day values will be used by this field.


forecastStartDate


xsd:dateTime  forecastStartDate
The forecasted start date

Read-only behavior: The value of this field is read only.

Validation: The year, month and day values will be used by this field.


lastScheduleWork


xsd:double  lastScheduleWork
Work in days at last schedule. Recalculated when EETCHours is modified: (EETCHours + actualHours) /hours per calendar day.

Read-only behavior: The value of this field is read only.


percentageComplete


xsd:double  percentageComplete

The percentage of completion of the task.

Calculated field: 100 - (EETCHours / (lastScheduleWork * hours in calendar day) * 100)

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 100.00.

Read-only: The percentageComplete is read only before the task has been copyProposedToPlan.

Also, it is read only in SummaryTimesheet when there is no actuals inputed.


percentageDurationComplete


xsd:int  percentageDurationComplete
The percentage duration completed of the task.

Read-only behavior: The value of this field is read only.


percentageRateAdjustment


xsd:int  percentageRateAdjustment
The percentage adjustment of regular selling rate.

If the sellingRatePerHour is modified, the percentageRateAdjustment is modified to reflect the percentage adjustment from the selling rate per hour defined in the resource's profile (ResourceRates.sellingRatePerHour).

If the percentageRateAdjustment is modified, the sellingRatePerHour is re-calculated to reflect the percentage adjustment.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 100.


percentageWork


xsd:double  percentageWork
Work percentage complete.

Field is Calculated: 100 - (EETCHours / (lastScheduleWork * hours in calendar day) * 100)

This field becomes editable for all task resources once actualStartDate exists for a resource.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 100.00.


plannedDurationHours


xsd:double  plannedDurationHours
Planned hours of duration.

proposedDurationHours


xsd:double  proposedDurationHours
The proposed duration time in hours.

remainingHours


xsd:double  remainingHours
The number of remaining hours to complete the task.

This field is calculated based on the actualWork field which represents the remaining number of hours to completion ((lastScheduleWork * number of work hours per calendar day) - actualWork) .

When EETCHours is overwritten, remainingHours takes on its value.

Read-only behavior: The value of this field is read only.


revenueLaborCode


ChargeCode revenueLaborCode
The Billable Benefit labor code for the assignment.

Scoping: This field will be used by the API if the scope field revenueLaborCode is enabled.

Relationship: This field is a reference relationship.


sellingRatePerHour


xsd:double  sellingRatePerHour
The resource's regular selling rate per hour.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.


specialCostPerHour


xsd:double  specialCostPerHour
The resource's special (overtime) cost rate.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.


specialSellingRatePerHour


xsd:double  specialSellingRatePerHour
The resource's special (overtime) selling rate.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.


unitsPercentage


xsd:double  unitsPercentage
The quantity of a resource assigned to the task. When this field is modified, this forces recalculation of the number of hours to be worked per day on this task (SummaryTimesheet[]).

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 999999.99.


workSchedule


xsd:double  workSchedule
Scheduled work.

Read-only behavior: The value of this field is read only.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.wbs.containers.ResourceTaskAssignment

shownInTimesheet


xsd:boolean  shownInTimesheet
Whether or not the task assignment is shown in the Web UI timesheet view.

Null value: This field may never be null during updates.

Default value: This default value is false.