Smart Export PRO

How To Use & Features

Create new Export

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

Image - 1

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

Image - 2

After selecting channel, Full settings stack will show.

Image - 3

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

Image - 4

General Settings are described 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 you want to export these settings outside of EE without any login, Mark this as “Yes”
3. Export Type: Mark this Export as “Private” to prevent any other guest or site user from downloading this Export. You and only you will be allowed to download this export. In the other case, If you mark this Export as “Public”, Anyone can access and able to download this export.
4. Export Procedure: There are 2 procedures 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.

Image - 5

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.

Image - 6

Download Export

AJAX download at backend:

Image - 7

AJAX download at Frontend:

Image - 8

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 Li
}

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

The Following Parameters can be used to run the 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 the default “Start date” that is specified in the export form. You can set valid timestamp of the 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 the export form.

Example:

start_date="1527061200"

End_date

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

Note: To use this parameter, you must need to set “Enable Date-wise filter?” to “Yes” in the 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"}