TimeSheetPolicyBean

TimeSheetPolicyBean is used to hold the information for an existing time sheet policy.

Note: TimeSheetPolicyBean is used as the OUTPUTin getTimeSheetPolicy.

Property

Type

Description

Required

Default

timeSheetPolicyId

Long

ID of the time sheet policy.

Yes

N/A

timeSheetPolicyName

String

String value of the time sheet policy name.

Yes

N/A

bucketShowLevel

String

Unit of measurement for each time bucket.

Valid values:

  • PERIOD

  • DAY

  • HOURS

Yes

N/A

bucketReportMethod

String

Defines how time sheets report time.

Valid values:

  • HOURS

  • DAYS

  • PERCENT

Yes

N/A

hoursPerPeriod

Double

Numeric value that defines how many hours a single period contains.

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

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

Numeric value of how many hours are in a workday. Relevant when time is measured by day or hours.

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

Boolean value - True if the policy allows multiple time sheets, False otherwise.

Yes

False

hoursInPeriodType

String

Defines how period in hours should be calculated.

Valid values:

  • FIXED (for period)

  • WORKDAY (for hours)

No

N/A

notifyDelinquentTimeSheet

Boolean

Boolean value - True if you need the notification of delinquent time, False otherwise.

Yes

False

maximumHoursPerDay

Double

Numeric value of the max hours per day to enforce. Relevant when time is measured by day.

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

Numeric value of the max days per day to enforce. Relevant when time is measured by day.

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

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

Numeric value of the min hours per time sheet to enforce. This field is relevant only when the value for bucketReportMethod is HOURS.

No

N/A

maximumDaysPerTimeSheet

Double

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

Numeric value of the min days per time sheet to enforce. This field is relevant only when the value for bucketReportMethod is DAYS.

No

N/A

maximumPercentPerTimeSheet

Double

Numeric value of the max 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

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

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.

Yes

False

reqActivitiesRequiredFlag

Boolean

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

Yes

False

tskActivitiesRequiredFlag

Boolean

Boolean value - True if activities are required for Task work items, False otherwise.

Yes

False

prjActivitiesRequiredFlag

Boolean

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

Yes

False

pkgActivitiesRequiredFlag

Boolean

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

Yes

False

miscActivitiesRequiredFlag

Boolean

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

Yes

False

reqWorkItemEnabledFlag

Boolean

Boolean value - True if Request work items are enabled for this time sheet, False otherwise.

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

Yes

Taken from server.conf

tskWorkItemEnabledFlag

Boolean

Boolean value - True if Task work items are enabled for this time sheet, False otherwise

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

Yes

Taken from server.conf

prjWorkItemEnabledFlag

Boolean

Boolean value - True if Project work items are enabled for this time sheet, False otherwise.

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

Yes

Taken from server.conf

pkgWorkItemEnabledFlag

Boolean

Boolean value - True if Package work items are enabled for this time sheet, False otherwise.

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

Yes

Taken from server.conf

mscWorkItemEnabledFlag

Boolean

Boolean value - True if Misc work items are enabled for this time sheet, False otherwise.

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

Yes

Taken from server.conf