Difference between revisions of "X-Cart:X-PDF Invoices"
m (→Enabling X-PDF invoices Module in X-Cart) |
|||
| (27 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
| + | 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:''' | |
| − | + | * Produce, print, email and save professional-looking PDF invoices | |
| + | * Adopt your corporate style | ||
| + | * Install in less than a minute | ||
| − | |||
| − | |||
| − | |||
| − | [ | + | <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 == | ||
| − | * | + | * 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 | + | 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> | + | {{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== | ||
| − | + | '''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 {{QA}} account. The distribution package is archived in the file <u>xpdf-x.y.z.tgz</u>, where <u>x</u>, <u>y</u> and <u>z</u> indicate the version of the module. Make sure the version of the module matches the version of your copy of X-Cart. | |
| − | |||
| − | 1. Obtain a distribution package for the X-PDF | ||
2. Copy the distribution package to the X-Cart root directory on your server or hosting account. | 2. Copy the distribution package to the X-Cart root directory on your server or hosting account. | ||
| Line 33: | Line 32: | ||
* If you use a Windows-based server or a UNIX-based server without terminal access: | * 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 | + | : 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. | : 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. | ||
| Line 39: | Line 38: | ||
* If you use a UNIX-based server with terminal access: | * If you use a UNIX-based server with terminal access: | ||
| − | : a) Use an FTP client to upload the archive with the X-PDF | + | : 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: | : b) Decompress the package by typing the following command: | ||
| Line 49: | 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. |
| − | |||
| − | |||
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 60: | Line 57: | ||
| − | '''To uninstall the X-PDF | + | '''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. | 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. |
| − | |||
| − | |||
| − | 3. Once the installation script has removed the X-PDF | + | 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. | 4. On the ''Uninstallation complete'' screen, click '''Next''' to leave the Wizard. | ||
| − | {{Note1|Important: After you have uninstalled the X-PDF | + | {{Note1|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 | + | ==Enabling X-PDF Invoices Module in X-Cart== |
| − | Once you have installed the X-PDF | + | 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 | + | '''To enable the X-PDF Invoices module:''' |
# Log in to the X-Cart Admin area and go to the <u>Modules</u> section (select <u>Settings</u> -> <u>Modules</u> on the administration menu). | # Log in to the X-Cart Admin area and go to the <u>Modules</u> section (select <u>Settings</u> -> <u>Modules</u> on the administration menu). | ||
| Line 84: | Line 79: | ||
# Scroll down to the bottom of the page and click the '''Apply changes''' button to apply the changes. | # Scroll down to the bottom of the page and click the '''Apply changes''' button to apply the changes. | ||
| + | : [[Image:xpdf_module_enable_page.png]] | ||
| − | + | ==Configuring X-PDF Invoices Module in X-Cart== | |
| − | |||
| − | ==Configuring X-PDF | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | 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:''' | |
| − | [[ | + | # Log in to the X-Cart Admin area. |
| + | # 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. | ||
| + | # Click the '''Apply changes''' button to save the changes. | ||
| − | + | [[Category:X-Cart modules]] | |
| + | [[Category:X-Cart video tutorials]] | ||
Latest revision as of 17:36, 22 July 2020
Contents
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:
- Log in to the X-Cart Admin area and go to the Modules section (select Settings -> Modules on the administration menu).
- On the list of modules, find the "X-PDF invoices" item and select the check box by the item's name.
- Scroll down to the bottom of the page and click the Apply changes button to apply the changes.
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:
- Log in to the X-Cart Admin area.
- Select Settings -> Modules on the menu.
- 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:
- Adjust the module settings as needed.
- Click the Apply changes button to save the changes.
