Civica APP (Flare)

Using the method of saving XML to disk it is possible to integrate data from your eDesigner form with the application Civica APP (hereafter known as Flare).

First read the article below:

Saving XML output

Next use the principles in there to achieve this.

So integration with Flare involves saving a file, in a format it expects, to a location which Flare looks for and imports automatically.

Data Mapping Template

Add the data mapping template as set out in the article above and, importantly, use this XML template below, which is tried and tested.

Flare basically has every possible scenario covered in its template XML, so technically you can use this for any service request. The only difference is that the elements like:

<Unit>

<Type>

Need to be set based upon the type. Note that these codes are held in Flare, so need to be taken from there, as they could be different from the values in these elements, which are purely examples

<ImportFile xmlns="http://www.flare.co.uk">
  <ImportRecord>
    <ImportControl>
      <Updtype>I</Updtype>
      <FlareDB>R</FlareDB>
      <Number/>
      <LAref/>
    </ImportControl>
    <ActivityRecord>
      <Activity>
        <OpenDate/>
        <ResponseDate/>
        <ClosedDate/>
        <Unit>BIN</Unit>
        <Type>CWA</Type>
        <InvOfficer>STR</InvOfficer>
        <Address>
          <FlareAddress>
            <HouseName/>
            <HouseNumber/>
            <Street/>
            <AddLine4/>
            <AddLine5/>
            <AddLine6/>
            <PostCode/>
            <UPRN/>
            <USRN/>
          </FlareAddress>
          <VerifyAddress>1</VerifyAddress>
          <PremPtr/>
          <Name/>
          <SearchName/>
          <LAref/>
          <Telephone/>
          <Fax/>
          <Mobile/>
          <Email/>
          <Website/>
          <Area/>
          <Ward/>
          <Easting/>
          <Northing/>
          <UserDefinedField/>
          <UserDefinedNameCode/>
        </Address>
        <ScheduledDate/>
        <Fee/>
        <CalculateFee/>
        <FeePaid/>
      </Activity>
      <RequestComp>
        <Comps>
          <TimeReceived/>
          <TimeResponded/>
          <Type/>
          <RecOfficer>WEB</RecOfficer>
          <OFTgoods/>
          <OFTtrading/>
          <Detail/>
          <Classification/>
          <Result/>
          <Cost>0.00</Cost>
          <TimeTaken>0:00</TimeTaken>
          <Charged>0.00</Charged>
          <HomeAuthority/>
          <Referred/>
          <ToDepartment/>
          <Cash>0.00</Cash>
          <CivilRedress>0.00</CivilRedress>
          <AllegedBreach>C</AllegedBreach>
          <TransactionType>P</TransactionType>
          <PurchaseMedium/>
          <TradeCountry/>
        </Comps>
        <Client>
          <HowReceived>W</HowReceived>
          <AccessTimes/>
          <VIPtype/>
          <VIPname/>
          <Date/>
          <NameAddress>
            <Data>
              <RecordID>0</RecordID>
              <FindBy>
                <LAref/>
                <NINo/>
                <PassportNo/>
              </FindBy>
              <NAUpdtype>V</NAUpdtype>
              <TypeCode/>
              <Address>
                <FlareAddress>
                  <HouseName/>
                  <HouseNumber/>
                  <Street/>
                  <AddLine4/>
                  <AddLine5/>
                  <AddLine6/>
                  <PostCode/>
                  <UPRN/>
                  <USRN/>
                </FlareAddress>
                <VerifyAddress>1</VerifyAddress>
                <PremPtr/>
                <Name/>
                <SearchName/>
                <LAref/>
                <Telephone/>
                <Fax/>
                <Mobile/>
                <Email/>
                <Website/>
                <Area/>
                <Ward/>
                <Easting/>
                <Northing/>
                <UserDefinedField/>
                <UserDefinedNameCode/>
              </Address>
              <SplitName>
                <Title/>
                <Forenames/>
                <Surname/>
                <Suffix/>
              </SplitName>
              <AlternativeNames>
                <anAlternativeName>
                  <SeqNo/>
                  <AlternativeName>
                    <SearchName/>
                    <SplitName>
                      <Title/>
                      <Forenames/>
                      <Surname/>
                      <Suffix/>
                    </SplitName>
                  </AlternativeName>
                </anAlternativeName>
              </AlternativeNames>
              <BirthDate/>
              <MaritalStatus/>
              <Gender/>
              <Ethnicity/>
              <PassportNo/>
              <NINo/>
              <PreferredContact/>
              <Desc1/>
              <Desc2/>
              <JobTitle/>
              <Organisation/>
              <PreferredTelephone/>
              <PreferredDaytime/>
              <Opened/>
              <Closed/>
              <Alarm/>
              <AlarmNote/>
              <Telephone2/>
              <Telephone3/>
              <VehicleReg/>
              <CloseReason/>
            </Data>
            <NamAddText>
              <UpdateMode>A</UpdateMode>
              <Text/>
            </NamAddText>
            <Attach>
              <SeqNumber>0</SeqNumber>
              <Attachment>
                <Package/>
                <Path/>
              </Attachment>
            </Attach>
          </NameAddress>
        </Client>
      </RequestComp>
      <ActivityText>
        <UpdateMode>A</UpdateMode>
        <Text/>
      </ActivityText>
      <UserDefinedWindow>
        <UDWString1/>
        <UDWString2/>
        <UDWString3/>
        <UDWString4/>
        <UDWString5/>
        <UDWString6/>
        <UDWString7/>
        <UDWString8/>
        <UDWString9/>
        <UDWString10/>
        <UDWString11/>
        <UDWString12/>
        <UDWcode1/>
        <UDWcode2/>
        <UDWcode3/>
        <UDWcode4/>
        <UDWcode5/>
        <UDWcode6/>
        <UDWcode7/>
        <UDWcode8/>
        <UDWcode9/>
        <UDWcode10/>
        <UDWcode11/>
        <UDWcode12/>
        <UDWdate1/>
        <UDWdate2/>
        <UDWdate3/>
        <UDWdate4/>
        <UDWdate5/>
        <UDWdate6/>
        <UDWdate7/>
        <UDWdate8/>
        <UDWdate9/>
        <UDWdate10/>
        <UDWdate11/>
        <UDWdate12/>
        <UDWnumber1/>
        <UDWnumber2/>
        <UDWnumber3/>
        <UDWnumber4/>
        <UDWnumber5/>
        <UDWnumber6/>
        <UDWnumber7/>
        <UDWnumber8/>
        <UDWnumber9/>
        <UDWnumber10/>
        <UDWnumber11/>
        <UDWnumber12/>
        <UDWmoney1>0.00</UDWmoney1>
        <UDWmoney2>0.00</UDWmoney2>
        <UDWmoney3>0.00</UDWmoney3>
        <UDWmoney4>0.00</UDWmoney4>
        <UDWmoney5>0.00</UDWmoney5>
        <UDWmoney6>0.00</UDWmoney6>
        <UDWmoney7>0.00</UDWmoney7>
        <UDWmoney8>0.00</UDWmoney8>
        <UDWmoney9>0.00</UDWmoney9>
        <UDWmoney10>0.00</UDWmoney10>
        <UDWmoney11>0.00</UDWmoney11>
        <UDWmoney12>0.00</UDWmoney12>
        <UDWflag1/>
        <UDWflag2/>
        <UDWflag3/>
        <UDWflag4/>
        <UDWflag5/>
        <UDWflag6/>
        <UDWflag7/>
        <UDWflag8/>
        <UDWflag9/>
        <UDWflag10/>
        <UDWflag11/>
        <UDWflag12/>
        <UDWreal1/>
        <UDWreal2/>
        <UDWreal3/>
        <UDWreal4/>
        <UDWreal5/>
        <UDWreal6/>
        <UDWreal7/>
        <UDWreal8/>
        <UDWreal9/>
        <UDWreal10/>
        <UDWreal11/>
        <UDWreal12/>
        <UDWcbxlist1>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist1>
        <UDWcbxlist2>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist2>
        <UDWcbxlist3>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist3>
        <UDWcbxlist4>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist4>
        <UDWcbxlist5>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist5>
        <UDWcbxlist6>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist6>
        <UDWcbxlist7>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist7>
        <UDWcbxlist8>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist8>
        <UDWcbxlist9>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist9>
        <UDWcbxlist10>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist10>
        <UDWcbxlist11>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist11>
        <UDWcbxlist12>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist12>
      </UserDefinedWindow>
      <UserDefinedTab>
        <UDWString1/>
        <UDWString2/>
        <UDWString3/>
        <UDWString4/>
        <UDWString5/>
        <UDWString6/>
        <UDWString7/>
        <UDWString8/>
        <UDWString9/>
        <UDWString10/>
        <UDWString11/>
        <UDWString12/>
        <UDWcode1/>
        <UDWcode2/>
        <UDWcode3/>
        <UDWcode4/>
        <UDWcode5/>
        <UDWcode6/>
        <UDWcode7/>
        <UDWcode8/>
        <UDWcode9/>
        <UDWcode10/>
        <UDWcode11/>
        <UDWcode12/>
        <UDWdate1/>
        <UDWdate2/>
        <UDWdate3/>
        <UDWdate4/>
        <UDWdate5/>
        <UDWdate6/>
        <UDWdate7/>
        <UDWdate8/>
        <UDWdate9/>
        <UDWdate10/>
        <UDWdate11/>
        <UDWdate12/>
        <UDWnumber1/>
        <UDWnumber2/>
        <UDWnumber3/>
        <UDWnumber4/>
        <UDWnumber5/>
        <UDWnumber6/>
        <UDWnumber7/>
        <UDWnumber8/>
        <UDWnumber9/>
        <UDWnumber10/>
        <UDWnumber11/>
        <UDWnumber12/>
        <UDWmoney1>0.00</UDWmoney1>
        <UDWmoney2>0.00</UDWmoney2>
        <UDWmoney3>0.00</UDWmoney3>
        <UDWmoney4>0.00</UDWmoney4>
        <UDWmoney5>0.00</UDWmoney5>
        <UDWmoney6>0.00</UDWmoney6>
        <UDWmoney7>0.00</UDWmoney7>
        <UDWmoney8>0.00</UDWmoney8>
        <UDWmoney9>0.00</UDWmoney9>
        <UDWmoney10>0.00</UDWmoney10>
        <UDWmoney11>0.00</UDWmoney11>
        <UDWmoney12>0.00</UDWmoney12>
        <UDWflag1/>
        <UDWflag2/>
        <UDWflag3/>
        <UDWflag4/>
        <UDWflag5/>
        <UDWflag6/>
        <UDWflag7/>
        <UDWflag8/>
        <UDWflag9/>
        <UDWflag10/>
        <UDWflag11/>
        <UDWflag12/>
        <UDWreal1/>
        <UDWreal2/>
        <UDWreal3/>
        <UDWreal4/>
        <UDWreal5/>
        <UDWreal6/>
        <UDWreal7/>
        <UDWreal8/>
        <UDWreal9/>
        <UDWreal10/>
        <UDWreal11/>
        <UDWreal12/>
        <UDWcbxlist1>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist1>
        <UDWcbxlist2>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist2>
        <UDWcbxlist3>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist3>
        <UDWcbxlist4>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist4>
        <UDWcbxlist5>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist5>
        <UDWcbxlist6>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist6>
        <UDWcbxlist7>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist7>
        <UDWcbxlist8>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist8>
        <UDWcbxlist9>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist9>
        <UDWcbxlist10>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist10>
        <UDWcbxlist11>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist11>
        <UDWcbxlist12>
          <aCbxList>
            <SeqNo>12</SeqNo>
            <CbxList>Y</CbxList>
          </aCbxList>
        </UDWcbxlist12>
      </UserDefinedTab>
      <Action>
        <Head>
          <Data>
            <AhAction/>
            <AhUnit/>
            <AhOfficer/>
            <AhOpenDate/>
            <AhClosedDate/>
            <AhUDcode1/>
            <AhUDcode2/>
            <AhCostCentre/>
          </Data>
          <ActionText>
            <UpdateMode>A</UpdateMode>
            <Text/>
          </ActionText>
        </Head>
        <Diary>
          <Data>
            <Ptr/>
            <AdActionDetail/>
            <AdOfficer/>
            <AdScheduled/>
            <AdActual/>
            <AdDescription/>
            <AdTimeUnits/>
            <AdLinkedAct>
              <DB/>
              <Number/>
            </AdLinkedAct>
            <AdAttachment>
              <Package/>
              <Path/>
            </AdAttachment>
            <AdDocNo/>
          </Data>
          <DiaryText>
            <UpdateMode>A</UpdateMode>
            <Text/>
          </DiaryText>
        </Diary>
      </Action>
    </ActivityRecord>
  </ImportRecord>
</ImportFile>

Once this is added it should appear similar to this:

Then, as shown in the Saving XML output article you need to map the answers from the various questions in the form to the template:

Having done that, add the Save Data Document action and provide details of where the file should be saved.

Clearly you should do this in Dev/Test first and its important to note that the above process needs to be done per environment to reflect differences in the template/file location to save to.

PreviousEnvironmental Health apps NexteMapper - generic integration

Last updated 3 years ago

Was this helpful?