Difference between revisions of "Civica"

From Keyfax Wiki
Jump to: navigation, search
(Created page with "==Servitor== ===Example Export XML=== ===Example Import XML=== ==Contact Manager== ===Known issues===")
 
(Example Export XML)
Line 2: Line 2:
  
 
===Example Export XML===
 
===Example Export XML===
 +
 +
<?xml version="1.0" encoding="utf-8" ?>
 +
 
 +
<KeyfaxData>   
 +
<Call kfRepeat="1" name="Call{n}" type="{any of RD, FL or ROL}">   
 +
<Company>{as passed in startup xml}</Company>   
 +
<CategoryId>{internal category id}</CategoryId>   
 +
<CategoryText>{Keyfax category text}</CategoryText>   
 +
<TopicId>{internal topic id}</TopicId>   
 +
<TopicText>{Keyfax topic text}</TopicText>   
 +
<CallText>{recorded call description}</CallText>   
 +
<LogDate>{dd/MM/yyyy HH:mm:ss}</LogDate>   
 +
<UserCode>{Keyfax userCode}</UserCode>   
 +
<AssetID>{as passed in startup xml}</AssetID>   
 +
<Asset>{as passed in startup xml}</Asset>   
 +
<Tenancy>{as passed in startup xml}</Tenancy>   
 +
<TenantId>{as passed in startup xml}</TenantId>   
 +
<Tenant>{as passed in startup xml}</Tenant>   
 +
<ReasonCode>{as captured by Keyfax}</ReasonCode>   
 +
<ReasonText>{as captured by Keyfax}</ReasonText>   
 +
<Recharge>{0 = no recharge or 1 = recharge}</Recharge>   
 +
<RechargeCode>{as captured by Keyfax}</RechargeCode>   
 +
<RechargeCost>{total cost ex vat}</RechargeCost>   
 +
<ScheduleId>{Keyfax orderId}</ScheduleId>   
 +
<SiteVisit>{as captured by Keyfax}</SiteVisit>   
 +
<AdditionalInfo>{as captured by Keyfax}</AdditionalInfo>   
 +
<SpecialInstructions>{as captured by Keyfax}</SpecialInstructions>   
 +
<RepairCount>{serviceCount}</RepairCount>   
 +
<AdviceCount>{messageCount}</AdviceCount>   
 +
<ActionCount>{taskCount}</ActionCount>   
 +
<SubActionCount>{taskScriptCaptureCount}</SubActionCount>   
 +
<Repair name="Repair{n}">   
 +
<CompleteBy>{{dd/MM/yyyy HH:mm:ss}}</CompleteBy>   
 +
<ResponseDays>{response days}</ResponseDays>   
 +
<Priority>{priority code configurable in Keyfax}</Priority>   
 +
<PriorityId>{internal Keyfax priority id}</PriorityId>   
 +
<RepairCode>{SOR code configurable in Keyfax}</RepairCode>   
 +
<RepairCodeDesc>{short SOR description}</RepairCodeDesc>   
 +
<UnitOfMeasure>{unit of measure}</UnitOfMeasure>   
 +
<UnitOfMeasureQuantity>{quantity}</UnitOfMeasureQuantity>   
 +
<Contractor>{contractor code fixed for each SOR}</Contractor>   
 +
</Repair>   
 +
<Advice name="Advice{n}">   
 +
{details of messages presented to the caller}   
 +
</Advice>   
 +
<Action name="Action{n}" type="{Keyfax action type}">   
 +
{details of emails, letters etc. generated by the script}   
 +
</Action>   
 +
<SubAction name="SubAction{n}" owner="{action code using this information}" type="{Keyfax sub-action type}">   
 +
{details of specific information captured in the script}   
 +
</SubAction>   
 +
</Call>   
 +
<GUID>{as returned from Keyfax Startup}</GUID>   
 +
<Status>1</Status>   
 +
</KeyfaxData>
  
 
===Example Import XML===
 
===Example Import XML===

Revision as of 10:49, 2 October 2018

Servitor

Example Export XML

<?xml version="1.0" encoding="utf-8" ?>

<KeyfaxData> <Call kfRepeat="1" name="Call{n}" type="{any of RD, FL or ROL}"> <Company>{as passed in startup xml}</Company> <CategoryId>{internal category id}</CategoryId> <CategoryText>{Keyfax category text}</CategoryText> <TopicId>{internal topic id}</TopicId> <TopicText>{Keyfax topic text}</TopicText> <CallText>{recorded call description}</CallText> <LogDate>{dd/MM/yyyy HH:mm:ss}</LogDate> <UserCode>{Keyfax userCode}</UserCode> <AssetID>{as passed in startup xml}</AssetID> <Asset>{as passed in startup xml}</Asset> <Tenancy>{as passed in startup xml}</Tenancy> <TenantId>{as passed in startup xml}</TenantId> <Tenant>{as passed in startup xml}</Tenant> <ReasonCode>{as captured by Keyfax}</ReasonCode> <ReasonText>{as captured by Keyfax}</ReasonText> <Recharge>{0 = no recharge or 1 = recharge}</Recharge> <RechargeCode>{as captured by Keyfax}</RechargeCode> <RechargeCost>{total cost ex vat}</RechargeCost> <ScheduleId>{Keyfax orderId}</ScheduleId> <SiteVisit>{as captured by Keyfax}</SiteVisit> <AdditionalInfo>{as captured by Keyfax}</AdditionalInfo> <SpecialInstructions>{as captured by Keyfax}</SpecialInstructions> <RepairCount>{serviceCount}</RepairCount> <AdviceCount>{messageCount}</AdviceCount> <ActionCount>{taskCount}</ActionCount> <SubActionCount>{taskScriptCaptureCount}</SubActionCount> <Repair name="Repair{n}"> <CompleteBy>Template:Dd/MM/yyyy HH:mm:ss</CompleteBy> <ResponseDays>{response days}</ResponseDays> <Priority>{priority code configurable in Keyfax}</Priority> <PriorityId>{internal Keyfax priority id}</PriorityId> <RepairCode>{SOR code configurable in Keyfax}</RepairCode> <RepairCodeDesc>{short SOR description}</RepairCodeDesc> <UnitOfMeasure>{unit of measure}</UnitOfMeasure> <UnitOfMeasureQuantity>{quantity}</UnitOfMeasureQuantity> <Contractor>{contractor code fixed for each SOR}</Contractor> </Repair> <Advice name="Advice{n}"> {details of messages presented to the caller} </Advice> <Action name="Action{n}" type="{Keyfax action type}"> {details of emails, letters etc. generated by the script} </Action> <SubAction name="SubAction{n}" owner="{action code using this information}" type="{Keyfax sub-action type}"> {details of specific information captured in the script} </SubAction> </Call> <GUID>{as returned from Keyfax Startup}</GUID> <Status>1</Status> </KeyfaxData>

Example Import XML

Contact Manager

Known issues