Difference between revisions of "Configuration Settings"

Revision as of 12:22, 11 December 2018

Inter•View is extraordinarily configurable. XML files are used to store all configuration settings and are easy to edit and read. Care has been made to group associated settings and name them in such a way to make them self-descriptive.

PLEASE NOTE! 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.

Multi-Company Configuration

The Host System needs merely to pass a company identifier code (via a URL parameter) when invoking Inter•View, and this tells Inter•View to run that session using settings from a company-specific XML configuration file. This allows a single Inter•View web-service installation to support any number of company configurations, each with their own database (if required). This supports both multi-company configurations and provides for testing/training instances.

Inter•View

Default installations of Inter•View have a single configuration file, this is typically called KF_config.xml (KF is replaced with company prefix in some Multi-company installations or for training/test instances) and is located in the KFLauncher shared folder.

The KF_config.xml configuration file schema is as follows.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
+<Client>
+<Paths>
+<Database>
+<Email>
+<CRM>
-<Scripting>
  -<RD>
    +<Images>
    +<Asset>
    +<History>
    +<Exchange>
   </RD>
  -<FL>
    +<Images>
    +<Exchange>
   </FL>
 </Scripting>
</configuration>

Note: Some CDATA sections (<![CDATA[ setting value ]]>) may have been in the Keyfax XML configuration files.
These are used where a setting contains characters which are invalid in element values of an XML file (such as "<" or ">"). 
CDATA sections can only be used for XML element values, not attributes.

Scripting

The configuration/Scripting section of the main configuration file contains settings for Scripting. Although the configuration settings for the two 'Model' script types are detailed here (i.e. Repair Diagnostics and General Enquiries), it is possible to define any script type, each with its characteristics.

<Scripting enableScriptTypeJumps="1">
 <RD></RD>
 <FL></FL>
 <ABC></ABC>
</Scripting>

Enquiries

<FL enabled="1" tree="1" headerHeight="110" standAlone="0">
 <HeaderLogo>
   <![CDATA[ <IMG height='50' src='images/misc/omfax_GeneralEnquiries.gif' width='198'> ]]>
 </HeaderLogo>
 <Default QAset="1" QAsetTenant="1" QAsetNonTenant="2" layer="1" />
 <Tabs class="tab" tableHeight="22" buttonWidth="75">
  <Q_A><![CDATA[Q & A]]></Q_A>
  <PCY>Policy</PCY>
  <INF>Information</INF>
 </Tabs>
 <Feedback Log="1" Administrator="Admin Staff" To="admin@omfax.co.uk" From="noreply@omfax.co.uk" CC="" BCC="" Subject="Keyfax: Advisor Feedback" ReplyTo="" />
 <Flow address="1" repeat="1" display="3" dialogs="top" dialogQText="1" messages="top" feedback="1" suggest="0">
  <SummaryImage title="Repair Details" displayFullAdvice="0">repair1.gif</SummaryImage>
  <EditsAllowed priority="1" quantity="1"/>
  <Sections responsibility="1" services="1" advices="1" tasks="1" addInfo="1" spInstr="1" access="1"/>
  <TargetComplete display="1" label="Complete By" format="dd/MM/yyyy"/>
  <TargetDays display="0" label="Days"/>
  <Quantity display="1" label="Qty"/>
  <CostCol display="1" label="Cost" currency="£" />
 </Flow>
 <Tasks merge="1" process="1" auto="1" showUnprocessedMergeFields="1" editMissingOptionalBookmarks="1" log="1" forceSendEmail="0">
  <RemoveUnusedBookmarks>CallerAddress3,CallerAddress4,CallerAddress5</RemoveUnusedBookmarks>
  <XSLfile>\\webprod1\prodsites\Keyfax32\xsl\tasks.xsl</XSLfile>
 </Tasks>
 <WelcomeMessage>
  <![CDATA[ <p><div class='mWelcomeTitle'>No current category selected</div>
   <div class="mTextBold">or selected category does not have a hotspot image</div></p><p />
   <p><div class="mText">Please select an enquiry category from the left hand list,
   or one of it's corresponding enquiry items.</div></p></p> ]]>
 </WelcomeMessage>
 <CompleteMessage>
   <![CDATA[ <p><div class='mWelcomeTitle'>Script Completed</div></p>
   <p><div class='mTextBold'>Please use your host system to launch Keyfax.</div></p> ]]>
 </CompleteMessage>
 <Images><-- See Images section --></Images>
 <Policy>
   <Folder>policy</Folder>
   <Default>policy/default.htm</Default>
 </Policy>
 <Exchange><-- See Exchange section --></Exchange>
 <Templates></Templates>
</FL>

Explanations of these settings as follows:

FL

• @enabled

Set to 1 if General Enquiry scripts are used.

Note: This setting is used in MIS-AMS integration only.

• @tree

Set to 1 if the script navigation tree is to be displayed.

• @headerHeight

Height of the header section for Keyfax General Enquiries. Default if not set=62.

• @standAlone

Allows General Enquiry scripts to be launched in stand-alone mode. User is first prompted for credentials. Default if not set=0.

• HeaderLogo

This contains a HTML code for an IMG element. This defines an image to be used in the top left of the main General Enquiry screen. This can be replaced with a customer logo. However this must be exactly 198px wide, by 50px high.

• Default
  • @QAset Defines the default General Enquiry script Q & A set to use if the "Tenure_Code" passed from the host HMS / CRM is not configured within the database.
  • @QAsetTenant Defines the default General Enquiry script Q & A set to use if launched via Keyfax Contact Centre and a tenant has been selected.
  • @QAsetNonTenant Defines the default General Enquiry script Q & A set to use if launched via Keyfax Contact Centre and a non-tenant has been selected, the currently selected property is void or no tenant/property has been selected.
  • @layer The header tab to highlight on load and body layer - numeric value 1-5.

1. Q & A
2. Policy

• Tabs

These settings provide a degree of customisation of the following tabs (where specified, settings apply to all tabs):

Q_A (Questions and answers)
PCY (Policy)
INF (Information i.e. Dataview) tabs.

• @class

Defines the class name for styling purposes. The default setting is tab

• @tableHeight

Defines the height of the containing table in pixels. The default value is 22

• @buttonWidth

Defines the button width of each button. The default value is 75.

• Feedback Advisor Feedback facility; options are:
  • @Log Whether advisor comments are logged to the database: 1 = log, 0 = don't log.
  • @Administrator The Administrator name displayed to the advisor when feedback details are submitted.
  • @To Typically, the Administrators email address is specified here. If omitted, no email is sent.
  • @From The email From address.
  • @CC The CC email address.
  • @BCC The BCC email address.
  • @Subject The email subject.
  • @ReplyTo The Reply To address.

• Flow General Enquiry workflow/display options:
  • @address Whether caller name and address is displayed below script selection tree: 1 = display, 0 = hide.
  • @repeat If multiple scripts can be run before returning results to host HMS / CRM: 1 = enabled, 0 = disabled.
  • @display (3.2 only!) Controls the display of elements on the Results screen; Sum of following bitwise values:
  1. Task List
  2. Advice List
  • @dialogs Location of script input dialogs; "top" or "center".
  • @dialogQText When [EDT] or [XAD] codes are displayed, controls where the title bar text of the dialog originates: 1 = Current question text, 0 = Action code short description
  • @messages Location of script message dialogs; "top" or "center".
  • @feedback Enable the Feedback button during scripts. Click here for more information about the Feedback feature.
  • @suggest Enable 'suggest' functionality where partially entered Keywords present a drop-down list for selection. 1=enable, 0=disable
  • SummaryImage Defines the summary image displayed at the top of the summary page.
    • @title Defines the text displayed following the summary image.
    • @displayFullAdvice Determines how the advice messages are displayed; 0=all collapsed, 1=expand 1st message only.
  • EditsAllowed Determines if the quantity and priority can be edited on the summary page (1=edit allowed or 0=not allowed for the following attributes).
    • @priority
    • @quantity
  • Sections Determines which sections are displayed on the summary page according to the appropriate attribte value: 1=display, 0=hide.
  • TargetComplete Controls the display of the target complete date column on the summary page.
    • @display Determines if the target complete date column is displayed at all; 1=display, 0=hide.
    • @label Determines the column header text.
    • @format Controls the date format.
  • TargetDays Controls the display of the target days column on the summary page.
    • @display Determines if the target days column is displayed at all; 1=display, 0=hide.
    • @label Determines the column header text.
  • Quantity Controls the display of the quantity column on the summary page.
    • @display Determines if the quantity column is displayed at all; 1=display, 0=hide.
    • @label Determines the column header text.
  • CostCol Controls the display of the target complete date column on the summary page.
    • @display Determines if the cost column is displayed at all; 1=display, 0=hide.
    • @label Determines the column header text.
    • @Currency Currency symbol to use or blank. As £, € and ¥ are not permitted in XML use their equivalents: 'pound', 'euro', 'yen' or blank.

Alternatvely encode values, e.g. for € enter € for £ enter £

Note that the $ (dollar) symbol is OK.

• Tasks
  • @merge Set to "1" if tasks are to be merged within General Enquiries.
  • @process Set to "1" if tasks are to be processed by users within General Enquiries before submission.
  • '@auto Since v4.0.1.9, @auto="1" is used to automatically process emails when @process="0". e.g. where emails are to be sent with no operator intervention. In this case all missing values are ignored and provided the from and to email addresses are available, the email is sent automatically.
  • @showUnprocessedMergeFields Since v4.0.1.0, @showUnprocessedMergeFields is not used. Individual Databoxes can have Empty bookmarks allowed checked to prevent task processing insisting a value is entered. When tasks are displayed, controls whether un-merged fields are highlighted. 1 = display, 0 = hide If set at '1', then un-merged fields will require text to be updated before letters can be printed, or emails can be sent. A separate setting in the CRM Tasks configuration section controls how un-merged fields are handled within Contact Centre.
  • @editMissingOptionalBookmarks (from v4.0.1.12) This controls the behaviour for optional databoxes (i.e. where Empty bookmarks allowed checked is checked) and no value is set. When @editMissingOptionalBookmarks="1" (default), optional databoxes with no value will be presented to the operator for review before the email or letter is considered complete. If @process="0" and ContactView is configured, the bookmark will be passed to the CRM for processing. When @editMissingOptionalBookmarks="0", all optional databoxes with no value will be ignored.
  • @log Provides the ability to create task history against a caller which can be accessed via Contact Centre (only). 1 = create task history, 0 = no history required (or Contact Centre not installed).
  • @forceSendEmail Controls the behaviour of the 'Process Tasks' screen where Tasks are utilised following an enquiry. If set to '1', the advisor may not proceed until any incomplete bookmarks are resolved and the email is sent.
  • RemoveUnusedBookmarks When a template is merged with data captured during a General Enquiry script, some orphaned Bookmarks (or Merge Fields) may remain in the letter or email body, preventing it from being printed correctly. By setting a CSV list of Bookmarks (or Merge Fields), will instruct the template merge process to search for and remove orphaned bookmarks matching the list of values. This list should be empty if the @showUnprocessedMergeFields attribute is set at 1.
  • XSLfile A UNC path to the server folder/file location of the XSL transformation file used to list tasks to process on tasks process screen.
• WelcomeMessage

This contains the HTML code for the message to be displayed to users on layer 1 (Q & A) of main frame at beginning.If this value begins with "FILE:" the remaining text is treated as a file path and is appended to the value in this node, then the contents of the file is returned.

• CompleteMessage

This contains the HTML code for the message to be displayed to users on layer 1 (Q & A) of main frame at script completion. The application should close at script completion, but time lags from host HMS / CRM may cause delay, therefore the message should describe the application status to the user.

• Policy
  • Folder The sub folder path (from the virtual root) which holds files defined in help links. If a help button is defined in messages, and the filename only is specified, it is assumed it will be in this folder.
  • Default The file to display in the policy layer at launch. This value is only used if the default policy file is not supplied in the database field "inf_QAset.policy" for the current script set. Note: to view examples of Policy 'skins', click here.

Images

<Images format="SWF" adminFormat="GIF">
 <Admin>
   <Hotspot>C:\Inetpub\wwwroot\keyfax32\images\new_cats</Hotspot>
   <Related>C:\Inetpub\wwwroot\keyfax32\images\related</Related>
 </Admin>
 <Client>
   <Hotspot>images/new_cats</Hotspot>
   <Related>images/related</Related>
 </Client>
</Images>

• Images
  • @format
    The format of the related images to be used in the Images layer. The images defined in the "jf_diagrams.Metafile" database field (the database defined extension will be replaced at runtime). If the format is "SWF" the images will be loaded from the "images/related/swf/" folder. If the format is "PNG", "GIF" or "JPG" the images will be loaded from the "images/related/" folder.
  • @adminFormat
    The format of the related images as used in the administration console.
  • Admin
    • Hotspot
      The physical path to a folder where the runtime hotspot images are located (or local copies if Keyfax is hosted remotely).
    • Related
      The physical path to a folder where the runtime related images are located (or local copies if Keyfax is hosted remotely).
  • Client
    • Hotspot
      Relative path to Keyfax32 folder where runtime hotspot images are located (see Admin Hotspot).
    • Related
      Relative path to Keyfax32 folder where runtime related images are located (see Admin/Related). Note: If the format="SWF" it is necessary for a sub-folder named 'SWF' to be located under this folder, containing the related images in SWF format.

Exchange

The configuration/Scripting/FL/Exchange section of the Keyfax KF_config.xml file contains settings for exchanging General Enquiry information with host HMS or CRM applications.

<Exchange>
 <SubActionValue default="Not found" />
 <ScriptPath type="2" />
 <AdvicePlainText html="0" prefix="MSG:" />
 <XSLTransformation process="0">
   <XSLfile>\\webprod1\prodsites\Keyfax32\xsl\bcc_poc1.xsl</XSLfile>
 </XSLTransformation>
 <AddNamespace process="0">
   <XSLfile>\\webprod1\prodsites\Keyfax32\xsl\namespace_ng1.xsl</XSLfile>
 </AddNamespace>
 <WebService process="0" asyncTimeout="5">
   <APIurl>http://www.uk.touch-base.com/kf31ws/Startup/RequestKeyfax</APIurl>
   <SOAPAction>http://www.uk.touch-base.com/kf31ws/Startup</SOAPAction>
   <SOAPenvelope bodyNode="[EXPORT_XML]">\\webprod1\prodsites\Keyfax32\xml\NG_soap_envelope.xml</SOAPenvelope>
 </WebService>
</Exchange>

Explanations of these settings as follows:

• Exchange
  • SubActionValue
    • @type If Sub Actions return without finding data from look-ups or operator inputs, this text will be returned in its place. This is often defaulted to "Not found" as above.
      If "void" then return element without any text.
      To specify an HTML string, this must be encoded, e.g. "<font color='#686868' size='1'>Question not applicable</font>".
      Note: this is distinct from the occasional appearance of "" during merge processes; this is associated with Add-in-data [AID] codes (FL only) and reflects situations where the database look-up has failed to return the requested data.
  • ScriptPath
    • @type The format for returning script path, numeric value 0-2:
      0. All Q & A returned in a multi delimited single XML element.
      1.Each Q & A in individual elements, one for each question.
      2.Each Q in individual elements with additional elements for each A.
      Note: If using in conjunction with MIS-AMS SQLActiveH products, and the MISexchange.XML file has been configured to receive the ScriptPath (MapOut[@saveScriptPath="True"]), ensure that this is set at '1'.
  • AdvicePlainText
    • @html If advice is to be returned in HTML or "plain text" format, 1 = HTML format, 0 = "plain text".
    • @prefix If @html = 1, the prefix value for returned message text.
  • InformHost - Removed as settings now held in client registry
    • HostApp***
      If the host application is to call (does not poll or receive callbacks), enter the path to the application here.
    • StatusCodes
      The host application will be called when the status codes are found in this list.
      Note: This should be a comma delimited list of status codes.

•XSLTransformation •@process

If export XML needs further modification before being returned to host HMS or CRM set to 1.

•XSLfile

The path to a XSL file which modifies the content.

•AddNamespace •@process

If export XML needs specific namespace(s) added before being returned to host HMS or CRM set to 1.

•XSLfile

The path to a XSL file which adds namespace(s) to the content.

•WebService •@process

If export XML needs needs sending to host HMS or CRM web-service, set to 1.

•@asyncTimeout

The asynchronous timeout for the host HMS or CRM web-service API call (in seconds).

•APIurl

The URL where the host HMS or CRM web-service SOAP envelope is to be sent.

•SOAPAction

The name of the host HMS or CRM web-service API call.

•SOAPenvelope

An XML template defining a SOAP envelope for the host HMS or CRM web-service API call.

•@bodyNode

The bookmark within the SOAPenvelope template in which to place export XML data.

Templates

Repairs

Images

Asset

Exchange

History

Templates

Contact•View

Paths

Client/Company

Database Connections

Email

Data•View

Debug Settings

Client

===Server===