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
  • What is the difference between Keyfax and Keyfax Self-Service?
  • What, if any, cookies does Keyfax use?
  • Does Keyfax use Java and if so, which version is it compatible with?
  • When I click the button to launch Keyfax in my host system, nothing happens
  • I have managed to launch the Keyfax pop-up but the tabs are not displayed and the main page is empty. All I see is the list of Categories on the left hand side -why?
  • I have a Message with a 'Link' button that points to a spreadsheet on a network server. If I run the script from Admin Tools' Test page, the Link merely presents a blank window whereas it works for our advisors running their scripts. It also works if I run the script outside of Admin Tools (e.g. in Internet Explorer).
  • After each question is displayed, I see a message box saying 'There was a problem retrieving information from the server. Please try again'.
  • If Support personnel have asked you to download a compressed (ZIP) file and asked you to 'unblock' it, - what does that mean?
  • Are uploaded photos/images whitelisted?
  • Does/can Keyfax connect to a cloud based Microsoft Dataverse (formerly Common Data Service) setup?
  1. General
  2. General FAQs

General Questions

General frequently asked questions related to Keyfax.

What is the difference between Keyfax and Keyfax Self-Service?

Keyfax Self-Service differs from the core product in the following ways:

  • Responsive web design - intended to work on any device on mainstream browsers

  • Initial selections are made via images/hotspots rather than a tree-view menu

  • Optional login page with validation e.g. valid tenancy reference

  • Optional address selection (e.g. where postcodes are supplied)

  • Optional 'Preferred appointment' page

  • Email generation (e.g. to tenant and housing dept)

  • Extensible via Host integration (webservices/XML etc, requiring besoke development/integration)

  • Styling; Keyfax Online can be customised to match your corporate identity.

What, if any, cookies does Keyfax use?

Keyfax uses cookies as follows:

Name
Description
Expires

ASP.NET_SessionId

Used for site session management

When you close your browser

Keyfax

Used for site session management

When you close your browser

Does Keyfax use Java and if so, which version is it compatible with?

Keyfax doesn't use Java but it does use Javascript. JavaScript is a (very) distant cousin of Java in that it is also an OOP (Object Oriented Programming) language. Many of their programming structures are similar. However, JavaScript contains a much smaller and simpler set of commands than does Java.

When I click the button to launch Keyfax in my host system, nothing happens

This is usually caused because the user id being passed across from the host is not present or enabled. Another reason, where the Keyfax Client is used, is that the user's profile is corrupt. We have found that deleting the profile corrects the problem.

I have managed to launch the Keyfax pop-up but the tabs are not displayed and the main page is empty. All I see is the list of Categories on the left hand side -why?

A number of things to check but it is most likely the case that JavaScript is not enabled in your browser. This is possibly due to IE Enhanced Security on the Citrix server; if so, can this be disabled? Otherwise/also it’s probably best if you add the Keyfax web server as a Trusted Site for all users. i.e. http://[KeyfaxWebServerName]. It may also be that you need to lower the secuity levels in your Group Policy for affected users, thus allowing Javascript to run.

I have a Message with a 'Link' button that points to a spreadsheet on a network server. If I run the script from Admin Tools' Test page, the Link merely presents a blank window whereas it works for our advisors running their scripts. It also works if I run the script outside of Admin Tools (e.g. in Internet Explorer).

This assumes that the Link was in the format (e.g.) FILE://\\\\FileServer\SharedDocs\AssetInfo.xlsx. Version 4.1.4.0 of Admin Tools introduced use of the Chromium browser and this does not support the FILE protocol. As a resolution may not be available, our recommendation is that to work in and out of Admin Tools, that these become HTTP links with any content you may care to display available on a web server.

After each question is displayed, I see a message box saying 'There was a problem retrieving information from the server. Please try again'.

Likely causes are that you are running with Internet Explorer 8.0 or you are viewing the website in Compatibility Mode (this is often the default for intranet sites but should be switched off for Keyfax):

Either upgrade your browser or change the Compatibility settings.

Another possible cause of this error is when there are no visible Categories or Topics beneath a script set (see below, - Any attempt to direct to the Supported Housing scriptset will fail ):

If Support personnel have asked you to download a compressed (ZIP) file and asked you to 'unblock' it, - what does that mean?

Are uploaded photos/images whitelisted?

Although we whitelist the file type extension (configurable by the Keyfax Administrator in the Upload Question definition), we do not interrogate the file content to confirm the type or perform any other checks. This should be further secured with 3rd party AV scanning software.

Does/can Keyfax connect to a cloud based Microsoft Dataverse (formerly Common Data Service) setup?

  • Only Azure Active Directory authentication is supported

  • This is in preview for SQL Server with no firm release dates

  • The connection is read-only (you cannot perform INSERTS or UPDATES to dataverse using the SQL connector)

  • There is a 80mb limit on SELECT results

  • There are some limitations with data types & joins (see link above)

Please note: as at March 2021 this is yet to be tested.

PreviousGeneral FAQsNextInstallation Questions

Last updated 1 year ago

Some files need to be “unblocked” after download in order to avoid security warnings; see for more information.

To connect an on-premise SQL Server instance to Dataverse Microsoft currently offer a feature which is in preview called SQL data connection for Dataverse. Further information can be found . If this can be set-up correctly this should allow Keyfax to query into Dataverse entities using regular SQL. Theoretically this should work like any other SQL query within Keyfax however there are some important considerations…

these instructions
here