TimeSheetLineBean

TimeSheetLineBean represents the time sheet line in a time sheet. It is used in TimeSheetBean. This data type is used in TimeSheetBean.

Property

Type

Description

Required

Default

timeSheetLineId

Long

Generated automatically by the system when a time sheet line object in PPM Center is created.

Yes if the timesheet line has already been existed

N/A

workItemId

String

String object which holds the ID of the work item of the line.

Yes

N/A

workItemSetId

String

String object which holds the ID of the parent of the work item of the line.

The parent of a request should be the request type.

The parent of a task should be the project.

The parent of a project should be the same project.

The parent of a package should be the workflow.

The parent of a misc should be the constant MISC.

Yes

N/A

workItemType

String

String object which holds the type of the work item of the line.

Valid values:

  • REQUEST

  • TASK

  • PROJECT

  • PACKAGE

  • MISC

Yes

N/A

State

TimeSheetLineStatus

This field is set by default to be "unsubmitted" during the creation of a line. See TimeSheetLineStatus for more details.

No

unsubmitted

timeActualsList

List

List of TimeActualsBean objects.

See TimeActualsBean for more details.

For each Line there must be at least two records of Time Actuals list. The two records include same actuals with different total flag Y and N. If there are more than one non-total records (records with total flag as N), each non-total record must be associated with an Activity ID. If there is only one non-total record, it may or may not be associated with an Activity ID.

No

N/A

chargeCodesList

List

List of ChargeCodeBean objects.

See ChargeCodeBean for more details.

The sum of all percentages in charge code list must be 100, otherwise an exception (ex.chargeCodePercentagesMustSum100) is thrown.

No

N/A

updateChargeCodeFlag

Boolean

Boolean value.

True if charge codes can be updated in the time sheet, False otherwise.

No

True

requireChargeCodeFlag

Boolean

Boolean value.

True if charge codes are required in the time sheet, False otherwise.

No

False

userDataBean

UserDataBean

UserDataBean object.

See UserDataBean for more details.

Holds an array of up to 20 user data hidden values and a corresponding array of up to 20 user data visible values.

No

N/A

actualApproverUserId

Long

Long value of the user ID of the user who approves the actual time logged in the line.

It is required when the state is "approved."

Yes If line is approved

N/A

effortOnWorkItemEntityFlag

Boolean

Boolean value.

True if effort must be synched to Project Management or Demand Management when you save the effort, False otherwise.

No

False

tmWorkUnitId

Long

Long value of the ID of the TM work unit, which is a record in the staging table that helps in synching the effort between Time Management and Project Management or Demand Management.

After first save

N/A

timeApproverParticipantGroupId

Long

Read-only field.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field is set only if the possible Time Approver of the line is a Participant Group (such as Project Managers). Otherwise it is null.

No

N/A

timeApproverSecurityGroupId

Long

Read-only field.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field is set only if the possible Time Approver of the line is a Security Group. Otherwise it is null.

No

N/A

timeApproverUsersIds

List

Read-only field.

List of Long object values, each representing a User ID.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field must be set on re-evaluation of approvers using this order of precedence:

  • If timeApproverParticipantGroupId is not null, this field is set to the IDs of all the users in this participant group.

  • Else, if timeApproverSecurityGroupId is not null, this field is set to the IDs of all the users in this security group.

  • Else, this field is set to the ID of the time approver of the line as determined by the re-evaluation of the approvers.

No

N/A

billingApproverParticipantGroupId

Long

Read-only field.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field is set only if the possible Billing Approver of the time sheet of this line is a Participant Group (such as Project Managers). Otherwise it is null.

No

N/A

billingApproverSecurityGroupId

Long

Read-only field.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field is set only if the possible Billing Approver of the time sheet of this line is a Security Group. Otherwise it is null.

No

N/A

billingApproverUsersIds

List

Read-only field.

List of Long object values, each representing User ID.

The system reevaluates possible approvers when you save and load the time sheet. At the same time, the system sets this field automatically.

This field must be set on re-evaluation of approvers using this order of precedence:

  • If billingApproverParticipantGroupId is not null, this field is set to the IDs of all the users in this participant group.

  • Else, if billingApproverSecurityGroupId is not null, this field is set to the IDs of all the users in this security group.

  • Else, this field is set to the ID of the time approver of the line as determined by the re-evaluation of the approvers.

No

N/A