Table of Contents

Breaking Changes

The following sections provide more details on the breaking changes introduced for release 2023.7.0.

API Breaking Change
AMPC.ASSETS Resource Costing Redesign
AMPC.ASSETTYPES Resource Costing Redesign
WM Resource Costing Redesign

Resource Costing

In On Key Plus we now track the usage of both Human and Special Resources.

Impacted Areas

The following API's are impacted by the change:

API Resource
AMPC.ASSETS
  • Regular Asset Task Resources
  • Auxiliary Asset Task Resources
AMPC.ASSETTYPES
  • Regular Asset Type Task Resources
  • Auxiliary Asset Type Task Resources
WM
  • Work Order Task Resources
  • Work Order Task Resource Usages (previously named Work Order Task Resource Durations)

Context

The expected and actual usage of Human Resources will typically (but don't have to) be captured using the already existing duration type while the expected and actual usage of Special Resources will typically (but don't have to) be captured as a quantity.

The Usage value is a dynamic type which can be either a Duration type or a Float type. A user editable UnitOfMeasurement property has been added to the AMPC resources listed above as well as the Work Order Task Resource resource. The UnitOfMeasurement.MeasurementType property is used to determine whether a Resource Usage is measured as a Duration type or as a Float. If the UnitOfMeasurement.MeasurementType selected is Duration then the Usage value is a Duration type, otherwise if the UnitOfMeasurement.MeasurementType is None then the Usage value is a Float.

On Work Order Task Resource Usages, the dynamic type of the Usage is determined by the chosen Resource Trade Financial Rate's UnitOfMeasurement.MeasurementType.

In summary, the following are breaking API changes:

  • On all AMPC resources listed above the Duration property has been renamed Usage and it is a dynamic type.
  • On Work Order Task Resources the EstimatedDuration property has been renamed EstimatedUsage and is a dynamic type.
  • The Work Order Task Resource Duration resource has been renamed Work Order Task Resource Usage.
  • The Work Order Task Resource Usage's Duration property has been renamed Usage and is a dynamic type.

The dynamic type properties above can be expressed in the following json patterns:

  • Duration types:
"Usage": {"value": "PT4H", "type": "Duration"}
  • Float types:
"Usage": {"value": 2, "type": "Float"}}