Once you've successfully installed the Magento 2 extension, you can begin configuration.
Before you begin, you should:
- generate an API key in your Ometria account, and;
- make sure you have your Ometria Site Identifier and Global Ometria Account key, which is provided by your technical project manager during onboarding.
General
Log into the Magento 2 admin panel and go to: Stores > Configuration > Ometria > Analytics or Marketing > Ometria > Configuration
Set the Enable field to 'Yes'.
This allows Ometria to collect data from your Magento 2 account:
Next, add your credentials and review the following fields:
|
Field |
Description |
|
Ometria Site Identifier (Account ID) |
Enter your Ometria Site Identifier, which your Ometria technical project manager (TPM) provided during onboarding. |
|
Ometria API Key |
Enter the API key you generated in Ometria. |
|
Ometria API Endpoint URL |
This field is set automatically when installing an extension. |
|
Magento Store Identifier |
This field is completed automatically and corresponds to the current/default store view code. |
|
Enable Request Logging |
Enable this option to receive data export request information from Ometria. You can see the request logs in Magento by going to: Marketing > Ometria > Export Requests Log |
|
Enable Error Logging |
Enable this option to get extra debugging information in the log file. You can see the error logs by going to: Marketing > Ometria > Export Errors Log |
Save your configuration and move on to the Global Account settings.
Global Account
The Global (Ometria) Account can be used as a 'parent account' to aggregate all data streams if you have several accounts connected to your stores.
Review and complete the following fields:
|
Field |
Description |
|
Ometria API Key |
Enter your Global Ometria Account key. Note: The scope of the exported data depends on the level at which the global Ometria account is connected (e.g. global, website, store-view). See Connecting Magento stores to your Ometria accounts for more information.
|
|
Use Entity Namespaces |
Use this setting to enable or disable sending namespace for the entities (collections) to your global account. |
Save your configuration and move on to the Coupons API settings.
Coupons API
Ometria uses these settings to manage your coupons data.
Review and complete the following fields:
|
Field |
Description |
|
API Public Key |
Provided to you by your technical project manager (TPM). |
|
API Private Key |
See also: Setting up coupons in Magento 2
Save your configuration and move on to the Data Export settings.
Data Export
The Data Export settings cover the initial transferring of your historical data (i.e. the first export) and the sending of live updates to Ometria.
Review and complete the following fields:
|
Field |
Description |
|
Historical Data Export |
WarningDo not start your export until you have completed the rest of the configuration for your account, otherwise you risk duplicating data in Ometria. Select Start Export to begin the initial export of all of your data (contacts, products and orders) into Ometria. Once the historical data export has started, you can see your requests in Magento by going to: Stores > Configuration > Ometria > Export Requests Log |
|
Enable Live Update Data Export |
WarningDo not start your export until you have completed the rest of the configuration for your account, otherwise you risk duplicating data in Ometria. Select 'Yes' to allow Magento to send live updates for all collections (customers, products and orders) to Ometria. Note: Live updates have a higher priority for sending data than the historical data export. This means that if you make changes to any of your collections during the historical export, these changes will take priority over data in your historical export.
|
|
Max Entries per job Session |
Use this field to define the number of entries sent to Ometria per session. The default is 1000. WarningSetting this value higher than 1000 may cause performance issues. |
|
Records Amount in The Export Queue |
This field displays the number of records per collection type remaining for export. |
|
Clean Up Logs Older Than |
Use this field to define the number of days after which Magento deletes logs. We recommend 14 days. Be aware that storing logs for longer than this may affect database disk space. |
|
Clean Up Logs Job Schedule |
Use this field to set a Chrontab expression for cleaning logs. The default is every day at 03:00. |
If you select the Use system value checkbox against any of these fields, that data will be applied to all of your Magento sites and stores under the global account.
Customers
The Customers panel allows you to define the settings for your customer records.
Review and complete the following fields:
|
Field |
Description |
|
Customer Namespace |
If you like, you can use this field to add a custom prefix to your customer IDs during the data export. The only special characters permitted are dashes (-) and underscores (_). If you already have a Magento extension for Ometria, you should use the same value as before. WarningYou should set this value before you begin any data exports in Magento, otherwise you could end up with duplicated data. |
|
Merge |
If you select 'Yes', then if Magento sends a record with blank/empty fields to Ometria, those won't overwrite fields with existing data. |
|
Newsletter Subscription Status Tracking |
Enable this field to send the contact's subscription status to Ometria. |
|
Customer Data Mapping |
Use this field to add and map additional customer attributes (i.e. custom fields) to send to Ometria. Select Add New Attribute and choose an attribute from the Magento Attribute dropdown. Set the Use the same attribute code column to 'Yes' if you want to send the attribute to Ometria as is. Set the Use the same attribute code column to 'No' if you want to map the Magento attribute to an Ometria field.
You will need to make sure you have created and mapped your Magento attribute to a custom field in Ometria in order to use it in the segment explorer. |
|
Re-export Customer Data |
Click this button to send historical data for customers only. |
Products
The Products panel allows you to define the settings for your products records.
Review and complete the following fields:
|
Field |
Description |
|
Product Namespace |
If you like, you can use this field to add a custom prefix to your product IDs during the data export. The only special characters permitted are dashes (-) and underscores (_). If you already have a Magento extension for Ometria, you should use the same value as before. WarningYou should set this value before you begin any data exports in Magento, otherwise you could end up with duplicated data. |
|
Merge |
If you select 'Yes', then if Magento sends a record with blank/empty fields to Ometria, those won't overwrite fields with existing data. |
|
Product ID Mapping |
Select the Magento attribute (either product ID or product SKU) to map to the Product ID field in Ometria. |
|
Product Data Mapping for Properties |
Use this field to add and map additional product properties to send to Ometria. Select Add New Attribute and choose an attribute from the Magento Attribute dropdown. Set the Use the same attribute code column to 'Yes' if you want to send the attribute to Ometria as is. Set the Use the same attribute code column to 'No' if you want to map the Magento attribute to an Ometria field.
|
|
Product Data Mapping for Attributes |
Use this field to add and map additional product attributes to send to Ometria. Product attributes are features or qualities of products, e.g. brand, style, colour, gender, etc. |
|
Use Custom Format For Product URL |
Use this field to customise your product URLs. Select 'Yes' to enable the field where you can set the format for your URL. Example: http://example.com/{product_id}/{url_path} {product_id} is the Magento Product ID. {url_path} is the Magento native Product URL path. |
|
Image URL Customisation |
You can customise the product image URL in Magento. |
|
Use Image Size in Image URL |
Define the size of your product image URL to send to Ometria.
If you choose 'Normal', you can select a particular image from the product image gallery. If the target image number can't be found, Magento will send the last one. |
|
Re-export Product Data |
Click this button to send historical data for products only. |
Orders
The Orders panel allows you to define the settings for your orders.
Review and complete the following fields:
|
Field |
Description |
|
Order Namespace |
If you like, you can use this field to add a custom prefix to your order IDs during the data export. The only special characters permitted are dashes (-) and underscores (_). If you already have a Magento extension for Ometria, you should use the same value as before. WarningYou should set this value before you begin any data exports in Magento, otherwise you could end up with duplicated data. |
|
Merge |
If you select 'Yes', then if Magento sends a record with blank/empty fields to Ometria, those won't overwrite fields with existing data. |
|
Currency Type |
Choose the currency you want to use for your orders:
Note: Your base currency is defined during your Ometria onboarding. Order totals are always sent in the local currency only. See: Currency conversion in Ometria.
|
|
Valid Order Statuses |
Define the order statuses that should be considered valid orders in Ometria. |
|
Order Data Mapping |
Use this field to add and map additional order attributes (i.e. custom fields) to send to Ometria. Select Add New Attribute and choose an attribute from the Magento Attribute dropdown. Set the Use the same attribute code column to 'Yes' if you want to send the attribute to Ometria as is. Set the Use the same attribute code column to 'No' if you want to map the Magento attribute to an Ometria field.
You will need to make sure you have created and mapped your Magento attribute to a custom field in Ometria in order to use it in the segment explorer. |
|
Re-export Order Data |
Click this button to send historical data for orders only. |
Once you've configured and tested your Magento extension, you can begin Connecting Magento stores to your Ometria accounts.
Data export error handling
If any errors occur during your historical export or live updates, a record is sent to the Export Requests Log and the Export Error Log tables.
In Magento, go to: Marketing > Ometria > Export Requests Log / Export Error Log
Export Errors Log
This log displays the errors received from Ometria which occurred due to invalid data send either during the historical export or a live update.
If you see this type of error, contact Ometria's support team.
Export Requests Log
This log displays error which occur due to poor data quality in Magento - e.g. missing data for required fields - or error caused by unstable Ometria service or an invalid API key.
Collections with poor data quality are 'skipped' during the export.
You can find information about skipped IDs in the Record Information column:
To correct this error, you need to correct the data for the skipped ID in the database and run the export again.
Alternatively, you can re-save the collection once you've made your changes.
Managing unsubscribes in Magento
The Unsubscribes Management panel allows you to unsubscribe contacts in Magento when the corresponding changes occur in Ometria:
|
Field |
Description |
|
Enabled |
Select 'Yes' to enable subscription synchronisation between Ometria and Magento. |
|
Schedule Expression for Unsubscribes Sync |
The Cronrab expression. Default: every 10 minutes |
Comments
0 comments
Article is closed for comments.