Export Organisations from webCRM

This task will export organisations from webCRM, including the related main person, in webCRM Organisation XML format to a file.

Settings

webCRM Connection

Required
The connection to webCRM to use, see Connecting to WebCRM for information on how to manage connections.

Export Settings > Export Date

Required
When the 'Export Type' setting is set to 'Modified' or 'New', only records modified or created after this date will be downloaded. The date will update automatically each time the task runs.

Export Settings > Export Type

Required
Used to choose which records should be included in the download. The available options are:

  • All - All records will be downloaded, regardless of whether or not they have been updated since the task last ran.
  • Modified - Only records created or updated since the task last ran will be downloaded.
  • New - Only records created since the task last ran will be downloaded.

Export Settings > Where Clauses

Optional
Allows filters to be added to the export to limit the data returned. The Field Name needs to exist from the source table in webCRM e.g. Status on the Delivery table, this can be specified with or without the table name prepended.

Include Field Metadata

Required
Set to true to include names of custom fields in the output XML.

Main Person Settings > Export Main Person

Required
Set to true to include the details of the main person of the organisation in the output XML.

Main Person Settings > Filter Field

Required
The field from the Person table to use when searching for the main person, defaults to CheckMark7.

Main Person Settings > Filter Value

Required
The value in the Person table to use when searching for the main person, defaults to true.

Page Size

Required
Used to control the number of records that will be downloaded in each page from webCRM. Defaults to 25.

Output File

Required
The name of the file to save the downloaded records to.

Defaults to webcrm_export_organisations.xml.

Zynk Settings

See Common Task Settings

Example XML

A sample showing all available fields for an organisation, see webCRM Organisation XML for detailed information.

<?xml version="1.0" encoding="utf-8"?>
<Organisations
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Organisation ExactMatch="true">
    <Id>2</Id>
    <CreatedAt>2016-12-08T14:20:58+00:00</CreatedAt>
    <UpdatedAt>2018-03-14T11:54:13+00:00</UpdatedAt>
    <Address>i6
6-8 Charlotte Square</Address>
    <Alert />
    <ApprovalStatus>0</ApprovalStatus>
    <City>Newcastle</City>
    <Comment />
    <CompareName>ZYNKSOFTWARELIMITEDNEWCASTLEUPONTYNE</CompareName>
    <Country>GB</Country>
    <CreatedBy>webCRM System</CreatedBy>
    <DivisionName>Newcastle upon Tyne</DivisionName>
    <Domain />
    <ExtraCustom1 Name="VAT no.">12345</ExtraCustom1>
    <ExtraCustom2 Name="Accounting ID Number">12345</ExtraCustom2>
    <ExtraCustom3></ExtraCustom3>
    <ExtraCustom4></ExtraCustom4>
    <ExtraCustom5></ExtraCustom5>
    <ExtraCustom6></ExtraCustom6>
    <ExtraCustom7></ExtraCustom7>
    <ExtraCustom8></ExtraCustom8>
    <Fax />
    <Gps />
    <ImageFileExtension />
    <Industry>IT</Industry>
    <LastDisplayedAt>2018-03-14T11:53:51+00:00</LastDisplayedAt>
    <LastItemType>SupportCase</LastItemType>
    <LastItemUpdatedAt>2018-01-26T11:43:37+00:00</LastItemUpdatedAt>
    <MarketDataId />
    <Name>Zynk Software Limited</Name>
    <NoAds>true</NoAds>
    <History />
    <OutlookSync>0</OutlookSync>
    <OverlayUrl />
    <Owner>3</Owner>
    <Owner2>0</Owner2>
    <PostCode>NE1 4XF</PostCode>
    <ReportTemp>0</ReportTemp>
    <Sla>0</Sla>
    <State>Tyne and Wear</State>
    <Status>Prospect</Status>
    <Telephone>0191 820 1484</Telephone>
    <TelephoneSearch>-01918201484-</TelephoneSearch>
    <TerritoryId>1</TerritoryId>
    <Type>Customer</Type>
    <UpdatedBy>api2 Zynk</UpdatedBy>
    <VatCountry>test</VatCountry>
    <VatGroup>test</VatGroup>
    <VatNumber />
    <VatStatus />
    <VatVerifiedAt>0001-01-01T00:00:00+00:00</VatVerifiedAt>
    <Www>http://zynk.com</Www>
    <XDate1>01/01/0001 00:00:00</XDate1>
    <XDate2>01/01/0001 00:00:00</XDate2>
    <XInt1>0</XInt1>
    <XInt2>0</XInt2>
    <XInt3>0</XInt3>
    <XInt4>0</XInt4>
    <XInt5>0</XInt5>
    <XInt6>0</XInt6>
    <XInt7>0</XInt7>
    <XInt8>0</XInt8>
    <XMemo1></XMemo1>
    <XMemo2></XMemo2>
    <XText1></XText1>
    <XText2></XText2>
    <XText3></XText3>
    <XText4></XText4>
    <XText5></XText5>
    <XText6></XText6>
    <XText7></XText7>
    <XText8></XText8>
    <Plus1 Name="Test Date">20180130</Plus1>
    <Custom1 Name="Original Lead Source">Advertising</Custom1>
    <Custom2 Name="No of Employess">51 to 100</Custom2>
    <Custom3 Name="Test">A1D001</Custom3>
    <Custom4></Custom4>
    <Custom5></Custom5>
    <Custom6></Custom6>
    <Custom7></Custom7>
    <Custom8></Custom8>
    <Custom9></Custom9>
    <Custom10></Custom10>
    <Custom11></Custom11>
    <Custom12></Custom12>
    <Custom13></Custom13>
    <Custom14></Custom14>
    <Custom15></Custom15>
    <Memo>test memo</Memo>
  </Organisation>
</Organisations>