Source ERP · 16 of 24

CRMPro → Shopify — Sage 100 2017: what the shipped templates set up

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

CRMPro → Shopify — Sage 100 2017: 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-shopify is the destination skill this page is a child of, and the authority for the Shopify 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-shopify/erps/sage-100-2017.md, and that skill’s ERP table is what points at it. What follows is only what the shipped Sage 100 2017 → Shopify 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
createcustomerThe templates push CUSTOMER to Shopify.CUSTOMERSF_ERP_Salesforce_Clone_AR_CUSTOMER
createcustomeraddressThe templates push CUSTOMERADDRESS to Shopify.CUSTOMERADDRESSSF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_AR_CUSTOMER
createproductThe templates push PRODUCT to Shopify.PRODUCTSF_ERP_Salesforce_Clone_CI_ITEM
createorderThe templates push ORDER to Shopify.ORDERSF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
createordershippingaddressThe templates push ORDERSHIPPINGADDRESS to Shopify.ORDERSHIPPINGADDRESSSF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
createorderbillingaddressThe templates push ORDERBILLINGADDRESS to Shopify.ORDERBILLINGADDRESSSF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
createorderlineitemThe templates push ORDERLINEITEM to Shopify.ORDERLINEITEMSF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SALESORDERDETAIL, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryDetail, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
CUSTOMERThe templates push CUSTOMER to Shopify. Records are created once; they are not updated and none are deleted.CUSTOMERSF_ERP_Salesforce_Clone_AR_CUSTOMER
CUSTOMER ADDRESSThe templates push CUSTOMERADDRESS to Shopify. Records are created once; they are not updated and none are deleted.CUSTOMERADDRESSSF_ERP_Salesforce_Clone_AR_CUSTOMER
PRODUCTThe templates push PRODUCT to Shopify. Records are created once; they are not updated and none are deleted.PRODUCTSF_ERP_Salesforce_Clone_CI_ITEM
PRODUCT UPDATEThe templates push PRODUCTQUANTITY, PRODUCTPRICE to Shopify. Existing records are updated only — nothing is created and nothing is deleted.PRODUCTQUANTITY, PRODUCTPRICESF_ERP_Salesforce_Clone_CI_ITEM, Shopify_ProductVariant, Shopify_InventoryLevel

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_NameSync_OrderTimeStamp_PrefixSQL_Query targetfield prefix / postfixSync_Operation_Type
createcustomerCUSTOMER1SHOPIFY_NEW_CUSTOMERvw_SHOPIFY_NEW_CUSTOMER'' / ''1
createcustomerCUSTOMER1SHOPIFY_NEW_CUSTOMERvw_SHOPIFY_NEW_CUSTOMER'' / ''
createproductPRODUCT1SHOPIFY_NEW_PRODUCTvw_SHOPIFY_NEW_PRODUCT'' / ''
updatequantityPRODUCTQUANTITY1PRODUCTQUANTITYShopify_ProductVariant_QuantyUpdate'' / ''
updatepricePRODUCTPRICE1PRODUCTPRICEShopify_ProductVariant_PriceUpdate'' / ''
createcustomeraddressCUSTOMERADDRESS2SHOPIFY_NEW_CUSTOMER_ADDRESSvw_SHOPIFY_NEW_CUSTOMER_ADDRESS'' / ''1
CUSTOMERADDRESSCUSTOMERADDRESS2SHOPIFY_NEW_CUSTOMER_ADDRESSvw_SHOPIFY_NEW_CUSTOMER_ADDRESS'' / ''
createproductPRODUCT3SHOPIFY_NEW_ITEMvw_SHOPIFY_NEW_ITEM'' / ''1
createorderORDER5SHOPIFY_NEW_ORDERvw_SHOPIFY_NEW_ORDER'' / ''1
createordershippingaddressORDERSHIPPINGADDRESS6SHOPIFY_NEW_ORDER_SHIPPING_ADDRESSvw_SHOPIFY_NEW_ORDER_SHIPPING_ADDRESS'' / ''1
createorderbillingaddressORDERBILLINGADDRESS7SHOPIFY_NEW_ORDER_BILLING_ADDRESSvw_SHOPIFY_NEW_ORDER_BILLING_ADDRESS'' / ''1
createorderlineitemORDERLINEITEM8SHOPIFY_NEW_ORDER_LINE_ITEMvw_SHOPIFY_NEW_ORDER_LINE_ITEM'' / ''1

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 '', Sync_Batch_Size 200. Text columns a template does not use are inserted as '' rather than left NULL. On createorderlineitem the SQL_Query names a view the same template’s CreateViewQuery does not create (vw_SHOPIFY_NEW_ORDER_LINE_ITEM against vw_SHOPIFY_NEW_ORDER_BILLING_ADDRESS), so check the view exists under the name the row selects from before activating it.

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_SHOPIFY_NEW_CUSTOMERinsert-onlySHOPIFY_NEW_CUSTOMER::RecordKeySF_ERP_Salesforce_Clone_AR_CUSTOMER
vw_SHOPIFY_NEW_CUSTOMERinsert-onlySHOPIFY_NEW_CUSTOMER::RecordKeySF_ERP_Salesforce_Clone_AR_CUSTOMER
vw_SHOPIFY_NEW_PRODUCTinsert-onlySHOPIFY_NEW_PRODUCT::RecordKeySF_ERP_Salesforce_Clone_CI_ITEM
Shopify_ProductVariant_QuantyUpdateRecordKeySF_ERP_Salesforce_Clone_CI_ITEM, Shopify_ProductVariant, Shopify_InventoryLevel
Shopify_ProductVariant_PriceUpdateRecordKeySF_ERP_Salesforce_Clone_CI_ITEM, Shopify_ProductVariant
vw_SHOPIFY_NEW_CUSTOMER_ADDRESSinsert-onlySHOPIFY_NEW_CUSTOMER_ADDRESS::SHOPIFY_NEW_CUSTOMER::RecordKeySF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_AR_CUSTOMER
vw_SHOPIFY_NEW_CUSTOMER_ADDRESSinsert-onlySHOPIFY_NEW_CUSTOMER_ADDRESS::SHOPIFY_NEW_CUSTOMER::RecordKeySF_ERP_Salesforce_Clone_AR_CUSTOMER
vw_SHOPIFY_NEW_ITEMinsert-onlySHOPIFY_NEW_ITEM::RecordKeySF_ERP_Salesforce_Clone_CI_ITEM
vw_SHOPIFY_NEW_ORDERinsert-onlySHOPIFY_NEW_ORDER::SHOPIFY_NEW_CUSTOMER::RecordKeySF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
vw_SHOPIFY_NEW_ORDER_SHIPPING_ADDRESSinsert-onlySHOPIFY_NEW_ORDER_SHIPPING_ADDRESS::SHOPIFY_NEW_ORDER::RecordKeySF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
vw_SHOPIFY_NEW_ORDER_BILLING_ADDRESSinsert-onlySHOPIFY_NEW_ORDER_BILLING_ADDRESS::SHOPIFY_NEW_ORDER::RecordKeySF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryHeader
vw_SHOPIFY_NEW_ORDER_BILLING_ADDRESSinsert-onlySHOPIFY_NEW_ORDER_LINE_ITEM::SHOPIFY_NEW_ORDER::, SHOPIFY_NEW_ORDER_BILLING_ADDRESS::, SHOPIFY_NEW_ITEM::, SHOPIFY_NEW_ITEM_VARIANT::RecordKeySF_ERP_Salesforce_Clone_SY_Country, SF_ERP_Salesforce_Clone_SO_SALESORDERHEADER, SF_ERP_Salesforce_Clone_AR_CUSTOMER, SF_ERP_Salesforce_Clone_SO_SALESORDERDETAIL, SF_ERP_Salesforce_Clone_SO_SalesOrderHistoryDetail

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 to 1, 2, 3, 5, 6, 7, 8. A run processes active rows in ascending Sync_Order, which is the order the templates put them in:

  • 1 — createcustomer, createproduct, updatequantity, updateprice
  • 2 — createcustomeraddress, CUSTOMERADDRESS
  • 3 — createproduct
  • 5 — createorder
  • 6 — createordershippingaddress
  • 7 — createorderbillingaddress
  • 8 — createorderlineitem

Several of these rows share a Sync_Order value: each template group carries its own numbering, so give the imported processes an order across the whole set rather than taking the template values as one.

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_SHOPIFY_NEW_CUSTOMER_ADDRESS reads SHOPIFY_NEW_CUSTOMER::
  • vw_SHOPIFY_NEW_ORDER reads SHOPIFY_NEW_CUSTOMER::
  • vw_SHOPIFY_NEW_ORDER_SHIPPING_ADDRESS reads SHOPIFY_NEW_ORDER::
  • vw_SHOPIFY_NEW_ORDER_BILLING_ADDRESS reads SHOPIFY_NEW_ORDER::
  • vw_SHOPIFY_NEW_ORDER_BILLING_ADDRESS reads SHOPIFY_NEW_ORDER::, SHOPIFY_NEW_ORDER_BILLING_ADDRESS::, SHOPIFY_NEW_ITEM::, SHOPIFY_NEW_ITEM_VARIANT::; no template in this set writes SHOPIFY_NEW_ITEM_VARIANT::
  • vw_SHOPIFY_NEW_CUSTOMER_ADDRESS reads SHOPIFY_NEW_CUSTOMER::

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 → Shopify pairs
createcustomerCUSTOMER11ARDIVISIONNO, CUSTOMERNORecordKey, ARDIVISIONNO, CUSTOMERNOdescription, ARDIVISIONNO, CUSTOMERNOerp_code, EMAILADDRESSEmail, CUSTOMERNAMEFirstName
createcustomerCUSTOMER10RecordKeyRecordKey, descriptiondescription, erp_codeerp_code, EmailEmail, FirstNameFirstName
createproductPRODUCT6ItemCodeDescTitle, ItemCodeDescBodyHtml, ItemCodeRecordKey, ItemCodeSKU, StandardUnitPricePrice
updatequantityPRODUCTQUANTITY4TotalQuantityOnHandInventoryQuantity, ProductVariantIdId, InventoryQuantityOldQuantity, LocationIdlocationId
updatepricePRODUCTPRICE2StandardUnitPricePrice, ProductVariantIdProductVariantId
createcustomeraddressCUSTOMERADDRESS12ADDRESSLINE1Address1, ADDRESSLINE2Address2, CITYCity, COUNTRYNAMECountry, COUNTRYCODECountryCode
CUSTOMERADDRESSCUSTOMERADDRESS18ARDivisionNo,CustomerNoRecordKey, ARDivisionNo,CustomerNodescription, ARDivisionNo,CustomerNoerp_code, AddressLine1Address1, AddressLine2Address2
createproductPRODUCT9ITEMCODERecordKey, ITEMCODEname, ITEMCODEDESCdescription, PRODUCTTYPEProductType, DATECREATEDPublishedAt
createorderORDER34SALESORDERNO, ARDIVISIONNORecordKey, SHIPEXPIREDATEClosedAt, ORDERDATECreatedAt, SALESORDERNOOrderNumber, ARDIVISIONNONumber
createordershippingaddressORDERSHIPPINGADDRESS13SHIPTOADDRESS1Address1, SHIPTOADDRESS2Address2, SHIPTOCITYCity, SHIPTOCOUNTRYCODECountry, SHIPTOCOUNTRYCODECountryCode
createorderbillingaddressORDERBILLINGADDRESS14BILLTOADDRESS1Address1, BILLTOADDRESS2Address2, BILLTOCITYCity, BILLTOCOUNTRYCODECountry, BILLTOCOUNTRYCODECountryCode
createorderlineitemORDERLINEITEM9UNITPRICEPrice, QUANTITYORDEREDQuantity, ITEMCODEName, ITEMCODETitle, SFDCIDProductId

6. 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:

  • SHOPIFY_NEW_CUSTOMER
  • SHOPIFY_NEW_CUSTOMER_ADDRESS
  • SHOPIFY_NEW_ITEM
  • SHOPIFY_NEW_ORDER
  • SHOPIFY_NEW_ORDER_SHIPPING_ADDRESS
  • SHOPIFY_NEW_ORDER_BILLING_ADDRESS
  • SHOPIFY_NEW_ORDER_LINE_ITEM
  • SHOPIFY_NEW_PRODUCT
  • PRODUCTQUANTITY
  • PRODUCTPRICE

7. 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 Sage 100 2017 → Shopify templates set up. dlake-crmpro-shopify is the destination skill this page sits under: its own text is the authority for the Shopify 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.