Zynk Workflow Documentation

The term Organisations refers to company records in your webCRM system. In most cases Organisations are Prospects and Customers, but this term can also be used to refer to Partners, Resellers or Suppliers.

In the B2B version of webCRM you must have at least an Organisation record – Person records are optional. All other module data links to the Organisation records in your system.

You can organise your Organisation records into many different categories, for example by type, status, industry sector, territory, relationship to you, source and more. This enables you to understand the nature of your Contacts, manage ownership of the Data, and communicate effectively.

Tasks

Identifiers

The logic surrounding inserting/updating organisations works as follows:

  1. If an <Id>1</Id> is provided for the organisation, the exiting organisation with this id will be updated.
  2. If an <ExternalId>1</ExternalId> is provided for the organisation, and a match is found in Zynk’s truth table, the existing organisation will be updated.
  3. If a LookupField="ExtraCustom2"is provided for Zynk will search for a match based on the data in the XML, and if a match is found the existing organisation will be updated.
  4. If none of the above conditions are fulfilled a new organisation will be created.

Fields

@LookupField

Dependant
The field to use when searching webCRM for an existing record. Can optionally be prepended with the table name e.g. OrganisationExtraCustom2 or ExtraCustom2

Type Example XML
string ExtraCustom2 LookupField="ExtraCustom2"

@ExactMatch

Dependant
Used with @LookupField, if set to true and more than one result is found when searching for a match the record will be rejected. defaults to true.

Type Example XML
string true ExactMatch="true"

Id

Dependant
The webCRM internal database identifier of the record. If specified the record will be updated, otherwise Zynk will attempt to lookup the record or create a new one.

Type Example XML
int 1 <Id>1</Id>

ExternalId

Dependant
Allows you to specify an external identifier that is used for preventing duplicate records being created. If provided Zynk will store both the Id and ExternalId in the Truth database for future lookups.

Type Example XML
string JOE001 <ExternalId>JOE001</ExternalId>

CreatedAt

Read Only

Type Example XML
datetime 2018-02-27T14:16:54+00:00 <CreatedAt>2018-02-27T14:16:54+00:00</CreatedAt>

UpdatedAt

Read Only

Type Example XML
datetime 2018-02-27T14:20:25+00:00 <UpdatedAt>2018-02-27T14:20:25+00:00</UpdatedAt>

Address

Optional

Type Example XML
datetime Nelson House  
Fleming Business Centre `<Address>Nelson House  
Fleming Business Centre</Address>`    

Alert

Optional

Type Example XML
string Unverified account <Alert>Unverified account</Alert>

ApprovalStatus

Optional

Type Example XML
int 0 <ApprovalStatus>0</ApprovalStatus>

City

Optional

Type Example XML
string Newcastle <City>Newcastle</City>

Comment

Optional

Type Example XML
string Originally called Internetware Ltd. <Comment>Originally called Internetware Ltd.</Comment>

CompareName

Read Only

Type Example XML
string ZYNKSOFTWARELIMITED <CompareName>ZYNKSOFTWARELIMITED</CompareName>

Country

Optional

Type Example XML
string United Kingdom <Country>United Kingdom</Country>

CreatedBy

Read Only

Type Example XML
string api2 Zynk <CreatedBy>api2 Zynk</CreatedBy>

DivisionName

Optional

Type Example XML
string North <DivisionName>North</DivisionName>

Domain

Optional

Type Example XML
string zynk.com <Domain>zynk.com</Domain>

ExtraCustom1 - ExtraCustom8

Optional
There are up to eight extra custom fields available per organisation in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.

Type Example XML
string JOE001 <ExtraCustom2 Name="Accounting ID Number">JOE001</ExtraCustom2>

Fax

Optional

Type Example XML
string 0845 123 2920 <Fax>0845 123 2920</Fax>

Gps

Read Only

Type Example XML
string 54.9783, -1.6178 <Gps>54.9783, -1.6178</Gps>

Industry

Optional

Type Example XML
picklist IT <Industry>IT</Industry>

Values

Available values depend on your webCRM setup.

LastDisplayedAt

Read Only

Type Example XML
datetime 2018-03-06T16:39:46+00:00 <LastDisplayedAt>2018-03-06T16:39:46+00:00</LastDisplayedAt>

LastItemType

Optional

Type Example XML
string SupportCase <LastItemType>SupportCase</LastItemType>

Available Values

LastItemUpdatedAt

Read Only

Type Example XML
datetime 2018-01-26T11:43:37+00:00 LastItemUpdatedAt>2018-01-26T11:43:37+00:00</LastItemUpdatedAt>

Name

Optional

Type Example XML
string Zynk Software Limited <Name>Zynk Software Limited</Name>

NoAds

Optional

Type Example XML
bool false <NoAds>false</NoAds>

Available Values

History

Read Only

Type Example XML
string   <History />

PostCode

Optional

Type Example XML
string NE1 4XF <PostCode>NE1 4XF</PostCode>

State

Optional

Type Example XML
string Tyne and Wear <State>Tyne and Wear</State>

Status

Optional

Type Example XML
picklist Prospect <Status>Prospect</Status>

Values

Available values depend on your webCRM setup.

Telephone

Optional

Type Example XML
string 0191 303 7279 <Telephone>0191 303 7279</Telephone>

TelephoneSearch

Read Only

Type Example XML
string -01913037279- <TelephoneSearch>-01913037279-</TelephoneSearch>

Type

Optional

Type Example XML
picklist Customer <Type>Customer</Type>

Values

Available values depend on your webCRM setup.

UpdatedBy

Read Only

Type Example XML
string api2 Zynk <UpdatedBy>api2 Zynk</UpdatedBy>

Www

Read Only

Type Example XML
string http://zynk.com <Www>http://zynk.com</Www>

Plus1 - Plus20

Optional
There are up to 20 plus custom fields available per organisation in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.

Type Example XML
string 20180130 <Plus1 Name="Start Date">20180130</Plus1>

Custom1 - Custom15

Optional
There are up to 15 custom fields available per organisation in webCRM. If enabled at the task level, exports will attempt to include the label of the field as setup in the webCRM admin in the Name attribute.

Type Example XML
string Advertising <Custom1 Name="Original Lead Source">Advertising</Custom1>

Example XML

<?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 303 7279</Telephone>
    <TelephoneSearch>-01913037279-</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>

Back | Edit on Github