Difference between revisions of "Configuration Settings"

Revision as of 11:10, 28 November 2018 (view source) Wikiadmin (talk | contribs) (→‎Enquiries) ← Older edit		Revision as of 11:10, 28 November 2018 (view source) Wikiadmin (talk | contribs) (→‎Enquiries) Newer edit →
Line 84:		Line 84:
	</WelcomeMessage>		</WelcomeMessage>
	<CompleteMessage>		<CompleteMessage>
−	<![CDATA[ <p><div class='mWelcomeTitle'>Script Completed</div></p>	+	<![CDATA[ <div class='mWelcomeTitle'>Script Completed</div>
	<p><div class='mTextBold'>Please use your host system to launch Keyfax.</div></p> ]]>		<p><div class='mTextBold'>Please use your host system to launch Keyfax.</div></p> ]]>
	</CompleteMessage>		</CompleteMessage>

---

Revision as of 11:10, 28 November 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><p />

</p> ]]>

 </WelcomeMessage>
 <CompleteMessage>

<![CDATA[

]]>

 </CompleteMessage>
 <Images><-- See Images section --></Images>
 <Policy>
   <Folder>policy</Folder>
   <Default>policy/default.htm</Default>
 </Policy>
 <Exchange><-- See Exchange section --></Exchange>
 <Templates></Templates>
</FL>

Images

Exchange

Templates

Repairs

Images

Asset

Exchange

History

Templates

Contact•View

Paths

Client/Company

Database Connections

Email

Data•View

Debug Settings

Client

Server