Overview

This structure includes information about a resource’s utilization.

Format

PwsUtilizationSummaryPackage
- LastYearUtilization: PwsUtilizationData
- ThisYearUtilization: PwsUtilizationData
- ShowUtilizationFlag: Boolean

Request Elements

Element	Data Type	Description	Sample Data

Element	Data Type	Description	Sample Data
LastYearUtilization	PwsUtilizationData	A summary of the resource’s utilization from the previous year
ThisYearUtilization	PwsUtilizationData	A summary of the resource’s utilization from the current year
ShowUtilizationFlag	Boolean	If set to 'true, year to date time off utilization will be displayed in the employee dashboard.	`true`

Usage Example(s)

             <a:UtilizationSummaryPackage>
               <a:LastYearUtilization>
                  <a:BillableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:BillableUtilizationAndTarget>
                  <a:ChargeableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ChargeableUtilizationAndTarget>
                  <a:OverMaximum>
                     <a:Color>#0000FF</a:Color>
                     <a:Symbol>▲</a:Symbol>
                  </a:OverMaximum>
                  <a:ProductiveUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ProductiveUtilizationAndTarget>
                  <a:TotalUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.15562248995983935</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:TotalUtilizationAndTarget>
                  <a:UnderMinimum>
                     <a:Color>#FF0000</a:Color>
                     <a:Symbol>▼</a:Symbol>
                  </a:UnderMinimum>
                  <a:WithinRange>
                     <a:Color>#FF00FF</a:Color>
                     <a:Symbol>■</a:Symbol>
                  </a:WithinRange>
                  <a:Year>2024</a:Year>
               </a:LastYearUtilization>
               <a:ThisYearUtilization>
                  <a:BillableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:BillableUtilizationAndTarget>
                  <a:ChargeableUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ChargeableUtilizationAndTarget>
                  <a:OverMaximum>
                     <a:Color>#0000FF</a:Color>
                     <a:Symbol>▲</a:Symbol>
                  </a:OverMaximum>
                  <a:ProductiveUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:ProductiveUtilizationAndTarget>
                  <a:TotalUtilizationAndTarget>
                     <a:ActualUtilizationPercent>0.78846153846153844</a:ActualUtilizationPercent>
                     <a:MaximumTargetPercent>1</a:MaximumTargetPercent>
                     <a:MinimumTargetPercent>0.8</a:MinimumTargetPercent>
                  </a:TotalUtilizationAndTarget>
                  <a:UnderMinimum>
                     <a:Color>#FF0000</a:Color>
                     <a:Symbol>▼</a:Symbol>
                  </a:UnderMinimum>
                  <a:WithinRange>
                     <a:Color>#FF00FF</a:Color>
                     <a:Symbol>■</a:Symbol>
                  </a:WithinRange>
                  <a:Year>2025</a:Year>
               </a:ThisYearUtilization>
               <a:ShowUtilizationFlag>true</a:ShowUtilizationFlag>
            </a:UtilizationSummaryPackage>

API Documentation

PwsUtilizationSummaryPackage

Overview

Format

Request Elements

Usage Example(s)

Related content