Admin New Order 1.4

Support thread: http://www.zen-cart.com/showthread.php?199779
Download link: http://www.zen-cart.com/downloads.php?do=file&id=1500


PURPOSE & AIM

Admin New Order adds the ability for administrative users to add new orders to Zen Cart from the administrative interface. The interface blends into the existing customer management page with the addition of a single "new orders" button. Access to this plugin can be restricted via Zen Cart Admin Profiles.

After creating a new order, this plugin logs into the order history the name of the admin user who created the order. The plugin then sends the admin to a page for editing orders. Currently this is done through integration with the plugin Edit Orders.

After following the installation instructions (and any additional instructions as needed), it is very strongly recommended that you read through the ENTIRE How to Use section. There you will find more details of the capabilities of Admin New Order.

*** READ EVERYTHING IN THIS README BEFORE YOU BEGIN ***

See the Credits & History section to see a detailed list of credits and the view the change history of Admin New Order since the last version.

REQUIREMENTS

  • Working installation of Zen Cart 1.5.x
  • Working installation of Edit Orders 4.1+
  • Secure FTP access to the Zen Cart installation (while you can use plain FTP it is not recommended)
  • An account to access Zen Cart's administrative interface
  • Read and agree to the License

Admin New Order IS NOT COMPATIBLE WITH VERSIONS OF ZEN CART PRIOR TO ZEN CART 1.5!!

There will be no support provided for Zen Cart v1.3.x with Admin New Order
(if you are still running an older version of Zen Cart we strongly recommend that you upgrade as there are many security and performance enhancements in Zen Cart v1.5.1)

KNOWN ISSUES

Currently no known issues exist.

POTENTIAL FUTURE ENHANCEMENTS

This module will only get better with the help of active contributors. If you use this module please consider helping answer questions in the Zen Cart forums regarding this module and contributing to the development of future versions.

  • More detailed documentation.
  • Dropdowns to select which addresses to use.

Do you use any other Zen Cart modules?

We've complied a list of other Zen Cart modules and any special instructions needed to integrate them with Admin New Order. Before installing please check out Integration with Other Modules section to learn more!

INSTALLATION

Inside the distribution zip for Admin New Order you will find the following folders:

  • 1_modified_core_files_150 (core Zen Cart files from Zen Cart 1.5.0)
  • 1_modified_core_files_151 (core Zen Cart files from Zen Cart 1.5.1)
  • 2_new_files (files not part of Zen Cart)
  • 3_install (installation files)
  • 4_uninstall (removal files)

*** READ EVERYTHING IN THIS README BEFORE YOU BEGIN ***

***** BACKUP YOUR STORE BEFORE YOU BEGIN*****

Installing / Upgrading Admin New Order

Admin New Order includes an installation / upgrade script and a removal script. These script will handle the process of installing, upgrading, and removing Admin New Order. You should not run any SQL files from older versions of Admin New Order.

DO NOT RUN OLDER VERSIONS OF THE INSTALL/UPGRADE SQL FILES when installing or upgrading!!!!!!
Doing so will cause issues with the installation and may cause Admin New Order to not function as expected.

Do you use any other Zen Cart modules? If you do make sure you read the Integration with Other Modules section for special instructions regarding the installation of Admin New Order PRIOR TO UPLOADING any files to your store.

Step by Step Installation Instructions

  1. Pre - Installation.
    1. Backup your Zen Cart installation and database. Best practice is to keep regular backups and perform a manual backup prior to the installation or modification of any portion of Zen Cart.
      You can use Secure FTP to backup the files. Two well known FTP programs are WinSCP and FileZilla.
      You can backup the MySQL database either using a tool such as PhpMyAdmin or from the Zen Cart admin interface using DrByte's Backup MYSQL Plugin
    2. Unzip the package contents to a temporary directory on your computer.
      For the rest of these instructions we will refer to this location as "/temp".
  2. Modified Core Files. ("/temp/1_modified_core_files_150") and ("/temp/1_modified_core_files_151")
    Because these files are modified versions of core Zen Cart files and will impact your store and potentially other plugins, they have been separated from the new files added by this plugin for easy identification.
    1. Determine which version of Zen Cart is installed and running on your store.
      1. If you are running Zen Cart 1.5.0 you can delete "/temp/1_modified_core_files_151".
        For the rest of this installation Modified Core Files refers to "/temp/1_modified_core_files_150".
      2. If you are running Zen Cart 1.5.1 you can delete "/temp/1_modified_core_files_150".
        For the rest of this installation Modified Core Files refers to "/temp/1_modified_core_files_151".
    2. Rename the "your_admin_folder" folder (inside the "Modified Core Files" folder) to match the name of your store's admin folder.
    3. If you have installed any other plugins or modifications to your Zen Cart installation which make changes to any of the Modified Core Files you will need to use a tool like Winmerge or Beyond Compare to incorporate those changes into these files.
      If you use "Admin New Customer" make sure you read the Integration with Other Modules section before uploading.
    4. Upload all of the folders and files inside the Modified Core Files folder to the location of your Zen Cart installation. The directory structure should match your store's directory structure.
      Do not upload the "1_modified_core_files_xxx" folder to your store, just the files and folders inside the Modified Core Files directory.
  3. New Files. ("/temp/2_new_files")
    These files do not include modifications to any core Zen Cart files. We will be adding these new files to Zen Cart as part of the installation of Admin New Order.
    1. Rename the "your_admin_folder" folder to match the name of your store's admin folder.
    2. If you have installed any other plugins or modifications to your Zen Cart installation which make changes to any of the New Files you will need to use a tool like Winmerge or Beyond Compare to incorporate those changes into these files.
    3. Upload all of the folders and files inside the New Files folder to the location of your Zen Cart installation. The directory structure should match your store's directory structure.
      Do not upload the "2_new_files" folder to your store, just the files and folders inside the New Files directory.
  4. Install. ("/temp/3_install")
    These files trigger the installation or upgrade scripts included with Admin New Order to run inside the Zen Cart administrative interface.
    1. Log into the admin side of your Zen Cart installation using a web browser. Yes, log into your admin interface now before continuing.
      Failing to first login can result in you missing vital installation and error messages.
    2. Upload all of the folders and files inside the Install folder to the location of your Zen Cart installation. The directory structure should match your store's directory structure.
      Do not upload the "3_install" folder to your store, just the files and folders inside the Install directory.
    3. Click on ANY link in the admin interface (except new order). The "Admin Home" link is a good choice.
    4. Note any error or success messages which appear on the top of the site.
      • If all goes well it should report success.
      • If additional steps need to be performed, follow the instructions. When done go back to Install Step 3 (previous step).
        The previous step should start with the text "Click on ANY link" .
Remove Admin New Order

Admin New Order includes a removal script. This script will handle the process of un-installing Admin New Order. You should not run any SQL files from older versions of Admin New Order.

DO NOT RUN OLDER VERSIONS OF THE UN-INSTALL / REMOVAL SQL FILES when removing!!!!!!
Doing so will cause issues with the removal and afterwards may cause Zen Cart to not function as expected.

Step by Step Removal Instructions

  1. Pre - Removal.
    1. Backup your Zen Cart installation and database. Best practice is to keep regular backups and perform a manual backup prior to the installation or modification of any portion of Zen Cart.
      You can use Secure FTP to backup the files. Two well known FTP programs are WinSCP and FileZilla.
      You can backup the MySQL database either using a tool such as PhpMyAdmin or from the Zen Cart admin interface using DrByte's Backup MYSQL Plugin
    2. Unzip the package contents to a temporary directory on your computer.
      For the rest of these instructions we will refer to this location as "/temp".
  2. Un-Install. ("/temp/4_uninstall")
    These files trigger the removal scripts included with Admin New Order (these run inside the Zen Cart administrative interface).
    1. Log into the admin side of your Zen Cart installation using a web browser. Yes, log into your admin interface now before continuing.
      Failing to first login can result in you missing vital installation and error messages.
    2. Upload all of the folders and files inside the Un-Install folder to the location of your Zen Cart installation. The directory structure should match your store's directory structure.
      Do not upload the "5_uninstall" folder to your store, just the files and folders inside the Install directory.
    3. Click on ANY link in the admin interface (except new order). The "Admin Home" link is a good choice.
    4. Note any error or success messages which appear on the top of the site.
      • If all goes well it should report success.
      • If additional steps need to be performed, follow the instructions. When done go back to Install Step 3 (previous step).
        The previous step should start with the text "Click on ANY link" .

        If a file could not be deleted it is always better to correct permissions and allow the script to remove files. If you manually remove files the removal process may not ever be completed.
  3. Cleanup Modified Core Files. ("/temp/1_modified_core_files_150") and ("/temp/1_modified_core_files_151")
    The un-installation script cannot automatically remove the alterations made to core Zen Cart files. These steps should aid you in undoing the changes.
    1. Determine which version of Zen Cart is installed and running on your store.
      1. If you are running Zen Cart 1.5.0 you can delete "/temp/1_modified_core_files_151".
        For the rest of this installation Modified Core Files refers to "/temp/1_modified_core_files_150".
      2. If you are running Zen Cart 1.5.1 you can delete "/temp/1_modified_core_files_150".
        For the rest of this installation Modified Core Files refers to "/temp/1_modified_core_files_151".
    2. Rename the "your_admin_folder" folder (inside the "Modified Core Files" folder) to "admin".
    3. Download a clean copy of your currently installed version of Zen Cart or locate a file backup made before Admin New Order was installed. Unzip the contents to a temporary directory on your computer.
      For the rest of these instructions we will refer to this location as "/clean".
    4. For each file found inside the Modified Core Files folder replace the file with the corresponding file from "/clean".
      The directory structure of both locations should be the same. You only need to copy individual files from "/clean" to "/temp/1_modified_core_files".
      Make sure you replace every file including those in folders underneath Modified Core Files folder.
    5. If you have installed any other plugins or modifications to your Zen Cart installation which make changes to any of the Modified Core Files you will need to use a tool like Winmerge or Beyond Compare to incorporate those changes into these files.
    6. Rename the "admin" folder to match the name of your store's admin folder.
    7. Upload all of the folders and files inside the Modified Core Files folder to the location of your Zen Cart installation. The directory structure should match your store's directory structure.
      Do not upload the "1_modified_core_files_xxx" folder to your store, just the files and folders inside the Modified Core Files directory.

HOW TO USE

Admin New Order is EASY to use. You simply navigate to Zen Cart's admin page for customers, select a customer, and click the "new order" button.

When creating the new order for the selected customer, the customer's primary address will be used for both the shipping and billing address. In the event the customer has never logged into Zen Cart and the customer has a second address, the second address will be used as the billing address.

You can manually change the addresses used for shipping and billing after the order has been created using Edit Orders.

INTEGRATION WITH OTHER MODULES

Edit Orders

(You MUST have Edit Orders 4.x installed to use this module)

You will need to install Edit Orders 4.x prior to installing Admin New Order.

Admin New Customer

(You MUST have Admin New Customer installed to use the the Admin New Customer integration features)

You will need to install Admin New Customer prior to installing Admin New Order.

CREDITS & CHANGE HISTORY

A special thank you to all those who have taken the time to BETA test Admin New Order and provide active feedback and functionality testing. BETA testers have contributed to the QA testing and helped create a better "Admin New Order" module! Without you and others who have contributed, this module would not exist or be as full featured.

We would also like to thank those who have joined the Zen Cart community and provided active help to others with Zen Cart, Edit Orders, Admin New Order and other modules.

v1.4.1 - 7/2013 A Ballanger: http://www.zen-cart.com/member.php?115838
  • Bugfix: Allow order total modules to always be preloaded when not in the Zen Cart admin.
v1.4 - 7/2013 A Ballanger: http://www.zen-cart.com/member.php?115838
  • Enhancement: Updated to work with Edit Orders 4.0, 4.1, and 4.1.1.
  • Included the "plugin" class and associated files.
    • The class and files are not part of "Edit Orders".
    • Provides for simplification of the installation / upgrade process.
    • Provides for simplification of the removal process.
    • Does some extra checks against Zen Cart's configure.php files.
  • Migrated installation, upgrade, and removal code to utilize the "plugin" class.
  • Added integration for "Admin New Customer" in "customers.php".
  • New readme format.

v1.3 - 4/12/2013 A Ballanger: http://www.zen-cart.com/member.php?115838
  • Updated to work with Edit Orders 4.1. This version only works with Edit Orders 4.1.

v1.2 - 10/01/2012 A Ballanger: http://www.zen-cart.com/member.php?115838
  • New Order button no longer shows up if installation failed.
  • Uses the address name fields if entered (previously it always used the actual customer name instead of the address name fields).
  • Fixes an issue where the state was not displayed when dropdowns were not used.
v1.1.1 - 9/25/2012 A Ballanger: http://www.zen-cart.com/member.php?115838
  • Corrected database table used when selecting a billing address.
v1.1 - 9/15/2012 A Ballanger: http://www.zen-cart.com/member.php?115838
  • Adds default currency information to the order.
  • Better handling of "state" information based upon zones.
  • When creating an order core order total module information will be updated.
v1.0 - 9/04/2012 A Ballanger: http://www.zen-cart.com/member.php?115838
  • First public release.
  • Updated installation scripts to provide additional feedback.
  • Can restrict via Admin Profiles.
  • Adds to the order history a log of the admin user who created the order.
  • Can restrict via Admin Profiles.

LICENSE

Admin New Order is released under the General Public License (see LICENSE)

This script is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Always backup your shop and database before making changes.