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
- 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 **deprecated**
- 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 []
- TimeApprovalUserIdentity: PwsUserRef
- TimeApproverType: String (1)
- TimeEntryRestrictedToResourcesAssignedToRolesFlag: Boolean **deprecated**
- 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 []
- ContractLineItemIdentity: PwsContractLineItemRef
- ManagementTeam: PwsProjectManagementTeamMember[]
- BdDashboards: PwsProjectBdDashboard **deprecated**
- AamDashboards: PwsProjectAamDashboardDetail
- ExpenseTypeConfigurationIdentity: PwsExpenseTypeConfigurationRef
- InheritPurchaseOrderNumberFlag: Boolean
- PurchaseOrderNumber: String (50)
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 | 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 | 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 | On Insert: Yes On Update: No | The location of this project. Click here for more information. | |||
ManagerIdentity | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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.** | ||
AamDashboards | PwsProjectAamDashboardDetail | On Insert: No On Update: No | |||
ExpenseTypeConfigurationIdentity | 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 |