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
  • File Sizes
  • Internet Information Services (IIS)
  • .NET Framework
  • Load Balancing
  • Email
  • Server Specification
  • Microsoft SQL Server
  • Database & Log File Sizes
  • Server Specification
  • File Server Requirements
  • File Sizes
  • Server Specification
  • Network
  • Monthly results
  1. Product Suite
  2. Keyfax Staff

System Requirements

The Keyfax system requirements.

Keyfax for Staff is a web application requiring a Windows based hosting environment. Here you'll find the minimum and recommended system requirements.

File Sizes

The file size of the ASP.NET Components, templates, HTML files, associated images and repairs policy files are around 170MB. This size can vary if additional components, images and/or policy files are included. In considering your data storage arrangements, it is best practice, in general, to keep data and system files separate in the case of a drive corruption/crash you can get easy access and for quick restores, security, etc.For operation of the website and to allow space for upgrade backups, Admin installations and Log files, at lease 1GB is required.

Internet Information Services (IIS)

Requires Microsoft® Internet Information Server (IIS) version 5 or greater running on Windows® 2012 Server/Advanced Server (32 or 64 bit) or above.

.NET Framework

Requires .NET 4.8 Full Framework for Keyfax 4.1.5.0 and above.

Load Balancing

Keyfax will run in an active-active load balanced configuration but would require ‘sticky-sessions’. A load balancer or router with sticky-session support is able to route a specific user to a single server, using the HTTP session or IP address.

Email

Keyfax requires the Keyfax web server is configured with access to an outbound SMTP server and authorised to send both internal and external emails.

How Emails Work

  1. Keyfax uses the local IIS SMTP server to queue and forward emails to your organisations outbound SMTP server. The Smtpsvc.dll service monitors the pickup and drop directories on the Keyfax web server for any new emails generated by Keyfax and forwards these emails to the "Smart Host" SMTP server defined within your IIS settings.

  2. When delivering mail, the Keyfax web server will perform a DNS look-up to obtain the IP address for the DNS name specified within the "Smart Host" field. Upon a successful DNS look-up Smtpsvc.dll will then use the authentication details configured on the Keyfax web server to connect to your SMTP server and deliver the message.

  3. The local IIS SMTP server running on the Keyfax web server is typically confidured to use SMTP authentication and TLS 1.2 to communicate with your organisations outbound SMTP server. The local SMTP server is also tied down to ensure emails can only be sent by the Keyfax web server.

  4. Once the email reaches your organizations outbound SMTP server Keyfax has no further control over how the email is delivered. It's upto your organisation to ensure DNS records are configured correctly (SPF, DMARC etc) to allow trusted delivery of email to both internal and external email addresses.

Server Specification

It generally follows that the higher the specification of the processor(s) and memory; the faster the delivery of web content to the client browsers. In any situation, we would recommend a specification in excess of the Minimum Microsoft® recommendation.

An example specification currently in use in a high-volume site (350 diagnostic jobs per day) is:

  • Windows Edition: Windows Server 2016 Datacenter (64 bit)

  • Processor: Intel® Xeon® CPU E5-2640 0 @ 2.50GHz 2.50GHz

  • RAM: 6-8GB

Microsoft SQL Server

Keyfax requires a Microsoft® SQL Server database and is supported on SQL Server 20014 SP4 platforms or greater. We would recommended at very minimum SQL Server 2016 Web Edition or above.

Database & Log File Sizes

There are many variables which determine storage requirements, - these include the number of Script Types/Sets, their content, associated Messages, Tasks, Order/Task history, housekeeping and archive retention periods, levels of activlity etc. Over and above this, the Keyfax database may co-exist with other databases and the sum total must be considered.

Generally, if a database contains a single set of diagnostic scripts and no history it will be around 30MB. Allowing for growth, e.g. where history is recorded, 20GB of capacity is normally ample.This can grow, together with its transaction log file over a period of time, so backup and maintenance plans must be established and monitored by your Database Administrator.

In considering your data storage arrangements, it is best practice, in general, to keep data and system files separate in the case of a drive corruption/crash you can get easy access and for quick restores, security, etc.

For the benefit of system architects/planners, to illustrate, the typical storage arrangement for a high activity site (500 transactions per day) would be:

Drive C: Size 40GB Description Operating System (assuming a minimum of logging activity and housekeeping of WIndows Updates)

Drive D: Size 30GB Description SQL Data (assuming a single Keyfax Database)

Drive E: Size 20GB Description SQL Logs

Server Specification

Microsoft® SQL Server® 2016 or greater should be installed on a server, whose specification is in excess of the minimum Microsoft® recommendation. The SQL Server® instance used by Keyfax must be installed with mixed-mode Authentication.

NOTE For newer versions of Microsoft® SQL Server not listed above, we endeavour to ensure that the Keyfax product range remains compatible but should issues arise, we will, on a best-efforts basis, ensure any problems are resolved.**

An example specification currently in use in a high-volume site is:

  • Windows Edition: Windows Server 2016 Datacenter (64 bit)

  • Processor: Intel® Xeon® CPU E5645 @ 2.40GHz 2.40GHz

  • RAM: 16GB

File Server Requirements

A file server is not normally a requirement but common files used by more than one workstation or Keyfax Administrator can be installed on a File server. These include; policy files, images, reports and configuration files. This prevents duplication and allows all users to have the most up-to-date information at any time.

File Sizes

Most shared configuration files are located in a virtual folder on the IIS Server. Shared administration Console files (Reports, Help files etc.) can be installed on a file server, although be default these files will be installed to a sub folder on the Administrator's PC.

Server Specification

As with any File Server, generally (and barring network latency), the higher the specification of the processor(s) and memory, the faster the delivery of files to clients will be. Therefore as a minimum, a Server with a single Intel Pentium 4 processor and 2-4GB of memory is recommended.

Network

Although difficult to predict usage, e.g. number of users, number of transactions, peak periods etc, we have taken measurements that should provide a reasonable guide.

In this case, a Client was submitting 6460 repair requests over one month (approx. 294 per day).

Monthly results

You can see that over the month there is a total transfer of 928MB + 832MB = 1760MB (Mega Bytes) or 1.76 GB of data.

As far as latency is concerned we get a very fast PING response from the server (which is remote to our office in a data centre) of 24ms which at the time of testing was faster than google.co.uk and bbc.co.uk. Obviously the customer connection plays a big part in this figure as well as the hosts network capability.

PreviousKeyfax StaffNextAdvisor Feedback

Last updated 1 month ago

As you can see from the monthly graph, bandwidth usage is minimal with an average IN/OUT of under 3Kb (kilobits per second). The server has bandwidth of up to 100Mb (megabits per second) available to it but is using a tiny fraction of this. Even the peak over the month is only 0.5 Mb.