Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 73 Next »

Overview

This structure is part of PwsProjectElement that is in the response for PwsGetProject, and it 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.

Format


PwsProjectDetail

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String (24)

On Insert: Yes (if naming method is manual)

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

See description

The project code is a unique identifier for a project. On insert, you are required to specify either ProjectCode or NewProjectCode if the account is configured for manual numbering. A value may optionally be specified if hybrid numbering is in effect (a unique project code will be generated automatically if not). A value may not be specified if automatic numbering is in effect. See "NewProjectCode" for guidance on how to change the project code of an existing project.

P001053-001

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. If an EngagementIdentity is specifed on update, it must match the existing engagement associated with the project. Projects may not be moved among engagements. 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, if any.

2018--07-31z

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 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

On Insert: No

On Update: No


If set to 'true", engagement manager recieves project related emails.

true

EngagementTimestamp

String

On Insert: No

On Update: No


Base64 encoded timestamp. Meaningless on an insert. Caller may optionally supply the value retrieved earlier by PwsGetProject. If the project has been updated since the project information was retrieved, the update will fail. No checking is done if no value is specified.


ExpenseApprovalUserIdentity

PwsUserRef

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

Engagement type's default value

The user who is the specific expense approver user. Ignored if ExpenseApproverType is not 'U'. If ExpenseApproverType is not specified on creation, defaults for both ExpenseApproverType and ExpenseApprovalUserIdentity are taken from the engagement type. Click here for more information. 


ExpenseApproverType

String (1)

On Insert: No

On Update:No

Engagement type's default value

The expense approver type 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

deprecated



Please use element BookExpenseResourcesAllowCode instead.


LocationIdentity

PwsLocationRef

On Insert: Yes

On Update: No


The location of this project. Click here for more information.


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. Used for task planning and daily billing calculation.

480

NarrativeRequiredFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value

If set to 'true', description is required on time cards.

true

NewProjectCode

String (24)

On Insert: No

On Update: No


The new project code. This is used by PwsSaveProject to support changing an existing project code. You can both identify a project by project code and modify the project code by specifying the original code in ProjectCode and the new value in NewProjectCode. NewProjectCode will always be null in responses from PwsGetProject.

On Insert, if both the ProjectCode and NewProjectCode are specified, the NewProjectCode will take precedence.

Note: The project code may only be changed if numbering scheme for projects is configured as Manual or Hybrid.


OpenDate

DateTime

On Insert: No

On Update: No

Today's date

The begin date of the project.


OpenForCostFlag

Boolean

On Insert: No

On Update: No

Project stage's default value

If set to 'true', this project is open for expense entry.

true

OpenForCostTransferFlag

Boolean

On Insert: No

On Update: No

Project stage's default value

If set to 'true', this project is open to have expense transferred in.

true

OpenForTimeFlag

Boolean

On Insert: No

On Update: No

Project stage's default value

If set to 'true', this project is open for time entry.

true

OpenForTimeTransferFlag

Boolean

On Insert: No

On Update: No

Project stage's default value

If set to 'true', this project is open to have time transferred in.

true

PercentLikelihood

Double

On Insert: No

On Update: No

Project stage's default value

The likelihood of winning a contract for this project. It is used in project financial analysis.

100

PmModuleEnabledFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value

If set to 'true', detailed task management is turned on for the project.

true

ProjectStageIdentity

PwsProjectStageRef

On Insert: No

On Update: No

The first available project stage

The stage of the project. If none specified on creation, the first allowable project stage is chosen. If enterprise configuration is enabled for your account, the enterprise configuration settings will determine which stages are allowable. Click here for more information.


ProjectWorkspaceEnabledFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value

If set to 'true', project workspace is enabled for the project.

true

Rates

PwsProjectRate [0..]

On Insert: No

On Update: No

Cost center's default with no begin/end date and 0% contract rate or billing adjusted rate discount

The rate cards used for the project. If specified on update, the current rates are replaced in their entirety by the specified rates. Click here for more information.


TimeApprovalUserIdentity

PwsUserRef

On Insert/update: Yes (if TimeApproverType is "U")

Engagement type's default value

The user who is the specific time approver user. Ignored if TimeApproverType is not 'U'. If TimeApproverType is not specified on creation, defaults for both TimeApproverType and TimeApprovalUserIdentity are taken from the engagement type. Click here for more information. 


TimeApproverType

String (1)

On Insert: Yes

On Update: No

Engagement type's default value

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

deprecated



Please use element BookTimeResourcesAllowCode instead.


TimeEntryRestrictedToRolesAssignedToTasksFlag

Boolean

On Insert: No

On Update: No

Engagement type's default value

If set to 'true', only resource that has been assigned to a task on this project can enter time. Only when project is DTM enabled can this value be set to 'true'.

true

TimeGlccOverride

String

deprecated


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


TimePlccMappingType

String

deprecated


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


UserDefinedFields

PwsUserDefinedFieldDetail [0..]

On Insert: No

On Update: No


The user defined fields associated with the project. Click here for more information. To delete an existing UDF, include a PwsUserDefinedFieldDetail record in this collection that refers to the target user defined field and specifies NULL for all values.


WorkspaceMessages

String (255)

On Insert: No

On Update: No


The project message displayed on project workspace home tab.


BookExpenseResourceCostCenterIdentity

PwsCostCenterRef

On insert/update: Yes (if BookExpenseResourcesAllowCode = C)


If only resources from a specific cost center can enter expenses, this is the cost center. Click here for more information. 


BookExpenseResourcesAllowCode

String (1)

On Insert: No

On Update: No

Engagement type's default value

The type of resources that can enter expense for this project:

A: any resource;

B: resource assigned to a role;

C: resource from a specific cost center.

Engagement types allow specification of either A (any resource) or B (resource assigned to a role) as a default on creation.

A/B/C

BookTimeResourceCostCenterIdentity

PwsCostCenterRef

On insert/update: Yes (if BookTimeResourcesAllowCode = C)


If only resources from a specific cost center can enter time, this is the cost center. Click here for more information. 


BookTimeResourcesAllowCode

String (1)

On Insert: No

On Update: No

Engagement type's default value

The type of resources that can enter time for this project:

A: any resource;

B: resource assigned to a role;

C: resource from a specific cost center.

Engagement types allow specification of either A (any resource) or B (resource assigned to a role) as a default on creation.

A/B/C

PlccMappings

PwsProjectPlccMappingCostCenter [0..]

On Insert: No

On Update: No

Engagement type's default value

For billable project, all five mapping types must be included. For non-billable project, three mapping types (no time revenue or ODC revenue) must be included. Each mapping type must have fraction total of 1. If specified on update, the current PLCC mappings are replaced in their entirety by the specified mappings. Click here for more information.


ContractLineItemIdentity

PwsContractLineItemRef

On Insert: Yes*

On Update: No


The contract line item that this project is associated with. Click here for more informaiton.

* If ContractLineItemIdentity is not specified on creation, but the engagement has a single contract line item, the single contract line item will be used. Otherwise, an error will be raised.


ManagementTeam

PwsProjectManagementTeamMember [0..]

On Insert: No

On Update: No


Members of the project management team (other than those directly identified as the engagement or project manager). If specified on update, the current PM team members are replaced in their entirety by the specified team. Do not include the engagement or project manager in this listing. Click here for more information.


BdDashboards

PwsProjectBdDashboard [0..]

deprecated


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


AamDashboardsPwsProjectAamDashboardDetail

On Insert: No

On Update: No


The configuration information for the Advanced Analytics Module dashboard within a project.

ExpenseTypeConfigurationIdentity

PwsExpenseTypeConfigurationRef

On Insert: No

On Update: No


The expense type configuration associated with this project. 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 assocated engagement.

true/false

PurchaseOrderNumber

String (50)

On Insert: No

On Update: No

Engagement's purchase order number

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

MET-DonCarlo-01

Usage Example(s)


Example 01 
                  <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-2020)</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>AAAAAA+CKBk=</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>10</b:BillingAdjustedDiscountPercent>
                           <b:ContractDiscountPercent>5</b:ContractDiscountPercent>
                           <b:EndDate>2018-06-30T00:00:00Z</b:EndDate>
                           <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:PwsProjectRate>
                           <b:BeginDate>2018-07-01T00:00:00Z</b:BeginDate>
                           <b:BillingAdjustedDiscountPercent>5</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>true</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>B</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:PwsProjectManagementTeamMember>
                           <b:EmailFlag>false</b:EmailFlag>
                           <b:UpdateFlag>true</b:UpdateFlag>
                           <b:UserIdentity>
                              <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                              <b:UserId i:nil="true"/>
                              <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                              <b:UserUid>1152921504606944254</b:UserUid>
                           </b:UserIdentity>
                        </b:PwsProjectManagementTeamMember>
                     </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 i:nil="true"/>
                           <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>
                        <b:ExpenseTypeConfigurationId i:nil="true"/>
                        <b:ExpenseTypeConfigurationName>No Travel, Meal or Entertainment</b:ExpenseTypeConfigurationName>
                        <b:ExpenseTypeConfigurationUid>1152921504606847094</b:ExpenseTypeConfigurationUid>
                     </b:ExpenseTypeConfigurationIdentity>
                     <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                     <b:PurchaseOrderNumber>MET-DonCarlo-01</b:PurchaseOrderNumber>
                  </b:ProjectDetail>



  • No labels