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
  • I noticed KeyNamics installed new Dataverse entities. Can you provide a list of KeyNamics entities and there purpose?
  • I noticed KeyNamics has a dependency on the built-in systemusers entity within Dynamics. Why is this?
  • Does KeyNamics support Dynamics 365 Legacy / Classic Web User Interface?
  • My Keyfax launch button isn't appearing on my Dynamics App running under iOS?
  • I want to send the contents of a Field on the current Form to Keyfax for use in scripting. I need to know the Field name, - how do I find this?
  • How do I migrate Settings, Mappings and FetchXML queries from one D365 organistation / instance to another?
  • As a supplier of KeyNamics, what level of access will I need to your D365 environment(s)?
  1. General
  2. Keyfax FAQs

KeyNamics

Frequently asked questions related to KeyNamics.

I noticed KeyNamics installed new Dataverse entities. Can you provide a list of KeyNamics entities and there purpose?

A summary of each KeyNamics entity is provided below...

  • Configuration Stores important KeyNamics application settings (start-up templates, Keyfax URL, purge settings & other important settings to control KeyNamics functionality & behaviour)

  • Fetch XML Stores FetchXML statements used withn KeyNamics mappings (to obtain data for mappings KeyNamics can execute FetchXML queries against Dataverse entities)

  • Mappings Stores KeyNamics mappings (mappings allow you to send data from Dynamics into Keyfax & vice versa)

  • Test Stores test records to help test & configure KeyNamics.

  • Error Logging Stores log entries for a limited period for every time Keyfax is launched via KeyNamics. This log entry will capture any exceptions or detail any invalid settings, fetch XML statements or mappings.

  • Session Stores launch details & metrics for a limited period about each Keyfax session launched from KeyNamics. This table is used primarily to help Omfax Systems troubleshoot and identify any performance bottlenecks within your KeyNamics installation. This entity can also be used to trigger Power Automate Flows whenever Keyfax is launched.

  • Result Stores results & metrics for a limited period about each Keyfax session launched from KeyNamics. This table is used primarily to help Omfax Systems troubleshoot and identify any performance bottlenecks within your KeyNamics installation. This entity can also be used to trigger Power Automate Flows whenever Keyfax completes.

I noticed KeyNamics has a dependency on the built-in systemusers entity within Dynamics. Why is this?

KeyNamics requires the built-in systemuser entity to exist within Dynamics as KeyNamics has several entity relationships into the systemuser.id column. For example, every entity within KeyNamics has a CreatedBy & ModifyBy column which has a relationship back to the systemuser entity.

These relationships include...

  • keyfax_configuration_createdby

  • keyfax_configuration_modifiedby

  • keyfax_errorlogging_createdby

  • keyfax_errorlogging_modifiedby

  • keyfax_fetchxml_createdby

  • keyfax_fetchxml_modifiedby

  • keyfax_mapping_createdby

  • keyfax_mapping_modifiedby

  • keyfax_result_createdby

  • keyfax_result_modifiedby

  • keyfax_session_createdby

  • keyfax_session_modifiedby

  • keyfax_test_createdby

  • keyfax_test_modifiedby

KeyNamics does not require any specific attributes to exist within the systemuser entity but of course the KeyNamics relationships above do depend upon the systemuser.id column. As the systemuser entity is a built-in Dynamics entity this should always exist and generally never be modified. KeyNamics will never attempt to modify the systemuser entity or add or update any records within the systemuser entity.

Does KeyNamics support Dynamics 365 Legacy / Classic Web User Interface?

Microsoft revealed early in 2019 that the Dynamics 365 Legacy Web User Interface would be discontinued in October 2020 with users still on it urged to make the move to the new Unified Interface as soon as possible. KeyNamics fully supports the Unified Interface. If a legacy integration is required, although this is not recommended we can supply a version of KeyNamics to support this. We can assist with any subsequent migration to UI.

My Keyfax launch button isn't appearing on my Dynamics App running under iOS?

To operate on your mobile phone, this will require the Keyfax webserver to be running with TLS1.2 enabled (without this, frames will not operate on iOS).

I want to send the contents of a Field on the current Form to Keyfax for use in scripting. I need to know the Field name, - how do I find this?

You can either ask your Dynamics system administrator or form designer, or you can identify the form fields yourself. For further information please see Mapping Entity Form Fields.

How do I migrate Settings, Mappings and FetchXML queries from one D365 organistation / instance to another?

This is possible by using the Dynamics SDK Configuration Migration Tool;.

As a supplier of KeyNamics, what level of access will I need to your D365 environment(s)?

We don’t believe that 'admin' rights are required as that would grant us more privileges than necessary. However, the account would need the ability to:

  • Import a Solution: which can be granted through security Roles

  • Publish a Solution: will require ‘Publish Customizations’ permissions, which are often included in standard ‘Customizer’ roles.

  • Access Model Driven Apps: For support purposes and assistance with Mappings we’ll need app-specific permissions via the relevant security roles (e.g., Customer Service Representative, etc.).

  • Perform further customisation: going forward, within the KeyNamics solution it may be necessary to apply fixes/enhancements but as publisher, I believe we should have these permissions.

PreviousKeyfax Self-ServiceNextKeyfax Client

Last updated 1 year ago