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
  • Menu options
  • User Properties
  • Script Permissions
  • System Permissions
  • Call Permissions
  • Passwords
  • Entry Fields Validation
  • Deleting Users
  • See also
  1. Product Suite
  2. Keyfax Administrator Tools

Users

Managing users via the Keyfax Admin Tools.

PreviousDsNextFinding active users

Last updated 19 days ago

Users can be said to be Advisors/Operators/Agents who actually run the scripts or Administrators who are responsible for creating and maintaining scripts. Anyone attempting to launch Keyfax must be registered as a user via Admin Tools.

Clicking Users from the menu ribbon will present the following tab:

Menu options

The list can be filtered by any combination of:

  1. Full Name or Username (and toggled between the two with the ‘Full/User’ button)

  2. Selecting a user ‘Type’ to filter by disabled or administrative status

  3. Selecting a 'User Group' to filter by - this filters by the group displayed in the brackets after the Full Name of the user

User Properties

Login Mode - this can be either ‘Windows’ or ‘Keyfax’ affecting Admin logins only. This is what each mode does:

  • Windows mode expects the Username to be a valid Windows User allowing Admin login without a password. The Admin Password Reset button is hidden as not required. In Windows mode, the Usernames can be prefixed or suffixed with the domain name; this will be set up by your system implementor.

  • Keyfax mode requires a password as with the current login. Security has been added around the password storage and authentication process. Configuration of (e.g.) password strength will be set up by your system implementor.

Username - for all operators, this name must match the name passed by the system that launched the Keyfax diagnostic. There is no password validation when launching from a host system

WARNING Usernames can be changed, however any previous activity/history records will be retained with the original Username.

Forename, Surname & Email Address - these three fields are mandatory.

User Group - This allows a free format text entry identifying the user as a group member. The User Group is intended for scripting purposes allowing different behaviour according to the user’s group. For example, some users may be designated as out of hours shift workers requiring that different script sets are presented to them; these could be set up in a group named 'OOH' and a Startup script can examine this and load the appropriate Script Set.

There is no predefined list of User Groups, however, the system presents a dropdown of all current User Groups for selection. This allows easy selection of any existing used group or just type a new group name to create one.

Other details:

The following fields can be hidden by configuration, if required:

  • Department

  • Address1-3

  • Town

  • County

  • Postcode

  • Telephone

  • Extension

  • Fax

  • User Group

Script Permissions

This section is only displayed for Admins with permission to access the ‘User Permissions’ feature themselves. Script Permissions control access to all Script maintenance functions.

Advisors without a need to use Admin tools should be set up with no Script or System permissions.

Script permissions are as follows:

Scripting - Allows maintenance of the script and all related structures and entities.

Scripting (Exclusive allowed) - Allows selection of Exclusive mode for all scripting as above.

Templates - Allows maintenance of Keyfax Base Task Templates.

System Permissions

Reporting - Allows access to the Reports Viewer and all standard Keyfax reports.

System Admin - This option is only available for system administrators in their support capacity.

Communications queue - To monitor the progress of outbound Keyfax communications, such as emails and SMS. Access to the communication queue can only be granted/applied to Keyfax Administrator accounts when logged in as the System Administrator.

User Maintenance - Allows maintenance of Keyfax Users as described in this document.

User Permissions - Allows Keyfax User maintenance as above with the ability to change user permissions (excluding System Admin permission).

Call Permissions

Disable service priority edits - Disable the option to override the service priority on the Results (final) Page.

Disable service quantity edits - Disable the option to override the service quantity on the Results (final) page.

Disable visibility of service costs - Hide the value of the service and total service cost on the Results (final) page.

The example below shows the Quantity and Priority fields have been disabled for the selected user, preventing them from editing these fields. The Service Costs have also been disabled and are therefore not visible.

Passwords

Keyfax user passwords are only required for administrators configured with a Keyfax login. Advisors and Admins using Windows login have no separate Keyfax password.

Initially, new Keyfax users, with any Admin permissions, are set up with a system generated random password. The person setting up a new user is never aware of the new users password which is automatically emailed to the new user. Emails are sent directly to the new user from the web server. The Password Reset button is enabled before an Edit session is started. If a user forgets their password this can be reset by any user with User Maintenance permission. Clicking ‘Reset’ will set a new random password and email this to the selected user. A confirmation message is displayed when the email has been sent.

The Password Reset button is hidden when the Edit button is clicked and the user properties are being edited.

Password Authentication Process

New administrative users are set up with an auto-generated password emailed to the email address assigned to that user. Users must change this password when they first login to Admin Tools. The same process applies for password Reset.

Entry Fields Validation

Mandatory fields must be populated, the Username must be unique and password validation prevents re-use of last n passwords (where 'n' is configurable). It also enforces a minimum length, mixed case, alpha, numeric and special characters as configured by your system implementor.

Deleting Users

'Exclusive mode' is not required to delete a User. Any other admin trying to select or edit a newly deleted user will be presented with a message advising the user has been deleted and the administrator will be unable to edit.

DANGER Deleting a user cannot be undone and is permanent.

See also

  • Finding active users

The User Maintenance tab
Filtering Users by 'Type'
Scripting permissions
System permissions
Call permissions
Disabled call permissions for Priority, Quantity and Service Costs fields on the Results Summary Page