Introduction

Smart Export PRO module is enhanced version of Smart export module. It is user friendly Module that allows user to export channel data into CSV and/or XML formats without writing any queries.

Smart Export PRO module is powerful tool to export data of default field types as well as third party field types.

Compatibility

EE Compatible Version: EE2, EE4, EE5.

Some of the features of Smart Export PRO are listed below:

  1. Easy to Install and use.
  2. Exports channel entries without writing queries. (channel wise)
  3. Support MSM sites. You can set export as Public or Private. In Private mode, it will hidden for other users who can access backend. (Except for Super admin.)
  4. Handle big amount of entries while exporting. We are introducing AJAX based export in PRO version. Now you can export thousands of data with a single click. If your memory limits run outs, just set ajax based export by some limit of entries per ajax call.
  5. Allows to Export the entries in XML and CSV formats.
  6. Allows to filter entries by their Status.
  7. Exports all the primary data including Channel title, URL title, Entry date, Author, Status, Categories etc.
  8. Allows user to choose the custom fields while exporting.
  9. Supports Relationships fields to export and facilitate user to choose the base of relationships entries to export. i.e., Title, URL title, Entry ID.
  10. Supports Grid fields to export.
  11. Supports Fluid fields (EE4 version).
  12. Supports Relationships fields inside Grid fields to export.
  13. Supports Grid fields inside Fluid field. Supports each relationships fields that is inside GRID. (That GRID is inside Fluid).
  14. Supports Images export by its URLs.
  15. Supports Outside data of channel field:
    1. Categories
    2. SEO Lite
    3. Pages
  16. Supports all default field types as well as given third party field types:
    1. Assets
    2. Channel Images
    3. Channel Files
    4. DevDemon Tagger
    5. EE Harbor Tag
    6. Solspace Tag
    7. Zeal Color picker field
    8. DevDemon Editor
    9. Wygwam
    10. Wyvern
    11. Low events
    12. Matrix
    13. Playa

Note: We are not providing support for EE2.

Installation

Follow below steps to install Smart Export PRO version:

EE2:

  1. Download and Extract ZIP file of the module. (We recommend to use the latest version.)
  2. Copy Smart_Export_Pro > EE2 > system > expressionengine > third_party > smart_export folder to “Your Site > system > expressionengine > third_party” Folder.
  3. Copy Smart_Export_Pro > EE2 > themes > third_party > smart_export folder to “Your Site > themes > third_party” Folder.
  4. Login to backend panel with Super admin credentials.
  5. Go to “Add-Ons > Modules” and Install Smart Export PRO module.

EE4:

  1. Download and Extract ZIP file of the module. (We recommend to use the latest version.)
  2. Copy Smart_Export_Pro > EE4 > system > user > addons > smart_export folder to “Your Site > system > user > addons” Folder.
  3. Copy Smart_Export_Pro > EE4 > themes > user > smart_export folder to “Your Site > themes > user” Folder.
  4. Login to backend panel with Super admin credentials.
  5. Go to “Developer > Add-Ons” and Install Smart Export PRO module.

EE5:

  1. Download and Extract ZIP file of the module. (We recommend to use the latest version.)
  2. Copy Smart_Export_Pro > EE5 > system > user > addons > smart_export folder to “Your Site > system > user > addons” Folder.
  3. Copy Smart_Export_Pro > EE5 > themes > user > smart_export folder to “Your Site > themes > user” Folder.
  4. Login to backend panel with Super admin credentials.
  5. Go to “Developer > Add-Ons” and Install Smart Export PRO module.

Note: If you purchased the addon from Devot:ee then you can get the license key from the licenses tab in your profile.

Create new Export

To create a new export, Go to backend Smart Export settings. Click on “Create new Export” Button.

In process of create new export, You need to select channel you want to export.

After selecting channel, Full settings stack will show.

Select which default and custom fields you want to export and fill general settings.

General Settings are described as below:

    1. Export Name:

      Name of your current export settings. This field is just a label of your export.

    2. Access export URL without Login ?:

      In case if you want to export this settings outside of EE without any login, Mark this as “Yes”

    3. Export Type:

       Mark this Export as “Private” will not allow any other guest or site user to download this Export. You and only you will allow to download this export. In other case, If you mark this Export as “Public”, Anyone can access and able to download this export.

    4. Export Procedure:

       There is 2 procedure to export channel data with Smart Export.

      1. Normal: 

        Click and download export on single click. In this method, no AJAX will fire. If you have plenty of entries to export and your server memory_limit and max_input_vars is low in compare of total entries to export in single shot, It will give you memory_limit error or 500 internal server error. This method is recommended if you have low number of entries to export.

      2. AJAX: 

        Loop base AJAX export. This method will calculate total number of entries and divide ajax calls by Batches you have entered in settings. Default batches is 50. So, Suppose you have 10,000 entries to export and you chose AJAX export with batches of 100 entries per ajax call. It will throw 100 calls of AJAX on your download button (one by one). After complete all the ajax calls, It will give you URL to download generated file. This method is highly recommended if you have plenty of entries to export in single file. No matter you have hundreds or thousands of entries, With this method, its too easy to generate an export file.

    5. At last, you have to select the format in which you want the exported data. We have 2 type of export formats. (CSV and XML).

Export List

Once you create an export settings, It will show under Smart export list. Where you can edit or delete export setting. Download export or copy the frontend URL to download export outside of EE.

When you click on URL icon, It will give you URL to download export from out side of EE in a POPUP. You can copy and run it in browser.

Note: If you pass extra _GET parameter in URL (type=ajax), It will download export with AJAX procedure.

Download Export

AJAX download at backend:

AJAX download at Frontend:

Custom Sidebar

We provide one “customSidebar” function in the MCP file. You can add more menus in the sidebar of the addon using this function.

/* To get dynamic menu in the addon */    
   function customSidebar(){
       $sidebar = ee('CP/Sidebar')->make();
       $this->navSettings  = $sidebar->addHeader('Test Link', '');
   }

Run Export

You can now run export from front end templates. All you need to pass is single tag:

 {exp:smart_export:run}

This parameter has view modify functions. We suggest you to use it in blank template only.

Parameters

  1. id
  2. token
  3. start_date
  4. end_date
  5. entry_id
  6. type

Following Parameters can be use Run tag:

id

This parameter will inform tag to download given export ID. This is alternative parameter of token.

Example:

id="1"

token

This parameter will inform tag to download given export Token. You can get token of given export by click on popup URL on backend table settings. This is alternative parameter of ID.

Example:

token="ae17e17a80c87776426efd6e164df3a8"

start_date

This parameter is created to override default “Start date” that is specified in export form. You can set valid timestamp of export entry start date. This parameter will force to download entries whose entry_date is greater then given timestamp.

Note: To use this parameter, You must need to set “Enable Date wise filter?” to “Yes” in export form.

Example:

start_date="1527061200"

end_date

This parameter is created to override default “End date” that is specified in export form. You can set valid timestamp of export entry end date. This parameter will force to download entries whose entry_date is less then given timestamp.

Note: To use this parameter, You must need to set “Enable Date wise filter?” to “Yes” in export form.

Example:

end_date="1527061200"

entry_id

You can specify which entries should export or which entries should not. This parameter will override all default entries export to limit only specified entries to export.

Example:

entry_id="20|55|48|800|700"
entry_id="not 23|36"

type

You can specify if you want to download exort on 1 click or AJAX. Passing this parameter will load its own view and you cannot use your view on it. (You can modify it if you want.)

Example:

type="ajax"

Example:

{exp:smart_export:run token="{segment_2}" type="ajax" entry_id="8|9|10|11|12|13|14|15|16|17|18|19|20" start_date="1527050000" end_date="1527061200"}

Changelog

Smart Export: Changelog (PRO)

V2.0.0.1

  • Solved a bug in EE4 where status field in create new export form was default throwing error in select box.

V2.0.0.2

  • Add whole new setting form where one can set there own settings like, Encode output or not, Encode HTML tags, repeated array to string Separator, XML root and element tag names etc.

V2.0.0.3

  • Bug Fix: Where upgraded site from EE3 to EE4 has legacy field export issues.

V2.0.0.6

  • File Grid field support in EE5.

V3.0.0

  • Updated the license verification process and setup so please update the license in your addon.

 

 

Loading your cart...