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
  • Category Images
  • The Topic Hotspot editor
  • Editing Related Images
  1. Product Suite
  2. Keyfax Administrator Tools
  3. Script Levels
  4. Master Scripts

Category Editing

How to edit Category properties and Image Hotspots

PreviousMaster ScriptsNextTopic Editing

Last updated 25 days ago

Clicking the Category name (e.g. Adaptations) from the Master Scripts Selection, will display the properties for the selected Category:

  • Name – the displayed name of the Category

  • Selectable (visible) – if this button is checked the category is visible to the Operators

  • .. Continuation (not visible) – if this button is checked the category is not visible to Operators and would be used as a Continuation Script, linked to a Visible Script

Category Images

  • Selection image - a Selection Image can be added to the selected Category by clicking the "Selection Image" icon. The image will appear on the Keyfax Application landing page as seen below. To access this feature within the staff modules, it must be enabled within your Keyfax installation (4.4.7+) by a member of Omfax Support.

  • Image text - the name given to the image. Please note, Keyfax will display this text for the Category Image as highlighted below instead of using the Name of the Master Script Category.

  • Images will be inherited at Script Set level but may be overwritten if required.

  • Administrators can select existing images from the Keyfax database or upload new images.

  • Topic Hotspots - Hotspots can be used with images to link to Topics within the selected Category. Images with ‘Hotspot’ areas can be added to the Script, which will be displayed to the Operator when they select a category. By selecting a Hotspot, Operators are selecting the associated Topic. Click on ‘Topic Hotspots’ which will open the Hotspot Editor in a new window

  • Related images - the facility for Operators to view additional images appropriate to the selected Category. Click on ‘Related Images’ to open the Related Images Selection in a new window.

The Topic Hotspot editor

Clicking the Topic Hotspots button will present this dialogue:

The Hotspot Editor - allows editing of images to be used within your scripts. To make any changes, click Edit on the Menu Bar.

  • Image – identifies the image file being used – default images are PNG format although GIF, BMP and JPG can also be used.

  • Display Text – the name displayed to Operators

  • Topic – displays the Topics within the selected Category. Where a Hotspot has yet to be created, a + (plus) sign is shown to the right of the Topic; when you click this, a new Hotspot area will be created in the image which can be moved and resized as required over the text label (any overlapping areas will be highlighted in red).

  • Text Pos. - setting the text position of Bottom, Left, Right or Top will add a clickable call-to-action button to the image. This can be used when using an image that has no text labels. This feature provides Administrators greater flexibility to upload their own images and add their own text buttons (v4.4.7 and later only)

  • Upload New Image - when in edit mode, displays a file selection dialog box through which new images can be uploaded to the server (v4.4.7 and later only).

  • Select Existing Image - when in edit mode, displays a dialog box through which images that are already in use on this server can be selected for use as this category's hot spot image (v4.4.7 and later only).

NOTE If you are in Exclusive mode you are able to remove the image and all related hotspots. To do so, click on Edit and then on the Remove image and Hotspots button. You can then save your changes.

Editing Related Images

Keyfax provides a facility for Operators to view additional images appropriate to the selected Category. Related images are available in the 'Images' tab:

Click on ‘Related Images’ to open the Related Images Selection in a new window.

To modify the list of related images click Edit on the Menu bar.

  • Image – identifies the file name for the selected image. To view or select another image click the Folder button

  • Name – the name for the image displayed to Operators.

  • Upload New Image - when in edit mode, displays a file selection dialog box through which new images can be uploaded to the server (v4.4.7 and later only).

  • Select Existing Image - when in edit mode, displays a dialog box through which images that are already in use on this server can be selected for use as this category's hot spot image (v4.4.7 and later only).

Note: Related images must be assigned for each Category at Script Set level in-order to be visible to the end user when they click on the images tab.

Master Script Category Properties
Category Selection Images for Repairs Diagnostics
Category Selection Image
The Hotspot Editor
Remove image and Hotspots when in Exclusive mode
Viewing related images
Related images selection