Basic Setup

IMPORTANT These instructions are provided for convenience purposes only. Typically if external access is available to your Dynamics environment Omfax Systems staff would install & configure your KeyNamics installation for you.

After successfully importing the KeyNamics solution into your Dynamics environment there are a number of general KeyNamics configuration settings and mappings you'll want to update to ensure KeyNamics is pointing to your Keyfax installation.

Configuration Settings

After installing the KeyNamics solution visit the KeyNamics model driven app and click Settings on the left as shown below...

From the Settings page you'll need to edit the following setting...

WebServiceBaseUrl (Required)

This contains the URL to your Keyfax installation. You will need to update the "Value" for this setting. By default the Value is...

https://kftest.touch-base.com/InterView/WS/KeyfaxWS.asmx

You will need to update this to use your Keyfax URL. For example...

https://keyfax.yourdomain.co.uk/InterView/WS/KeyfaxWS.asmx

For a list of all settings please see Settings.

Creating Start Up Templates

IMPORTANT Before following the steps below please ensure you've confirmed with Omfax systems the Keyfax configuration file name(s) for to your Keyfax installation(s). You will need to know your Keyfax configuration file name(s) to correctly create the below described new settings.

Under KeyNamics Settings you'll need to add a few new settings. Depending on the script types available within your Keyfax installation you'll need to create new Setting entries within KeyNamics containing the default start-up data to use for each configuration and script type when launching Keyfax.

If you have Keyfax Staff installed (RD & FL script types) you'll need to create a new setting for each enabled staff script type. If you have Keyfax Self-Service installed (ROL & EOL script types) you'll also need to create settings for both the ROL & EOL script types.

Repairs Diagnostics Staff Template (RD)

Only required if you have the repair diagnostics script type enabled within your Keyfax installation. Under Settings Click New to add a new setting and complete the fields as described below...

• Key: Template_KF_Company_Staff_Live_RD IMPORTANT Where KF_Company_Staff_Live is the name of your Keyfax configuration file confirmed with Omfax Systems. This will need to be replaced with your real Keyfax configuration file name.

• Name: Startup Template (RD)

• Value: This should be as follows...

<?xml version="1.0" encoding="utf-8"?><KeyfaxData test="0"><Startup name="Fault1"><OriginatingSystem /><GUID/><Company/><Mode>RD</Mode><UserName /><Password/><Tenant/><ClientID/><RepairNo/><TenantID/><AssetID/><ScriptSet/><Asset/><History/></Startup></KeyfaxData>

Save the new Setting.

General Enquiries Staff Template (FL)

Only required if you have the general enquiries script type enabled within your Keyfax installation. Under Settings Click New to add a new setting and complete the fields as described below...

• Key: Template_KF_Company_Staff_Live_FL IMPORTANT Where KF_Company_Staff_Live is the name of your Keyfax configuration file confirmed with Omfax Systems. This will need to be replaced with your real Keyfax configuration file name.

• Name: Startup Template (FL)

• Value: This should be as follows...

<?xml version="1.0" encoding="utf-8" ?><KeyfaxData test="0"><Startup name="Enquiry1"><GUID/><Company/><Mode>FL</Mode><UserName/><Password kf="protected"/><Tenant/><ClientID/><TenantID/><AssetID/><ScriptSet/><Scheme_Code/><LA_Code/><Road_Code/><Block_Code/><History/></Startup></KeyfaxData>

Save the new Setting.

Repairs Online Self-Service Template (ROL)

Only required if you have the repairs online script type enabled within your Keyfax installation. Under Settings Click New to add a new setting and complete the fields as described below...

• Key: Template_KF_Company_Online_Live_ROL IMPORTANT Where KF_Company_Online_Live is the name of your Keyfax configuration file confirmed with Omfax Systems. This will need to be replaced with your real Keyfax configuration file name.

• Name: Startup Template (ROL)

• Value: This should be as follows...

<?xml version="1.0" encoding="utf-8"?><!--OL2 Startup XML template. Used as template to create startup xml from login details    kfId values for future use:      startCategory:    Permits direct startup of a single Topic skipping System StartupScript and Topic selection      startTopic:       As above, startCategory must also be defined according to Master Category and Topic names. --><KeyfaxData test="0"><Startup><OriginatingSystem kfId="originatingSystem">TemplateLogin</OriginatingSystem><GUID kfId="guid" /><OriginatingGUID kfId="originatingGuid" /><Mode kfId="scriptType" /><UserName kfId="userName" /><Password kfId="password" kf="protected">Global</Password><Config kfId="config" /><ClientID kfId="clientId" /><ScriptSet kfId="scriptSetCode" /><!-- Category kfId="startCategory"/ --><!-- Topic kfId="startTopic"/ --><ReturnURL kfId="returnUrl"/><!-- CallerDetails are typically not populated on startup and must be scripted as required from the login details in ROLDetail --><CallerDetails isTenant=""><CallerID kfId="tenantId" /><Caller kfId="tenantText" /></CallerDetails><ROLDetail kfId="loginDetails"><!-- Further elements are appended from the login and property select pages --></ROLDetail></Startup></KeyfaxData>

Save the new Setting.

Enquiries Online Self-Service Template (EOL)

Only required if you have the enquiries online script type enabled within your Keyfax installation. Under Settings Click New to add a new setting and complete the fields as described below...

• Key: Template_KF_Company_Online_Live_EOL IMPORTANT Where KF_Company_Online_Live is the name of your Keyfax configuration file confirmed with Omfax Systems. This will need to be replaced with your real Keyfax configuration file name.

• Name: Startup Template (EOL)

• Value: This should be as follows...

<?xml version="1.0" encoding="utf-8"?><!--OL2 Startup XML template. Used as template to create startup xml from login details    kfId values for future use:      startCategory:    Permits direct startup of a single Topic skipping System StartupScript and Topic selection      startTopic:       As above, startCategory must also be defined according to Master Category and Topic names. --><KeyfaxData test="1"><Startup><OriginatingSystem kfId="originatingSystem">TemplateLogin</OriginatingSystem><GUID kfId="guid" /><OriginatingGUID kfId="originatingGuid" /><Mode kfId="scriptType" /><UserName kfId="userName" /><Password kfId="password" kf="protected">Global</Password><Config kfId="config" /><ClientID kfId="clientId" /><ScriptSet kfId="scriptSetCode" /><!-- Category kfId="startCategory"/ --><!-- Topic kfId="startTopic"/ --><ReturnURL kfId="returnUrl" /><!-- CallerDetails are typically not populated on startup and must be scripted as required from the login details in ROLDetail --><CallerDetails isTenant=""><CallerID kfId="tenantId" /><Caller kfId="tenantText" /></CallerDetails><ROLDetail kfId="loginDetails"><!-- Further elements are appended from the login and property select pages --></ROLDetail></Startup></KeyfaxData>

Save the new Setting.

Update Company Mapping

You'll need to ensure your "Global" Company mapping contains the correct configuration file name previously supplied by Omfax Systems.

You will need to ensure your Keyfax configuration file name appears within the "Default" value for the "Company" mapping as shown below...

Test Launching Keyfax

After configuring the above settings & mapping visit the KeyNamics Model Driven App and click "Test" on the left. Select an existing test entry or create a new one. Scroll down to the Keyfax Launch button and attempt to launch Keyfax.

If changes have been successful your Keyfax installation should launch within the Test entity form as shown below...

Keyfax launched via KeyNamics

If Keyfax does not launch please double check the above configuration settings and Company mapping and review Known Issues or Contact Us.

How is the start-up template determined?

Within the above examples we can see the Keyfax start-up templates follow the naming convention of...

• Template_{config}_{mode}

The {config} is determined by the Company mapping and the {mode} or script type is determined by the Mode mapping within KeyNamics Mappings.

When looking at the Company and Mode mappings you'll notice these follow the format of...

• web={value},mobile={value},outlook={value}

Where we identify each configuration name and script type with a unique key. KeyNamics can supply this key to launch specific Keyfax configurations or script types. For further information please see Mode Translation Rules.

Minimal Mapping Requirements

Alongside the Company and Mode mappings there are a few other mappings you may wish to consider. For further information please see Minimum Mapping Requirements.

NOTE In the above start-up template examples the Username and Password elements are already populated and you shouldn't need to update the Username and Password mappings to launch Keyfax.

Next Steps

Once you've configured KeyNamics you'll want to look at Embedding KeyNamics into your Model Driven App entity form or within your Power Pages Portal.

You'll also want to create Mappingsand possibly FetchXMLstatements to send data from your entity forms or Dataverse into Keyfax and vice-versa.

Please Contact Usfor assistance with configuring your mappings to suite your requirements.