X-POS GUIDE. v3.4 INSTALLATION SmartOSC and X-POS

Transcription

1 GUIDE INSTALLATION X-POS v SmartOSC and X-POS

2 1. Prerequisites for Installing and Upgrading Server has Apache/PHP 5.2.x/MySQL installed. Magento Community version 1.7.x or above already installed (assume the installation path is [magento_root]), or Magento Enterprise 1.11 or above. All types of cache are disabled Check that Compilation is disabled by going to System > Tools > Compilation Disable JS and CSS merging by going to System > Configurations > ADVANCED > Developer > JavaScript Settings and CSS Settings X-Payment module is installed From version 3.4 of X-POS web and 1.4 of X-POS ipad App Connector, X-Payment is a required module which should be installed before installing X-POS web or ipad App Connector. To check if X-Payment is installed or not, in Magento Admin, please refer to System > Configuration > ADVANCED > Advanced > Disable Modules Output and see if there is a module named SM_XPayment or not. Please see Installation Procedure below for installing X-Payment Module. If you have both X-POS web and X-POS ipad app on one Magento site, you just need install X-Payment once. 2. Installation Procedure The installation can be done in two ways, either by using the built in MagentoConnect setup, or by manually uploading files via FTP/SSH. The former gives benefits in terms of checking for potential conflicts, easier re- and de-installing. The latter makes you fully in charge of the update. If you are upgrading from a previous version of X-POS, please skip to point C below. A. Magento Connect installation Use the following steps for installing the extension through Magento Admin: 1. Unzip the downloaded file you received upon purchasing the extension locate to the folder downloaded. 2. Log into Magento Admin 3. Go to System > Magento Connect > Magento Connect Manager 4. Login 5. If you already have X-Payment installed, proceed to step 8. If not, proceed to step 6 6. On tab Extensions select Direct package file upload and browse for the XPAYMENTversion_date.tgz file 7. Click Upload button. Then installing X-Payment module should be successful.

3 8. On tab Extensions select Direct package file upload and browse for the XPOS-version_date.tgz file 9. Click Upload button to install X-POS The extension will install and cache will be flushed, and you can now configure the extension. If the box Put store on the maintenance mode while installing/upgrading/backup creation has been ticked, you will need login to remove the file maintenance.flag from your Magento root folder. B. Manual FTP/SSH installation 1. Unzip the zipped package file, and you will find inside XPAYMENT-version_date.tgz and XPOSversion_date.tgz 2. Unzip these.tgz files, and you will see the following folder structure: 3. Upload the sub-folder in XPAYMENT-version_date folder to install X-Payment module 4. Then upload the three folders in XPOS-version_date including the files to your server. Maintain keep the same level with your Magento root folder. Note, that if you modified an earlier version of the extension, you will have to make sure you changes are manually kept. C. Upgrade from previous version To install the X-POS version 3 as an upgrade to an earlier extension, you will need to ensure that already ongoing data is not overwritten. The following is the step-by-step procedure to handle this: Note, that when upgrading from previous versions of X-POS the re-install procedure differs depending on your previous version. A. If you're running X-POS 2.x: 1. Preparation: Make backup of site and database and disable cache in site 2. Uninstall X-POS v2.4.x completely by delete the following files/folders app\code\local\sm\xpos app\design\adminhtml\default\default\layout\sm\xpos.xml

4 app\design\adminhtml\default\default\template\sm\xpos app\etc\modules\sm_core.xml app\etc\modules\sm_xpos.xml js\sm\xpos skin\adminhtml\default\default\sm\xpos 3. Open database, find 'core_resource' table, delete the record 'xpos_setup' 4. Change $upgrade variable in "app\code\local\sm\xpos\sql\xpos_setup\mysql4-install php" to value 1 (default value is 0 ) 5. Install X-Payment and X-POS version 3.x according to manual installation described above. B. If you're running X-POS 3.x or above: 1. Preparation: Make backup of site and database and disable cache in site 2. Install X-Payment according to manual installation described above 3. Use the manual package, copy and paste the three folders \app, \js and \skin to the same ones in your web folder and confirm to overwrite existing files of X-POS Note, after installing or upgrading successfully, we recommend user should perform the following steps to avoid having 404 or blank page of X-POS: - Log out of Magento Admin and log in again - Flush Magento Storage Cache in Admin Dashboard/System/Cache Management

5 4. Configure Extensions If you install both X-POS web and X-POS ipad app, the file app\etc\modules\sm_xpos.xml should be inserted the following code snippet at the same level with <version> tag: <depends> <SM_XPosAPI /> </depends> The following are the bare minimum configurations that needs to be done to have the X-POS running. Disable SID 1. Go to Magento Admin -> System -> Configuration -> General/Web 2. Go to Sesion Validation Settings 3. Set Use SID on Frontend to value No Shipping Free shipping 1. If you use the POS in a store, please go to Magento Admin -> System -> Configuration -> Tab Sales/Shipping Methods, make sure that Free Shipping is Enabled

6 2. To prevent the Free shipping to display on frontpage you can set a high Minimum order Amount. Default Customer Id 1. From version 3.4, X-POS uses a specific customer in database for Guest Customer (who does not have information before). 2. Please fill the details of Default Customer in your database and enter this Customer Id before using license key of X-POS. Setup Categories to view in X-POS For the default browse mode when entering the X-POS GUI, you can set which categories should be possible view and see products from through the product browse window.

7 You enable categories to display in X-POS in the following way: 1. Go to Catalog > Manage categories 2. Choose one category 3. Choose the tab XPOS 4. Set Enable the X-POS to value Yes, additional you can set a display name and if the category should be default showing when you enter the X-POS GUI 5. Save Category The category will now display in X-POS GUI.

8 Enable License 1. Go to Magento Admin -> Sales -> POS -> Setting 2. Select Enable in box and input the provided license key into License key textbox. 3. Click Save Config. 4. Go to Sales -> POS -> X-POS to check newly installed module.

9 4. Uninstall Extension MagentoConnect Uninstall If you installed the extension via the MagentoConnect setup, the uninstall is done simply by accessing MagentoConnect from your Magento backend and selecting uninstall for the extension. Note, in some cases the MagentoConnect does not remove the full information from table eav_attribute. Run the following SQL query in your DB to make a clean-up: DELETE FROM eav_attribute WHERE attribute_code = 'xpos_default' Manual Uninstall In case you installed the extension manually by updating all the files, you will need to manually remove them again. A quick solution if you just wish to remove all functionalities from your site, is to just renaming the xml main extension file:

10 \app\etc\modules\sm_xpos.xml This will make the X-POS fully disabled. To make a complete uninstall you need to delete all the files uploaded on install and delete all tables created by the extension. The list of files can be found by looking at installation package, and the tables to remove can be found by checking the all SQL queries in the following folder: \app\code\local\sm\xpos\sql 5. Further information Disabling Compilation When installing the extension be aware that you need to deactivate compilation if enabled, otherwise the newly updated files will not run, or will only run partly. To disable compilation take the following steps: 1. Go to "System > Tools > Compilation" 2. Click button "Disable" 3. Clear Cache In case you forgot to disable compilation before installing the extension, the backend might not be accessible, and you will in that case have to disable the compilation manually. You can either do this through SSH or in the config.php file. To disable compilation via SSH, run the following command: php shell/compiler.php disable To disable compilation manually go to /includes/config.php and comment out the following two lines:

11 #define('compiler_include_path', dirname( FILE ).DIRECTORY_SEPARATOR.'src'); #define('compiler_collect_path', dirname( FILE ).DIRECTORY_SEPARATOR.'stat'); After installing the extension, you can enable compilation again in Magento backend. Other issues If the extension does not run properly, check the installation steps above and you are welcome to contact us at our Support Center - Please note that we do not provide any free support for compatibility issues with 3rd party extensions. Check the User guide for further information on the advanced functions of the extensions.