Versions Compared

Key

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

Overview


This structure contains an instance of PwsProjectRoleDetail which completely defines a project role. Currently, this structure has no other contents, but may in the future include additional related information about the project role that is not a direct attribute of the role itself, or additional non-editable attributes of the role.  This element structure is contained in the response for PwsGetProjectis a data structure that holds project role's initial allocation configuration. 

Format


Panel
titlePwsProjectRoleElementPwsProjectRoleHoursPattern
  • PwsProjectRoleElementPwsProjectRoleHoursPattern
    • ProjectRoleDetailHoursAllocationPercentage: PwsProjectRoleDetail Double
    • AssignedToSchedulersFlagHoursBucketCount: BooleanInt
    • Notes: PwsProjectNote []
    • ProjectIdentity: PwsProjectRef
    • DeletedFlag: Boolean
    • TotalScheduledMinutes: DoubleHoursSchedulingMode: String(1)
    • HoursStartDate: DateTime
    • ConstraintType: String(1)
    • MinutesPerBucket: Int

Elements


0

Element

Data Type

Requried?

Description

Sample Data

ProjectRoleDetail

PwsProjectRoleDetail

The complete set of project role information. Click here for more detail.

AssignedToSchedulersFlagBooleanIf set to "true", this project role is assigned to scheduler to be booked.false
NotesPwsProjectNote []Notes that have been entered for the role.ProjectIdentityPwsProjectRefThe identity of the project that has the project role.
DeletedFlagBooleanIf set to true, this role is deleted.true
TotalScheduledMinutesDoubleThe total of this role's scheduled minutes.

HoursAllocationPercentage

Double

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

HoursBucketCountIntYesNumber of buckets to allocate. This is either a number of weeks or a number of days, depending upon HoursSchedulingMode.5
HoursSchedulingModeString(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 prior to the current date. Otherwise, defaults to the role open date,2019-10-01z
ConstraintTypeString(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
MinutesPerBucketIntSee 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
                     <b:PwsProjectRoleElement><sch:InitialAllocation>
                        <b:ProjectRoleDetail>
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRoleId i:nil="true"/><com:HoursAllocationPercentage>0.6</com:HoursAllocationPercentage>
                           <b:ProjectRoleUid>1152921504609687526</b:ProjectRoleUid><com:HoursBucketCount>5</com:HoursBucketCount>
                           <b:BaseRateOnTitleIdentity i:nil="true"/>
                           <b:CandidateIdentities>
                              <b:PwsResourceRef>
                                 <b:ResourceDisplayName>Barry Allen</b:ResourceDisplayName>
                                 <b:ResourceId i:nil="true"/>
                                 <b:ResourceReferenceSystemId>barry1</b:ResourceReferenceSystemId>
                                 <b:ResourceUid>1152921504607019493</b:ResourceUid>
                              </b:PwsResourceRef>
                           </b:CandidateIdentities>
                           <b:CostCenterAnyFlag>false</b:CostCenterAnyFlag>
                           <b:CostCenterCriteria xmlns:c="http://projectorpsa.com/CommonServices/"/>
                           <b:CostCenterIdentity i:nil="true"/><com:HoursSchedulingMode>W</com:HoursSchedulingMode>
                           <b:DefaultSchedulingMode>W</b:DefaultSchedulingMode>
                           <b:Description i:nil="true"/>
                           <b:Keywords i:nil="true"/>
                           <b:LocationAnyFlag>false</b:LocationAnyFlag>
                           <b:LocationIdentities/>
                           <b:LocationIdentity i:nil="true"/>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                           <b:ResourceIdentity>
                              <b:ResourceDisplayName>Barry Allen</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
                              <b:ResourceReferenceSystemId>barry1</b:ResourceReferenceSystemId>
                              <b:ResourceUid>1152921504607019493</b:ResourceUid>
                           </b:ResourceIdentity>
                           <b:RoleEndDate i:nil="true"/>
                           <b:RoleName>Barry Allen</b:RoleName>
                           <b:RoleStartDate i:nil="true"/>
                           <b:ShareCostCenterIdentity i:nil="true"/>
                           <b:SkillCriteria/>
                           <b:TitleIdentities/>
                           <b:TitleIdentity i:nil="true"/>
                           <b:RdcTransferCurrencyIdentity i:nil="true"/>
                           <b:RdcTransferHourlyRate i:nil="true"/>
                           <b:RevenueTransferHourlyRate i:nil="true"/>
                           <b:UserDefinedFields/>
                           <b:RateExceptions/>
                           <b:RdcExceptions/>
                           <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                           <b:PurchaseOrderNumber i:nil="true"/>
                           <b:ResourceTypeAnyFlag>false</b:ResourceTypeAnyFlag>
                           <b:ResourceTypeIdentities/>
                           <b:ResourceTypeIdentity i:nil="true"/>
                           <b:ShareUserIdentity i:nil="true"/>
                           <b:Timestamp>AAAAABFFCO4=</b:Timestamp>
                        </b:ProjectRoleDetail>
                        <b:AssignedToSchedulersFlag>false</b:AssignedToSchedulersFlag>
                        <b:Notes>
                           <b:PwsProjectNote>
                              <b:CreatedByUserIdentity>
                                 <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504606944254</b:UserUid>
                              </b:CreatedByUserIdentity>
                              <b:CreatedTimestamp>2018-11-13T17:02:57.423Z</b:CreatedTimestamp><com:HoursStartDate>2019-02-01z</com:HoursStartDate>
                              <b:Note>Need cover singer for Rossina nailed down.</b:Note>
                              <b:CreatedByUser>
          <com:ConstraintType>N</com:ConstraintType>
                      <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504606944254</b:UserUid>
                                 <b:EmailAddress>Larry@revcorp.min</b:EmailAddress>
                                 <b:FirstName>Larry</b:FirstName>
                                 <b:LastName>Krakauer</b:LastName>
                                 <b:MiddleName>A</b:MiddleName>
                              </b:CreatedByUser>
                              <b:ReadFlag>true</b:ReadFlag>
                              <b:ReadTimestamp>2018-11-13T12:02:57.423</b:ReadTimestamp>
                           </b:PwsProjectNote>
                        </b:Notes>
                        <b:ProjectIdentity>
                           <b:ProjectCode>P001125-001</b:ProjectCode>
                           <b:ProjectId i:nil="true"/>
                           <b:ProjectUid>1152921504607425735</b:ProjectUid>
                        </b:ProjectIdentity>
                        <b:DeletedFlag>false</b:DeletedFlag>
                        <b:TotalScheduledMinutes>60</b:TotalScheduledMinutes>
                     </b:PwsProjectRoleElement>
Code Block
languagexml
titleExample 02 - unnamed
collapsetrue
  					  <b:PwsProjectRoleElement>
                        <b:ProjectRoleDetail>
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRoleId i:nil="true"/>
                           <b:ProjectRoleUid>1152921504609687954</b:ProjectRoleUid>
                           <b:BaseRateOnTitleIdentity i:nil="true"/>
                           <b:CandidateIdentities/>
                           <b:CostCenterAnyFlag>false</b:CostCenterAnyFlag>
                           <b:CostCenterCriteria xmlns:c="http://projectorpsa.com/CommonServices/">
                              <c:PwsCostCenterCriteria>
                                 <c:CascadeFlag>true</c:CascadeFlag>
                                 <c:CostCenterIdentity>
                                    <b:CostCenterId i:nil="true"/>
                                    <b:CostCenterName>US-Public Sector*</b:CostCenterName>
                                    <b:CostCenterNumber>US1</b:CostCenterNumber>
                                    <b:CostCenterUid>1152921504606856645</b:CostCenterUid>
                                 </c:CostCenterIdentity>
                              </c:PwsCostCenterCriteria>
                           </b:CostCenterCriteria>
                           <b:CostCenterIdentity>
                              <b:CostCenterId i:nil="true"/>
                              <b:CostCenterName>US-Public Sector*</b:CostCenterName>
                              <b:CostCenterNumber>US1</b:CostCenterNumber>
                              <b:CostCenterUid>1152921504606856645</b:CostCenterUid>
                           </b:CostCenterIdentity>
                           <b:DefaultSchedulingMode>W</b:DefaultSchedulingMode>
                           <b:Description i:nil="true"/>
                           <b:Keywords i:nil="true"/>
                           <b:LocationAnyFlag>true</b:LocationAnyFlag>
                           <b:LocationIdentities/>
                           <b:LocationIdentity>
                              <b:LocationId i:nil="true"/>
                              <b:LocationName>Boston</b:LocationName>
                              <b:LocationUid>1152921504606852816</b:LocationUid>
                           </b:LocationIdentity>
                           <b:NewExternalSystemIdentifier i:nil="true"/>
                           <b:ResourceIdentity i:nil="true"/>
                           <b:RoleEndDate i:nil="true"/>
                           <b:RoleName>Project Manager</b:RoleName>
                           <b:RoleStartDate i:nil="true"/>
                           <b:ShareCostCenterIdentity i:nil="true"/>
                           <b:SkillCriteria/>
                           <b:TitleIdentities>
                              <b:PwsTitleRef>
                                 <b:DepartmentIdentity>
                                    <b:DepartmentId i:nil="true"/>
                                    <b:DepartmentName>Technology</b:DepartmentName>
                                    <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
                                 </b:DepartmentIdentity>
                                 <b:TitleId i:nil="true"/>
                                 <b:TitleName>Principal Technical Consultant</b:TitleName>
                                 <b:TitleUid>1152921504606862841</b:TitleUid>
                              </b:PwsTitleRef>
                              <b:PwsTitleRef>
                                 <b:DepartmentIdentity>
                                    <b:DepartmentId i:nil="true"/>
                                    <b:DepartmentName>Technology</b:DepartmentName>
                                    <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
                                 </b:DepartmentIdentity>
                                 <b:TitleId i:nil="true"/>
                                 <b:TitleName>Senior Technical Consultant</b:TitleName>
                                 <b:TitleUid>1152921504606862842</b:TitleUid>
                              </b:PwsTitleRef>
                           </b:TitleIdentities>
                           <b:TitleIdentity>
                              <b:DepartmentIdentity>
                                 <b:DepartmentId i:nil="true"/>
                                 <b:DepartmentName>Technology</b:DepartmentName>
                                 <b:DepartmentUid>1152921504606851320</b:DepartmentUid>
                              </b:DepartmentIdentity>
                              <b:TitleId i:nil="true"/>
                              <b:TitleName>Principal Technical Consultant</b:TitleName>
                              <b:TitleUid>1152921504606862841</b:TitleUid>
                           </b:TitleIdentity>
                           <b:RdcTransferCurrencyIdentity i:nil="true"/>
                           <b:RdcTransferHourlyRate i:nil="true"/>
                           <b:RevenueTransferHourlyRate i:nil="true"/>
                           <b:UserDefinedFields>
                              <b:PwsUserDefinedFieldDetail>
                                 <b:UdfId i:nil="true"/>
                                 <b:UdfName>RUDF_Tlst_3vals</b:UdfName>
                                 <b:UdfUid>1152921504606857067</b:UdfUid>
                                 <b:BooleanValue i:nil="true"/>
                                 <b:DataType>L</b:DataType>
                                 <b:DateValue i:nil="true"/>
                                 <b:IntegerValue i:nil="true"/>
                                 <b:ResourceIdentityValue i:nil="true"/>
                                 <b:TextValue>c. Hycinth (inactive)</b:TextValue>
                                 <b:UdfTreatment>A</b:UdfTreatment>
                                 <b:StoplightValues/>
                                 <b:NumericValue i:nil="true"/>
                                 <b:RelationValue i:nil="true"/>
                              </b:PwsUserDefinedFieldDetail>
                           </b:UserDefinedFields>
                           <b:RateExceptions/>
                           <b:RdcExceptions/>
                           <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                           <b:PurchaseOrderNumber i:nil="true"/>
                           <b:ResourceTypeAnyFlag>false</b:ResourceTypeAnyFlag>
                           <b:ResourceTypeIdentities>
                              <b:PwsResourceTypeRef>
                                 <b:ResourceTypeCode>Sal</b:ResourceTypeCode>
                                 <b:ResourceTypeId i:nil="true"/>
                                 <b:ResourceTypeName>Salaried</b:ResourceTypeName>
                                 <b:ResourceTypeUid>1152921504606847077</b:ResourceTypeUid>
                              </b:PwsResourceTypeRef>
                              <b:PwsResourceTypeRef>
                                 <b:ResourceTypeCode>Sal with OT</b:ResourceTypeCode>
                                 <b:ResourceTypeId i:nil="true"/>
                                 <b:ResourceTypeName>Salaried with Overtime</b:ResourceTypeName>
                                 <b:ResourceTypeUid>1152921504606847078</b:ResourceTypeUid>
                              </b:PwsResourceTypeRef>
                           </b:ResourceTypeIdentities>
                           <b:ResourceTypeIdentity>
                              <b:ResourceTypeCode>Sal</b:ResourceTypeCode>
                              <b:ResourceTypeId i:nil="true"/>
                              <b:ResourceTypeName>Salaried</b:ResourceTypeName>
                              <b:ResourceTypeUid>1152921504606847077</b:ResourceTypeUid>
                           </b:ResourceTypeIdentity>
                           <b:ShareUserIdentity>
                              <b:UserDisplayName>Chris Evans</b:UserDisplayName>
                              <b:UserId i:nil="true"/>
                              <b:UserReferenceSystemId>008</b:UserReferenceSystemId>
                              <b:UserUid>1152921504606944233</b:UserUid>
                           </b:ShareUserIdentity>
                           <b:Timestamp>AAAAABFEKj4=</b:Timestamp>
                        </b:ProjectRoleDetail>
                        <b:AssignedToSchedulersFlag>false</b:AssignedToSchedulersFlag>
                        <b:Notes/>
                        <b:ProjectIdentity>
                           <b:ProjectCode>P001125-001</b:ProjectCode>
                           <b:ProjectId i:nil="true"/>
                           <b:ProjectUid>1152921504607425735</b:ProjectUid>
           <!--com:MinutesPerBucket>500</com:MinutesPerBucket-->
            </b:ProjectIdentity>
                        <b:DeletedFlag>false</b:DeletedFlag>
                        <b:TotalScheduledMinutes>120</b:TotalScheduledMinutes>sch:InitialAllocation>                      </b:PwsProjectRoleElement>