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

Version 1 Next »

Overview


This structure contains key fields associated with a project workspace

Format


PwsProjectWorkspaceDescriptor
  • PwsProjectWorkspaceDescriptor
    • ProjectCode: String
    • ProjectId: Int32
    • ProjectUid: Int64
    • ClientIdentity: PwsClientRef
    • ClientName: String
    • Description: String
    • EngagementIdentity: PwsEngagementRef
    • EngagementManagerIdentity: PwsUserRef
    • EngagementName: String
    • EngagementTypeIdentity: PwsEngagementTypeRef
    • MemorizedFlag: Boolean
    • ProjectDocumentsPermissionSetting: String
    • ProjectInfoPermissionSetting: String
    • ProjectInvoicesPermissionSetting: String
    • ProjectIssuesPermissionSetting: String
    • ProjectManagerIdentity: PwsUserRef
    • ProjectName: String
    • ProjectStageClosedFlag: Boolean
    • ProjectTeamPermissionSetting: String
    • ProjectWorkspaceEnabledFlag: Boolean
    • WorkspaceMessages: String
    • ProjectBdDashboards: PwsProjectBdDashboardDescriptor [???]
    • ProjectStageIdentity: PwsProjectStageRef
    • ColorMapBackgroundColor: PwsColor
    • EngagementStageIdentity: PwsEngagementStageRef

Elements


Element

Data Type

RequiredDefault

Description

Sample Data

ProjectCode

String

On Insert: One of ProjectCode or ProjectUid is required

On Update: No


The project code is a unique identifier for a project

P001395-001

ProjectId

Int32

No

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


ProjectUid

Int64

See ProjectCode

A unique and immutable identifier for a project

1152921504607412209

ClientIdentity

PwsClientRef

On Insert: Yes

On Update: No


The client identity

 

ClientName

String

No


The client name

Projector PSA

Description

String

No

The description of the project associated with the project workspace

New Web Services Project (A) - 2018 

EngagementIdentity

PwsEngagementRef

On Insert: Yes

On Update: No


The engagement identity

 

EngagementManagerIdentity

PwsUserRef

No

The engagement manager identity

 

EngagementName

String

No


The engagement name

Web Services Engagement 

EngagementTypeIdentity

PwsEngagementTypeRef

No

The engagement type identity

 

MemorizedFlag

Boolean

No

If set to 'true', the project workspace is in the most recently used list for the authenticated user

true

ProjectDocumentsPermissionSetting

String

No

The project workspace document permission setting respective of the authenticated user:

'V' for view

'U' for update

U

ProjectInfoPermissionSetting

String

No

The project workspace information permission setting respective of the authenticated user:

'V' for view

'U' for update

V

ProjectInvoicesPermissionSetting

String

No

The project workspace invoices permission setting respective of the authenticated user:

'V' for view

'U' for update

U

ProjectIssuesPermissionSetting

String

No

The project workspace issues permission setting respective of the authenticated user:

'V' for view

'U' for update

U

 

ProjectManagerIdentity

PwsUserRef

No

The project manager identity

 

ProjectName

String

No

The project name 

New Web Services Project (A)

ProjectStageClosedFlag

Boolean

No

If set to 'true', the project associated with the project workspace is in a closed stage

false

ProjectTeamPermissionSetting

String

No

The project workspace permission associated with the project team (i.e. booked resources) 

 

ProjectWorkspaceEnabledFlag

Boolean

Nodepedent on the engaement type

If set to 'true', the project is enabled for project workspaces

true

WorkspaceMessages

String

No

The project workspace message 

Good work team!

 

ProjectBdDashboards

PwsProjectBdDashboardDescriptor [???]

No

The key fields associated with the Belladati dashboard(s) associated with the project workspace

 

ProjectStageIdentity

PwsProjectStageRef

No

The project stage identity

 

ColorMapBackgroundColor

PwsColor

No

The color map of the project workspace background 

 

EngagementStageIdentity

PwsEngagementStageRef

No

The engagement stage identity

 

Usage Example(s)


Example 01 
               <a:PwsProjectWorkspaceDescriptor>
                  <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001395-001</ProjectCode>
                  <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607412209</ProjectUid>
                  <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>PR-PSA</b:ClientNumber>
                     <b:ClientUid>1152921504606961482</b:ClientUid>
                  </a:ClientIdentity>
                  <a:ClientName>Projector PSA</a:ClientName>
                  <a:Description i:nil="true"/>
                  <a:EngagementIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementCode>E001395</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607324698</b:EngagementUid>
                  </a:EngagementIdentity>
                  <a:EngagementManagerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607112369</b:UserUid>
                  </a:EngagementManagerIdentity>
                  <a:EngagementName>Web Services Engagement</a:EngagementName>
                  <a:EngagementTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementTypeId i:nil="true"/>
                     <b:EngagementTypeName>Billable - Time and Materials</b:EngagementTypeName>
                     <b:EngagementTypeShortName>TandM</b:EngagementTypeShortName>
                     <b:EngagementTypeUid>1152921504606863884</b:EngagementTypeUid>
                  </a:EngagementTypeIdentity>
                  <a:MemorizedFlag>true</a:MemorizedFlag>
                  <a:ProjectDocumentsPermissionSetting>U</a:ProjectDocumentsPermissionSetting>
                  <a:ProjectInfoPermissionSetting>V</a:ProjectInfoPermissionSetting>
                  <a:ProjectInvoicesPermissionSetting>U</a:ProjectInvoicesPermissionSetting>
                  <a:ProjectIssuesPermissionSetting>U</a:ProjectIssuesPermissionSetting>
                  <a:ProjectManagerIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607112369</b:UserUid>
                  </a:ProjectManagerIdentity>
                  <a:ProjectName>New Web Services Project (A)</a:ProjectName>
                  <a:ProjectStageClosedFlag>false</a:ProjectStageClosedFlag>
                  <a:ProjectTeamPermissionSetting i:nil="true"/>
                  <a:ProjectWorkspaceEnabledFlag>true</a:ProjectWorkspaceEnabledFlag>
                  <a:WorkspaceMessages>Good work team!</a:WorkspaceMessages>
                  <a:ProjectBdDashboards>
                     <a:PwsProjectBdDashboardDescriptor>
                        <ProjectBdDashboardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectBdDashboardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606848960</ProjectBdDashboardUid>
                        <a:ProjectBdDashboardName>Resource List</a:ProjectBdDashboardName>
                     </a:PwsProjectBdDashboardDescriptor>
                  </a:ProjectBdDashboards>
                  <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ProjectStageId i:nil="true"/>
                     <b:ProjectStageName>Delivery</b:ProjectStageName>
                     <b:ProjectStageShortName>Delivery</b:ProjectStageShortName>
                     <b:ProjectStageUid>1152921504606853304</b:ProjectStageUid>
                  </a:ProjectStageIdentity>
                  <a:ColorMapBackgroundColor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:B>255</b:B>
                     <b:G>255</b:G>
                     <b:R>0</b:R>
                  </a:ColorMapBackgroundColor>
                  <a:EngagementStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementStageId i:nil="true"/>
                     <b:EngagementStageName>Open</b:EngagementStageName>
                     <b:EngagementStageShortName>Open</b:EngagementStageShortName>
                     <b:EngagementStageUid>1152921504606849675</b:EngagementStageUid>
                  </a:EngagementStageIdentity>
               </a:PwsProjectWorkspaceDescriptor>
  • No labels