Draft:X-Cart:X-Payments Subscriptions and Installments

System requirements and installation

To successfully install and use the X-Payments Subscriptions and Installments module, you need the following components installed and configured on your system:

• X-Cart 4.4.5-4.6.x (If you do not remember the version of X-Cart on which your store is based, you can look it up in the Environment info section of the Summary page in X-Cart Admin area);
• X-Payments 2.0.0 or later.

The X-Cart installation must be connected to X-Payments using X-Cart’s built-in X-Payments Connector module.

The module archive contains a script "xps_cron.php" (for X-Cart versions 4.6.1 and earlier - "cron_subscriptions.php"). After installing the module, you must be able to configure your server to run this script automatically on a schedule.

0 2 * * * cd /path/to/your/xcart; /path/to/php -d safe_mode=Off xps_cron.php --key=c901d65fc15ff15d0ac0af967437d051 0 2 * * * - to run the script every day at 2:00 AM

Installing the X-Payments Subscriptions module

To install X-Payments Subscriptions:

1. Obtain a distribution package for the X-Payments Subscriptions module 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.y.z.tgz where x, y and z are the version numbers of the module.
2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
   • If you are using a Windows-based server, or a UNIX-based server without terminal access:

   a) Decompress the archive with the X-Payments Subscriptions module 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 are using 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.y.z.tgz

   Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files may be overwritten!

3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install_xpayments_subscriptions.php replacing <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart store.
4. Enter the Auth code, accept the License Agreement and click Next.
5. The installation script patches the files and activates the module. Click Next to continue the installation.
   
   Note: If you are using a custom skin, you will need to patch it manually.

After the installation process has been completed, use the ADMINISTRATOR AREA link to log in to the Admin area.

Getting started

To begin using the X-Payments Subscriptions and Installments module on your system, use the following guidelines:

1. Install the module.
2. Configure the module.
3. If you disabled the module after installation, enable (activate) it again.

Once these steps are completed, the module is ready to use. Instructions for using the X-Payments Subscriptions module are available here:

• Using the X-Payments Subscriptions module (Admin area)
• Using the X-Payments Subscriptions module (Customer area)

Activating and deactivating the module

If the module X-Payments Subscriptions and Installments is installed, but not active, you can enable (activate) it.

To enable the module:

1. Go to the Modules section of your store's Admin area (Settings menu->Modules). This opens the list of your store's installed modules.
2. Locate the entry for the X-Payments Subscriptions and Installments module and select the respective check box on the left.
3. Click Apply changes. The module will be enabled.

It is possible to temporarily disable (deactivate) the installed X-Payments Subscriptions and Installments module. Deactivation stops the module from operation, but it does not remove any settings you made to the module configuration nor clear any data that was generated during the period that the module was in operation. If you wish to completely remove all the data related to using the module, you need to uninstall it. See X-Payments Subscriptions and Installments: Uninstallation for more info.

To disable the module:

1. Go to the Modules section of your store's Admin area (Settings menu->Modules).
2. Locate the entry for the X-Payments Subscriptions and Installments module and unselect the respective check box on the left.
3. Click Apply changes. The module will be disabled.