Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
moneyworks:magento_integration [2016/10/06 16:05] – [Moneyworks settings] Adrian Boonemoneyworks:magento_integration [2024/03/20 15:20] (current) – Fix broken link for component and typo Adrian Boone
Line 13: Line 13:
 =====Introduction===== =====Introduction=====
  
-This is a standalone application (Windows or Mac) using our [[:4d_moneyworks_component|Moneyworks component]] which is designed to periodically (or manually) connect to Magento and import transactions into Moneyworks. Transctions may be imported as sales orders, sales invoices or receipts, depending on the customisation code entered and/or the import map used.+This is a standalone application (Windows or Mac) using our [[:moneyworks:4d_moneyworks_component|Moneyworks component]] which is designed to periodically (or manually) connect to Magento and import transactions into Moneyworks. Transactions may be imported as sales orders, sales invoices or receipts, depending on the customisation code entered and/or the import map used.
  
 We call this process 'syncing', and it is controlled by the //Sync// menu items: We call this process 'syncing', and it is controlled by the //Sync// menu items:
Line 49: Line 49:
 {{ :moneyworks:connector_MW_connection_REST.png |}} {{ :moneyworks:connector_MW_connection_REST.png |}}
  
-By default, there is a single connection to the Magento database, but for some customisations of the Connector it is possible to have multiple Magento connections e.g. you may want to apply different rules and settings for different Magento stores and/or sync them to different Moneyworks data files. If this is the caseyou'll be able to switch connection settings using the drop-down list at the top right. Please contact us for more details if you're interested.+By default, there is a single connection to the Magento database, but it is now possible for a single instance of the Connector to have multiple connections e.g. you may want to apply different rules and settings for different Magento stores and/or sync them to different Moneyworks data files. Apart from the synchronisation intervalall other settings can be different for each connection: 
 +  * Switch connection settings using the drop-down list at the top right. 
 +  * Add a new one (which will duplicate the existing connection settings) using the //+// button to the left of the drop-down list 
 +  * Remove the last one using the //-// button to the right of the drop-down list - obviously, you can't delete Connection1!
  
 ====Moneyworks test==== ====Moneyworks test====
Line 73: Line 76:
 Click on the //Test// button to verify the connection. Clicking on //OK// will save the current connection settings, and //Cancel// will discard any changes made. Click on the //Test// button to verify the connection. Clicking on //OK// will save the current connection settings, and //Cancel// will discard any changes made.
  
-If your customisation allows multiple connections, you'll be able to select which stores are synced for each connection. Clicking the //Reload// button will reload the list of stores from Magento.+If you have multiple connections, you'll be able to select which stores are synced for each connection. Clicking the //Reload// button will reload the list of stores from Magento.
  
 ====Moneyworks settings==== ====Moneyworks settings====
Line 90: Line 93:
     * Depending on the customisation code entered, the same facility is available for assigning new customer codes.      * Depending on the customisation code entered, the same facility is available for assigning new customer codes. 
     * Note that there is a limit of 11 characters in Moneyworks for transaction and customer codes, so this determines the maximum length of the mask.     * Note that there is a limit of 11 characters in Moneyworks for transaction and customer codes, so this determines the maximum length of the mask.
-    * Note that the numeric part of the Magento ID must not be longer than the number of trailing zeroes in the mask, otherwise it won't fit into the space available. The Connector will attempt to append extra trailing zeroes up to the maximum length of the mask - if that fails, then it reverts back to the original Magento ID.+    * Note that the numeric part of the Magento ID must not be longer than the number of trailing zeroes in the mask, otherwise it won't fit into the space available. If it doesn't fit, the Connector will attempt to append extra trailing zeroes up to the maximum length of the mask - if that fails, then it reverts back to the original Magento ID.
   * If set, the //Shipping code// is applied to all orders which have a non-zero shipping amount in Magento. This will normally be shown as an extra line in the invoice.   * If set, the //Shipping code// is applied to all orders which have a non-zero shipping amount in Magento. This will normally be shown as an extra line in the invoice.
  
Line 121: Line 124:
   * Make sure that the base currency in Moneyworks has been set correctly.   * Make sure that the base currency in Moneyworks has been set correctly.
   * Make sure that the tax codes in Moneyworks have been setup correctly, with the same rates as in Magento.   * Make sure that the tax codes in Moneyworks have been setup correctly, with the same rates as in Magento.
 +
 +===== Upgrading the Connector =====
 +
 +  - Make sure that the Connector is not currently syncing (or about to sync) with Magento. One way to check this is to look at the timestamp of the latest log file (in the //Logs// folder) and compare that with the next scheduled time.
 +  - Exit the Connector
 +  - Make a backup copy of the //Database// folder (unless it is a major upgrade, in which case backup the entire Connector folder)
 +  - Copy over the updated application files as directed (usually only //MoneyworksConnector.4DC// and //MoneyworksConnector.4DIndy// to the //Database// folder)
 +  - If an import map has been updated, then copy it to the //Database/Resources// folder 
 +  - Restart the Connector - if prompted for a data file, browse to the *.4DD Connector data file (usually //MoneyworksConnector.4DD// in the //Database// folder)
 +  - Check the Connector settings and set appropriate values for any which have been newly added since the previous version
 +
 +It is possible to run multiple Connector instances on the same machine as long as:
 +  * They are installed in different folders
 +  * They connect to different Moneyworks data files
 +  * They don't try to sync at the same time - either set their scheduling to be different, use a REST connection for at least one of them, or install multiple instances of the Moneyworks client
  
 ===== Common errors ===== ===== Common errors =====
Back to top