Installation

Installation of the module is plain and simple as it only requires the modification of two files for Zen Cart 1.3.x, everything else makes use of Zen Cart's overrides & notifications systems.

Installation Overview

1. Copy the new files for this module into your Zen Cart installation directory.
2. Copy template files to your template's templates directory or merge with your current template.
3. Copy CSS files to your template's css directory or merge with your current stylesheets.
4. Create the database by running the provided SQL script.
5. Install the PayOffline module.
6. [Optional but Recommended] Enable the “PayOffline Info” sidebox.
7. Configure and test the PayOffline module.

Installation Steps

1. Copy the PayOffline module's files to your Zen Cart installation directory

   These are the files which make up this module. Copy each one into its respective folder in your Zen Cart installation:

   • admin/images/ceon_button_logo.png
   • admin/includes/extra_datafiles/payoffline_ipro_database_tables.php
   • email/email_template_payoffline_ipro.html
   • email/email_template_payoffline_ipro_callback.html
   • includes/auto_loaders/config.payoffline_iproAccountHistoryInfo.php
   • includes/auto_loaders/config.payoffline_iproCheckoutSuccess.php
   • includes/classes/observers/class.payoffline_iproAccountHistoryInfo.php
   • includes/classes/observers/class.payoffline_iproCheckoutSuccess.php
   • includes/extra_datafiles/payoffline_ipro_database_tables.php
   • includes/extra_datafiles/payoffline_ipro_filenames.php
   • includes/languages/english/extra_definitions/payoffline_ipro_account_history_info.php
   • includes/languages/english/extra_definitions/payoffline_ipro_checkout_success.php
   • includes/languages/english/extra_definitions/payoffline_ipro_info_sidebox.php
   • includes/languages/english/modules/payment/payoffline_ipro.php
   • includes/languages/english/payoffline_ipro_callback.php
   • includes/languages/english/payoffline_ipro_help.php
   • includes/languages/english/payoffline_ipro_payslip.php
   • includes/languages/english/popup_payoffline_ipro_help.php
   • includes/modules/pages/account_history_info/jscript_payoffline_ipro.php
   • includes/modules/pages/checkout_payment/jscript_payoffline_ipro.php
   • includes/modules/pages/checkout_success/jscript_payoffline_ipro.php
   • includes/modules/pages/payoffline_ipro_help/header_php.php
   • includes/modules/pages/popup_payoffline_ipro_help/header_php.php
   • includes/modules/pages/popup_payoffline_ipro_help/jscript_main.php
   • includes/modules/payment/payoffline_ipro/payoffline_ipro_admin_notification.php
   • includes/modules/payment/payoffline_ipro.php
   • includes/modules/sideboxes/payoffline_ipro_info.php
   • includes/templates/template_default/images/payoffline/*. (All files in this directory!)
   • includes/templates/template_default/popup_payoffline_ipro_help/tpl_main_page.php
   • includes/templates/template_default/sideboxes/tpl_payoffline_ipro_info.php
   • includes/templates/template_default/templates/tpl_payoffline_ipro_info_default.php
   • includes/templates/PAYOFFLINE_IPRO/css/account_history_info.css
   • includes/templates/PAYOFFLINE_IPRO/css/checkout_payment.css
   • includes/templates/PAYOFFLINE_IPRO/css/checkout_success.css
   • includes/templates/PAYOFFLINE_IPRO/css/payoffline_ipro_help.css
   • includes/templates/PAYOFFLINE_IPRO/css/popup_payoffline_ipro_help.css
   • includes/templates/PAYOFFLINE_IPRO/templates/tpl_account_history_info_default.php
   • includes/templates/PAYOFFLINE_IPRO/templates/tpl_checkout_success_default.php
   • payoffline_ipro_callback.php
   • payoffline_ipro_payslip.php

2. Copy template files to your template's templates directory or merge with your current template.

   The list of files above includes two files which are in the directory includes/templates/PAYOFFLINE_IPRO/templates.

   The contents of these files differ slightly from the fresh versions of these files that come with Zen Cart.

   If you haven't already got modified versions of these files for your template:

   • Simply copy the files into your template's templates directory (i.e. replace PAYOFFLINE_IPRO with the name of your template!).

   However, If you already have modified versions of these files for your template:

   • The additional code which causes these files to differ from the originals must be added to any customised version of these files you have in your includes/templates/PAYOFFLINE_IPRO/templates directory.

   • In the file tpl_account_history_info_default.php the code which you need to add to your version of the file starts with the comment:

     <!--bof PayOffline iPro Information -->

     and ends with the comment:

     <!--eof PayOffline iPro Information -->

   • In the file tpl_checkout_success_default.php the code which you need to add to your version of the file starts with the comment:

     <!--bof PayOffline iPro Payslip -->

     and ends with the comment:

     <!--eof PayOffline iPro Payslip -->

   • You should take care to add the new code snippets at the appropriate place in each file.

3. Copy CSS files to your template's css directory or merge with your current stylesheets.

   The list of files above includes some files which are in the directory includes/templates/PAYOFFLINE_IPRO/css.

   These files are additional CSS stylesheets.

   If you haven't already got modified versions of these files for your template:

   • Simply copy the files into your template's css directory (i.e. replace PAYOFFLINE_IPRO with the name of your template!).

   However, If you already have modified versions of these files for your template:

   • Merge the contents of these files with any customised versions you have in your includes/templates/PAYOFFLINE_IPRO/css directory.

4. Create the Database

   A SQL script, payoffline_ipro.sql, is provided with this module to create the database in which the module stores transaction information.

   • You can either use software like PHPMyAdmin to run the SQL script (Don't forget to check the name of the table. If you use a prefix for your table names you should make sure that you put this prefix in front of the table name)..

   • Or you can go to Tools > Install SQL Patches in the Zen Cart Admin and run the file through that.

5. Install the PayOffline iPro module

   Installing the module is just as simple as with any other Zen Cart module.

   • Go to Modules > Payment, click on payoffline_ipro and then on Install

6. [OPTIONAL but RECOMMENDED] Enable the “PayOffline Info” sidebox

   As with all other sideboxes in Zen Cart, the “PayOffline Info” sidebox can be enabled by going to:

   • Tools > Layout Boxes Controller, then clicking on payoffline_ipro_info.php.

   The options for this sidebox are the same as for any other so they won't be explained here.

7. Configure the PayOffline module

   Almost Done! Now all that has to be done is to configure the module and follow PayOffline's test procedures.

Back to top