SummaryTimesheet

Description

Package: com.ibm.rpm.timesheet.containers

Extends: AbstractTimesheet

Usage

The SummaryTimesheet object is used to report time against specific TaskAssignments. SummaryTimesheet objects are automatically deleted when their parent is deleted, they cannot be deleted otherwise,.

Two steps must be taken before creating a SummaryTimesheet:

  1. The project has to be published to the team (project.setPublished(PublishedType.ToTeam).
  2. The proposed dates of the project must be copied to planned dates using the Application Interface’s method copyProposedToPlan(ssessionID, workElement, workElementScope).

Once a SummaryTimesheet is submitted for approval, it can no longer be modified, unless it has been rejected by the manager. In addition, the SummaryTimesheet object cannot be modified if the task has been broken into steps (for example, Activity objects exist for TaskAssignment)

Parent is mandatory, allowed parent type is TaskAssignment.

Supported API Calls

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. SummaryTimesheet Field Description
Field Detail
approvalStatus

Type: TimesheetApprovalStatus

Default value: null

Description: Determines if summary timesheet has been submitted, approved, or rejected.

Field validation description: N/A

Additional field security restrictions: N/A

complete

Type: boolean

Default value: false

Description: Determines whether the task has been completed or not. For example, percentageComplete is 100. This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

EETCHours

Type: double

Default value: EETC = (TaskAssignment’s expectedWork) - totalIncurred – (the summation of hours reported for the week).

Description: The Estimated Effort to Complete the assignment. If the user set the value of this field, then no calculation will take place. Otherwise, the above formula will be used to determine EETC. When EETC is 0, percentageComplete is 100.

Field validation description: Must be a positive number rounded to the nearest 0.25.

Additional field security restrictions: N/A

expectedWorkPerWeek

Type: double

Default value: totalWeek

Description: The expected work for the week.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

percentageComplete

Type: double

Default value: 0

Description: The percentage of the work that is complete. When EETC is 0, percentageComplete is 100.

Field validation description:

Value range: 0 - 100.

Additional field security restrictions: N/A

scheduleWorlBaseline

Type: double

Default value: N/A

Description: The schedule baseline work expressed in hours .

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

scheduleWorkSchedule

Type: double

Default value: N/A

Description: The current scheduled work expressed in hours.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

timeCode1

Type: TimeCode

Default value: null

Description: The first time code of the summary timesheet.

Field validation description: The time code must belong to Time Codes I category and it must be assigned to the project.

Additional field security restrictions: N/A

timeCode2

Type: TimeCode

Default value: null

Description: The second time code of the summary timesheet.

Field validation description: The time code must belong to Time Codes II category and it must be assigned to the project.

Additional field security restrictions: N/A

totalIncurred

Type: double

Default value: 0

Description: Total hours worked for the assignment.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

totalRegular

Type: double

Default value: 0

Description: Total regular hours worked in the week. The value of this field is the summation of regularFriday, regularMonday, regularSaturday, regularSunday, regularThursday, regularTuesday, and regularWednesday.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

totalSpecial

Type: double

Default value: 0

Description: Total special (overtime) hours worked in the week. The value of this field is the summation of specialFriday, specialMonday, specialSaturday, specialSunday, specialThursday, specialTuesday, and specialWednesday.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

totalWeek

Type: double

Default value: 0

Description: Total hours worked in the week. The value of this field is the summation of totalRegular and totalSpecial.

This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

Inherited Fields

Click on object for list of inherited fields:

From RPMObject

From AbstractTimesheet

Related Objects

  • SummaryTimesheetScope
  • GenericProject