You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 33 Next »



Installation




Before installing the extension, please make sure to Backup your web directory and store database


You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.

Root Directory is - "app/code/magedelight/#YourExtensionName#"

  • Unzip the extension package file into the root folder of your Magento 2 installation.
  • Connect to SSH console of your server:
    • Navigate to the root folder of your Magento 2 setup
    • Run command as per below sequence,

      php bin/magento setup:upgrade

      php bin/magento setup:di:compile

      php bin/magento setup:static-content:deploy

      php bin/magento cache:clean

  • log out from the backend and log in again


If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.   


Backend Configuration (Admin side)


  • Enable: Select "YES" to enable the product feeds module.


  • Directory for Feed Files: Select the directory where the feed files will be stored.
  • File Path: Enter the path where the feed files will be saved.
  • Export Feeds: Select the settings for exporting the feed, such as daily, weekly, or monthly.
  • CRON JOB Start Time: Define the start time for the Cron job that will trigger the feed export.


  • Enable Email Notifications: Select "Yes" to enable email notifications for feed events.

  • Email Sender: Select the email sender representative from which the notifications will be sent.

  • Send Email To: Enter the recipient email addresses. Separate multiple email addresses with commas.

  • Enable Successful Feeds Export Email Notifications: Select "Yes" to receive email notifications when a feed export is successful.

  • Email Template for Successful Export: Choose the email template to be used for successful feed export notifications.

  • Enable Unsuccessful Export Email Notifications: Select "Yes" to receive email notifications when a feed export fails.

  • Email Template for Unsuccessful Export: Choose the email template to be used for unsuccessful feed export notifications.

  • Enable Successful Feeds Delivery Email Notifications: Select "Yes" to receive email notifications when a feed is successfully delivered.

  • Email Template for Successful Delivery: Choose the email template to be used for successful feed delivery notifications.

  • Enable Unsuccessful Delivery Email Notifications: Select "Yes" to receive email notifications when a feed delivery fails.

  • Email Template for Unsuccessful Delivery: Choose the email template to be used for unsuccessful feed delivery notifications.


  • Enable: Select "Yes" to enable the export logs Cron job.

  • Delete Export Logs: Choose the frequency for deleting export logs, such as daily, weekly, or monthly.

  • CRON JOB Start Time: Define the start time for the Cron job that will trigger the deletion of export logs.


Backend Functionality 


Templates

  • Manage all the templates you create through the "Manage Templates" grid. Navigate to Magedelight → Product Feeds → Manage Templates to view existing templates and add new ones. To create a new template, click on 'Add Template', where you can assign the appropriate file type.

  • Template Name: Enter a name for the new template to identify it within the system.
  • File Type: Select the desired feed output format for the template. There are three available file types:
    • CSV - A comma-separated values format where each item is listed on a new line. The file extension is .csv.
    • TXT - Similar to a CSV file but with a .txt extension.
    • XML - A format that uses tags to structure the content. Information about the items is enclosed within these tags, which are represented by angle brackets. The file extension is .xml.
  • Export Type: Select the appropriate export type for the template from the drop-down menu. This determines the method in which the data will be exported.

Feeds

  • Manage all the feeds you create through the "Manage Feeds" grid. To view existing feeds and add new ones, navigate to Magedelight → Product Feeds → Manage Feeds. To create a new feed, click 'Add Feed', where you can select the appropriate template and provide the necessary information.

  • To create a feed, select an existing template (CSV, TXT, or XML) from the drop-down menu. If you prefer to create an empty feed, choose the Empty Template option and click the Load Template button to proceed.


Additionally, if you selected the Empty Template, you will need to fill in the following fields:
* **File Type** - there are three file types available for the data feed.
    * [**CSV**](/feed/csv) 
    * [**TXT**](/feed/csv)
    * [**XML**](/feed/xml)

CSV and TXT Configuration Feeds

        When you select either the CSV or TXT file type under the Information tab, you gain the ability to create or edit the attribute schema for your feed.

    • Enabled: Select "Yes" to enable the data feed.
    • Feed Name: Enter the desired name for the data feed.
    • Feed File Export Name: Specify the export name for the data feed.
    • File Format: The file format will be automatically determined based on the template you have selected.
    • Export Type: The export type will be automatically populated according to the selected template.
    • Store View: Choose the store view for which the data feed will be generated.


  • Fields Delimiter: This delimiter is used to split text into columns within your feed file. The supported delimiters are as follows:
    • Comma (",")
    • Tab ("\t")
    • Colon (":")
    • Space (" ")
    • Vertical Pipe ("|")
    • Semi-colon (";")
  • Fields Enclosure: This option allows you to enclose data within your feed file.


  • Include Header: Set to "Yes" to include a header row (attribute names) in the first line of your feed file.
  • Append Additional Header: Enter a piece of additional information, include an additional header row above the first attributes row ( header) in the first line of your feed file.


In the Manage Content field mapping table, you can add or remove rows, reorder them, set the output type, and define the symbols limit. Each row in the mapping table corresponds to a column in the data feed file.

To add a new column, click on "Add Column" to your CSV feed, create a new row and fill in the following parameters:

  • Source Key Name: The name of the header column.
  • Value Type: The following value types are available:
    • Pattern: Allows you to enter a static value or use patterns from the XML template.
    • Attribute: Enables you to select any store attribute from the drop-down list.
    • Parent Product: Allows you to export configurable products. In this case, simple associated products will have an attribute. For configurable or bundle products, it is recommended to use this value type with fields such as "Product URL" and "Grouped ID."
  • Magento Value: Allows you to select the attribute or input a pattern for the column output.
  • Value Required: Select this option to define whether the field is "Required" or "Optional" for the data feed.


  • The option to select a filter created for the template will be displayed here. You can choose any filters associated with the selected template by selecting the corresponding checkbox (optional).


  • UTM Source: Specifies the source of traffic, such as a search engine, newsletter name, or other origin (e.g., Google, Citysearch, Newsletter).
  • UTM Medium: Identifies the medium through which the traffic is generated, such as email or cost-per-click (e.g., CPC, banner, email).
  • UTM Name: Denotes a specific product promotion or strategic campaign (e.g., product, promo code, slogan).
  • UTM Term: Identifies the paid keywords associated with the campaign
  • UTM Content:  Helps distinguish between different ads or links that direct to the same URL.


  • Mode: The following modes are available:

    • Manual: You will need to manually export the feed.
    • Cron: When selecting Cron, you must specify the days of the week and the time at which the Cron job will run to export the feed.
  • Days of the Week: Specify the days on which the feed will be generated.
  • Time of the Day: Define the time at which the feed will be generated.


  • Enabled: Select "Yes" to enable the FTP upload.
  • Protocol: Select either FTP or SFTP as the connection protocol.
  • Host Name: Enter the server address where the feed will be sent. The format should be: example.com:port.
  • User Name: Provide the username for accessing the FTP server.
  • Password: Enter the password associated with the FTP server.
  • Path: This is an optional field. Enter the path to your merchant folder as provided by the Shopping Engine Service.
  • Passive Mode: Select "Yes" to enable Passive mode, which is commonly used when a firewall is present. Select "No" if not needed.


  • Email: Enter the email address for notifications. Use a comma to separate multiple email addresses.
  • Notification Events: Select the checkboxes for the events for which you wish to receive email notifications. The extension can automatically send email notifications for the following events:

    • Successful Feed Export
    • Unsuccessful Feed Export
    • Successful Feed Delivery
    • Unsuccessful Feed Delivery


  • You will see all the details for the exported feeds, including execution mode, title, message, status, and creation date. Additionally, you can search for and filter the exported feeds.

XML Configuration Feeds

  • Adding an XML feed follows the same process as CSV and TXT feeds, with one key difference: you will need to select the XML Template while adding the template. The Manage Content tab will also be different for XML, while all other functionality tabs will remain the same for the XML feed.
  • The following value types are available to select:
    • Pattern: Allows you to enter a static value or use patterns from the XML template.
    • Attribute: Enables you to select any store attribute from the drop-down list.
    • Parent Product: Allows you to export configurable products. In this case, simple associated products will have an attribute. For configurable or bundle products, it is recommended to use this value type with fields such as "Product URL" and "Grouped ID."

Filters

  • You can manage all the filters you create through the Manage Filters grid. To view existing filters and add new ones, navigate to Magedelight → Product Feeds → Manage Filters. To create a new filter, click on Add New Filter, where you can select feeds and apply filters.


  • Enable: Select "Yes" to enable the filters.
  • Rule Name: Enter a name for the filter.
  • Choose Feeds: Select the feeds to which the filter will be applied. You can also apply filters directly on the feed edit page.
  • Rule Conditions: In the Rules tab, you can specify the conditions required for the filter. Select an attribute from the list and apply the desired filter conditions. The extension allows you to set a combination of conditions using if ALL, if ANY, TRUE, or FALSE rules.


FAQs


Click here to visit FAQs.

Support


Click here to raise a support ticket using your MageDelight account.

Additional Services


Click here to get the customized solution for this extension.


Thank you for choosing MageDelight!



  • No labels