This is an old revision of the document!


Introduction

This is a standalone application (Windows or Mac) using our Moneyworks component which is designed to periodically (or manually) connect to Magento and import transactions into Moneyworks. We call this process 'syncing', and it is controlled by the Sync menu items:

Entering the customisation code

Available from the Sync → Customisation code menu item. This code determines which options are available and must be entered first to enable the other menu items.

By default, the connector works on the basis that all customers and products have the same codes in Magento and in Moneyworks. However, it is also possible to allow customers to be automatically created in Moneyworks if they don't already exist. By default, the connector uses both name and code to determine if there's a match for either.

Setting up the sync parameters

Available from the Sync → Setup menu item. This consists of four tabs with settings for the Moneyworks connection and Magento connection parameters, and also some Moneyworks-specific options and advanced options to control the sync process.

Moneyworks connection

This tab controls how the Moneyworks Connector connects to Moneyworks:

The left hand side of the tab allows you to enter the parameters for the Moneyworks connection:

  • The connection type can be Local file, Gold client, or Datacentre client
  • The datafile location or filename must be entered (full path must be entered if a local file)
  • The location of the Moneyworks executable must be entered
  • Enter the document user name and password (even if blank) in all cases
  • The Gold client license key is only needed if connecting to a Gold server
  • The server IP address and port number are not needed for connecting to a local file
  • The DC user name and password should be entered (even if blank) if connecting to a Datacentre server, and the operating system of the Datacentre server must also be selected in this case

The right hand side of the tab allows you to send commands to Moneyworks (see the Moneyworks manual for details), and you can use the examples in the Input drop-down menu to check that the connection is setup correctly e.g. selecting evaluate expr=“documentpath” and then clicking on the Execute button should return the Moneyworks document name/path in the Output box (and nothing in the Errors box). Clicking on OK will save the current connection settings, and Cancel will discard any changes made.

Magento connection

This tab controls how the Moneyworks Connector connects to Magento:

  • Enter user name and password (API key) as supplied by the Magento site administrator
  • Enter the IP address or hostname of the Magento site
  • If a secure connection is required, check Use SSL

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.

Moneyworks settings

This tab allows you to customise how imported records appear in Moneyworks. When it is selected, the system attempts to read tax codes and shipping codes from the Moneyworks data file:

  • Highlight colour controls how the imported records are coloured in Moneyworks.
  • Base currency code should correspond to the base currency in the Moneyworks data file.
  • The default and shipping tax codes are applied to orders which have a non-zero tax amount in Magento, otherwise the tax code is set to blank.
  • If Use Moneyworks address for business customers is checked, then the mailing and delivery addresses are not passed across from Magento for customers which have a company name.
  • If required, you can define a mask for the order/invoice sequence numbers e.g. “W00000000” means that the first transaction will be assigned a sequence number of “W00000001”, and so on. If left blank, Moneyworks will assign the next sequence number automatically. Depending on the customisation code entered, the same facility is available for assigning new customer codes.
  • If set, the Shipping code is applied to all orders which have a non-zero shipping amount in Magento.

Note that most of these settings can be overridden by using a customised Moneyworks import map e.g. different tax codes can be assigned according to the transaction currency.

Other settings

This tab controls the sync process itself:

Edit this page