Installation / Quick Start Guide

Product Release Information

Product:	Instant Order Status Tracking for CRELoaded 6.x
Release Number:	1.0.1
Release Date:	Aug 11th, 2007
Customer Support:	For more information or support, please visit our website or contact us from the online form

Introduction

This document describes how to install and get started with Instant Order Status Tracking Module. This module enables user track order status anytime by inputting order ID and email address.

Features of the Instant Order Status Tracking module as following:

Fully integrated into your CRELoaded store, allow inputting two tracking numbers for one carrier in each order
Supports tracking for most popular carriers including UPS, Fedex, Canada Post and USPS
Provides direct tracking information link to UPS, Fedex, Canada Post, and USPS order tracking system
Allow order tracking by order ID and email address as well as direct tracking number input, single page access to multiple carriers' parcel tracking system
No more need to answer order status enquiry!

Note: to allow user track the order status, admin needs to set order status and input the tracking number in the corresponding tracking number field of the carrier by editing the order.

Minimal System Requirements

System requirements are described in the release notes.

Installation

What other software must be installed first?

Before you can install this product, you must obtain access to a web server with the following:

PHP 4.x with :

GD Library
mCrypt
Register Globals set to On via httpd.conf, php.ini or .htaccess

The Apache Webserver
MySQL database
The Linux / Unix Operating System
CRE Loaded 6.15 or later

How do I install CRE Loaded : Instant Order Status Tracking Module?

Please follow these steps:

FTP the files to your catalog directory on the webserver.

Open includes/filenames.php file add:
define('CONTENT_TRACKING', 'tracking'); define('FILENAME_TRACKING', CONTENT_TRACKING . '.php');

Open admin/includes/filenames.php file add:
define('CONTENT_TRACKING', 'tracking'); define('FILENAME_TRACKING', CONTENT_TRACKING . '.php');

Open admin/includes/languages/english/orders.php file add:
define('TABLE_HEADING_UPS_TRACKING','UPS tracking number:'); define('TABLE_HEADING_FEDEX_TRACKING','Fedex tracking numbers:'); define('TABLE_HEADING_USPS_TRACKING','USPS tracking number:'); define('TABLE_HEADING_CANADA_POST_TRACKING','CANADA POST tracking number:'); define('EMAIL_TEXT_TRACKING_NUMBER', 'You can track your packages by clicking the link below:' . "\n\n%s\n\n"); define('TEXT_TRACKING','Track');

Open admin/orders.php file, change:
$email = STORE_NAME . "\n" . EMAIL_SEPARATOR . "\n" . EMAIL_TEXT_ORDER_NUMBER . ' ' . $oID . "\n" . EMAIL_TEXT_INVOICE_URL . ' ' . tep_catalog_href_link(FILENAME_CATALOG_ACCOUNT_HISTORY_INFO, 'order_id=' . $oID, 'SSL') . "\n" . EMAIL_TEXT_DATE_ORDERED . ' ' . tep_date_long($check_status['date_purchased']) . "\n\n" . $notify_comments . sprintf(EMAIL_TEXT_STATUS_UPDATE, $orders_status_array[$status]);
to:
if ($ups_track_num != '') { $track_text = TABLE_HEADING_UPS_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'ups=' . $ups_track_num) . '" target="_blank">' . $ups_track_num . '</a>' . "\n"; } if ($ups_track_num2 != '') { $track_text .= TABLE_HEADING_UPS_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'ups=' . $ups_track_num2) . '" target="_blank">' . $ups_track_num2 . '</a>' . "\n"; } if ($fedex_track_num != '') { $track_text .= TABLE_HEADING_FEDEX_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'fedex=' . $fedex_track_num) . '" target="_blank">' . $fedex_track_num . '</a>' . "\n"; } if ($fedex_track_num2 != '') { $track_text .= TABLE_HEADING_FEDEX_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'fedex=' . $fedex_track_num2) . '" target="_blank">' . $fedex_track_num2 . '</a>' . "\n"; } if ($usps_track_num != '') { $track_text .= TABLE_HEADING_USPS_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'usps=' . $usps_track_num) . '" target="_blank">' . $usps_track_num . '</a>' . "\n"; } if ($usps_track_num2 != '') { $track_text .= TABLE_HEADING_USPS_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'usps=' . $usps_track_num2) . '" target="_blank">' . $usps_track_num2 . '</a>' . "\n"; } if ($canada_post_track_num != '') { $track_text .= TABLE_HEADING_CANADA_POST_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'canada_post=' . $canada_post_track_num) . '" target="_blank">' . $canada_post_track_num . '</a>' . "\n"; } if ($canada_post_track_num2 != '') { $track_text .= TABLE_HEADING_CANADA_POST_TRACKING . " " . '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'canada_post=' . $canada_post_track_num2) . '" target="_blank">' . $canada_post_track_num2 . '</a>'; } $email = STORE_NAME . "\n" . EMAIL_SEPARATOR . "\n" . EMAIL_TEXT_ORDER_NUMBER . ' ' . $oID . "\n" . EMAIL_TEXT_INVOICE_URL . ' ' . tep_catalog_href_link(FILENAME_CATALOG_ACCOUNT_HISTORY_INFO, 'order_id=' . $oID, 'SSL') . "\n" . EMAIL_TEXT_DATE_ORDERED . ' ' . tep_date_long($check_status['date_purchased']) . "\n\n\n" . EMAIL_SEPARATOR . "\n" . sprintf(EMAIL_TEXT_TRACKING_NUMBER, HTTP_CATALOG_SERVER . DIR_WS_HTTP_CATALOG . FILENAME_TRACKING) . "\n" . $track_text . "\n\n" . $notify_comments . sprintf(EMAIL_TEXT_STATUS_UPDATE, $orders_status_array[$status]);

Open admin/orders.php file, just before
$order_updated = false;
add:
$ups_track_num = tep_db_prepare_input($_POST['ups_track_num']); $usps_track_num = tep_db_prepare_input($_POST['usps_track_num']); $fedex_track_num = tep_db_prepare_input($_POST['fedex_track_num']); $canada_post_track_num = tep_db_prepare_input($_POST['canada_post_track_num']); $ups_track_num2 = tep_db_prepare_input($_POST['ups_track_num2']); $usps_track_num2 = tep_db_prepare_input($_POST['usps_track_num2']); $fedex_track_num2 = tep_db_prepare_input($_POST['fedex_track_num2']); $canada_post_track_num2 = tep_db_prepare_input($_POST['canada_post_track_num2']); tep_db_query("update " . TABLE_ORDERS . " set ups_track_num = '" . tep_db_input($ups_track_num) . "', usps_track_num = '" . tep_db_input($usps_track_num) . "', fedex_track_num = '" . tep_db_input($fedex_track_num) . "', ups_track_num2 = '" . tep_db_input($ups_track_num2) . "', usps_track_num2 = '" . tep_db_input($usps_track_num2) . "', fedex_track_num2 = '" . tep_db_input($fedex_track_num2) ."', canada_post_track_num = '" . tep_db_input($canada_post_track_num) ."', canada_post_track_num2 = '" . tep_db_input($canada_post_track_num2) . "' where orders_id = '" . tep_db_input($oID) . "'");

Open admin/orders.php file, after
<tr> <td class="main"> <?php echo TABLE_HEADING_COMMENTS; ?></td> </tr> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '5'); ?></td> </tr> <tr><?php echo tep_draw_form('status', FILENAME_ORDERS, tep_get_all_get_params(array('action')) . 'action=update_order', 'post', '', 'SSL'); ?> <td class="main"><?php echo tep_draw_textarea_field('comments', 'soft', '60', '5'); ?></td> </tr>
add:
<?php if ($order->info['ups_track_num'] != '') { $ups_link = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'ups=' . $order->info['ups_track_num']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['ups_track_num2'] != '') { $ups_link2 = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'ups=' . $order->info['ups_track_num2']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['usps_track_num'] != '') { $usps_link = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'usps=' . $order->info['usps_track_num']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['usps_track_num2'] != '') { $usps_link2 = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'usps=' . $order->info['usps_track_num2']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['fedex_track_num'] != '') { $fedex_link = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'fedex=' . $order->info['fedex_track_num']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['fedex_track_num2'] != '') { $fedex_link2 = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'fedex=' . $order->info['fedex_track_num2']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['canada_post_track_num'] != '') { $dhl_link = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'canada_post=' . $order->info['canada_post_track_num']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } if ($order->info['canada_post_track_num2'] != '') { $canada_post_link2 = '<a href="' . tep_catalog_href_link(FILENAME_TRACKING, 'canada_post=' . $order->info['canada_post_track_num2']) . '" target="_blank">' . TEXT_TRACKING . '</a>'; } ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <tr> <td> <table> <tr><td class="main" width="20%"></td><td width="40%" class="main">Tracking Number1</td><td width="40%" class="main">Tracking Number2</td></tr> <tr> <td class="main"><?php echo TABLE_HEADING_UPS_TRACKING; ?></td><td class="main"><?php echo tep_draw_textarea_field('ups_track_num', '23', '18', '', $order->info['ups_track_num']) . ' ' . $ups_link . ' ' .'</td><td class="main">'. tep_draw_textarea_field('ups_track_num2', '23', '18', '', $order->info['ups_track_num2']) . ' ' . $ups_link2; ?></td> </tr> <tr> <td class="main"><?php echo TABLE_HEADING_FEDEX_TRACKING; ?></td><td class="main"><?php echo tep_draw_textarea_field('fedex_track_num', '23', '18', '', $order->info['fedex_track_num']) . ' ' . $fedex_link . ' ' .'</td><td class="main">'. tep_draw_textarea_field('fedex_track_num2', '23', '18', '', $order->info['fedex_track_num2']) . ' ' . $fedex_link2; ?></td> </tr> <tr> <td class="main"><?php echo TABLE_HEADING_USPS_TRACKING; ?></td><td class="main"><?php echo tep_draw_textarea_field('usps_track_num', '23', '18', '', $order->info['usps_track_num']) . ' ' . $usps_link . ' '.'</td><td class="main">'. tep_draw_textarea_field('usps_track_num2', '23', '18', '', $order->info['usps_track_num2']) . ' ' . $usps_link2; ?></td> </tr> <tr> <td class="main"><?php echo TABLE_HEADING_CANADA_POST_TRACKING; ?></td><td class="main"><?php echo tep_draw_textarea_field('canada_post_track_num', '23', '18', '', $order->info['canada_post_track_num']) . ' ' . $canada_post_link . ' '.'</td><td class="main">'. tep_draw_textarea_field('canada_post_track_num2', '23', '18', '', $order->info['canada_post_track_num2']) . ' ' . $canada_post_link2; ?></td> </tr> </table> </td> </tr>

Open admin/includes/classes/order.php file, change:
$order_query = tep_db_query("select customers_id, customers_name, customers_company, customers_street_address, customers_suburb, customers_city, customers_postcode, customers_state, customers_country, customers_telephone, customers_email_address, customers_address_format_id, delivery_name, delivery_company, delivery_street_address, delivery_suburb, delivery_city, delivery_postcode, delivery_state, delivery_country, delivery_address_format_id, billing_name, billing_company, billing_street_address, billing_suburb, billing_city, billing_postcode, billing_state, billing_country, billing_address_format_id, payment_method, cc_type, cc_owner, cc_number, cc_ccv, cc_expires, currency, currency_value, date_purchased, orders_status, ipaddy, ipisp, last_modified, payment_id,cc_start,cc_issue from " . TABLE_ORDERS . " where orders_id = '" . (int)$order_id . "'");
to:
$order_query = tep_db_query("select customers_id, customers_name, customers_company, customers_street_address, customers_suburb, customers_city, customers_postcode, customers_state, customers_country, customers_telephone, customers_email_address, customers_address_format_id, delivery_name, delivery_company, delivery_street_address, delivery_suburb, delivery_city, delivery_postcode, delivery_state, delivery_country, delivery_address_format_id, billing_name, billing_company, billing_street_address, billing_suburb, billing_city, billing_postcode, billing_state, billing_country, billing_address_format_id, payment_method, cc_type, cc_owner, cc_number, cc_ccv, cc_expires, currency, currency_value, date_purchased, orders_status, ipaddy, ipisp, last_modified, payment_id, cc_start, cc_issue, fedex_track_num, ups_track_num, usps_track_num, canada_post_track_num, fedex_track_num2, ups_track_num2, usps_track_num2, canada_post_track_num2 from " . TABLE_ORDERS . " where orders_id = '" . $order_id . "'");

Open admin/includes/classes/order.php file, after:
'date_purchased' => $order['date_purchased'],
add:
'ups_track_num' => $order['ups_track_num'], 'usps_track_num' => $order['usps_track_num'], 'fedex_track_num' => $order['fedex_track_num'], 'ups_track_num2' => $order['ups_track_num2'], 'usps_track_num2' => $order['usps_track_num2'], 'fedex_track_num2' => $order['fedex_track_num2'], 'canada_post_track_num' => $order['canada_post_track_num'], 'canada_post_track_num2' => $order['canada_post_track_num2'],

Run SQL statement:
ALTER TABLE `orders` ADD `ups_track_num` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `usps_track_num` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `fedex_track_num` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `canada_post_track_num` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `ups_track_num2` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `usps_track_num2` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `fedex_track_num2` VARCHAR( 32 ) NOT NULL ; ALTER TABLE `orders` ADD `canada_post_track_num2` VARCHAR( 32 ) NOT NULL ;

How can I uninstall CRE Loaded : Instant Order Status Tracking Module?

Delete all files that you added

Change all modified files back

What if I encounter problems?

Please see the troubleshooting section in the FAQ.