PwsProjectRoleDetail

Owned by Min Zeng
Last updated: Jun 21, 2021
24 min read

Overview

This structure is part of PwsProjectRoleElement, and contains the complete set of information about a project role. The structure is used both to retrieve detailed project role information and to pass information about a project role back to the server to get updated.

The candidates, resources and criteria represented in this structure will reflect either the requested values, assigned values or effective values, as determined by the mode specified when retrieving the record (see PwsGetProject). This applies to:

  • CandidateIdentities
  • CostCenterAnyFlag
  • CostCenterCriteria
  • CostCenterIdentity
  • Keywords
  • LocationAnyFlag
  • LocationIdentities
  • LocationIdentity
  • ResourceIdentity
  • SkillCriteria
  • TitleIdentities
  • TitleIdentity

Format

PwsProjectRoleDetail

Elements

Element

Data Type

Required?

Default

Description

Sample Data

ExternalSystemIdentifier

String (50)

One of ExternalSystemIdentifier or ProjectRoleUid is required


The external system identifier is a unique identifier for a project role (may be null, but once set can only be updated to a different, non-null value).

#00001

ProjectRoleId

Int32

On Insert: No

On Update: No


The project role id is a unique identifier for a project role. For internal use only.   


ProjectRoleUid

Int64

See ExternalSystemIdentifier


A unique and immutable identifier for a project role.

1152921504608152048

BaseRateOnTitleIdentity

PwsTitleRef

On Insert: No

On Update: No


If the role has a billing title override, this identifies the title to base rates upon. Click here for more information.


CandidateIdentities [1...100]

PwsResourceRef [1...100]

On Insert: No

On Update: No


A collection of named resource candidates for the role. Click here for more information.


CostCenterAnyFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', all cost centers are selected as part of the unnamed candidate search criteria.

false

CostCenterCriteria

PwsCostCenterCriteria [1...100]

On Insert: No

On Update: No


A collection of cost centers that are selected as part of the unnamed candidate search criteria. Click here for more information.


CostCenterIdentity

PwsCostCenterRef

On Insert: No

On Update: No


The preferred, allocated or effective cost center in the unnamed candidate search criteria. Click here for more information.


DefaultSchedulingMode

String (1)

On Insert: No

On Update: No

Engagement Type's default setting

The scheduling mode for this role:

D: daily

W: weekly


Description

String (255)

On Insert: No

On Update: No


The description for this role.

Business analyst (Web Commerce)_

Keywords

String (255)

On Insert: No

On Update: No


The keywords used in the unnamed candidate search criteria.

HTML

LocationAnyFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', all locations are selected as part of the unnamed candidate search criteria.

false

LocationIdentities [1...100]

PwsLocationRef [1...100]

On Insert: No

On Update: No


A collection of locations that are selected as part of the unnamed candidate search criteria. Click here for more information. 


LocationIdentity

PwsLocationRef

On Insert: No

On Update: No


The preferred, allocated or effective location in the unnamed candidate search criteria. Click here for more information. 


NewExternalSystemIdentifier

String

On Insert: No

On Update: No


See ExternalSystemIdentifier above. Use this to modify the external system identifier for an existing project role.

#00001-1

ResourceIdentity

PwsResourceRef

On Insert: No

On Update: No


The preferred, allocated or effective named candidate for this role. Click here for more information.


RoleEndDate

DateTime

On Insert: No

On Update: No


The end date of this role.

2018-12-31z

RoleName

String (32)

On Insert: Yes

On Update: No


The name of this role.

Business Analyst

RoleStartDate

DateTime

On Insert: No

On Update: No


The start date of this role.

2018-07-01z

ShareCostCenterIdentity

PwsCostCenterRef

On Insert: No

On Update: No


The identity of shared cost center for this role. Click here for more information.


SkillCriteria

PwsSkillCriteria [1...100]

On Insert: No

On Update: No


The collection of skills that are selected in the unnamed candidate search criteria. Click here for more information.


TitleIdentities [1...100]

PwsTitleRef [1...100]

On Insert: No

On Update: No


A collection of titles that are selected as part of the unnamed candidate search criteria. Click here for more information. 


TitleIdentity

PwsTitleRef

On Insert: No

On Update: No


The preferred, allocated or effective title in the unnamed candidate search criteria. Click here for more information. 


RdcTransferCurrencyIdentity

PwsCurrencyRef

On Insert: No

On Update: No

Resource's cost center currency

The RDC transfer rate currency for this role. Click here for more information.


RdcTransferHourlyRate

Double

On Insert: No

On Update: No


The RDC transfer hourly rate for this role.

35

RevenueTransferHourlyRate

Double

On Insert: No

On Update: No


The revenue transfer hourly rate for this role.

80

UserDefinedFields [1...100]

PwsUserDefinedFieldDetail [1...100]

On Insert: No

On Update: No


A collection of user defined fields and their values for this role. Click here for more information.


RateExceptions [1...100]

PwsProjectRoleRateException [1...100]

On Insert: No

On Update: No


Overrides to resource's title based rates. Click here for more information.


RdcExceptions [1...100]

PwsProjectRoleRDCException [1...100]

On Insert: No

On Update: No


Overrides to resource's RDC rates. Click here for more information.


InheritPurchaseOrderNumberFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', project inherits the purchase order number from the project.


PurchaseOrderNumber

String

On Insert: No

On Update: No

Project's purchase order number

The purchase order number associated with this project role. Specify only if not inheriting the purchase order number from the project.


ResourceTypeAnyFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', all resource types are selected as part of the unnamed candidate search criteria.true
ResourceTypeIdentitiesPwsResourceTypeRef [1...100]

On Insert: No

On Update: No


A collection of resource types that are selected as part of the unnamed candidate search criteria. Click here for more information.
ResourceTypeIdentityPwsResourceTypeRef

On Insert: No

On Update: No


The preferred, allocated or effective resource type in the unnamed candidate search criteria. Click here for more information.
ShareUserIdentityPwsUserRef

On Insert: No

On Update: No


The user that shares the scheduling responsibility of this project role. Click here for more information.
TimestampString

On Insert: No

On Update: No


This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.
AAAAABFEKj4=
RoleTypeIdentityPwsRoleTypeRef

On Insert: No

On Update: No


The role type of the project role. Click here for more information.

Usage Example(s)


Example 01 - unnamed 
                         <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>
Example 02 - named 
                          <b:ProjectRoleDetail>
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRoleId i:nil="true"/>
                           <b:ProjectRoleUid>1152921504609687526</b:ProjectRoleUid>
                           <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"/>
                           <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>AAAAABE+Ank=</b:Timestamp>
                        </b:ProjectRoleDetail>