MISExchange.xml

Keyfax mapping configuration file (MISExchange.xml)

The MISExchange.xml file is used by the Keyfax Client to control the way data is exchanged between ActiveH and Keyfax.

Configuration settings are published for information purposes only. Unless express consent has been granted, changes to configuration settings must only be made by Omfax Systems/Touch-Base Ltd technicians or their representatives.

The MISExchange.xml file has the following schema:

<KeyfaxData>
   <Config>
      <Admin active="True[/False]" />
      <SQLConnection><![CDATA[ ]]></ SQLConnection>
      <MailMergeTypeID sql="" default="" source="" />
      <MailMergeLetterID sql="" default="" source="" />
      <InspectionTypeID sql="" default="" source="" />
      <InspectionPriorityCodeID sql="" default="" source="" />
   </Config>
   <MapIn>
      <MISRequest obj="" target="" type="" source="" sql="" />
   </MapIn>
   <MapOut saveScriptPath="True[/False]">
      <!-- KEYFAX REPAIRS DIAGNOSTIC -->
      <MISTask obj="" target="" dtype="" length="" type="" KFparent="" KFsource="" KFsourceType="" sql="">
      <!-- KEYFAX GENERAL ENQUIRY -->
      <MISTask obj="" target="" dtype="" length="" type="" KFparent="" KFsource="" KFsourceType="" sql="">
          <MISTask obj="" target="" dtype="" length="" type="" KFparent="" KFsource="" KFsourceType="" sql="">
              <MISTask obj="" target="" dtype="" length="" type="" KFparent="" KFsource="" KFsourceType="" sql="" />
          </MISTask>
      </MISTask>
   </MapOut>
</KeyfaxData>

Keyfax Administration Tools configuration settings

The setting up and configuration of MIS-AMS CRM tasks within Keyfax is dependent on the Keyfax Administrator Tools. The configuration requirements are defined in a shared XML file (MISExchange.xml) of which its path is defined in a configuration file in the KFLauncher IIS virtual folder.

The <Config> section of the MISExchange.xml file contains settings which are used in the Keyfax Administration console wizards to assist script writers to generate Keyfax scripted actions to create repair Inspections and CRM mail merge requests. The specific details are as follows:

• Admin active: Set to True or False, to allow the administration console to include MIS-AMS CRM task wizards when designing scripts.

• SQLConnection: This should be set as a valid OLEDB connection string to the MIS-AMS SQL Server database.

• MailMergeTypeID: A SQL statement to populate a dropdown list of available CRM MailMergeTypes and their IDs. The default attribute allows the Administrator Tools to pre select a default value. This should be the REQUIRED

• CRM MailMergeTypeID. The source attribute should be "NA", as this is not used in the Keyfax Task wizard.

• MailMergeLetterID: A SQL statement to populate a dropdown list of available CRM MailMergeLetters and their IDs. The default attribute should be "NA" and source attribute "MailMergeTypeID". This attribute allows the Administration Tools to only include Letters which have been defined with a MailMergeTypeID as selected in the MailMergeTypes dropdown.

• InspectionTypeID: A SQL statement to populate a dropdown list of available Repair InspectionTypes and their IDs. The default attribute allows the Administrator Tools to pre select a default value. This should be the REQUIRED

• Repair InspectionTypeID. The source attribute should be "NA", as this is not used.

• InspectionPriorityCodeID: A SQL statement to populate a dropdown list of available Repair InspectionPriorityTypes and their IDs. The default attribute allows the Administrator Tools to pre select a default value. This should be the REQUIRED

• Repair InspectionPriorityCodeID. The source attribute should be "NA", as this is not used in the Keyfax Inspection wizard.

• Keyfax MISexchange.xml Schema.

The Keyfax OCX will parse the MISExchange.xml file on start-up request (<MapIn> section) and when results are ready to return (<MapOut> section). The following table explains in detail how each XML Element and its Attributes are used within the MISExchange.xml mapping file:

Element	Attribute	Allowed Values	Description
<KeyfaxData>	-	-	REQUIRED XML Root - Only 1 must exist.
<Config>	-	-	REQUIRED Keyfax Administration Console requirement - Only 1 must exist.
<Admin>	active	True False	REQUIRED To allow the administration console to include MIS-AMS CRM task wizards when designing scripts.
<SQLConnection> (May be XML CDATA)	-	<OLEDB string>	REQUIRED This should be set as a valid OLEDB connection string to the MIS-AMS SQL Server database.Note that this connection string is only used by Keyfax Admin Tools (in order to populate MIS-specific menus). The Gateway object itself provides its own connection string for use in acessing the SQLActiveH database during Map-in and map-out exchange processing. Note: Microsoft Vista and Server 2008 will not supply the password in the SQL connection string. The Administrator Tools and the Keyfax Client (as from v3.2.0.32), the connection string is derived from the MISexchange.xml configuration file.
<MailMergeTypeID>	sql	<SQL statement>	SQL query to fetch available MailMergeTypes and their IDs from the SQL ActiveH database. Default: (SELECT MergeType_ID, Name_VC FROM Shared_SYS_Merge_Types_T)
default	<number>	OPTIONAL ID of MIS-AMS CRM MailMergeType to default to. Default: (13)
source	NA	Leave as default: (NA)
<MailMergeLetterID>	sql	<SQL statement>	SQL query to fetch available MailMergeLetters and their IDs from the SQL ActiveH database. Default: (SELECT MergeLetter_ID, MergeLetters_Name_VC FROM Shared_Merge_Letters_T WHERE MergeType_ID = [Value])
default	<number>	OPTIONAL ID of MIS-AMS CRM MailMergeLetter to default to. Default: (NA)
source	MailMergeTypeID	This is the result on the selection of the MailMergeType in Administrator Tools. Default: (MailMergeTypeID)
<InspectionTypeID>	sql	<SQL statement>	SQL query to fetch available InspectionTypes and their IDs from the SQL ActiveH database. Default: (SELECT Code_ID, Description_VC FROM Shared_Codes_T WHERE Type_ID = 49)
default	<number>	OPTIONAL ID of MIS-AMS Repair InspectionType to default to. Default: (587)
source	NA	Leave as default: (NA)
<InspectionPriorityCodeID>	sql	<SQL statement>	SQL query to fetch available InspectionPriorityTypes and their IDs from the SQL ActiveH database. Default: (SELECT Code_ID, Description_VC FROM Shared_Priorities_T)
default	<number>	OPTIONAL ID of MIS-AMS Repair InspectionPriorityCodeID to default to. Default: (33)
source	NA	Leave as default: (NA)
<MapIn>	-	-	REQUIRED Keyfax start-up requirement - Only 1 must exist.
<MISRequest>	-	-	REQUIRED Keyfax start-up requirement - Multiple allowed.
obj	CGateway	REQUIRED Name of the MIS-AMS object being passed to OCX
target	Startup Export Mode Source UserName Password Tenant TenantID *Tenure_Code #Tenancy *LA_Code *Scheme_Code *Block_Code *Road_Code RepairNo Visibility OAP_Disability Communal Bookmark History Asset AssetID SAsset SHistory	REQUIRED Any required Keyfax startup.xml node to be written to. * = Enquiry Scripts only requirement. # = Enquiry scripts can jump to Repair Diagnostics so must be supplied for both modes.
type	NA FL	REQUIRED NA = Enquiry or Repair Diagnostic start-up value FL = Enquiry only start-up value (see items marked * in target)
source	UserID AssetID CallerID ContactID StartupSource	REQUIRED Any of the defined MIS-AMS SQL ActiveH.CGateway properties, marked as available to fetch start-up data from.
sql	<SQL statement>	OPTIONAL A valid SQL Statement to fetch data from SQL ActiveH SQL Server database based on WHERE clause value returned from source attribute. Note: use the text [value] to represent the value of the WHERE clause in statement.
<MapOut>	-	-	REQUIRED Keyfax export requirement - Only 1 must exist.
saveScriptPath	True False	OPTIONAL If saveScriptPath = "True" Then script path questions and answers will be appended to CRM Call Description or Repair Description. Note: For this to work, ensure that the KF_Config settings are set for ScriptPath type 1: Configuration/Scripting/RD/Exchange/ScriptPath[@type="1"] Configuration/Scripting/FL/Exchange/ScriptPath[@type="1"]
<MISTask>	-	-	REQUIRED Keyfax export requirement - Multiple allowed. General Enquiries result processing requires nesting of this elements to enumerate multiple Sub-actions, Email Addressees and SetGatewayValue items.
obj	CRQRequest CRQTask CRQInspection CTSKTask CTSKEmailAddressee	REQUIRED Name of the MIS-AMS object being written to.
target	<various>	REQUIRED Any of the defined MIS-AMS SQL ActiveH object (CRQRequest, CRQTask, CRQInspection, CTSKTask or CTSKEmailAddressee) properties, marked as available to fetch start-up data from. Note. Additional parameters need to be defined if the SQL ActiveH object property to be written too has more than one parameter. Example: "SetGatewayValue.FieldName" and "SetGatewayValue.Value" If data is to be concatenated to existing SQL ActiveH object property value the APPEND parameter should be specified. Example: "Description.APPEND" Note 2: To set properties at the Call Level prefix the property name with the directive 'SetCallLevel', e.g. 'SetCallLevel:CallPriority'
dtype	text ntext varchar nvarchar char nchar int smallint bit decimal money	REQUIRED The data type of the SQL ActiveH database table column which is to be updated through the SQL ActiveH object (CRQRequest, CRQTask, CRQInspection, CTSKTask or CTSKEmailAddressee) properties (see target attribute).
length	<number>	REQUIRED If text column is being written to, then set the length to the maximum allowed text size. If 'char' or 'nchar' longer data will be truncated. If 'text', 'ntext', 'varchar' or 'nvarchar' longer data will be truncated and ellipsis added. Numeric length used otherwise: int=4, smallint=2 etc.
type	RD FL	REQUIRED Keyfax export mode RD = Repair Diagnostics FL = General Enquires
KFparent	#Repair Advice #Custom #Update Action *SubAction	REQUIRED Parent Path to Keyfax Export.xml element required in KFsource attribute (see below). * = Enquiries only requirement. # = Repairs Diagnostic only requirement This can also contain additional XML XPath syntax to identify the element. Example: "SubAction[SubActionKey='MIS_EmailTo']"
KFsource	<various>	REQUIRED Name of Keyfax Export.xml element with required data (this must be a child element of the defined KFParent element - If no KFparent is defined the parent element is assumed to be the Fault or Enquiry element). This can also contain additional XML XPath syntax to identify the element. If the KFsourceType = "VALUE" and type = "FL" then a constant value can be supplied in this parameter (see KFsourceType below).
KFsourceType	MIS_REPAIR MIS_INSPECTION MIS_EMAIL MIS_MERGE MIS_ACTION *MIS_GATEWAY_VALUE *VALUE	REQUIRED Required only for Repair inspections and Enquiry export section to group instructions for different MIS-AMS task types. * = General Enquiries only: MIS_GATEWAY_VALUE is used with a target property with two parameters: "SetGatewayValue.FieldName" and "SetGatewayValue.Value" VALUE is used where a constant value is required, not originating from the export XML or a SQL Query; the constant value should be supplied in the KFSource parameter: Example: KFsource="128" Note: Repair Diagnostic constant values must be achieved by a SQL statement: Example sql="SELECT '1'"
sql	<SQL statement>	OPTIONAL A valid SQL Statement to fetch data from SQL ActiveH SQL Server database based on WHERE clause value returned from KFsource attribute. Note: use the text '[value]' to represent the value of the WHERE clause in statement, please encase in single quotes when using text values.

Sample MISExchange.xml File

A sample MISExchange.xml file can be viewed here. This file has been used in development and testing with MIS-AMS SQL ActiveH Repairs and CRM, and meets all the default requirements to generate Repair Requests, Inspections, CRM System Mail Merge, System Email Tasks, Desktop User Tasks. In most installations this file will need little or no modifications.

MIS Internal Configuration

It is necessary to configure MIS such that it is aware of the presence of Keyfax. The following dialog is located on the ActiveH Desktop screen, choose TOOLS/OPTIONS. The Keyfax database shown is ONLY used when creating the SubActions (from the 'app_export_sub' table) in the CRM setup dialog to register them in the MIS database. Any Live, Train or Test CRM databases are likely to refer to the same database. This MIS config data is stored in MIS database table: 'Shared_Options_T'.