Export Persons from webCRM

This task will export persons from webCRM in webCRM Person 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.

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_persons.xml.

Zynk Settings

See Common Task Settings

Example XML

A sample showing all available fields for a person, see webCRM Person XML for detailed information.

<?xml version="1.0" encoding="utf-8"?>
<Persons
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Person ExactMatch="true">
    <Id>4</Id>
    <CreatedAt>2018-08-06T17:18:57+01:00</CreatedAt>
    <UpdatedAt>2018-08-07T09:33:39+01:00</UpdatedAt>
    <BlockMassEmail>true</BlockMassEmail>
    <CampaignWrongPasswordCount>0</CampaignWrongPasswordCount>
    <CheckMark1>False</CheckMark1>
    <CheckMark2>False</CheckMark2>
    <CheckMark3>False</CheckMark3>
    <CheckMark4>False</CheckMark4>
    <CheckMark5>False</CheckMark5>
    <CheckMark6>False</CheckMark6>
    <CheckMark7 Name="Key Accounting System Contact">True</CheckMark7>
    <CheckMark8>False</CheckMark8>
    <CheckMark9>False</CheckMark9>
    <CheckMark10>False</CheckMark10>
    <Comment />
    <CreatedBy>James Shaw</CreatedBy>
    <DirectPhone>0191 820 1484</DirectPhone>
    <Email>[email protected]</Email>
    <EmailBounces>false</EmailBounces>
    <FirstName>Andrew</FirstName>
    <ImageFileExtension />
    <LastLoginDateTime>0001-01-01T00:00:00+00:00</LastLoginDateTime>
    <LastName>Snape</LastName>
    <LoginLog />
    <MarketDateId />
    <MemberGroupId>0</MemberGroupId>
    <MemberLanguageId>0</MemberLanguageId>
    <MemberNumber />
    <MemberStartDate>0001-01-01T00:00:00+00:00</MemberStartDate>
    <MemberStatusId>0</MemberStatusId>
    <MemberWrongPasswordCount>0</MemberWrongPasswordCount>
    <MiddleName />
    <MobilePhone />
    <Name>Andrew Snape</Name>
    <History />
    <OrganisationId>3</OrganisationId>
    <Salutation>Mr</Salutation>
    <Skype />
    <SortOrder>0</SortOrder>
    <Status>Active</Status>
    <SupportLanguageId>0</SupportLanguageId>
    <TelephoneSearch>-01918201484-</TelephoneSearch>
    <Title>Developer</Title>
    <UpdatedBy>James Shaw</UpdatedBy>
    <Plus1 Name="Start Date"></Plus1>
    <Custom1 Name="Role">4</Custom1>
    <Custom2></Custom2>
    <Custom3></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 />
  </Person>
</Persons>