Difference between revisions of "X-Cart:X-PDF Invoices"

From X-Cart 4 Classic
Jump to: navigation, search
m (→‎Installation and removal)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
  
−
The [http://www.x-cart.com/xpdf-invoices.html X-PDF Invoices module] is an add-on that allows to create invoices in the PDF format. An invoice is sent to customer upon purchase in the order confirmation message.
+
The <u>X-PDF Invoices</u> module is an add-on that allows to create invoices in the PDF format. An invoice is sent to customer upon purchase in the order confirmation message.
  
 
'''Key benefits of using X-PDF Invoices:'''
 
'''Key benefits of using X-PDF Invoices:'''
Line 10: Line 10:
  
  
−
<videoflash>Z6BgM3cIGKI|800|476</videoflash>
+
<youtube>Z6BgM3cIGKI</youtube>
−
 
+
<br /><br />
 +
The <u>X-PDF Invoices</u> module can be [https://www.x-cart.com/extensions/modules/pdf-invoices.html purchased] and installed on all X-Cart editions.
  
 
== System requirements ==
 
== System requirements ==
  
−
* X-Cart 4.1.X or above
+
* PHP 5.4 or above with '''GD''' library and '''mbstring''' functions support (for more information see the corresponding section of PHP manual)
−
* PHP 5.3 of above with gd lib support
 
  
−
To be able to successfully install and use the X-PDF Invoices module, you must have a working copy of X-Cart Gold or X-Cart Pro already installed on your server. Make sure that the version of the X-PDF Invoices module matches the version of your copy of X-Cart.
+
To be able to successfully install and use the X-PDF Invoices module, you need a working copy of X-Cart (version 4.1.x or later) installed on your server. Make sure that the version of the X-PDF Invoices module matches the version of your copy of X-Cart.
  
 
{{Note1|Note: If you do not remember the version of your copy of X-Cart, you can find it in the <u>Environment info</u> section of the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area.}}
 
{{Note1|Note: If you do not remember the version of your copy of X-Cart, you can find it in the <u>Environment info</u> section of the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area.}}
  
 
==Installation and removal==
 
==Installation and removal==
−
 
−
These instructions on both installing and removing the X-PDF Invoices module are the same for both X-Cart Gold and X-Cart Pro.
 
  
 
'''To install the X-PDF Invoices module:'''
 
'''To install the X-PDF Invoices module:'''
Line 50: Line 48:
 
3. In a web browser, run the installation script at httр://www.example.com/install-xpdf.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.
 
3. In a web browser, run the installation script at httр://www.example.com/install-xpdf.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.
  
−
4. Enter the Auth code, accept the License Agreement and click the '''Next''' button.
+
4. Enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
−
 
 
−
{{Note|The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it on the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area, right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
 
  
 
5. The installation script copies the files and activates the module. Click the '''Next '''button to continue.
 
5. The installation script copies the files and activates the module. Click the '''Next '''button to continue.
Line 65: Line 61:
 
1. In a web browser, run the installation script at http://www.example.com/install-xpdf.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.
 
1. In a web browser, run the installation script at http://www.example.com/install-xpdf.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.
  
−
2. Choose the <u>Uninstall the module</u> option, enter the Auth code, accept the License Agreement and click the '''Next''' button.
+
2. Choose the <u>Uninstall the module</u> option, enter the [[X-Cart:FAQs#What_is_Auth_code_and_where_can_I_find_it.3F|Auth code]], accept the License Agreement and click the '''Next''' button.
−
 
 
−
{{Note1|Note: The Auth code is a random code that was generated after you installed your copy of X-Cart. If you do not remember the Auth code, find it on the [[X-Cart:Summary_Page |Summary]] page in X-Cart Admin area, right over the License info subsection. Another way to find out the code is to retrieve the value of the $installation_auth_code variable from the file <u><xcart_dir>include/install.php</u> .}}
 
  
 
3. Once the installation script has removed the X-PDF Invoices module files and deactivated the module, click the '''Next''' button to complete the uninstallation.
 
3. Once the installation script has removed the X-PDF Invoices module files and deactivated the module, click the '''Next''' button to complete the uninstallation.
Line 93: Line 87:
 
'''To configure the X-PDF Invoices module in your X-Cart Admin area:'''
 
'''To configure the X-PDF Invoices module in your X-Cart Admin area:'''
  
−
1. Log in to the X-Cart Admin area.
+
# Log in to the X-Cart Admin area.
−
 
+
# Select <u>Settings</u> -> <u>Modules</u> on the menu.
−
2. Select <u>Settings</u> -> <u>Modules</u> on the menu.
+
# Scroll down until you see the X-PDF Invoices module item and then click on the <u>Configure</u> link by the item. This opens a box with the X-PDF Invoices module settings:<br />[[File:xpdf_configuration_settings.png|border]]
−
 
+
# Adjust the module settings as needed.
−
3. Scroll down until you see the X-PDF Invoices module item and then click on the <u>Configure</u> link by the item.
+
# Click the '''Apply changes''' button to save the changes.
−
 
 
−
This opens a box with options and settings for the X-PDF Invoices module.
 
−
 
 
−
: [[Image:xpdf_configuration_page.png]]
 
−
 
 
−
4. In the X-PDF section that appears, toggle the '''Attach PDF invoice to order notification''' and then click the '''Apply changes''' button.
 
  
 
[[Category:X-Cart modules]]
 
[[Category:X-Cart modules]]
 
[[Category:X-Cart video tutorials]]
 
[[Category:X-Cart video tutorials]]

Latest revision as of 17:36, 22 July 2020

Overview

The X-PDF Invoices module is an add-on that allows to create invoices in the PDF format. An invoice is sent to customer upon purchase in the order confirmation message.

Key benefits of using X-PDF Invoices:

  • Produce, print, email and save professional-looking PDF invoices
  • Adopt your corporate style
  • Install in less than a minute




The X-PDF Invoices module can be purchased and installed on all X-Cart editions.

System requirements

  • PHP 5.4 or above with GD library and mbstring functions support (for more information see the corresponding section of PHP manual)

To be able to successfully install and use the X-PDF Invoices module, you need a working copy of X-Cart (version 4.1.x or later) installed on your server. Make sure that the version of the X-PDF Invoices module matches the version of your copy of X-Cart.

Note: If you do not remember the version of your copy of X-Cart, you can find it in the Environment info section of the Summary page in X-Cart Admin area.

Installation and removal

To install the X-PDF Invoices module:

1. Obtain a distribution package for the X-PDF Invoices module by downloading it from the File Area section of your X-Cart Account account. The distribution package is archived in the file xpdf-x.y.z.tgz, where x, y and z indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart.

2. Copy the distribution package to the X-Cart root directory on your server or hosting account.

  • If you use a Windows-based server or a UNIX-based server without terminal access:
a) Extract the contents of the archive with the X-PDF Invoices module files to a directory on your system using your favorite compression program (WinZIP or any other archiver that supports TAR files).
b) Use an FTP client to upload all the files extracted from the archive (retaining the directory structure) to the X-Cart root directory on your server or hosting account.
  • If you use a UNIX-based server with terminal access:
a) Use an FTP client to upload the archive with the X-PDF Invoices module distribution package to the X-Cart root directory on your server or hosting account.
b) Decompress the package by typing the following command:
tar -xzvf xpdf-x.y.z.tgz
Important: Make sure that you maintain the directory structure while unpacking and uploading the distribution package; otherwise, some critical files can be overwritten!

3. In a web browser, run the installation script at httр://www.example.com/install-xpdf.php, replacing the variable www.example.com with the real domain name, where your X-Cart is installed.

4. Enter the Auth code, accept the License Agreement and click the Next button.

5. The installation script copies the files and activates the module. Click the Next button to continue.

6. The installation script generates a new system fingerprint. Click the Next button to complete the installation.

7. Use the ADMINISTRATOR AREA link to log in to the Admin area.


To uninstall the X-PDF Invoices module:

1. In a web browser, run the installation script at http://www.example.com/install-xpdf.php, replacing the "www.example.com" with the real domain name, where your X-Cart is installed.

2. Choose the Uninstall the module option, enter the Auth code, accept the License Agreement and click the Next button.

3. Once the installation script has removed the X-PDF Invoices module files and deactivated the module, click the Next button to complete the uninstallation.

4. On the Uninstallation complete screen, click Next to leave the Wizard.

Important: After you have uninstalled the X-PDF Invoices module, make sure to remove the module's distribution package from your web directory as well.

Enabling X-PDF Invoices Module in X-Cart

Once you have installed the X-PDF Invoices module, enable it in the X-Cart Admin area. Otherwise, you will be unable to use the module for launching the affiliate system at your store.

To enable the X-PDF Invoices module:

  1. Log in to the X-Cart Admin area and go to the Modules section (select Settings -> Modules on the administration menu).
  2. On the list of modules, find the "X-PDF invoices" item and select the check box by the item's name.
  3. Scroll down to the bottom of the page and click the Apply changes button to apply the changes.
Xpdf module enable page.png

Configuring X-PDF Invoices Module in X-Cart

Now, tell your X-Cart what it should do with all the stuff you have just set up -- configure the X-PDF Invoices module that you installed a few steps earlier.

To configure the X-PDF Invoices module in your X-Cart Admin area:

  1. Log in to the X-Cart Admin area.
  2. Select Settings -> Modules on the menu.
  3. Scroll down until you see the X-PDF Invoices module item and then click on the Configure link by the item. This opens a box with the X-PDF Invoices module settings:
    Xpdf configuration settings.png
  4. Adjust the module settings as needed.
  5. Click the Apply changes button to save the changes.
Retrieved from "https://help.x-cart.com/index.php?title=X-Cart:X-PDF_Invoices&oldid=15422"