2.0.0.13

Learn what's new with KeyNamics 2.0.0.13.

Improved Dynamics 365 Customer Service & Omnichannel Support

With KeyNamics 2.0.0.13 we've focused on improving the advisor experience when working with KeyNamics within Omnichannel. Keyfax sessions will now be persisted between Omnichannel chats & KeyNamics has been improved to seamlessly integrate with Application Tabs within Omnichannel.

New Fields to persist Keyfax launch state on the Dynamics entity

We've added support for two new optional fields that can appear on any Dynamics entity to persist the Keyfax launch state. This allows KeyNamics to relaunch a previously saved Keyfax session on the Dynamics entity when switching between entities within Dynamics or swapping between Omnichannel chats.

If available KeyNamics will reuse the launch details found within these two new fields when a Dynamics entity is loaded as opposed to creating a new Keyfax session. If one or more of the new fields are not found on the form or any of the values are empty for these fields then a new Keyfax session will be launched for the Dynamics entity.

The two new optional fields persist the Keyfax launch URL and launch GUID on the Dynamics entity to ensure an existing Keyfax session can be relaunched again when an entity is loaded again within Dynamics.

Upon completion or cancellation of a Keyfax script the launch URL and launch Guid stored within these two new fields on the Dynamics form will be cleared so when the entity is reloaded again within Dynamics a new Keyfax session will be created for the Dynamics entity. An existing Keyfax session will only persist on the Dynamics form until a user complete or cancels the Keyfax session.

New Launch Validation

To better support integrations we've updated KeyNamics to now optionally require required fields on the Dynamics form are completed before KeyNamics will allow Keyfax to launch. This is controlled by the new RequireValidDynamicsFormBeforeLaunch setting within KeyNamics.

If RequireValidDynamicsFormBeforeLaunch is true and the Dynamics form is not complete and required fields are missing a value you will see the following alert from KeyNamics when KeyNamics attempts to launch Keyfax...

image

If RequireValidDynamicsFormBeforeLaunch is false no validation will occur and Keyfax will launch regardless of the Dynamics form state.

New Field to persist Keyfax completed state on the Dynamics entity

The new StateCompletedGuidLogicalFieldName setting now allows integrations to store the Keyfax GUID for a completed Keyfax session directly on the Dynamics entity. If the completed GUID is stored on the entity integrations can now use the new RequireCompletedGuidResetBeforeLaunch setting to control how Keyfax is launched if a previous Keyfax session GUID has been persisted to the StateCompletedGuidLogicalFieldName field.

New Reset Completed Keyfax Sessions

If RequireCompletedGuidResetBeforeLaunch is true and an existing GUID is stored within the StateCompletedGuidLogicalFieldName field Keyfax will now prompt you to check you which to reset the old session and launch a new Keyfax Session. This prompt is shown below...

image

After accepting the prompt you can click Reset Keyfax and then launch Keyfax again manually as shown below...

image

If RequireCompletedGuidResetBeforeLaunch is falseKeyfax will always launch a new session as before even if the GUID for a previous Keyfax session is stored within the StateCompletedGuidLogicalFieldName field

New Save Notification

To ensure performance KeyNamics does not attempt to automatically save the Dynamics entity to persist Keyfax launch or completed state and instead replies upon the dirty checking provided by Dynamics to ensure Keyfax state is persisted on the Dynamics entity before the user navigates away from the entity.

To ensure users save the entity to persist Keyfax state when necessary Keyfax will remind the user and a prompt as shown below...

image

Whenever the entity is automatically saved by Dynamics the above notification will disappear.

How Keyfax state is automatically persisted

IMPORTANT If the user navigates away from the Dynamics entity after Keyfax has launched or completed and the Dynamics entity has not been saved then the Keyfax launch or completed state would not be persisted on the Dynamics entity and KeyNamics will simply launch a new Keyfax session the next time the entity is displayed. To ensure Keyfax relaunches existing sessions or indicates completed sessions the Dynamics entity must be saved to persist the Keyfax state before the user navigates away from the Dynamics entity.

When users navigate between pages within Dynamics entities are automatically saved so in this scenario Keyfax state would be automatically persisted on the Dynamics entity displaying KeyNamics. Dynamics also periodically saves entities when being viewed which again will automatically persist Keyfax state on the Dynamics entity. If users manually refresh the entire Dynamics page Dynamics will typically prompt the user to save unsaved changes. before leaving the page.

New KeyNamics Settings

In order to make the launch process more configurable we've introduced the following new KeyNamics settings...

• RequireValidDynamicsFormBeforeLaunch (boolean - true or false)

  • If "true" the Dynamics form must be in a valid state before Keyfax can launch. If the Dynamics form is in a valid state and the StateLaunchUrlLogicalFieldName and StateLaunchGuidLogicalFieldName fields exist the Keyfax launch details will be persisted within these fields before Keyfax is launched

  • If "false" Keyfax will launch even if the Dynamics form contains empty or invalid required fields. The Keyfax launch details will still be persisted on the form. Upon navigating away from the entity Dynamics may automatically save the entity or the user may be prompted to save any changes to the StateLaunchUrlLogicalFieldName and StateLaunchGuidLogicalFieldName fields.

• RequireCompletedGuidResetBeforeLaunch (boolean - true or false)

  • If the completed Keyfax GUID is persisted within the StateCompletedGuidLogicalFieldName field on the Dynamics form and this value is "true" a new Keyfax session cannot be launched until the previously completed Keyfax session is explicitly reset by the user using the "Reset Keyfax" button

  • If "false" a new Keyfax session will always be allowed to launch even for Dynamics entities that contain a value within the StateCompletedGuidLogicalFieldName field on the Dynamics form.

• StateCompletedGuidLogicalFieldName (string)

  • A string value representing the logical field name of a 255 character single line text field on the Dynamics form. This field is used to persist the Keyfax GUID for a completed Keyfax session and can be used to indicate if Keyfax has already been completed for a Dynamics entity. Please note this field is not updated if the Keyfax script is cancelled and is only updated when the Keyfax script is fully completed.

• StateLaunchUrlLogicalFieldName (string)

  • A string value representing the logical field name of a 255 character single line text field on the Dynamics form. This field is used to persist the Keyfax launch URL field to on the Dynamics form. This allows KeyNamics to reload the same Keyfax session for the entity when the entity is reloaded or as users navigate between entities.

• StateLaunchGuidLogicalFieldName (string)

  • A string value representing the logical field name of a 255 character single line text field on the Dynamics form. This field is used to persist the Keyfax launch URL field to on the Dynamics entity. This allows KeyNamics to reload the same Keyfax session for the entity when the entity is reloaded or as users navigate between entities.

Required Keyfax Version (4.3.3.1 and above)

This update depends upon both xsl/completed.xsl and xsl/errorPage.xsl within Keyfax. These files will need to be updated to a minimum of 4.3.3.1 within the target Keyfax installation to fully support the above functionality.