Versions Compared

Old Version 2

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Luke Wright

Saved on

Key

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

Overview


This structure represents information about a project a collection of time cards associated with a time cardspecific project, and includes information about the project itself.

Format


Panel
titlePwsTimeEntryProject
  • PwsTimeEntryProject

Elements

 This structure contains key fields associated with a client 


Element

Data Type

Required?

Defaultfalse

Description

Sample Data

AllowAssignmentFlag

Boolean

No

If set to 'true', the project allows resources to report time against tasks they are not already assigned to. A task assignment will be created when the time card is submitted.

true

AllowBookingFlag

Boolean

No

false false 

If set to 'true', the project allows resources to report time against it, even if the resource currently has no role for the resource. A new role will be created when the time card is submitted.

true

CanOpenFlag

Boolean

No

*** deprecated ***

false

CloseDate

DateTime

No

The close / end date of the project.


DescriptionRequiredFlag

Boolean

No 

If set to 'true', descriptions are required on time cards associated with this project.

false

OpenDate

DateTime

Nofalse

The start / open date of the project.

2018-01-01T00:00:00Z

OpenFlag

Boolean

No

false

If set to 'true', the project is currently open for time.

true

PmModuleEnabledFlag

Boolean

No

If set to 'true', project management is enabled in this installation and, detailed task management is enabled for the project.

true

ProjectDescriptor

PwsProjectDescriptor

Yes

This structure contains key fields associated with a project

This structure basic information about the project, including the project name and project code.


ProjectRateTypes

PwsProjectRateTypeSummary []

Yes

The rate types associated with the project.


ProjectTaskTypes

PwsTaskType []

Yes

The task types associated with the project.


ProjectTasks

PwsProjectTask []

Yes

The tasks associated with the project.


RoleCount

Int32

No

The number of roles associated with the project.

1

TaskCount

Int32

No

This structure contains the complete set of information about a time card. 

The number of tasks associated with the project.

1

TimeCards

PwsTimeCardDetail []

Yes 

The collection of time cards.


Udf1Treatment

String

No

User Defined Treatement for the first UDF associated with the time card:

  • "R" for required – UDF should be displayed and requires a value. Yes/no UDFs never have this status, and always have a value of yes or no (checked or unchecked). There’s no third (i.e., null) state for yes/no UDFs.
  • "A" for available—UDF should be displayed and null is a valid value (except for yes/no; see above)
  • "N" for unavailable—This calls for displaying the UDF as read only if populated, and not displaying it at all otherwise. In the case of yes/no, only a value of yes/checked should cause the UDF to be displayed. <N> could be (a) UDF inactive flag = T, (b) Cost UDF expense type setting: Not available, or (c) Not enabled via Enterprise Configuration for a certain engagement type. 
A

Udf2Treatment

String

No

User Defined Treatement for the second UDF associated with the time card:

  • "R" for required – UDF should be displayed and requires a value. Yes/no UDFs never have this status, and always have a value of yes or no (checked or unchecked). There’s no third (i.e., null) state for yes/no UDFs.
  • "A" for available—UDF should be displayed and null is a valid value (except for yes/no; see above)
  • "N" for unavailable—This calls for displaying the UDF as read only if populated, and not displaying it at all otherwise. In the case of yes/no, only a value of yes/checked should cause the UDF to be displayed. <N> could be (a) UDF inactive flag = T, (b) Cost UDF expense type setting: Not available, or (c) Not enabled via Enterprise Configuration for a certain engagement type. 
A

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <a:PwsTimeEntryProject>
                  <a:AllowAssignmentFlag>true</a:AllowAssignmentFlag>
                  <a:AllowBookingFlag>true</a:AllowBookingFlag>
                  <a:CanOpenFlag>false</a:CanOpenFlag>
                  <a:CloseDate i:nil="true"/>
                  <a:DescriptionRequiredFlag>false</a:DescriptionRequiredFlag>
                  <a:OpenDate>2018-01-01T00:00:00Z</a:OpenDate>
                  <a:OpenFlag>true</a:OpenFlag>
                  <a:PmModuleEnabledFlag>true</a:PmModuleEnabledFlag>
                  <a:ProjectDescriptor>
                     <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:EngagementDescriptor>
                        <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001395</EngagementCode>
                        <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607324698</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>Web Services Engagement</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>
                     <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:LocationId i:nil="true"/>
                        <b:LocationName>USA</b:LocationName>
                        <b:LocationUid>1152921504606855985</b:LocationUid>
                     </a:LocationIdentity>
                     <a:ProjectCloseDate i:nil="true"/>
                     <a:ProjectDescription i:nil="true"/>
                     <a:ProjectManager 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:ProjectManager>
                     <a:ProjectName>New Web Services Project (A)</a:ProjectName>
                     <a:ProjectOpenDate>2018-01-01T00:00:00Z</a:ProjectOpenDate>
                     <a:ProjectRoles>
                        <a:PwsRole>
                           <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ProjectRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ProjectRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504609522500</ProjectRoleUid>
                           <a:RoleEndDate i:nil="true"/>
                           <a:RoleName>JS</a:RoleName>
                           <a:RoleStartDate>2018-01-01T00:00:00Z</a:RoleStartDate>
                        </a:PwsRole>
                     </a:ProjectRoles>
                     <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:UnavailableReasonCode i:nil="true"/>
                     <a:Udf1InactiveFlag>false</a:Udf1InactiveFlag>
                     <a:Udf1Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                     <a:Udf2InactiveFlag>false</a:Udf2InactiveFlag>
                     <a:Udf2Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                     <a:Udf1DefaultValue i:nil="true"/>
                     <a:Udf2DefaultValue i:nil="true"/>
                     <a:ExpenseTypeIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  </a:ProjectDescriptor>
                  <a:ProjectRateTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:PwsProjectRateTypeSummary>
                        <b:ExternalSystemIdentifier i:nil="true"/>
                        <b:ProjectRateTypeId i:nil="true"/>
                        <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                        <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName>
                     </b:PwsProjectRateTypeSummary>
                  </a:ProjectRateTypes>
                  <a:ProjectTaskTypes>
                     <a:PwsTaskType>
                        <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectTaskTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectTaskTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608115974</ProjectTaskTypeUid>
                        <a:AllowedProjectRateTypes xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:PwsProjectRateTypeSummary>
                              <b:ExternalSystemIdentifier i:nil="true"/>
                              <b:ProjectRateTypeId i:nil="true"/>
                              <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                              <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName>
                           </b:PwsProjectRateTypeSummary>
                        </a:AllowedProjectRateTypes>
                        <a:DefaultProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                        </a:DefaultProjectRateTypeIdentity>
                        <a:InactiveFlag>false</a:InactiveFlag>
                        <a:NarrativeRequiredFlag>false</a:NarrativeRequiredFlag>
                        <a:ProjectTaskTypeName>Task Type 01</a:ProjectTaskTypeName>
                        <a:StandardTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:StandardTaskTypeCode>TT01</b:StandardTaskTypeCode>
                           <b:StandardTaskTypeId i:nil="true"/>
                           <b:StandardTaskTypeName>Task Type 01</b:StandardTaskTypeName>
                           <b:StandardTaskTypeUid>1152921504606848772</b:StandardTaskTypeUid>
                        </a:StandardTaskTypeIdentity>
                     </a:PwsTaskType>
                  </a:ProjectTaskTypes>
                  <a:ProjectTasks>
                     <a:PwsProjectTask>
                        <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectTaskId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <ProjectTaskUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608644258</ProjectTaskUid>
                        <a:Description i:nil="true"/>
                        <a:Name>Task A1</a:Name>
                        <a:Notes/>
                        <a:OpenForTimeFlag>true</a:OpenForTimeFlag>
                        <a:ParentProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectTaskId i:nil="true"/>
                           <b:ProjectTaskUid>1152921504608637335</b:ProjectTaskUid>
                        </a:ParentProjectTaskIdentity>
                        <a:ParentTaskName>Task A</a:ParentTaskName>
                        <a:PlannedEndDateTime>2018-03-30T08:00:00Z</a:PlannedEndDateTime>
                        <a:PlannedStartDateTime>2018-03-01T00:00:00Z</a:PlannedStartDateTime>
                        <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectTaskTypeId i:nil="true"/>
                           <b:ProjectTaskTypeUid>1152921504608115974</b:ProjectTaskTypeUid>
                        </a:ProjectTaskTypeIdentity>
                        <a:Roles>
                           <a:PwsProjectTaskRole>
                              <ProjectRoleIdentity xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">
                                 <ExternalSystemIdentifier i:nil="true"/>
                                 <ProjectRoleId i:nil="true"/>
                                 <ProjectRoleUid>1152921504609522500</ProjectRoleUid>
                              </ProjectRoleIdentity>
                              <ProjectTaskIdentity xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">
                                 <ExternalSystemIdentifier i:nil="true"/>
                                 <ProjectTaskId i:nil="true"/>
                                 <ProjectTaskUid>1152921504608644258</ProjectTaskUid>
                              </ProjectTaskIdentity>
                              <ProjectTaskRoleId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                              <ProjectTaskRoleUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608549425</ProjectTaskRoleUid>
                              <a:ActualMinutesSinceAsOfDate>0</a:ActualMinutesSinceAsOfDate>
                              <a:BudgetedMinutes>10560</a:BudgetedMinutes>
                              <a:CompletedFlag>false</a:CompletedFlag>
                              <a:Estimates/>
                              <a:LateFlag>false</a:LateFlag>
                              <a:TotalMinutesToDate>0</a:TotalMinutesToDate>
                              <a:CompletedFlagAtLatestPostAsOfDate i:nil="true"/>
                              <a:LateEligibleFlag>false</a:LateEligibleFlag>
                              <a:LatestAsOfDatePostDateRange i:nil="true"/>
                              <a:RemainingMinutesPostDateRange i:nil="true"/>
                              <a:RemainingMinutesPriorToDateRange>10560</a:RemainingMinutesPriorToDateRange>
                              <a:TotalMinutesPostTimesheet>0</a:TotalMinutesPostTimesheet>
                           </a:PwsProjectTaskRole>
                        </a:Roles>
                        <a:SequenceNumber>1</a:SequenceNumber>
                        <a:WbsCode>1.1</a:WbsCode>
                        <a:ParentTaskWbsCode>1</a:ParentTaskWbsCode>
                     </a:PwsProjectTask>
                  </a:ProjectTasks>
                  <a:RoleCount>1</a:RoleCount>
                  <a:TaskCount>2</a:TaskCount>
                  <a:TimeCards>
                     <a:PwsTimecardDetail>
                        <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">T</TimecardType>
                        <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504646141261</TimecardUid>
                        <a:Description>Initial research</a:Description>
                        <a:DescriptionClearFlag>false</a:DescriptionClearFlag>
                        <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:RejectedReason i:nil="true"/>
                        <a:RejectedTimestamp i:nil="true"/>
                        <a:Status>Submitted</a:Status>
                        <a:WorkDate>2018-03-05T00:00:00Z</a:WorkDate>
                        <a:WorkMinutes>480</a:WorkMinutes>
                        <a:Timestamp>AAAAAA64Niw=</a:Timestamp>
                        <a:CardStatus>S</a:CardStatus>
                        <a:LocationClearFlag>false</a:LocationClearFlag>
                        <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:LocationId i:nil="true"/>
                           <b:LocationName>USA</b:LocationName>
                           <b:LocationUid>1152921504606855985</b:LocationUid>
                        </a:LocationIdentity>
                        <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ProjectCode>P001395-001</b:ProjectCode>
                           <b:ProjectId i:nil="true"/>
                           <b:ProjectUid>1152921504607412209</b:ProjectUid>
                        </a:ProjectIdentity>
                        <a:ProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRateTypeId i:nil="true"/>
                           <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                        </a:ProjectRateTypeIdentity>
                        <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectTaskId i:nil="true"/>
                           <b:ProjectTaskUid>1152921504608644258</b:ProjectTaskUid>
                        </a:ProjectTaskIdentity>
                        <a:RoleClearFlag>false</a:RoleClearFlag>
                        <a:RoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:ExternalSystemIdentifier i:nil="true"/>
                           <b:ProjectRoleId i:nil="true"/>
                           <b:ProjectRoleUid>1152921504609522500</b:ProjectRoleUid>
                        </a:RoleIdentity>
                        <a:Udf1 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>TC-Jira</b:UdfName>
                           <b:UdfUid>1152921504606857618</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>P</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue>
                              <b:CodeValue>SD-23</b:CodeValue>
                              <b:TextValue>2 laptops for demo</b:TextValue>
                              <b:UidValue>10022</b:UidValue>
                           </b:RelationValue>
                        </a:Udf1>
                        <a:Udf1ClearFlag>false</a:Udf1ClearFlag>
                        <a:Udf2 xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>TC-Zendesk</b:UdfName>
                           <b:UdfUid>1152921504606857619</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>P</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </a:Udf2>
                        <a:Udf2ClearFlag>false</a:Udf2ClearFlag>
                        <a:ExternalGroupingIdentifier i:nil="true"/>
                        <a:ExternalGroupingIdentifierClearFlag>false</a:ExternalGroupingIdentifierClearFlag>
                     </a:PwsTimecardDetail>
                  </a:TimeCards>
                  <a:Udf1Treatment>A</a:Udf1Treatment>
                  <a:Udf2Treatment>A</a:Udf2Treatment>
               </a:PwsTimeEntryProject>