Overview

This structure contains key fields associated with an engagement.

Format

PwsEngagementDescriptor

PwsEngagementDescriptor
- EngagementCode: String (20)
- EngagementId: Int32
- EngagementUid: Int64
- ClientDescriptor: PwsClientDescriptor
- EngagementManager: PwsUserSummary
- EngagementName: String (255)
- EngagementTypeDescriptor: PwsEngagementTypeDescriptor
- EngagementCurrencyDecimalDigits: Byte
- EngagementCurrencyIdentity: PwsCurrencyRef

Elements

Element	Data Type	Description	Sample Data
EngagementCode	String (20)	The engagement code is a unique identifier for an engagement.	E001407
EngagementId	Int32	The engagement Id is a unique identifier for an engagement. For internal use only.
EngagementUid	Int64	A unique and immutable identifier for an engagement.	1152921504607325242
ClientDescriptor	PwsClientDescriptor	The key fields associated with the client associated with this engagement.
EngagementManager	PwsUserSummary	The engagement manager.
EngagementName	String (255)	The engagement name.	Engagement A
EngagementTypeDescriptor	PwsEngagementTypeDescriptor	The key fields associated with the engagement type associated with this engagement.
EngagementCurrencyDecimalDigits	Byte	The number of decimal places associated with the engagement currency. Note: Computed amounts are always rounded to the nearest minor currency unit as identified by the currency's decimalDigits property.	2
EngagementCurrencyIdentity	PwsCurrencyRef	The engagement currency.

Usage Example(s)

Example 01

                      <a:EngagementDescriptor>
                        <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001407</EngagementCode>
                        <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607325242</EngagementUid>
                        <a:ClientDescriptor>
                           <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber>
                           <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid>
                           <a:ClientName>Projector PSA</a:ClientName>
                           <a:ParentClientDescriptor i:nil="true"/>
                        </a:ClientDescriptor>
                        <a:EngagementManager 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>
                           <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                           <b:FirstName>Jack</b:FirstName>
                           <b:LastName>Spratt</b:LastName>
                           <b:MiddleName i:nil="true"/>
                        </a:EngagementManager>
                        <a:EngagementName>Engagement A</a:EngagementName>
                        <a:EngagementTypeDescriptor>
                           <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time and Materials</EngagementTypeName>
                           <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">TandM</EngagementTypeShortName>
                           <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606863884</EngagementTypeUid>
                           <a:BillableFlag>true</a:BillableFlag>
                        </a:EngagementTypeDescriptor>
                        <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits>
                        <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:CurrencyCode>USD</b:CurrencyCode>
                           <b:CurrencyId i:nil="true"/>
                           <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                        </a:EngagementCurrencyIdentity>
                     </a:EngagementDescriptor>