Difference between revisions of "X-Cart:X-ProductNotifications"
Line 41: | Line 41: | ||
To be able to successfully install and use the X-ProductNotifications module, you must have a working copy of X-Cart Gold or X-Cart Pro v4.4.0 or later already installed on your server. Make sure that the version of the <u>X-ProductNotifications module</u> you are installing is the same as the version of X-Cart on which your store is based. | To be able to successfully install and use the X-ProductNotifications module, you must have a working copy of X-Cart Gold or X-Cart Pro v4.4.0 or later already installed on your server. Make sure that the version of the <u>X-ProductNotifications module</u> you are installing is the same as the version of X-Cart on which your store is based. | ||
{{Note1|Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the <u>Environment info</u> section of the <u>Summary</u> page in X-Cart Admin area (<u>Tools menu -> Summary</u>).}} | {{Note1|Note: If you do not remember the version of X-Cart on which your store is based, you can look it up in the <u>Environment info</u> section of the <u>Summary</u> page in X-Cart Admin area (<u>Tools menu -> Summary</u>).}} | ||
+ | |||
+ | == Installing the X-ProductNotifications module== | ||
+ | X-ProductNotifications installation process is the same for both X-Cart Gold and X-Cart Pro. | ||
+ | |||
+ | To install X-ProductNotifications: | ||
+ | |||
+ | # Obtain the X-ProductNotifications distribution package by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>X-ProductNotifications-x.y.z-with-installer.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> stand for X-Cart version (These need match the version of X-Cart on which your store is based). | ||
+ | # Put 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) Decompress the archive with the X-ProductNotifications distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files). | ||
+ | #: b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account. | ||
+ | #* ''If you use a UNIX-based server with terminal access:'' | ||
+ | #: a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account. | ||
+ | #: b) Decompress the package using the following command: | ||
+ | #: <pre>tar -xzvf X-ProductNotifications-x.y.z-with-installer.tgz</pre> | ||
+ | #: {{Note1|'''Important:''' Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten! }} | ||
+ | # In a web browser, run the installation script <u>httр://<YOUR_XCART_DOMAIN>/install-product-notifications.php</u>, replacing <u><YOUR_XCART_DOMAIN></u> with the actual domain name of your X-Cart based store. | ||
+ | # Enter the Auth code, accept the License Agreement and click the '''Next''' button.<br />{{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 in the <u>Summary</u> section of the X-Cart Admin area (<u>Administration menu -> Summary</u>) before the License info subsection. Another way to obtain the code is to retrieve the value of the variable <u>$installation_auth_code</u> from the file <u><xcart_dir>include/install.php</u>}} | ||
+ | # The installation script copies the files and activates the modules. Click the '''Next''' button to continue the installation. | ||
+ | # The installation script generates a new system fingerprint. Click the '''Next''' button to complete the installation. | ||
+ | # Use the ADMINISTRATOR AREA link to access the Admin area.<br /><br /> |
Revision as of 11:57, 26 June 2012
Contents
Overview
X-ProductNotifications is a software package that includes three different types of product notifications available for customers upon their submission:
- price-drop notification An email notification is sent to a customer when a product price goes down;
- low-stock notification A subscribed customer will get an email when there is just a few items remaining in stock. It is going to provoke an indecisive customer to buy a product;
- back in stock notification If an item is temporarily out-of-stock, a customer may want to be notified when it is back in stock;
Each type of notification may be enabled/disabled. The way customers unsubscribe may also be configured for each notification type. Moreover, the store owner is able to manage all the subscriptions on a separate page.
The mod works with variants as well as with regular products.
Depending on the module settings, the product nofications links (buttons) can be visible in Customer area:
in the product list section (main column):
on the product details page:
Roles in Product Notificaton module management
If you are an X-Cart GOLD administrator/provider or an X-Cart PRO administrator:
- You can enable/disable and configure the module;
If you are an X-Cart GOLD administrator/provider or an X-Cart PRO provider:
- You can manage (list, unsubsribe, filter by type, product, e-mail) product notifications on Product Notifications
page. In Admin/Provider area, go to the Catalog section -> Product Notifications.
System requirements for installing the X-ProductNotifications module
To be able to successfully install and use the X-ProductNotifications module, you must have a working copy of X-Cart Gold or X-Cart Pro v4.4.0 or later already installed on your server. Make sure that the version of the X-ProductNotifications module you are installing is the same as the version of X-Cart on which your store is based.
Installing the X-ProductNotifications module
X-ProductNotifications installation process is the same for both X-Cart Gold and X-Cart Pro.
To install X-ProductNotifications:
- Obtain the X-ProductNotifications distribution package by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file X-ProductNotifications-x.y.z-with-installer.tgz where x, y and z stand for X-Cart version (These need match the version of X-Cart on which your store is based).
- Put 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) Decompress the archive with the X-ProductNotifications distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
- b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
- If you use a UNIX-based server with terminal access:
- a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
- b) Decompress the package using the following command:
tar -xzvf X-ProductNotifications-x.y.z-with-installer.tgz
- Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!
- In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-product-notifications.php, replacing <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart based store.
- Enter the 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 in the Summary section of the X-Cart Admin area (Administration menu -> Summary) before the License info subsection. Another way to obtain the code is to retrieve the value of the variable $installation_auth_code from the file <xcart_dir>include/install.php
- The installation script copies the files and activates the modules. Click the Next button to continue the installation.
- The installation script generates a new system fingerprint. Click the Next button to complete the installation.
- Use the ADMINISTRATOR AREA link to access the Admin area.