Versions Compared

Key

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

...

This structure includes basic information about an engagement type. The information represented in this structure is not comprehensive and only includes certain key attributes of an engagement type deemed to be useful in a listing of engagementsengagement types.

Format


Panel
titlePwsEngagementTypeSummary
  • PwsEngagementTypeSummary
    • EngagementTypeId: Int32
    • EngagementTypeName: String (50)
    • EngagementTypeShortName: String (15)
    • EngagementTypeUid: Int64
    • BillableFlag: Boolean
    • BusyFlag: Boolean
    • InactiveFlag: Boolean

Elements


Element

Data Type

Required?

Default

Description

Sample Data

EngagementTypeId

Int32

 

No


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

 


EngagementTypeName

String

 

(50)

One of EngagementTypeName, EngagementTypeShortName or EngagementTypeUid is required


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

Billable - Fixed Price 

EngagementTypeShortName

String (15)

 

See EngagementTypeName


The engagement type short name is a unique identifier for an engagement type.

BFP 

EngagementTypeUid

Int64

 

See EngagementTypeName


A unique and immutable identifier for an engagement

type 

type.

1152921504606863885

BillableFlag

Boolean

No

 
false

If set to 'true', engagements under this engagement type will be defined as billable.

true

BusyFlag

Boolean

 

No

false

If set to 'true', engagements under this engagement type will be included in productive hours in utilization reports.

true 

InactiveFlag

Boolean

No

 
false

If set to 'true', the engagement type is marked as inactive.

false

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
              <b:PwsEngagementTypeSummary>
                  <b:EngagementTypeId i:nil="true"/>
                  <b:EngagementTypeName>Billable - Fixed Price</b:EngagementTypeName>
                  <b:EngagementTypeShortName>BFP</b:EngagementTypeShortName>
                  <b:EngagementTypeUid>1152921504606863885</b:EngagementTypeUid>
                  <b:BillableFlag>true</b:BillableFlag>
                  <b:BusyFlag>true</b:BusyFlag>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsEngagementTypeSummary>