Modern Admin Dashboard Documentation v1.0


Modern Admin Dashboard

Version: 1.0
By: Leonard Blauhorn
Contact: e-mail me
(considered as quote requests)

Thank you for downloading this plugin. If you have any questions that are beyond the scope of this help file, please visit the official support thread for the plugin. You are also welcome to contact us directly, but please note any work done will be billed at our standard hourly rate. ZenExpert takes no responsibility for problems related to the installation or use of this plugin.


Table of Contents

  1. Installation
  2. Usage
  3. Common Issues
  4. Sources and Credits
  5. Support
  6. License

Installing - top

Modern Admin Dashboard was built for Zen Cart 2.1.0 or newer. It has not been tested on earlier versions, but should work just fine with versions 1.5.8 or newer.

Before you proceed, make a backup of your files. Installation is done at your own risk.

Unzip the files from "files" directory to your computer. Connect to your server via FTP.
For Zen Cart 2.1.0: Upload the content of YOUR_ADMIN directory to your website's admin directory.
For Zen Cart older than 2.1.0: the orders.php file may be different than the one in this package. Please use a file comparison tool to compare the file on your server with the one in this package, and manually apply the changes to your existing orders.php file.

All files in this plugin are considered core files, but you may overwrite ONLY IF you haven't made modifications to those files.

NOTE: You will notice 3 additional directories in the zip file: files-dashboard-ONLY, files-header-ONLY, files-status-color-coding-ONLY. You don't need to upload anything from those directories - they are provided in case you want to change only in case you don't want to apply all 3 modification, but instead only one. Each modification is independent and can be applied as a standalone modification if required for any reason.


Usage - top

After uploading the files, simply refresh your admin home page to see the new layout.

Your dashboard can easily be customized to a layout you prefer using drag-and-drop. The center section is locked and can only display recent orders and sales graph, and you can only swap their positions. All other widgets can be rearranged as you please.

You can color-code your orders statuses by going to Localization -> Orders Status. When you add or edit any status, you have an option to select its color code. This color will be used for the label background and will be displayed on the home page, as well as your orders listing. If you don't assign any color, it will just show text (except home page which has a fallback to default colors).

Home page New Orders widget will display the latest 10 orders and the "pills" will show only Pending and Processing orders. If you want to change that, you can use your admin/includes/extra_datafiles/site_specific_admin_overrides.php (create the file if you don't have it, more info here) and set the following as you seem fit:

    $recentOrdersMaxRows = 20; // number of orders to show
    $target_status_ids = [1,2,4,7]; // IDs you want to show
    $show_status_pills = false; // if you don't want the pills at all


Common Issues - top

None reported so far.


Sources and Credits - top

External libraries used in this plugin:

Support - top

Please note that I don't provide support for this module via email for free. Any private support is considered commercial work and will be billed at our standard hourly rate.

If contacting us with a request for any kind of tech support, please make sure you include a link to your site - all problems are usually very simple, but I can't go guessing what happened in YOUR case.

Stay up-to-date: you can always find the most recent version here and request for an updated version if it exists. If you downloaded the plugin through the ZenExpert shop, you can login to your account and download the latest version.


License - top

The plugin is licensed under GPL.


Once again, thank you for downloading this plugin. As I said at the beginning, I'd be glad to help you if you have any questions relating to this plugin.

Leonard

Go To Table of Contents