Source ERP · 105 of 105

CRMPro → Salesforce — Xero: what the shipped templates set up

Read it in the terminal with "dlake skills show dlake-crmpro-salesforce/erps/xero". It extends the dlake-crmpro-salesforce skill, which holds what is true whatever the source ERP.

CRMPro → Salesforce — Xero: what the shipped templates set up

Keep this skill current. dlake ships updates often and this text is embedded in the CLI you have installed. Before relying on it, compare dlake --version with npm view @commercient/dlake version; if they differ, run npm install -g @commercient/dlake@latest and then dlake skills install, which overwrites the installed skill files with the current text.

dlake-crmpro is the parent skill and the authority for everything general: the crmpro_* tools, CRM_Configuration and CRM_FieldList, TimeStampRepository, the three kinds of source view, the NULL-cursor rule and the silent zero-record run. Read it first; this page does not repeat it. dlake-crmpro-salesforce is the destination skill this page is a child of, and the authority for the Salesforce conventions that hold across every ERP: read it first, then come back here for what this source’s own templates set. This page is dlake-crmpro-salesforce/erps/xero.md, and that skill’s ERP table is what points at it. What follows is only what the shipped Xero → Salesforce templates themselves set, read from their Insert_Query, CreateViewQuery and MappingJson. This page grows as the catalogue does.

1. What the templates deliver

GroupBusiness outcomeObjectsSource tables and views
Get Salesforce UserThe templates push User to Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted.User
DOCUMENT SYNC - XERO INVOICESERP INVOICES, INVOICESATTACHMENTS data becomes ContentDocument in Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted.ContentDocumentSF_ERP_Salesforce_Clone_Invoices, SF_ERP_Salesforce_Clone_InvoicesAttachments
XERO Credit NotesERP CONTACT, CREDITNOTES, CREDITNOTESCONTACT data becomes CommercientSF15__InvoicesCreditNotes__c in Salesforce. New records are created, existing ones updated, and records removed in the ERP are deleted.CommercientSF15__InvoicesCreditNotes__cSF_ERP_Salesforce_Clone_CreditNotes, SF_ERP_Salesforce_Clone_CreditNotesPayments, SF_ERP_Salesforce_Clone_CreditNotesContact, SF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_InvoicesCreditNotes
AccountIn addition to creating the Account record from your ERP customer records, Commercient syncs over the entire Accounting AR Customer record into a Commercient AR Customer object which is a Managed Custom Object (MCO). A lookup field is provided to lookup to the default AR Customer record MCO from the Account record. New records are created, existing ones updated, and records removed in the ERP are deleted.Account, Contact, CommercientSF15__XERO_CONTACT__cSF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_ContactAddresses, SF_ERP_Salesforce_Clone_ContactPhones, SF_ERP_Salesforce_Clone_ContactSalesTrackingCategories, SF_ERP_Salesforce_Clone_ContactAccountsPayable, SF_ERP_Salesforce_Clone_ContactAccountsReceivable
Customer Multi Ship AddressesIf you are using multiple ship to addresses for a given AR Customer in your ERP system then you will be able to see all the addresses inside the CRM Account screen in a Commercient Multi Ship To Address MCO related list. New records are created, existing ones updated, and records removed in the ERP are deleted.CommercientSF15__XERO_ADDRESS__cSF_ERP_Salesforce_Clone_ContactAddresses, SF_ERP_Salesforce_Clone_Contact
InvoiceBoth Open and Historical invoices are synchronized. Open invoice changes, such as a balance change, or a terms change are reflected in the CRM as they sync based on the frequency of the sync you have chosen (e.g. every hour for example). New records are created, existing ones updated, and records removed in the ERP are deleted.CommercientSF15__XERO_INVOICE__c, CommercientSF15__XERO_LINEITEM__c, CommercientSF15__XERO_PAYMENT__c, CommercientSF15__InvoicesCreditNotes__cSF_ERP_Salesforce_Clone_Invoices, SF_ERP_Salesforce_Clone_InvoicesContact, SF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_InvoicesLineItems, SF_ERP_Salesforce_Clone_InvoicesPayments, SF_ERP_Salesforce_Clone_Payments

2. The process rows the templates create

Each template’s Insert_Query writes one CRM_Configuration row. These are the values it sets; a column the inserts never set is not listed.

Display nameCRM_Object_API_NameCRM_PK_API_NameSync_OrderTimeStamp_PrefixSQL_Query targetfield prefix / postfixSync_Operation_Type
Get Salesforce UserUserCommercientSF6__SalespersonCode__c0vw_XERO_GetUser1=0'' / ''1
AccountAccountCommercientSF__Commercient_ArCustomerCode__c1vw_XERO_Accountvw_XERO_Account'' / ''1
XERO CustomerCommercientSF15__XERO_CONTACT__cCommercientSF15__ExternalKey__c2vw_XERO_Customervw_XERO_CustomerCommercientSF15__ / __c1
XERO CustomerToAccountLookupAccountCommercientSF__Commercient_ArCustomerCode__c3vw_XERO_CustomerToAccountLookupvw_XERO_CustomerToAccountLookup'' / ''1
XERO AddressCommercientSF15__XERO_ADDRESS__cCommercientSF15__ExternalKey__c4vw_XERO_Addressvw_XERO_AddressCommercientSF15__ / __c1
XERO InvoiceCommercientSF15__XERO_INVOICE__cCommercientSF15__ExternalKey__c5vw_XERO_Invoicevw_XERO_InvoiceCommercientSF15__ / __c1
XERO InvoiceLineItemCommercientSF15__XERO_LINEITEM__cCommercientSF15__ExternalKey__c6vw_XERO_InvoiceLineItemvw_XERO_InvoiceLineItemCommercientSF15__ / __c1
XERO InvoicePaymentCommercientSF15__XERO_PAYMENT__cCommercientSF15__ExternalKey__c7vw_XERO_InvoicePaymentvw_XERO_InvoicePaymentCommercientSF15__ / __c1
DOCUMENT SYNC - XERO INVOICESContentDocument8vw_XERO_InvoiceUploadvw_XERO_InvoiceUpload'' / ''5
ContactContactExternalKey__c10vw_XERO_Contactvw_XERO_Contact'' / ''1
XERO Invoice Credit NotesCommercientSF15__InvoicesCreditNotes__cCommercientSF15__ExternalKey__c11vw_XERO_InvoiceCreditNotesvw_XERO_InvoiceCreditNotesCommercientSF15__ / __c1
XERO Credit NotesCommercientSF15__InvoicesCreditNotes__cCommercientSF15__ExternalKey__c12vw_XERO_CreditNotesvw_XERO_CreditNotesCommercientSF15__ / __c1

Every one of these inserts Is_Active as 0, so an imported process is inactive until an operator activates it. Across the set they insert Is_Create_Entity 0, Is_Create_Fields 0, Is_Active_Get_Records 0, Is_Active_Delete_Records 0, IsAccountMatching False, Sync_Batch_Size 200. Text columns a template does not use are inserted as '' rather than left NULL. Get_SOQL_Query carries a query on Get Salesforce User, DOCUMENT SYNC - XERO INVOICES, Account, Contact — those rows read records back from Salesforce as well as pushing.

3. The views

Each template creates its view with CreateViewQuery, in the gateway dbo schema. “Change detection” names which of the three kinds dlake-crmpro defines the view’s own WHERE makes it; where a view’s shape is not one of those three the column is left empty and the view’s own WHERE is the authority.

ViewChange detectionRepository keyReads other prefixesIdentity columnSource tables
vw_XERO_Accountinsert + updatevw_XERO_Account:vw_XERO_GetUser:SF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_ContactAddresses, SF_ERP_Salesforce_Clone_ContactPhones, SF_ERP_Salesforce_Clone_ContactSalesTrackingCategories
vw_XERO_Customerinsert + updatevw_XERO_Customer:vw_XERO_Account:ExternalKeySF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_ContactAccountsPayable, SF_ERP_Salesforce_Clone_ContactAccountsReceivable
vw_XERO_CustomerToAccountLookupinsert + updatevw_XERO_CustomerToAccountLookup:vw_XERO_Customer:, vw_XERO_Account:SF_ERP_Salesforce_Clone_Contact
vw_XERO_Addressinsert + updatevw_XERO_Address:vw_XERO_Account:, vw_XERO_Customer:ExternalKeySF_ERP_Salesforce_Clone_ContactAddresses, SF_ERP_Salesforce_Clone_Contact
vw_XERO_Invoiceinsert + updatevw_XERO_Invoice:vw_XERO_Account:, vw_XERO_Customer:ExternalKeySF_ERP_Salesforce_Clone_Invoices, SF_ERP_Salesforce_Clone_InvoicesContact, SF_ERP_Salesforce_Clone_Contact
vw_XERO_InvoiceLineIteminsert + updatevw_XERO_InvoiceLineItem:vw_XERO_Invoice:ExternalKeySF_ERP_Salesforce_Clone_InvoicesLineItems, SF_ERP_Salesforce_Clone_Invoices
vw_XERO_InvoicePaymentinsert + updatevw_XERO_InvoicePayment:vw_XERO_Customer:, vw_XERO_Invoice:ExternalKeySF_ERP_Salesforce_Clone_InvoicesPayments, SF_ERP_Salesforce_Clone_Payments, SF_ERP_Salesforce_Clone_InvoicesContact, SF_ERP_Salesforce_Clone_Contact
vw_XERO_InvoiceUploadinsert + updatevw_XERO_InvoiceUpload:vw_XERO_Invoice:, LTD:ExternalKeySF_ERP_Salesforce_Clone_Invoices, SF_ERP_Salesforce_Clone_InvoicesAttachments
vw_XERO_Contactinsert + updatevw_XERO_Contact:vw_XERO_Account:SF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_ContactPhones, SF_ERP_Salesforce_Clone_ContactAddresses
vw_XERO_InvoiceCreditNotesinsert + updatevw_XERO_InvoiceCreditNotes:vw_XERO_Account:, vw_XERO_Customer:, vw_XERO_Invoice:ExternalKeySF_ERP_Salesforce_Clone_InvoicesCreditNotes, SF_ERP_Salesforce_Clone_Invoices, SF_ERP_Salesforce_Clone_InvoicesContact, SF_ERP_Salesforce_Clone_Contact
vw_XERO_CreditNotesinsert + updatevw_XERO_CreditNotes:vw_XERO_Account:, vw_XERO_Customer:ExternalKeySF_ERP_Salesforce_Clone_CreditNotes, SF_ERP_Salesforce_Clone_CreditNotesPayments, SF_ERP_Salesforce_Clone_CreditNotesContact, SF_ERP_Salesforce_Clone_Contact, SF_ERP_Salesforce_Clone_InvoicesCreditNotes

The repository key these templates build is <TimeStamp_Prefix>:<key>. The literal in the view and the TimeStamp_Prefix on the configuration row have to be the same string, case included.

4. Order of work

The templates set Sync_Order from 0 to 12. A run processes active rows in ascending Sync_Order, which is the order the templates put them in:

  • 0 — Get Salesforce User
  • 1 — Account
  • 2 — XERO Customer
  • 3 — XERO CustomerToAccountLookup
  • 4 — XERO Address
  • 5 — XERO Invoice
  • 6 — XERO InvoiceLineItem
  • 7 — XERO InvoicePayment
  • 8 — DOCUMENT SYNC - XERO INVOICES
  • 10 — Contact
  • 11 — XERO Invoice Credit Notes
  • 12 — XERO Credit Notes

These views read another process’s repository prefix, which is what makes the order a dependency order: the row appears in the view only once the process that writes that prefix has run, so a parent flows on one run and its children on the next.

  • vw_XERO_InvoiceUpload reads vw_XERO_Invoice:, LTD:; no template in this set writes LTD:
  • vw_XERO_CreditNotes reads vw_XERO_Account:, vw_XERO_Customer:
  • vw_XERO_Account reads vw_XERO_GetUser:
  • vw_XERO_CustomerToAccountLookup reads vw_XERO_Customer:, vw_XERO_Account:
  • vw_XERO_Contact reads vw_XERO_Account:
  • vw_XERO_Customer reads vw_XERO_Account:
  • vw_XERO_Address reads vw_XERO_Account:, vw_XERO_Customer:
  • vw_XERO_Invoice reads vw_XERO_Account:, vw_XERO_Customer:
  • vw_XERO_InvoiceLineItem reads vw_XERO_Invoice:
  • vw_XERO_InvoicePayment reads vw_XERO_Customer:, vw_XERO_Invoice:
  • vw_XERO_InvoiceCreditNotes reads vw_XERO_Account:, vw_XERO_Customer:, vw_XERO_Invoice:

5. Field mapping

CRM_FieldList carries one row per pushed column, with Object_Name equal to the CRM_Object_API_Name value — as dlake-crmpro puts it, an object with no CRM_FieldList rows pushes nothing and records no error. Each template carries its intended mapping in MappingJson. Read that with dlake admin crmpro_templates, then check crmpro_field_mapping on the created process before activating it.

TemplateObjectMapped fieldsFirst ERP → Salesforce pairs
AccountAccount13CommercientSFommercient_ArCustomerCodeCommercientSF__Commercient_ArCustomerCode__c, PhonePhone, BillingStreetBillingStreet, BillingCityBillingCity, BillingStateCodeBillingStateCode
XERO CustomerCommercientSF15__XERO_CONTACT__c24AccountAccount, AccountNumberAccountNumber, AccountsPayableTaxTypeAccountsPayableTaxType, AccountsReceivableTaxTypeAccountsReceivableTaxType, ApBalanceOutstandingApBalanceOutstanding
XERO CustomerToAccountLookupAccount2CommercientSFommercient_ArCustomerCodeCommercientSF__Commercient_ArCustomerCode__c, CommercientSF15__XERO_ContactCommercientSF15__XERO_Contact__c
XERO AddressCommercientSF15__XERO_ADDRESS__c14AccountAccount, XERO_ContactXERO_Contact__c, AddressLine1CommercientSF15__AddressLine1__c, AddressLine2CommercientSF15__AddressLine2__c, AddressLine3CommercientSF15__AddressLine3__c
XERO InvoiceCommercientSF15__XERO_INVOICE__c25AccountAccount, XERO_ContactXERO_Contact, AmountCreditedAmountCredited, AmountDueCommercientSF15__AmountDue__c, AmountPaidCommercientSF15__AmountPaid__c
XERO InvoiceLineItemCommercientSF15__XERO_LINEITEM__c13XERO_InvoiceXERO_Invoice, AccountCodeAccountCode, DescriptionDescription, DiscountRateDiscountRate, InvIdCommercientSF15__InvId__c
XERO InvoicePaymentCommercientSF15__XERO_PAYMENT__c13XERO_ContactXERO_Contact, Invoice1Invoice1, AmountCommercientSF15__Amount__c, BankAmountCommercientSF15__BankAmount__c, CurrencyRateCurrencyRate
DOCUMENT SYNC - XERO INVOICESContentDocument6IDID, FileDisplayNameFileDisplayName, BodyBody, DescriptionDescription, ParentIDParentID
ContactContact12FirstNameFirstName, LastNameLastName, AccountIDAccountID, EmailEmail, PhonePhone
XERO Invoice Credit NotesCommercientSF15__InvoicesCreditNotes__c13AccountAccount, XERO_ContactXERO_Contact, XERO_InvoiceXERO_Invoice, CreditNoteIDCommercientSF15__CreditNoteID__c, CreditNoteNumberCommercientSF15__CreditNoteNumber__c
XERO Credit NotesCommercientSF15__InvoicesCreditNotes__c11AccountAccount, XERO_ContactXERO_Contact, CreditNoteIDCommercientSF15__CreditNoteID__c, CreditNoteNumberCommercientSF15__CreditNoteNumber__c, IDCommercientSF15__ID__c

6. Community templates

The catalogue carries 23 community templates for this pair. A community template is authored in a tenant rather than shipped with the product, and it imports the same way as any other. Its own names, notes, field mapping and SQL are tenant content, so what this section states is what the set amounts to: how many templates there are, what they default to doing, which destination objects they write and which groups they fall in. They are not part of the shipped set described above.

  • Templates: 23
  • Default operations: insert on 23, update on 23, delete on 23
  • Marked circular-sync: 1
  • Licence groups they span: 6
  • Destination objects: Account, CommercientSF15__InvoicesCreditNotes__c, CommercientSF15__XERO_ADDRESS__c, CommercientSF15__XERO_CONTACT__c, CommercientSF15__XERO_INVOICE__c, CommercientSF15__XERO_LINEITEM__c, CommercientSF15__XERO_PAYMENT__c, Contact, ContentDocument, User
  • Object display names: Account, Contact, DOCUMENT SYNC - XERO INVOICES, XERO Address, XERO Credit Notes, XERO Customer, XERO CustomerToAccountLookup, XERO Invoice, XERO Invoice Credit Notes, XERO InvoiceLineItem, XERO InvoicePayment, Get Salesforce User
  • Template groups: Account, Invoice, Customer Multi Ship Addresses

A community template is imported the way a shipped one is, and the same rules apply to what it creates: read the process it creates with crmpro_get_process, its mapping with crmpro_field_mapping, and the view it selects from, before activating it.

7. Verifying

# per-prefix counts; every synced record carries its destination id
dlake tool query --profile <tenant> --sql "SELECT LEFT([Key], CHARINDEX(':',[Key])-1) AS prefix, COUNT(*) n, COUNT(NULLIF(SFDCID,'')) withId FROM dbo.TimeStampRepository WHERE CHARINDEX(':',[Key])>0 GROUP BY LEFT([Key], CHARINDEX(':',[Key])-1)"

withId = n for every prefix is the success condition dlake-crmpro defines. The split is on the first colon, which is the prefix boundary whether the key separator is : or ::.

The prefixes these templates set:

  • vw_XERO_GetUser
  • vw_XERO_InvoiceUpload
  • vw_XERO_CreditNotes
  • vw_XERO_Account
  • vw_XERO_CustomerToAccountLookup
  • vw_XERO_Contact
  • vw_XERO_Customer
  • vw_XERO_Address
  • vw_XERO_Invoice
  • vw_XERO_InvoiceLineItem
  • vw_XERO_InvoicePayment
  • vw_XERO_InvoiceCreditNotes

8. Where this sits

dlake-crmpro is the general operating surface — the crmpro_* tools, the setup and transaction tables, field mapping, and the source-view contract that applies to every destination. This page adds what the shipped Xero → Salesforce templates set up. dlake-crmpro-salesforce is the destination skill this page sits under: its own text is the authority for the Salesforce conventions that hold across every ERP, and its ERP table lists this page alongside every sibling ERP page for this destination. For the extract leg that fills the clone tables, see dlake-normalsync; for the on-premises agent that runs it, dlake-syncagent; for the writeback leg, dlake-txdownloaderpro; for standing an integration up, dlake-integration-setup.