Versions Compared

Version Old Version 18 New Version 19
Changes made by

Min Zeng

Min Zeng

Saved on

Key

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

Overview

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

...

Panel
titlePwsProjectDetail
  • PwsProjectDetail
    • ProjectCode: String (24)
    • ProjectId: Int32
    • ProjectUid: Int64
    • EngagementIdentity: PwsEngagementRef
    • ProjectName: String (255)
    • CloseDate: DateTime
    • CostGlccOverride: String **deprecated**
    • CostPlccMappingType: String **deprecated**
    • DefaultSchedulingMode: String (1)
    • Description: String (1000)
    • EmEmailFlag: Boolean
    • EngagementTimestamp: String
    • ExpenseApprovalUserIdentity: PwsUserRef
    • ExpenseApproverType: String (1)
    • ExpenseEntryRestrictedToResourcesAssignedToRolesFlag: Boolean
    • LocationIdentity: PwsLocationRef
    • ManagerIdentity: PwsUserRef
    • MinutesPerDay: Int16
    • NarrativeRequiredFlag: Boolean
    • NewProjectCode: String (24)
    • OpenDate: DateTime
    • OpenForCostFlag: Boolean
    • OpenForCostTransferFlag: Boolean
    • OpenForTimeFlag: Boolean
    • OpenForTimeTransferFlag: Boolean
    • PercentLikelihood: Double
    • PmModuleEnabledFlag: Boolean
    • ProjectStageIdentity: PwsProjectStageRef
    • ProjectWorkspaceEnabledFlag: Boolean
    • Rates: PwsProjectRate [] (Luke, how big is this array allowed?)
    • TimeApprovalUserIdentity: PwsUserRef
    • TimeApproverType: String (1)
    • TimeEntryRestrictedToResourcesAssignedToRolesFlag: Boolean
    • TimeEntryRestrictedToRolesAssignedToTasksFlag: Boolean

    • TimeGlccOverride: String **deprecated**

    • TimePlccMappingType: String **deprecated**

    • UserDefinedFields: PwsUserDefinedFieldDetail []
    • WorkspaceMessages: String (255)
    • BookExpenseResourceCostCenterIdentity: PwsCostCenterRef
    • BookExpenseResourcesAllowCode: String (1)
    • BookTimeResourceCostCenterIdentity: PwsCostCenterRef
    • BookTimeResourcesAllowCode: String (1)
    • PlccMappings: PwsProjectPlccMappingCostCenter [] (Luke, what is this array's limit?)
    • ContractLineItemIdentity: PwsContractLineItemRef
    • ManagementTeam: PwsProjectManagementTeamMember[] (Luke, what is this array's limit?)
    • BdDashboards: PwsProjectBdDashboard[] (Luke, what is this array's limit?)
    • ExpenseTypeConfigurationIdentity: PwsExpenseTypeConfigurationRef
    • InheritPurchaseOrderNumberFlag: Boolean
    • PurchaseOrderNumber: String (50)

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String (24)

On Insert: Yes

On Update: Yes (if the ProjectUid is not supplied)


The project code is a unique identifier for a project. See "NewProjectCode" for guidance on how to change the project code of an existing project.


ProjectId

Int32

On Insert: No

On Update: No


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


ProjectUid

Int64

On Insert: No

On Update: Yes (if the ProjectCode is not supplied)


A unique and immutable identifier for a project


EngagementIdentity

PwsEngagementRef

On Insert: Yes

On Update: No


The engagement associated with this project. Click here for more information. 


ProjectName

String (255)

On Insert: Yes

On Update: No


The name of the project


CloseDate

DateTime

On Insert: No

On Update: No


The end date of the project


CostGlccOverride

String

deprecated


** This field has been deprecated in favor of PwsProjectPlccMappingCostCenter.**


CostPlccMappingType

String

deprecated


** This field has been deprecated in favor of PwsProjectPlccMappingCostCenter.**


DefaultSchedulingMode

String (1)

On Insert: No

On Update: No

Engagement type's default

setting

value

The default scheduling mode associated with this project:

"D" for daily scheduling mode;

"W" for weekly scheduling mode

D/W

Description

String (1000)

On Insert: No

On Update: No


The description of the project


EmEmailFlag

Boolean



???


EngagementTimestamp

String

On Insert: No

On Update: No


Base64 encoded timestamp 


ExpenseApprovalUserIdentity

PwsUserRef

ExpenseApproverType

String (1)

On Insert: Yes (if ExpenseApproverType is "U")

On Update: No


The

expense approver associated with this project

user who is the specific expense approver user. Click here for more information. 


ExpenseApproverType

String (1)

On Insert:

On Update:


The expense approver associated with this project:

"E" for engagement manager

"M" for project manager (PM) for team, engagement manger for PM

"P" for project manager

"R" for resource/disbursing cost center-based approver

"T" for the project's acting PM team

"U" for specific approver user

E/M/P/R/T/U

ExpenseEntryRestrictedToResourcesAssignedToRolesFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value

If set to 'true', only resource that has been assigned to a role on this project can enter expense.

true

LocationIdentity

PwsLocationRef

On Insert: Yes

On Update: No




ManagerIdentity

PwsUserRef

On Insert: Yes

On Update: No


The project manager associated with the project. Click here for more information. 


MinutesPerDay

Int16

On Insert: No

On Update: No

Project location default value

The number of working minutes in a day and it is used for task planning and daily billing calculation.


NarrativeRequiredFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value



NewProjectCode

String





OpenDate

DateTime





OpenForCostFlag

Boolean





OpenForCostTransferFlag

Boolean





OpenForTimeFlag

Boolean





OpenForTimeTransferFlag

Boolean





PercentLikelihood

Double





PmModuleEnabledFlag

Boolean





ProjectStageIdentity

PwsProjectStageRef





ProjectWorkspaceEnabledFlag

Boolean





Rates

PwsProjectRate[]





TimeApprovalUserIdentity

PwsUserRef





TimeApproverType

String (1)



The time approver associated with this project:

"A" for None (automatically approved)

"E" for engagement manager

"M" for project manager (PM) for team, engagement manger for PM

"P" for project manager

"R" for resource-based approver

"T" for the project's acting PM team

"U" for specific approver user

A/E/M/P/R/T/U

TimeEntryRestrictedToResourcesAssignedToRolesFlag

Boolean





TimeEntryRestrictedToRolesAssignedToTasksFlag

Boolean





TimeGlccOverride

String





TimePlccMappingType

String





UserDefinedFields

PwsUserDefinedFieldDetail[]





WorkspaceMessages

String (255)





BookExpenseResourceCostCenterIdentity

PwsCostCenterRef





BookExpenseResourcesAllowCode

String





BookTimeResourceCostCenterIdentity

PwsCostCenterRef





BookTimeResourcesAllowCode

String





PlccMappings

PwsProjectPlccMappingCostCenter[]





ContractLineItemIdentity

PwsContractLineItemRef





ManagementTeam

PwsProjectManagementTeamMember[]





BdDashboards

PwsProjectBdDashboard[]





ExpenseTypeConfigurationIdentity

PwsExpenseTypeConfigurationRef





InheritPurchaseOrderNumberFlag

Boolean




true/false

PurchaseOrderNumber

String (50)

On Insert:

On Update:


The purchase order number associated with this project

MET-DonCarlo-01

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                   <b:ProjectDetail>
                     <b:ProjectCode>P001053-001</b:ProjectCode>
                     <b:ProjectId i:nil="true"/>
                     <b:ProjectUid>1152921504607161987</b:ProjectUid>
                     <b:EngagementIdentity>
                        <b:EngagementCode>P001053</b:EngagementCode>
                        <b:EngagementId i:nil="true"/>
                        <b:EngagementUid>1152921504607090526</b:EngagementUid>
                     </b:EngagementIdentity>
                     <b:ProjectName>Don Carlo (2010-2011)</b:ProjectName>
                     <b:CloseDate i:nil="true"/>
                     <b:CostGlccOverride i:nil="true"/>
                     <b:CostPlccMappingType i:nil="true"/>
                     <b:DefaultSchedulingMode>W</b:DefaultSchedulingMode>
                     <b:Description i:nil="true"/>
                     <b:EmEmailFlag>true</b:EmEmailFlag>
                     <b:EngagementTimestamp>AAAAAA98iKE=</b:EngagementTimestamp>
                     <b:ExpenseApprovalUserIdentity i:nil="true"/>
                     <b:ExpenseApproverType>R</b:ExpenseApproverType>
                     <b:ExpenseEntryRestrictedToResourcesAssignedToRolesFlag>false</b:ExpenseEntryRestrictedToResourcesAssignedToRolesFlag>
                     <b:LocationIdentity>
                        <b:LocationId i:nil="true"/>
                        <b:LocationName>Springfield</b:LocationName>
                        <b:LocationUid>1152921504606850978</b:LocationUid>
                     </b:LocationIdentity>
                     <b:ManagerIdentity>
                        <b:UserDisplayName>Ronni Skinner</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>030</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944264</b:UserUid>
                     </b:ManagerIdentity>
                     <b:MinutesPerDay>480</b:MinutesPerDay>
                     <b:NarrativeRequiredFlag>false</b:NarrativeRequiredFlag>
                     <b:NewProjectCode i:nil="true"/>
                     <b:OpenDate>2010-11-01T00:00:00Z</b:OpenDate>
                     <b:OpenForCostFlag>true</b:OpenForCostFlag>
                     <b:OpenForCostTransferFlag>true</b:OpenForCostTransferFlag>
                     <b:OpenForTimeFlag>true</b:OpenForTimeFlag>
                     <b:OpenForTimeTransferFlag>true</b:OpenForTimeTransferFlag>
                     <b:PercentLikelihood i:nil="true"/>
                     <b:PmModuleEnabledFlag>true</b:PmModuleEnabledFlag>
                     <b:ProjectStageIdentity>
                        <b:ProjectStageId i:nil="true"/>
                        <b:ProjectStageName>Planning</b:ProjectStageName>
                        <b:ProjectStageShortName>Planning</b:ProjectStageShortName>
                        <b:ProjectStageUid>1152921504606849648</b:ProjectStageUid>
                     </b:ProjectStageIdentity>
                     <b:ProjectWorkspaceEnabledFlag>true</b:ProjectWorkspaceEnabledFlag>
                     <b:Rates>
                        <b:PwsProjectRate>
                           <b:BeginDate i:nil="true"/>
                           <b:BillingAdjustedDiscountPercent>0</b:BillingAdjustedDiscountPercent>
                           <b:ContractDiscountPercent>0</b:ContractDiscountPercent>
                           <b:EndDate i:nil="true"/>
                           <b:RateCardIdentity>
                              <b:RateCardId i:nil="true"/>
                              <b:RateCardName>Corporate Standard Rates (USD)</b:RateCardName>
                              <b:RateCardType>R</b:RateCardType>
                              <b:RateCardUid>1152921504606854730</b:RateCardUid>
                           </b:RateCardIdentity>
                        </b:PwsProjectRate>
                     </b:Rates>
                     <b:TimeApprovalUserIdentity i:nil="true"/>
                     <b:TimeApproverType>T</b:TimeApproverType>
                     <b:TimeEntryRestrictedToResourcesAssignedToRolesFlag>false</b:TimeEntryRestrictedToResourcesAssignedToRolesFlag>
                     <b:TimeEntryRestrictedToRolesAssignedToTasksFlag>false</b:TimeEntryRestrictedToRolesAssignedToTasksFlag>
                     <b:TimeGlccOverride i:nil="true"/>
                     <b:TimePlccMappingType i:nil="true"/>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>Tentative Start Date</b:UdfName>
                           <b:UdfUid>1152921504606859825</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-01T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                     </b:UserDefinedFields>
                     <b:WorkspaceMessages>This project is for set and costume production for the opera Don Carlo.</b:WorkspaceMessages>
                     <b:BookExpenseResourceCostCenterIdentity i:nil="true"/>
                     <b:BookExpenseResourcesAllowCode>A</b:BookExpenseResourcesAllowCode>
                     <b:BookTimeResourceCostCenterIdentity i:nil="true"/>
                     <b:BookTimeResourcesAllowCode>A</b:BookTimeResourcesAllowCode>
                     <b:PlccMappings>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>0.6</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>E</b:CostCenterType>
                           <b:GlccOverride>CC-US1</b:GlccOverride>
                           <b:MappingType>TR</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>0.4</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>R</b:CostCenterType>
                           <b:GlccOverride i:nil="true"/>
                           <b:MappingType>TR</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>0.6</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>E</b:CostCenterType>
                           <b:GlccOverride>CC-US1</b:GlccOverride>
                           <b:MappingType>RDC</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>0.4</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>R</b:CostCenterType>
                           <b:GlccOverride i:nil="true"/>
                           <b:MappingType>RDC</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>1</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>E</b:CostCenterType>
                           <b:GlccOverride>CC-US</b:GlccOverride>
                           <b:MappingType>SRDC</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>1</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>E</b:CostCenterType>
                           <b:GlccOverride>CC-US</b:GlccOverride>
                           <b:MappingType>OR</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                        <b:PwsProjectPlccMappingCostCenter>
                           <b:AllocationFraction>1</b:AllocationFraction>
                           <b:CostCenterIdentity i:nil="true"/>
                           <b:CostCenterType>E</b:CostCenterType>
                           <b:GlccOverride>CC-US1</b:GlccOverride>
                           <b:MappingType>OE</b:MappingType>
                        </b:PwsProjectPlccMappingCostCenter>
                     </b:PlccMappings>
                     <b:ContractLineItemIdentity>
                        <b:ContractLineItemCode>P001053-CL1</b:ContractLineItemCode>
                        <b:ContractLineItemId i:nil="true"/>
                        <b:ContractLineItemUid>1152921504606877177</b:ContractLineItemUid>
                     </b:ContractLineItemIdentity>
                     <b:ManagementTeam/>
                     <b:BdDashboards>
                        <b:PwsProjectBdDashboard>
                           <b:BookedResourcesAllowedFlag>false</b:BookedResourcesAllowedFlag>
                           <b:ClientsAllowedFlag>false</b:ClientsAllowedFlag>
                           <b:DashboardAlias>Approved TC</b:DashboardAlias>
                           <b:DashboardName>Hours approved</b:DashboardName>
                           <b:DashboardParameters>{0}</b:DashboardParameters>
                           <b:EmAllowedFlag>false</b:EmAllowedFlag>
                           <b:LtdBookedResourcesAllowedFlag>false</b:LtdBookedResourcesAllowedFlag>
                           <b:LtdOtherResourcesAllowedFlag>false</b:LtdOtherResourcesAllowedFlag>
                           <b:OtherResourcesAllowedFlag>false</b:OtherResourcesAllowedFlag>
                           <b:PmAllowedFlag>true</b:PmAllowedFlag>
                        </b:PwsProjectBdDashboard>
                     </b:BdDashboards>
                     <b:ExpenseTypeConfigurationIdentity i:nil="true"/>
                     <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
      				 <b:PurchaseOrderNumber>MET-DonCarlo-01</b:PurchaseOrderNumber>
                  </b:ProjectDetail>

...