TimeSheetBean

timeSheetId

Long

Generated automatically when the time sheet object is created in PPM Center. This field is not required in the createTimeSheet operation, but it is required for other operations that use TimeSheetBean.

No

N/A

resourceId

Long

ID of the resource of the time sheet.

Yes

N/A

periodId

Long

Period ID of the Time Period of the time sheet.

Yes

N/A

description

String

Description of the time sheet.

If you do not provide this property when you create a time sheet, it is automatically created with the default value: resourceName - periodName #sequence

No

resourceName - periodName #sequence

sequence

Integer

Read-only field.

Numeric value starting from 1.

Unique per resource and time period.

If the policy allows multiple time sheets per resource and period, each subsequent time sheet that you create is automatically increment the sequence number.

No

1 (the first one)

state

TimeSheetStatus

Status of the time sheet. On the time sheet creation, the default value is "unsubmitted." See TimeSheetStatus for more details.

No

unsubmitted

timeSheetLines

List

List of TimeSheetLineBean objects. See TimeSheetLineBean

No

N/A

bucketShowLevel

String

Part of policy fields.

The unit of measurement of each time bucket.

Valid values:

• PERIOD

• DAY

• HOURS

It is the only field that the system checks to determine whether policy fields are set. If you do not set this field, the system discards the values in the following fields marked with policy fields.

No

N/A

bucketReportMethod

String

Part of policy fields.

Defines how time sheets report time.

Valid values:

• HOURS

• DAYS

• PERCENT

It is required when bucketShowLevel is set.

No

N/A

hoursPerPeriod

Double

Part of policy fields.

Numeric value of how many hours should be per period.

This field is relevant only when all of the following conditions are true:

• The value for bucketShowLevel is PERIOD.

• The value for bucketReportMethod is PERCENT.

• The value for periodHoursCalcTypeCode is FIXED.

No

N/A

periodHoursCalcTypeCode

String

Part of policy fields.

Defines how period in hours should be calculated.

Valid values:

• FIXED (for period)

• WORKDAY (for days).

This field is relevant only when both of the following conditions are true:

• The value for bucketShowLevel is PERIOD.

• The value for bucketReportMethod is PERCENT.

No

N/A

workdayHours

Double

Part of policy fields.

Numeric value of how many hours should be in a workday.

This field is relevant only when all of the following conditions are true:

• The value for bucketShowLevel is PERIOD.

• The value for bucketReportMethod is PERCENT.

• The value for periodHoursCalcTypeCode is WORKDAY.

No

N/A

allowMultipleTimeSheets

Boolean

Part of policy fields.

Boolean value - Set this field to true if the policy allows multiple time sheets.

The default value for this field is False, which means multiple time sheets are not allowed by default.

This field is required if you set the bucketShowLevel field.

No

False

hoursInPeriodType

String

Part of policy fields.

Defines how period in hours should be calculated.

Valid values:

• FIXED (for period)

• WORKDAY (for hours)

No

N/A

notifyDelinquentTimeSheet

Boolean

Part of policy fields.

Boolean value - Set this field to true if you need the notification of delinquent time sheets. False otherwise.

It is required if you set the bucketShowLevel field.

No

False

maximumHoursPerDay

Double

Part of policy fields.

Numeric value of the max hours per day to enforce.

This field is relevant only when both of the following conditions are true:

• The value for bucketShowLevel is Day.

• The value for bucketReportMethod is HOURS.

No

N/A

maximumDaysPerDay

Double

Part of policy fields.

Numeric value of the max days per day to enforce.

This field is relevant only when both of the following conditions are true:

• The value for bucketShowLevel is Day.

• The value for bucketReportMethod is DAYS.

No

N/A

maximumHoursPerTimeSheet

Double

Part of policy fields.

Numeric value of the max hours per time sheet to enforce.

This field is relevant only when the value for bucketReportMethod is HOURS.

No

N/A

minimumHoursPerTimeSheet

Double

Part of policy fields.

Numeric value of the minimum hours per time sheet to enforce.

This field is relevant only when the value for bucketReportMethod is HOURS.

No

N/A

maximumDaysPerTimeSheet

Double

Part of policy fields.

Numeric value of the max days per time sheet to enforce.

This field is relevant only when the value for bucketReportMethod is DAYS.

No

N/A

minimumDaysPerTimeSheet

Double

Part of policy fields.

Numeric value of the minimum days per time sheet to enforce.

This field is relevant only when the value for bucketReportMethod is DAYS.

No

N/A

maximumPercentPerTimeSheet

Double

Part of policy fields.

Numeric value of the maximum percent per time sheet to enforce.

This field is relevant only when both of the following conditions are true:

• The value for bucketShowLevel is PERIOD

• The value for bucketReportMethod is PERCENT

No

N/A

minimumPercentPerTimeSheet

Double

Part of policy fields.

Numeric value of the min percent per time sheet to enforce.

This field is relevant only when both of the following conditions are true:

• The value for bucketShowLevel is PERIOD.

• The value for bucketReportMethod is PERCENT.

No

N/A

enforcementLevelError

Boolean

Part of policy fields.

Boolean value - Set this field to True if you want the system to prevent the submission of a time sheet when the submission violates the policy enforcements. Set it to False if you want the system to display only a warning when a violation occurs.

It is required if you set the bucketShowLevel field.

No

False

reqActivitiesRequiredFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if activities are required for Request work items, False otherwise.

It is required if you set the bucketShowLevel field.

No

False

tskActivitiesRequiredFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if activities are required for Task work items, False otherwise).

It is required if you set the bucketShowLevel field.

No

False

prjActivitiesRequiredFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if activities are required for Project work items, False otherwise.

It is required if you set the bucketShowLevel field.

No

False

pkgActivitiesRequiredFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if activities are required for Package work items, False otherwise.

It is required when bucketShowLevel is set.

No

False

miscActivitiesRequiredFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if activities are required for Misc work items, False otherwise.

It is required if you set the bucketShowLevel field.

No

False

reqWorkItemEnabledFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if you want to track Request work items for this time sheet, False otherwise. It is required if you set the bucketShowLevel field.

The default value is taken from server.conf.

com.kintana.core.server.PURGE_SERVER_PROPERTIES_TABLE=true

com.kintana.core.server.ENABLE_TM_WORK_ITEM_REQUESTS=true

No

Taken from server.conf

tskWorkItemEnabledFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if you want to track Task work items for this time sheet, False otherwise.

It is required if you set the bucketShowLevel field.

The default value is taken from server.conf.

com.kintana.core.server.PURGE_SERVER_PROPERTIES_TABLE=true

com.kintana.core.server.ENABLE_TM_WORK_ITEM_TASKS=true

No

Taken from server.conf

prjWorkItemEnabledFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if you want to track Project work items for this time sheet, False otherwise.

It is required if you set the bucketShowLevel field.

The default value is taken from server.conf.

com.kintana.core.server.PURGE_SERVER_PROPERTIES_TABLE=true

com.kintana.core.server.ENABLE_TM_WORK_ITEM_PROJECTS=true

No

Taken from server.conf

pkgWorkItemEnabledFlag

Boolean

Part of policy fields.

Boolean value - Set this field to True if you want to track Package work items in this time sheet, False otherwise.

It is required if you set the bucketShowLevel field.

The default value is taken from server.conf.com.kintana.core.server.

PURGE_SERVER_PROPERTIES_TABLE=true

com.kintana.core.server. ENABLE_TM_WORK_ITEM_PACKAGES =true

No

Taken from server.conf

mscWorkItemEnabledFlag

Boolean

Part of policy fields.

Boolean value - True if you want to track Misc work items in this time sheet, False otherwise).

It is required when bucketShowLevel is set.

The default value is taken from server.conf.

com.kintana.core.server.PURGE_SERVER_PROPERTIES_TABLE=true

com.kintana.core.server. ENABLE_TM_WORK_ITEM_MISC =true

No

Taken from server.conf

exceptionMessage

String

Read-only field.

If there is a violation of the policy, this field is set by the system automatically when you save the Time Sheet.

No

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 all the lines in the time sheet 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 all the lines in the time sheet 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 reevaluation of approvers using the following 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, if all lines have the same user as possible time approver, this field is set to the IDs of this user ID.

• Else, this field is set to the ID of the default time approver of the resource of this time sheet.

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 this time sheet 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 this time sheet is a Security Group. Otherwise it is null.

No

N/A

billingApproverUsersIds

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 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 default billing approver as determined by the re-evaluation of the approvers.

No

N/A