Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This is a data structure that holds project role's initial allocation configuration. 

Format


Panel
titlePwsProjectRoleHoursPattern
  • PwsProjectRoleHoursPattern
    • HoursAllocationPercentage: Double
    • HoursBucketCount: Int
    • HoursSchedulingMode: String(1)
    • HoursStartDate: DateTime
    • ConstraintType: String(1)
    • MinutesPerBucket: Int

Elements


Element

Data Type

Requried?

Description

Sample Data

HoursAllocationPercentage

doubleDouble

See Description

Percentage of working hours to allocate over the requested range. Must be 0 or greater. Specify the value as a ratio (e.g. 100% = 1.0). One and only one of HoursAllocationPercentage and MinutesPerBucket must be specified.

0.75

HoursBucketCountIntintYesNumber of buckets to allocate. This is either a number of weeks or a number of days, depending upon HoursSchedulingMode. Required.5
HoursSchedulingModestringString(1)NoSchedule time by day (D) or week (W). Defaults to the assignment's default scheduling mode.D
HoursStartDateDateTimeSee DescriptionThe starting date for the allocations. Required if the role open date is prioer prior to the current date. Otherwise, defaults to the role open date,2019-10-01z
ConstraintTypestringString(1)NoThe constraint to apply. N - None, W - Working Hours, H - Working Hours less Holidays, T - Working Hours less Holidays and Time Off, A - Available Hours (Working Hours less Holidays, Time Off and Other Allocations). Defaults to 'N'.N
MinutesPerBucketintIntSee DescriptionNumber of minutes to allocate per bucket. This is an alternative to specifying HoursAllocationPercentage. Only one of the two can be specified.450

Usage Example(s)


Code Block
languagexml
titleExample 01 - named
collapsetrue
            <sch:InitialAllocation>
               <com:HoursAllocationPercentage>0.6</com:HoursAllocationPercentage>
               <com:HoursBucketCount>5</com:HoursBucketCount>
               <com:HoursSchedulingMode>W</com:HoursSchedulingMode>
               <com:HoursStartDate>2019-02-01z</com:HoursStartDate>
               <com:ConstraintType>N</com:ConstraintType>
               <!--com:MinutesPerBucket>500</com:MinutesPerBucket-->
            </sch:InitialAllocation>