Keyfax
  • 📋What is Keyfax?
  • Product Suite
    • Keyfax Administrator Tools
      • System Requirements
      • Installation
      • Logging On
      • Navigation
      • Exclusive Mode
      • Script Levels
        • Master Scripts
          • Category Editing
          • Topic Editing
          • Self-Service Categories
        • System Scripts
          • Cancel
          • Priority Justifications
          • Results
          • Special Instructions
          • Startup
        • Script Sets
          • Category Properties
          • Setting up Topics
          • Topic Properties
          • Loading Script Sets
      • Script Editing
        • Script Editing - The basics
        • References
        • Testing your changes
        • Script Flows
      • Script Entities
        • Databoxes
          • Script Data
            • Host-specific notes
          • SQL Query
            • Testing SQL Query Databoxes
          • Import XML
          • Export XML
          • System Values
          • Company Data
          • Testing Databoxes & Expressions
          • Databox Read
          • Databox Write
          • Databoxes in Messages & Tasks
        • Questions
          • Address
          • Checklist
          • Date/Time
          • Dynamic Lists
            • Testing Dynamic Lists
            • Dynamic List Examples
          • External Forms (eForms)
            • External Forms - Technical
          • File Upload
          • List
          • Numeric
          • Text
          • Video Call
        • Asset Data
        • Markers
        • Messages
          • Testing Messages
        • Services
          • Host-specific notes
        • Priorities
        • Tasks
          • Enclosures & Attachments
          • Continuations
          • Host-specific notes
      • Reports
      • Databox Examples
        • Business Days
        • Working Hours
        • Time of day
        • Higher priority jobs
        • Script Duration
        • How did it happen?
        • Repair Description
        • Concatenating CSV
        • Tenant Handbook
        • Multi-line Addresses
        • Priority / Response Days
        • Contains Text
      • Databox Expressions
        • Text Expressions
          • CSV
          • Entry
          • Exists
          • FieldMerge
          • Index
          • IndexOf
          • InList
          • Item
          • Len
          • ListTidy
          • Lower
          • PadLeft
          • Replace
          • Row
          • RowMerge
          • SubStr
          • Trim
          • Upper
          • WCase
        • Numeric Expressions
          • Abs
          • AsNum
          • Between
          • Int
          • Mod
          • Number
          • Result
          • Round
        • Date Expressions
          • After
          • AsDate
          • Before
          • BetweenDates
          • DateAdd
          • Day
          • Month
          • Now
          • Today
          • WeekDay
          • Year
        • Number Formatting
        • Operators And Literals
        • Logical Expressions
        • Additional Functions
          • Ds
      • Users
        • Finding active users
        • Keyfax SSO – via Microsoft Entra ID Support
      • Advanced
        • Base Task Templates
          • Email Task Templates
          • Letter Task Templates
          • Note Task Templates
          • SMS Task Templates
          • VoiceSage Task Templates
          • Host-specific notes
        • Export & Import
        • Communications Queues
      • Host Operations
        • ActiveH Operations
          • Introduction
          • Actions
          • Databoxes & UDEs
          • Emails
          • Mail Merge Letters
          • Populating CallType
          • Populating JobType
          • Repairs Inspection Task
          • Repairs Interface
        • Fast Lean Smart
      • Best Practices
        • Extracting XML from Keyfax tables
        • Script Performance
        • Handling multiple rows from SQL
        • HTML Editor
        • Writing SQL Queries
      • Known Issues
        • Startup Messages
        • Running but not Visible
        • Error 1001 During Install
        • Stopped Working
    • Keyfax Staff
      • System Requirements
      • Advisor Feedback
      • Priority and Quantity
    • Keyfax Self-Service
      • System Requirements
      • Browser Support
    • KeyNamics
      • Model Driven Apps
      • Power Pages Portals
      • Installation
        • System Requirements
        • Solution Import
        • Basic Setup
        • Known Issues
      • Embedding
        • Model Driven Apps
        • Power Pages Portals
      • Configuration
        • Settings
        • Mappings
          • Creating Mappings
          • Minimum Mapping Requirements
          • Mapping Entity Form Fields
          • Mapping Lookup fields
          • Mapping Examples
        • FetchXML
          • Creating FetchXML queries
        • Logging
        • Test
      • Advanced
        • Mode Translation Rules
        • Customising Launch Button
        • Extending Export Data
        • Mapping Dump Fields
        • Mapping JSON Results
        • Enabling Help Panes
        • Mobile Operation
        • Handling uploaded content
      • Technical
        • Topology
        • Copying Environments
        • Keyfax Startup Data
        • Keyfax Export Data
    • Keyfax Client
      • Installation
        • Getting Started
        • Launch Tester
        • Uninstall / reinstall
        • Known Issues
    • Keyfax Cloud
      • Uptime Guarantee
      • Business Continuity
  • General
    • General FAQs
      • General Questions
      • Installation Questions
      • Migration Questions
      • Security Questions
      • Test & Training Questions
    • Keyfax FAQs
      • Keyfax Administrator Tools
      • Keyfax Staff
      • Keyfax Self-Service
      • KeyNamics
      • Keyfax Client
      • Keyfax Cloud
    • Issues & Solutions
      • Emails not working
    • Release Notes
      • Keyfax
        • 4.4.7
        • 4.4.6
        • 4.4.5
        • 4.4.4
        • 4.4.3
        • 4.4.2
        • 4.4.1
        • 4.4.0
        • Previous Releases
      • Keyfax Client
        • 4.0.0.44
        • 4.0.0.43
        • 4.0.0.42
        • Previous Releases
      • KeyNamics
        • 3.0.0.0
        • 2.0.0.13
        • Previous Releases
      • Older Releases
        • Staff
  • Integrations
    • API Docs
      • REST API
        • Quick Start
        • Deep Dive
        • API SDKs
          • .NET SDK
          • JavaScript SDK
          • Start-Up Data
          • Processing Results
        • API Reference
      • SOAP API
        • Quick Start
        • Error Handling
        • Status Codes
        • XML Schemas
          • Startup Schema
          • Results Schema
          • Results with Note
          • Cancelled Schema
          • Address data
      • Legacy APIs
        • Active X
        • Asynchronous Pluggable Protocols
        • XmlHttp
    • Integrations
      • Aareon
        • Introduction
        • Launching Keyfax Repairs
        • Launching Keyfax Enquiries
        • Configuration
        • SOAP based integration
        • QL Message fields
        • Known problems
      • Accuserve
      • ActiveH Desktop
        • Introduction
        • ActiveH Repair Interface
        • Known Problems
        • Keyfax Configuration
          • MISExchange.xml
          • Example Settings
          • Retrieving Block Codes
        • MIS Configuration
          • Exchange Process
          • Exchange Elements
          • User Permissions
          • User Security
          • UDE Interface
          • UDE Configuration
          • Settings
          • Desktop Configuration
          • Priorities Configuration
          • Populating Job Type
          • Populating Assigned To
          • Populating Call Classification
          • Configuring Log Call
            • Launching Keyfax from Response Repairs
          • Workflow Integration Actions
        • MIS interface Objects
          • CRM Gateway
          • Desktop Task
          • System Task Email Addressee
          • Desktop Task Action
          • Repair Request
          • Repair Request Inspection
          • Repair Request Task
      • ActiveH Portal (TIPS)
        • Introduction
        • Settings
        • Known Issues
      • ActiveH Web
      • Breeze IT
      • Caltech
      • Capita
        • Capita Housing / Academy
          • Host Table Usage
          • Troubleshooting
        • Open Housing
      • Civica
        • Civica CX
          • Introduction
          • Mappings
          • Start Up Data
          • Inspections
          • Known Issues
        • Civica CM
          • Known problems
        • Servitor
          • Example Import XML
          • Example Export XML
      • ContactView
      • Dynamics
      • Kirona
      • Lagan
      • MIS
      • MRI
      • Northgate
        • Launching Keyfax
        • Exchange process
        • XML/Field mappings
      • OneServe
      • ROCC
      • Total Mobile
        • Launching Keyfax (TASK)
        • TotalView Configuration
      • SDM
    • Best Practices
      • Integration Considerations
      • Displaying Keyfax Self-Service
  • Technical
    • General
      • Keyfax Architecture
      • Clearing Cache
    • Cloud Operation
      • Microsoft Azure
      • Amazon Web Services
    • Configuration Settings
      • Introduction
      • Paths Element
    • Developer Zone
      • eForm Technical Details
    • SQL Server
      • Freeing Space
      • Maintaining Indexes
      • Maintenance Plan
      • Restoring Live into Test
  • Links
    • Our Web Site
    • Our Blog
    • Try Keyfax
    • Contact Us
Powered by GitBook
On this page
  1. General
  2. Release Notes
  3. Keyfax Client

Previous Releases

Release notes for previous versions of the Keyfax Client.

Ticket numbers are listed, e.g. KFX-01234-A1B1 and this will usually indicate the item is linked to an original Support issue.

Version
Date
Affected Host Integration
Details

4.0.0.40

25/08/2022

ALL

KFX-01187-K1H6 Drilling into 'Keyfax has disabled status notifications' and freeze. A new configuration setting in KF40install.ini: StopTimerOnError (default is 'don't stop' i.e. '0'). If the call to GetKeyfaxStatusInternal fails or times out this will determine if the polling is to stop. At this time, a revamped 'heavy load' message is output.

4.0.0.39

09/02/2022

MIS-AMS CRM

KFX-06479-J7R9 even if no SOR is generated, we should still be creating a Repair Request. New setting in MISexchange mappings MapOut\@alwaysCreateRepairRequest (SW)

4.0.0.38

11/01/2022

MIS-AMS CRM

Reverse 4.0.0.36

4.0.0.37

09/12/2021

MIS-AMS CRM

KFX-01017-X3T3 Added MISActionCount to pick up Inspections (CHOICE)

4.0.0.36

04/06/2021

MIS-AMS CRM

Update reversed (combined Config/webserver support)

4.0.0.35

04/06/2021

MIS-AMS CRM

KFX-04679-J7R9 Configurably output ScriptPath when processing Call-level properties only . Requires new config setting in MISexchange.XML i.e. MapOut\@saveScriptPathCallLevel_MODE where MODE is RD (repairs) or FL (enquiries). (SW)

4.0.0.34

23/03/2021

ALL

Block attempts to relaunch the Keyfax scripts within a configurable number of seconds since the previous launch. It addresses issues where the Client can be invoked twice by a host system, usually by a doubleclick or multiple clicks, often when response times are slow. It requires a new top level configuration setting ClientConfig\MinPeriodBetweenLaunching which defines a number of seconds. The default is 10 seconds. (ORB)

4.0.0.33

17/08/2020

MIS-AMS CRM

Always output call level Description when handling Repairs+Tasks. (WHG) Handle single quotes when mapping data in/out (SW)

4.0.0.32

15/07/2020

ORCHARD

Include KF_Archouse.exe v1.0.0.8 - this supports latest Keyfax components (i.e. OCX).

4.0.0.31

16/06/2020

ALL

Increase default window size to accomodate responsive design (Keyfax 4.2 or greater). Ensure popup window position and size persist.

4.0.0.30

01/11/2018

ALL

Additional tracing to assist support. MIS Repairs+Tasks - handle jobs without SOR when task exists.

4.0.0.29

04/04/2018

ALL

Support CallerID, originally for the OPENhousing integration (CHP) Fixes to Keyfax Launcher (test program); some previous versions had been failing due to OCX errors. IMPORTANT: This round of changes has broken binary compatibility so this will affect any early-bound (non-MIS) integrations; specifically, this affects: OPENhousing using the Class Id (CLSID) (custom WRX) and Capita Academy using the TypeLib Globally Unique ID (GUID).

In order to use v4.0.0.29 (or greater), the necessary code changes to Capita's Academy/Open Housing need to be made to reflect the new GUIDs above (some sites, through licence arrangements, have the ability to make changes and recompile modules themselves). Please consult your technical support at Capita Software Services. You should ensure that custom changes are located in the custom folder to ensure they are not overwritten during subsequent upgrades. (CHP, NCC, SHT)

CLSID (OPENhousing)

TypeLib GUID (Academy)

Previously

{60B6DF9A-85E5-4C49-A177-A14FAC58D322}

{7EADF07A-3779-4061-8923-7A556490257F}

v29+

{E4F93A9C-C214-4CB0-BC40-A58D96C861C3}

{5BA79BC6-F3DC-4DBB-B49A-C4BAC757682A}

4.0.0.28

22/03/2018

MIS-AMS CRM

KFX-04153-G3S5: Keyfax Email tasks (non MIS) should be ignored when sending task data back to ActiveH (WHG)

4.0.0.27

16/03/2018

MIS-AMS CRM

Repairs with Tasks for MIS. Ensure that on returning to ActiveH, the Call's Description field only contains the Scriptpath and does not prepend the Description with the Fault Text (i.e. the Note contents).

4.0.0.26

25/01/2018

MIS-AMS CRM & Others

Tracing output to individual files e.g. KeyfaxDebug_JSMITH.log. Set config (e.g.) Debug\@file="1", @folder="\\WebserverDebugFiles$ and CSV list of users in @user="JSmith,GWatson". Fix issue when company-specific ClientConfig details not picked up due to wrong case! In Set Gateway, prevent re-entry as a result of doubleclicks in CRM

4.0.0.25

03/01/2018

MIS-AMS CRM & Others

Repairs with Tasks* for MIS - ensure that ScriptPath isn't written out to the Task's description, so for both RD and ENQ... - Task’s Description field contains task details, address, comments etc - Call’s Description field contains the Script path *The modification for Repairs+Tasks requires additional Exchange mapping settings. Increased size of popup window to accomodate wider left hand menu tree.

4.0.0.24

16/11/2017

MIS-AMS CRM

Support for Scheme_Code, LA_Code, Block_Code and Road_Code when Keyfax is launched from Response Repairs. Previously, these codes were only supported in Enquiries mode when launched from CRM (or after script-jumping into Repair Diagnostics from Enquiries). This change relies on updates to the MISexchange configuration & mapping file as well as the Startup XML template (startupRD_MIS.xml) (HHA)

4.0.0.23

16/07/2017

ALL

KFX-03940-S1D4: Additional tracing to detect relaunching of popup after completion.

4.0.0.22

04/05/2017

CAPITA HOUSING

KFX-03901-V7N0: Additional tracing when launching EXE on completion (e.g. EXTEVENT.EXE)

4.0.0.21

05/04/2017

MIS-AMS CRM/Others

KFX-03889-Y4Y9: MIS Inspections weren't being raised. Force tracing for user 'omfax' or any other user listed in the config's Debug\@user CSV list. Write to KeyfaxDebug files in Debug\@folder if specified. KFX-03901-V7N0: Additional tracing when launching EXE on completion. KFX-03903-R0C8: add StartupTimePeriodMs support (was hard coded as 10000 (10 seconds) in attempt to minimise problems with timeout on launch.

4.0.0.20

10/02/2017

ALL

KFX-03845-H6X1: Handle windows Close button cleanly by offering options to Continue or Cancel (some host systems struggle if the Keyfax pop-up isn't dismissed cleanly) (OG)

4.0.0.19

27/01/2017

MIS-AMS CRM

Under ticket KFX-03834-F0B8: 1) Prevent replication of EnquiryText in Description (could cause Error 5 in ProcessMISRequestTasks (line 1270) when returning multiple MIS Emails to host). 2) Correct Description string handling (call to 'Left' could fail with negative Length parameter).

4.0.0.18

04/07/2016

MIS-AMS CRM

Make the Gateway property CallerID available for use as well as properties of the DesktopTask object (embedded in the gateway), the most likely property of interest being CallID.

4.0.0.17

25/02/2016

ALL

KFX-03499-Z1N0: The installation program now warns/advises installers/system builders about Mapped Drives and displays the target folders. Once images are generated for deployment (e.g. 'Gold Build'), if the mapped drives (possibly used during the installation) are not present at runtime, the Client will be inoperable; this will usually display a 'Cannot access drive X:' message.

4.0.0.16

12/01/2016

MIS-AMS CRM

Ensure that when the Keyfax Client counts the number of tasks generated (finding zero tasks means the Log Call functionality kicks in) it differentiates between Keyfax tasks (e.g. Emails) and MIS tasks (Emails/Letters etc) in order that Keyfax auto-generated emails (and the tasks they produce) do not prevent the Log Call functionality from working

4.0.0.15

05/01/2016

ALL

Adjustments for fast processors

4.0.0.14

27/10/2015

MIS-AMS CRM

4.0.0.13

27/04/2015

DUAL HOST

Support SkipInformHostApp parameter in KFserverConfig.xml to allow Academy and OPEN to co-exist on the same desktop. Now it is possible to override Keyfax 'exit' processing, e.g. skip call to EXTEVENT.EXE.

4.0.0.12

06/03/2015

MIS-AMS CRM

For 'Log Call' functionality, this fixes a problem whereby the default Call Classification and Type values were being passed back to CRM, rather than the returned Scripted values.

4.0.0.11

11/12/2014

MIS-AMS CRM

For Repairs, allow Additional_Info (or other items) to be passed through to the Call Description. This requires an update to the MISexchange file, e.g. It requires the following directive in MISexchange: <MISTask obj="CRQTask" target="AppendCallDescription" dtype="varchar" length="2000" type="RD" KFparent="Repair" KFsource="../Additional_Info" KFsourceType="MIS_REPAIR" sql="" /> This directive will cause pre 4.0.0.11 Clients to fail as they will find the above directive and attempt to set a target property of "AppendCallDescription", which does not exist!

4.0.0.10

27/11/2014

MIS-AMS CRM

Updated DLL to ensure ActionCount is considered in the Log Call functionality as it is preventing the proper creation of Inspections and their fields.

4.0.0.9

3/02/2014

Orchard Housing

(Orchard Housing) handle rogue spaces in KF_archouse.exe's command Line, e.g. /FN: "\\path"

4.0.0.8

27/01/2014

MIS-AMS CRM

4.0.0.7

27/09/2013

MIS-AMS CRM

Minor bugfix required for 'Log Call' functionality

4.0.0.6

03/09/2013

MIS-AMS CRM

Process *all* SetCallLevel directives and use 'default="nnnn" attribute if supplied for 'Log Call' support.

4.0.0.5

26/07/2013

MIS-AMS CRM

Reset mMode when IV dismissed. May have been launched in FL Enquiry mode only for user to switch into RD. This was causing problems in the new call to RepairCount to deduce if Log Call skeletal entry can be written to the gateway.

4.0.0.4

27/07/2013

MIS-AMS CRM

Rebuilt to include TestOcx_MIS.exe which supports the property Priority_ID in it's 'dummy' CTskTask object (otherwise you'll get Error 438 ProcessMISRequestTasks Line 1120)

4.0.0.3

22/02/2013

MIS-AMS

Read default values for Priority_ID (FL) and PriorityID (RD) from MISexchange MapOut sections as these values must be mapped out for 'Log Call' functionality.

4.0.0.2

21/02/2013

MIS-AMS CRM

Further modifications for 'Log Call' processing (as per MIS-AMS)

4.0.0.1

23/01/2013

ALL

Include debug version of keyfax32.dll (which could be switched to if necessary). Add support for OriginatingSystem in OCX and DLL

4.0.0.0

15/01/2013

MIS-AMS CRM

Initial support for 'Log Call' functionality

3.2.0.41

19/08/2012

MIS-AMS CRM

Additional tracing to try to track down problem "unable to launch Repair Request".

3.2.0.40

06/10/2011

ALL

Ignore setting of Company Code to empty string (arose from Civica UHW testing). The Client thinks that the config code has changed, and it overrides the ConfigCode registry setting.

3.2.0.39

25/08/2011

Orchard Archouse Plus

AddToTaskBar support in KF32install.ini. Change arose because users need to switch from Keyfax to another app and if they click back onto Orchard, by getting focus it thinks that Keyfax has returned, no export XML is found and Keyfax isn't visible in the taskbar! Not clicking Orchard is a Training issue.

3.2.0.38

17/11/2010

MIS-AMS CRM

Ensure Keyfax window is closed on Cancellation

3.2.0.37

05/11/2010

Orchard Housing

To address problem where 000's of rows of history against a null TenantID, added the /TI: argument in order that Orchard can send this through on the command line to KFarchouse.exe.

(earlier details available on request)

Previous4.0.0.42NextKeyNamics

Last updated 1 year ago

Support for Tasks in Repairs Mode (MIS-AMS CRM v6.4.0 or greater) (RAG, RCH) Support passing of ConfigurationID property (aka Config or Company code) in MIS-AMS CRM Gateway object (CRM v6.4.0 or greater). Display the Version, Configuration name (and ActiveH database name for MIS-AMS integrations only) in status bar of scripting pop-up window, e.g:

Additional tracing added in an attempt to locate a problem relating to the error "Object does not support this property or method." Found to be an issue upon returning to ActiveH ().

CLSID (OPENhousing)

TypeLib GUID (Academy)

Previously

{60B6DF9A-85E5-4C49-A177-A14FAC58D322}

{7EADF07A-3779-4061-8923-7A556490257F}

v29+

{E4F93A9C-C214-4CB0-BC40-A58D96C861C3}

{5BA79BC6-F3DC-4DBB-B49A-C4BAC757682A}

more...