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
  • Error message "Please be advised - Object doesn't support this property or method"
  • The 'Keyfax' hyperlink is not visible or is disabled (greyed out) in ActiveH.
  • The 'Keyfax' hyperlink is visible and not greyed out but Keyfax does not launch.
  • Where multiple instances of ActiveH and Keyfax are present (e.g. Live, Test, Training), unless the Keyfax Client or configuration settings are correct or ActiveH databases are synchronised, there may be user validation (and other) data-mapping problems.
  • Using Asynchronous Pluggable Protocols.
  • SORs not being returned to CRM
  • Priorities not returning to CRM
  • Failed to start Repair Finder. Please contact your system administrator.
  • Job Type not always populating in ActiveH
  • Unable to connect to ActiveH database
  • Client window freezing
  • User in ActiveH with blank username (sites using AssignedTo)
  1. Integrations
  2. Integrations
  3. ActiveH Desktop

Known Problems

Know issues related to ActiveH Desktop and the Keyfax Client.

PreviousActiveH Repair InterfaceNextKeyfax Configuration

Last updated 1 year ago

Error message "Please be advised - Object doesn't support this property or method"

This error can result if you created consecutive mail merge (letter) tasks and is caused by a problem with the tasking in CRM. It will appear as soon as CRM takes control back from the diagnostic popup. It is subsequently followed by a second message 'Object variable or With block variable not set' We understand from MIS-AMS that this will be resolved in Service Pack 1 of ActiveH 6.1.0. Any Keyfax sites moving to version 6.1.0 of ActiveH will require at least Service Pack 1.

The 'Keyfax' hyperlink is not visible or is disabled (greyed out) in ActiveH.

The possible reasons for this are:

  • the Keyfax Client is not installed (or is not ) - please check with your IT.

  • the call handler has not been set up with the correct access role or permissions in ActiveH - please refer to your IT or MIS-AMS support desk.

  • the call handler has not completed specific form field(s) - please refer to your IT or MIS-AMS support desk

The 'Keyfax' hyperlink is visible and not greyed out but Keyfax does not launch.

This can happen with a 'new' ActiveH database that has been moved from a different SQL server. To resolve this issue see 'Unable to connect to ActiveH database' below.

Where multiple instances of ActiveH and Keyfax are present (e.g. Live, Test, Training), unless the Keyfax Client or configuration settings are correct or ActiveH databases are synchronised, there may be user validation (and other) data-mapping problems.

This is probably best illustrated below:

Using Asynchronous Pluggable Protocols.

This is a rather verbose term to describe the initiation and passing of parameters to a desktop application via a browser URL. ActiveH supports 'drilldowns' whereby any application can fire off a 'link' and ActiveH pages pop up. The link takes the form (e.g.):

activeh://AccountDetails/1234

Currently, these links will not operate behind Keyfax's Message Button UNC/HTTP functionality but it will work as an HREF in a message, e.g:

In the above example you would need to drop in the account ref (and maybe ‘AccountDetails’ if that’s variable too) as bookmark(s).

SORs not being returned to CRM

When the Keyfax script completes and an SOR is raised, it will be mapped back to a code within the CRM system. This mapping may fail for a variety of reasons. One possible cause is that the SQL View created for the purpose of mapping (Shared_SYS_SOR_Active_SORs_v) needs to be recreated.

Priorities not returning to CRM

If the Priority codes in Keyfax match those in CRM yet on returning from a diagnostic script they are not being preselected in the dropdown list it is likely that the Priority has not been enabled for CRM and Tasking, i.e.

Failed to start Repair Finder. Please contact your system administrator.

When starting CRM, you may see the message below. Possible reasons for this are that the Client is incorrectly installed or the ProgID in the ActiveH configuration settings is incorrect; it should read 'KeyfaxMIS.KF_MIS':

Job Type not always populating in ActiveH

Randomly, it seems, the Job Type was not being populated after returning to ActiveH following a repair, This was originally logged under Support Ticket ref: KFX-04319-V8N9. This issue was resolved and a fix was made available by MIS in June 2019; this required deployment of a new version of the CRMGateway DLL (MIS ref: 104734).

Unable to connect to ActiveH database

This will cause the Client to fail when it attempts to launch Keyfax. It can also cause SQL Databox queries to fail. Ensure that the connection strings in the Keyfax configuration files and MISexchange files (note: the latter carry two connections) are correct and the SQL Server is accessible. Logins and credentials will normally be provided by MIS or a site's IT department. This Login must be a member of the ActiveHGRP role. If ActiveH databases have been moved to another SQL Server, it may be necessary to fix up orphaned users. Keyfax will usually be configured to connect using a SQL 'Keyfax' user (i.e. ALTER USER keyfax WITH LOGIN = keyfax).

Client window freezing

At two customer sites, investigations into reasons that the Keyfax Client window was freezing (on clicking the final page's Submit button) were a consequence of performance issues:

  1. The cost threshold for parallelism configuration option in SQL Server was increased from 5 to 50. It is understood that best practice is to run with this set between 25-50.

  2. The ActiveH telephone number search was changed from "contains" to "equals" as the former is very inefficient

  3. The Rent Accounts table index was rebuilt and an additional index created on ‘EndDate’

  4. A user-define (USR) View was tweaked

  5. Configured the virus scanner exclusions in Windows Defender on the SQL Server. These were not set, so were scanning the SQL Server process plus the data and log files, and the Swap File.

Further, repeated clicking of the Keyfax launch button/link can cause this. Keyfax will ignore multiple clicks for up to 5 seconds after the original click was accepted. We believe that, subsequently, changes were also made in ActiveH to prevent multiple clicks.

User in ActiveH with blank username (sites using AssignedTo)

If a username with a name of ‘empty string’ exists in ActiveH, it will cause problems as we execute a lookup for every task, using this SQL found in the MISexchange file:

NOTE: '[value]' is replaced with the value found in the AssigngedTo node of the export XML:

DECLARE @hierarchy_ID as integer
SELECT @hierarchy_ID=o.hierarchy_ID
       from
              shared_organisation_hierarchy_t o (nolock) join shared_users_t s (nolock)
              on s.user_id = o.user_id where s.username_vc = '[value]' 

IF @hierarchy_ID IS NULL
       SELECT @hierarchy_ID=o.hierarchy_ID from shared_organisation_hierarchy_t o (nolock)
              join shared_departments_t d (nolock) on d.department_id=o.department_id
       where d.Description_VC = '[value]'

SELECT @hierarchy_ID

If the ActiveH username can’t be corrected, we can change our mapping by amending the query as follows:

DECLARE @hierarchy_ID as integer
IF '[value]' = ''
       SELECT ''
ELSE
BEGIN

       SELECT @hierarchy_ID=o.hierarchy_ID
              from
                     shared_organisation_hierarchy_t o (nolock) join shared_users_t s (nolock)
                     on s.user_id = o.user_id where s.username_vc = '[value]'

       SELECT @hierarchy_ID

       IF @hierarchy_ID IS NULL
              SELECT @hierarchy_ID=o.hierarchy_ID from shared_organisation_hierarchy_t o (nolock)
                     join shared_departments_t d (nolock) on d.department_id=o.department_id
              where d.Description_VC = '[value]'

       SELECT @hierarchy_ID

END
installed properly