Versions Compared

Key

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

...

Panel
titlePwsEngagementDescriptor

Elements


Element

Data Type

Required?

Default

Description

Sample Data

EngagementCode

String (20)

 

 

 

 

One of EngagementCode or EngagementUid is required

The engagement code is a unique identifier for an engagement. See "NewEngagementCode" in PwsEngagementDetail for guidance on how to change the engagement code of an existing engagement.

E001407

EngagementId

Int32

 

 

 

 

No

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


EngagementUid

Int64

 

 

 

 

 

See EngagementCode

A unique and immutable identifier for an engagement

1152921504607325242

ClientDescriptor

PwsClientDescriptor

 

 

 

On Insert: Yes

On Update: No

The key fields associated with the client associated with this engagement


EngagementManager

PwsUserSummary

 

 

 

 

 

On Insert: Yes

On Update: No

The engagement maanager


EngagementName

String (255)

 

 

 

 

On Insert: Yes

On Update: No

The engagement name

Engagement A

EngagementTypeDescriptor

PwsEngagementTypeDescriptor

 

 

 

 

On Insert: Yes

On Update: No

The key fields associated with the engagement type associated with this engagement


EngagementCurrencyDecimalDigits

Byte

 

 

 

 

On Insert: Yes

On Update: No

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

 

 

 

On Insert: Yes

On Update: No

The engagement currency


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                      <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>