Entities

Form ID: (BC202000)

On this form, you specify the import and export settings for entities supported by the e-commerce connector. Additionally, you can configure filters to determine which data needs to be synchronized or excluded from the synchronization process. You can also use this form to define the rules for mapping MYOB Advanced fields to fields in the online store—for example, to map additional standard or custom fields or to override the default mapping.

Note: This form is available only if the Retail Commerce feature is enabled on the Enable/Disable Features (CS100000) form.

Form Toolbar

The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be shown as buttons on the form toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.

Command Description
Clear Sync Data Opens the Clear Sync Data dialog box, which you can use to delete all synchronization information for the selected entity.
Start Real-Time Sync

For the Export synchronization direction: Starts the real-time synchronization process and sets the Real-Time Export status to Running for the selected entity.

For the Import and Bidirectional synchronization direction: Opens the Start Real-Time Sync dialog box.

Stop Real-Time Sync Disables the real-time synchronization process and sets the Real-Time Export or Real-Time Import status, depending on the selected direction of the synchronization, to Stopped for the selected entity.
Table 1. Start Real-Time Sync Dialog Box
Element Description
Real-Time Webhook URL The URL that will be used to receive push notifications from the external system. By default, the URL of your instance is displayed, but you can change it if necessary.
The dialog box also contains the following buttons.
Continue Starts the real-time synchronization process, sets the Real-Time Import status to Running for the selected entity, and closes the dialog box.
Cancel Closes the dialog box without starting real-time synchronization.
Table 2. Clear Sync Data Dialog Box
Element Description
Entity Name The name of the entity for which synchronization data needs to be deleted. This name should be the same as the entity selected in the Summary area.
The dialog box also contains the following buttons.
Continue Deletes all synchronization information for the entity specified in the Entity Name box, and closes the dialog box.

This operation cannot be undone.

Cancel Closes the dialog box without deleting synchronization information.

Summary Area

In this area, you can select a particular entity for which you want to configure field mapping and filtering rules that are applied when data is imported to MYOB Advanced or exported to the external system. The elements also display the general settings for the selected entity.

Element
Connector The name of the e-commerce connector, which corresponds to the platform on which the online store has been deployed.
Store

The name of the online store.

By default, the system inserts the store for which the Default check box is selected on the BigCommerce Stores(BC201000) or Shopify Stores (BC201010) form, but you can select another store.

Entity

The name of the entity supported by the connector. The available options are the following, based on the entities for which the connector supports synchronization:

  • For BigCommerce: Customer Price Class, Customer, Customer, Sales Category, Stock Item, Non-Stock Item, Template Item, Base Sales Price, Price List, Product Image, Product Availability, Sales Order, Payment, Shipment, Refund
  • For Shopify: Customer, Customer Location, Stock Item, Non-Stock Item, Template Item, Product Image, Product Availability, Sales Order, Payment, Shipment, Refund
Active A read-only check box that indicates (if selected) that the entity has been activated (that is, selected for synchronization) on the BigCommerce Stores (BC201000) form or on the Shopify Stores (BC201010) form.
Sync Direction

The direction in which the entity should be synchronized, which can be one of the following:

  • Export: Data is exported from MYOB Advanced to the external system.
  • Import: Data is imported to MYOB Advanced from the external system.
  • Bidirectional: Data is synchronized between MYOB Advanced and the external system in both directions.

For the BigCommerce stores, the direction of the synchronization is inserted by the system and cannot be changed for the following entities:

  • Stock Item (predefined as Export)
  • Non-Stock Item (predefined as Export)
  • Template Item (predefined as Export)
  • Base Sales Price (predefined as Export)
  • Price List (predefined as Export)
  • Product Image (predefined as Export)
  • Product Availability (predefined as Export)
  • Payment (predefined as Import)
  • Shipment (predefined as Export)
  • Refund (predefined as Import)

For the Shopify stores, the direction of the synchronization is inserted by the system and cannot be changed for the following entities:

  • Stock Item (predefined as Export)
  • Non-Stock Item (predefined as Export)
  • Template Item (predefined as Export)
  • Product Image (predefined as Export)
  • Product Availability (predefined as Export)
  • Sales Order (predefined as Import)
  • Payment (predefined as Import)
  • Shipment (predefined as Export)
  • Refund (predefined as Import)
Primary System

The system that is used as the source of data during the synchronization of entities. If bidirectional synchronization is selected for the entity, the data of the primary system takes precedence if any conflicts arise during the synchronization.

The primary system can be either of the following:

  • ERP (that is, MYOB Advanced)
  • External System (that is, the external system)

The primary system is determined based on the direction of the synchronization as follows:

  • For Export, ERP is set to be the primary system and cannot be changed.
  • For Import, External System is set to be the primary system and cannot be changed.
  • For Bidirectional, you can select which system should be used as the primary system, based on your synchronization processes.
Max. Number of Failed Attempts

The maximum number of errors that are allowed during the import or export of data before the synchronization record is skipped (that is, excluded from further synchronization).

By default, the box contains 5, indicating that the system allows five failed attempts before excluding the synchronization record from further processing.

Real-Time Import

The status of real-time import for the entity. The system inserts the status, which is one of the following:

  • Stopped: Real-time synchronization is not started for the Import direction.
  • Running: Real-time synchronization is started for the Import direction.
  • Not Supported: Real-time synchronization is not supported for the Import direction.
Real-Time Export

The status of real-time export for the entity. The system inserts the status, which is one of the following:

  • Stopped: Real-time synchronization is not started for the Export direction.
  • Running: Real-time synchronization is started for the Export direction.
  • Not Supported: Real-time synchronization is not supported for the Export direction.
Real-Time Mode

The mode of the processing of the synchronization records, which can be either of the following:

  • Prepare: As soon as a push notification about a change to data is received, the corresponding synchronization record is placed in the processing queue.
  • Prepare & Process: As soon as a push notification about a change to data is received, the corresponding synchronization record is placed in the processing queue, and the data processing is immediately started for the synchronization record.

Import Mapping Tab

By using the table on this tab, you configure the mapping of standard or custom fields to be used in import processing. This tab is displayed only if the Import direction is supported for the selected entity. You can use the drag-and-drop functionality to arrange rows of the table in the needed order.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table 3. Table Columns
Column Description
Active A check box that indicates (if selected) that the import mapping rule is active.
ERP Object

The object in MYOB Advanced whose field is set to the value of the external field or to a calculated value on import.

The list of available options depends on the selected entity.

ERP Field

The field of the selected ERP object that is set to the value of the mapped external field or a to calculated value on import.

The list of fields available for selection depends on the selected ERP object.

External Object

The object in the external system whose field's value is assigned to the ERP field.

The list of available options depends on the selected entity and the e-commerce connector.

External Field / Value

The field of the external object whose value is assigned to the ERP field, or the expression to be executed on import to generate the value that is assigned to the ERP field.

The list of available options depends on the selected entity, the e-commerce connector, and the external object.

Import Filtering Tab

By using the table on this tab, you can set up the rules according to which data will be included in or excluded from the import processing. This tab is displayed only if the Import direction is supported for the selected entity. You can use the drag-and-drop functionality to arrange rows of the table in the needed order.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table 4. Table Columns
Column Description
Active A check box that indicates (if selected) that the condition is active and is used for filtering.
Opening Brackets The opening bracket or brackets for enclosing a logical expression. Brackets are used to designate the order of the operation within the rule. There can be up to five brackets (and up to five levels of nesting).
Field Name The name of the field in the external system to which the filter will be applied.

The list of available options depends on the selected entity.

Condition The logical operation to apply to the value of the selected field. The following options are available: Equals, Does Not Equal, Is Greater Than, Is Greater Than or Equal To, Is Less Than, Is Less Than or Equal To, Contains, Starts With, Ends With, Does Not Contain, Is Between, Is Empty, Is Not Empty, Is Null, and Is Not Null.
Value The primary value of the condition to be compared with the value of the selected field.
Value 2 The secondary value, if required by the selected condition. Most of the conditions require only one value, while Is Between requires two values.
Closing Brackets The closing bracket or brackets for enclosing a logical expression.
Operator The logical operator, And or Or, to be used to join logical expressions on different lines.

Export Mapping Tab

By using the table on this tab, you configure manual mapping of standard or custom fields to be used in export processing. This tab is displayed only if the Export direction is supported for the selected entity. You can use the drag-and-drop functionality to arrange rows of the table in the needed order.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table 5. Table Columns
Column Description
Active A check box that indicates (if selected) that the export mapping rule is active.
External Object

The object in the external system whose field is set to the value of the ERP field or to a calculated value on export.

The list of available options depends on the selected entity and the e-commerce connector.

External Field

The field of the selected external object that is set to the value of the ERP field or to a calculated value on export.

The list of available options depends on the selected entity, the e-commerce connector, and the external object.

ERP Object

The object in MYOB Advanced whose field's value is assigned to the external field on export.

The list of available options depends on the selected entity and the e-commerce connector.

ERP Field / Value

The field of the selected ERP object whose value is assigned to the external field on export, or the expression to be executed on export to generate the value that is assigned to the external field.

The list of available options depends on the selected entity and the ERP object.

Export Filtering Tab

By using the table on this tab, you can set up the rules according to which data will be included in or excluded from the export processing. This tab is displayed only if the Export direction is supported for the selected entity. You can use the drag-and-drop functionality to arrange rows of the table in the needed order.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Column Description
Active A check box that indicates (if selected) that the condition is active and is used for filtering.
Opening Brackets The opening bracket or brackets for enclosing a logical expression. Brackets are used to designate the order of the operation within the rule. There can be up to five brackets (and up to five levels of nesting).
Field Name The name of the field in MYOB Advanced to which the filter will be applied.

The list of available options depends on the selected entity.

Condition The logical operation to apply to the value of the chosen data field. The following options are available: Equals, Does Not Equal, Is Greater Than, Is Greater Than or Equal To, Is Less Than, Is Less Than or Equal To, Contains, Starts With, Ends With, Does Not Contain, Is Between, Is Empty, Is Not Empty, Is Null, and Is Not Null.
Value The primary value of the condition to be compared with the selected data field value.
Value 2 The secondary value, if required by the selected condition. Most of the conditions require only one value, while Is Between requires two values.
Closing Brackets The closing bracket or brackets for enclosing a logical expression.
Operator The logical operator, And or Or, to be used to join logical expressions on different lines.