4.0.0.42

Lean what's new with Keyfax Client 4.0.0.42.

The Keyfax Client version 4.0.0.42 was released alongside Keyfax 4.4.6in January 2024.

New

Update ActiveH Progress Status Fields (Requires ActiveH Desktop 7.0.3+)

With Keyfax Client 4.0.0.42 and Keyfax 4.4.6.0 it's now possible for Keyfax to set the progress status fields introduced within ActiveH Desktop 7.x via scripting for the following ActiveH entities...

• Requests

• Works Orders

• Inspections

Setting the Progress Status

To set the progress status for requests, works orders and inspections Keyfax returns up to 3 analysis codes to identify the progress status to use for the request, works orders and / or inspection. Keyfax returns up to 3 analysis codes to identify the progress status reason to associate with the progress status change. To set the progress status notes for a request, works order or inspection a single export XML can be written to for each object containing the progress status notes.

The Keyfax Client 4.0.0.42 update contains additional logic to parse new progress status MISExchange.xml mappings to obtain the internal ActiveH identifiers from the supplied analysis codes and call the ChangeProgressStatus method on the appropriate ActiveH object via the ActiveH gateway API.

Known Limitations

Request Progress Status

A request progress status can only be set when creating a new request or editing an existing request via the "Requests" screen within ActiveH Desktop. If Keyfax is launched from the CRM Call Entry screen the MIS gateway object does not contain the required repair request object and so Keyfax cannot call the ChangeProgressStatus method on the repair request object to update the request progress statues. To update the request progress status ensure Keyfax is always launched from the Requests screen and not the Call Entry screen within ActiveH Desktop.

Works Order

Keyfax never creates the works order and so cannot set the progress status until the works order has been created by ActiveH Desktop. Once a works order has been created by ActiveH Keyfax can then present this works order for selection within a Keyfax script and update the progress status on the existing works order.

Update ActiveH Job Group / Job Category field (Requires ActiveH Desktop 7.0.3+)

The Keyfax integration with ActiveH Desktop can now optionally update the Job Group / Category field within ActiveH Desktop 7. A new <JobGroupJobCategoryID/> export XML element has been introduced within the MIS export XML template to support this functionality.

Obtain ActiveH Desktop Request ID

With the Keyfax Client 4.0.0.42 update when Keyfax is launched via the Requests screen within ActiveH Desktop a new <RepairRequestID/> element is provided to Keyfax within the Keyfax start-up data.

This element contains the request ID for the request Keyfax was launched from within ActiveH Desktop or contains 0 if Keyfax was launched from a new request. Keyfax can use this request ID to identify if Keyfax was launched from a new or existing request and for existing requests this can be used to obtain or display additional information for the ActiveH request during Keyfax scripting.

For example the request ID could be used to query for the list of works orders associated with the request Keyfax was launched from to allow the operator to select an existing works order and for Keyfax to update the progress status for the selected works order. This could also used to allow operators to select from an existing inspection and update the progress status for the selected inspection via Keyfax scripting when Keyfax is launched via an existing request within ActiveH Desktop.

Request Description

The Keyfax Client 4.0.0.42 release now includes the ability to update the request description within ActiveH Desktop separately from the call description field on the Call Entry screen. A new <Request_Additional_Info/> export XML element has been introduced within Keyfax to support this functionality. If Keyfax returns a value within this element this will be appended to the description field upon the Requests screen within ActiveH Desktop.

Change History

• Added UpdateProgressStatus method to assist with Orbit 4.4.6 requirements

• Added TenantGroupID and RepairRequestID start-up properties

• Added support for multiple XPath expressions when processing repair elements (//MapOut/MISTask[@obj='CRQTask' and @KFparent='Repair' and @KFsourceType='MIS_REPAIR'])

• Added InspectorID start-up property

• Added RentAccountID start-up property for Payment Information screen within Keyfax

• Added GetWorksOrderByID and UpdateOrderProgressStatus method

• Added GetInspectionByID and UpdateInspectionProgressStatus method