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
  • Explore, understand, streamline
  • Make Better Business Decisions
  • Script Flow Legend
  1. Product Suite
  2. Keyfax Administrator Tools
  3. Script Editing

Script Flows

Visualise your script structures with script flows.

PreviousTesting your changesNextScript Entities

Last updated 24 days ago

Explore, understand, streamline

Visual script flows introduced with Keyfax 4.4 allow you explore any script within Keyfax in a visual interactive manner. Script flows are designed to help script authors using Keyfax to better understand the possible paths and outcomes residents or call centre advisors can expect whilst walking through Keyfax scripts.

Script flows can also be shared via a regular hyperlink allowing you to share a visual representation of your scripts with key decision makers and stakeholders within your organization. This is helpful during the script creation or review process to gather feedback, inform decisions & help streamline your diagnostics scripts for both residents and call centre advisors.

Whenever a script is present in the editing grid, the Flow button can be used to display a visual representation of your script:

A typical flow can be seen:

Upon initial load script flows are displayed in a "Pan & Zoom" mode. This "Pan & Zoom" mode allows you to quickly navigate larger scripts by simply dragging to move around the script and holding CTRL/CMD and using the middle mouse button to quickly zoom in or out of the script. Script authors can also toggle into "Selection" mode to select individual script steps to see additional script step properties.

A description of each highlighted area from the screen grab above is provided below.

Script Flow Tools

Using the script flow tools, you can toggle between "Pan & Zoom" or "Selection" modes. You can also reset the visualisation or open the flow visualisation full screen within a new side-by-side window. A brief description of each toolbar option is provided below.

Pan & Zoom Mode

The Pan & Zoom mode allows script authors to quickly navigate larger scripts by simply dragging to move around the script and holding CTRL/CMD and scrolling the middle mouse button to quickly zoom in or out within the script.

Selection Mode

The Selection Mode allows script authors to select any script step shown within a script flow to reveal further information about about the selected script step. Selecting a specific script step will also highlight all possible paths through the script from the currently selected script step. Selecting messages or tasks within a script flow will also reveal an abstract or summary of the selected message or task.

Fit to Page

As the title suggests the Fit to Page option attempts to center and fit the entire script flow within the visible area within Keyfax administrator tools. This can be helpful for larger scripts if you want to quickly reset the view after panning and zooming within a script flow.

Open in new window

It's can be helpful to have multiple script flows open at once to better understand how certain scripts relate to one another. You can use the Open in new window option to open any displayed script flow within it's own independent floating window leaving you free to continue work within Keyfax admin tools but leave the script flow open for reference.

The Script Flow

The main interactive script flow. All script steps presented within a script flow are uniquely colour coded and have a unique icon to help visually identify the type of script step at a glance. By default script flows open up in "Pan & Zoom" mode allowing script authors to quickly explore scripts. Script authors can also swap to "Selection" mode to select any individual script step shown within a script flow to reveal additional properties & information about the selected script step.

Details & Options

Using the "Details" button you can view general information about the current script being visualized.

Using the "Options" button you can also easily export the script flow as an SVG, PNG, GIF or BMP for viewing offline.

If exporting a static script flow is not enough you can also optionally share a link to the fully interactive web based script flow via a temporary, private, unique URL. This can be helpful to easily share script flows with key stakeholders or business owners. You can see an example of the share dialog below...

Make Better Business Decisions

Understand Outcomes

Script flows make it easier to understand the possible outcomes of a Keyfax script by providing a more visual colour coded representation of any Keyfax script. This colour coding helps you quickly identify at a glance the priority, tasks and / or services that would be associated with the outcome of any Keyfax repair or enquiry.

Understand the User Journey

Using Selection Mode within any script flow and selecting a specific script step will highlight all possible paths through the Keyfax script from the currently selected script step. This makes it easy to visually understand the journey tenants or Operators could take through the Keyfax script until completion. We hope by making it easier for script authors to understand the user journey through scripts, script authors can have more confidence they are developing the most streamlined, useful, user-friendly scripts.

You can see an example of this below...

Script Flow Legend

A guide to Script Flow colours, icons and labels.

The Flow menu option
Script Flow main screen
Script Flow details
Exporting your Flow to various graphic formats
Sharing script flows...
Selected path is highlighted in green
Script Flow Legend