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
  • Additional Configuration
  • Launching Keyfax from MIS-AMS SQL ActiveH Repairs.
  1. Integrations
  2. Integrations
  3. ActiveH Desktop
  4. MIS Configuration

Settings

PreviousUDE ConfigurationNextDesktop Configuration

Last updated 1 year ago

Before Keyfax is used with the MIS-AMS SQL ActiveH Repairs, various settings need to be applied to the MIS-AMS installation. This is done via MIS-AMS SQL ActiveH Desktop and Repairs.

The following information give a walk-through of the various steps required to complete the configuration:

  1. The MIS-AMS SQL ActiveH Desktop application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL Active Desktop.

  1. If the MIS-AMS SQL ActiveH installation has more than one instance available, a "configurations" dialog will be displayed (see right). This may contain Live, Test and Training versions, all of which will need to be configured independently.

    For this walk-through, the "Live" instance will be selected - Click the "OK" button to continue.

  1. A login dialog will prompt you for a valid username (ID) and password.

    It is important that a MIS-AMS SQL ActiveH user account with administrative access to edit configurations is used for this process. In this case the "MIS" user account, once the details are entered - Click the "OK" button to continue.

  1. The Main MIS-AMS SQL ActiveH Desktop window is displayed (see right). This give access to the required configuration screens.

  1. From the Main MIS-AMS SQL ActiveH Desktop window, select the "Options.." item from the "Tools" menu (see right).

  1. The "Options" screen has a series of settings which can be set on "tabs". The "Repair Finder" tab should be selected, and the details should be entered as follows: Prog ID: the class name for the Keyfax OCX control used in interface ("KeyfaxEx.Keyfax") Caption: The text used for the Keyfax hyperlink button in the CRM (i.e. "Keyfax"), although not necessary, with Repairs. Database: The name of the Keyfax database for MIS-AMS SQL ActiveH CRM usage (format: "KF_[company name]_32" -should be on the same SQL Server instance as the SQL ActiveH database)

  1. While in the "Options" screen, the "Integration" tab should be selected, and the "Repair Finder" item should be checked. - This enables/disables the Keyfax hyperlink button in the CRM.

    Click the "OK" button to save any changes.

  1. Note: In later versions of the MIS-AMS SQL ActiveH Desktop application, the Options screen has been revised. The screen capture on the right is from version 5.5.0.

    This version now has the "Repair Finder" settings on the the "Integration" tab.

Additional Configuration

Once the MIS-AMS SQL ActiveH Desktop configuration is complete, additional configuration is required in the MIS-AMS SQL ActiveH Repairs module.

The following information gives a walk-through of the various steps required to complete the configuration:

  1. The MIS-AMS SQL ActiveH Repairs application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL ActiveH Repairs, and login as an administrative user (as indicated above).

  2. From the Main MIS-AMS SQL ActiveH Repairs window, select the "Options.." item from the "Tools" menu (see right).

  1. The "Options" screen has a series of settings which can be set on "tabs". The "Job Fax " tab should be selected, and the details should be entered as follows: Enable Job Fax : the checkbox should be checked. Exchange Start Up : This is a series of command line parameters, which instruct the Keyfax OCX to establish a communications interface with the host application. This should be: /S:XML /E:XML /V:MIN /M:RD. Global Password : The Keyfax Global password should be set to allow Keyfax Repairs Diagnostic to skip user password validation during operation. This password can be obtained by request from Omfax.

Launching Keyfax from MIS-AMS SQL ActiveH Repairs.

Once the MIS-AMS SQL ActiveH Desktop and repairs modules have been configured the Keyfax application can then be launched from the Repairs module. The following information give a walk-through of the various steps required to test this configuration:

  1. The MIS-AMS SQL ActiveH Repairs application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL ActiveH Repairs, and login (as indicated above).

  2. From the toolbar, select the "Requests" item from the "Tasks" menu icon drop-down (see right).

  1. A new "Repairs Request" will be created, which will require an asset to be selected (or looked up) before Keyfax can be launched.

    Click the "New" icon (left most icon on toolbar), which will launch the "Asset Lookup" window.

  1. The MIS-AMS SQL ActiveH "Asset Lookup" window is displayed (see right). Enter in search criteria to select an Asset by it's address, postcode, type or current tenant details.

  1. Once a tenant is selected from the "Asset Lookup" window, it will close and populate the "Repairs Request" window (see right).

    Click the "Add Task " icon (left most icon on toolbar above the Tasks pane), which will launch the "Task Line" window to capture SOR and other repair details.

  1. You will now see a "Keyfax" button (Blue "K" icon), next to the MIS-AMS SOR Lookup button (magnifying glass icon). This will launch Keyfax Repairs Diagnostic to capture SOR codes (see right).

  1. When the "Keyfax" button is clicked a "JobFax Communications" window will be displayed. This remains on screen, with Keyfax status information displayed until the Keyfax scripting process is complete (see right).

  1. Once Keyfax closes, the SOR code will be returned to the "Task Line " window, where the Priority, Unit Of Measure and Quantity, Job Type and other required information should be completed manually.