Magestore Open Source POS - Marketplace

Transcription

Magestore Open Source POSMagestore Open Source POSExported on Dec 4, 2021 10:49 AM

Magestore Open Source POS – Magestore Open Source POSTable of Contents1How to Download Magestore POS Open . 32 How to install the open source POS package . 42.1How to Install Brand New Original Magestore POS via SSH . 42.1.12.1.22.1.3Compatibility Check . 4Prerequisite . 4POS Installation . 42.2How to Update Original Magestore POS via SSH . 62.2.12.2.22.2.32.2.4Compatibility Check . 7Prerequisite . 7Update the POS . 7Summary . 83 Getting started. 103.1Quick Guide for Admin . 103.2Quick Guide for Cashier . 103.2.13.2.23.2.3Log in to POS . 10Create orders. 11Refund orders . 164 User Features Guide . 184.1POS & User Management . 184.1.14.1.2How to manage POS . 18How to Manage Staff Users to Magestore POS . 184.2Product Management . 194.2.14.2.24.2.34.2.44.2.54.2.64.2.7How to show products on POS. 19How to Mass Visible Product on POS . 19Why product doesn’t show on POS . 21How POS and Website Share Stock . 22How to Visible Products on POS Only but not Available on Website . 22How to Sell Out of Stock Product on POS but Can not Sell on Website . 23How to Avoid Limiting Display Long Product Name . 244.3Customer Management . 254.3.1How to create a new customer on POS . 255 GNU GENERAL PUBLIC LICENSE . 275.1Preamble . 275.2TERMS AND CONDITIONS . 85.360. Definitions. . 281. Source Code. 282. Basic Permissions. . 293. Protecting Users' Legal Rights From Anti-Circumvention Law. . 294. Conveying Verbatim Copies. . 295. Conveying Modified Source Versions. 296. Conveying Non-Source Forms. . 307. Additional Terms. 318. Termination. 329. Acceptance Not Required for Having Copies. . 3210. Automatic Licensing of Downstream Recipients. . 3211. Patents. . 3312. No Surrender of Others' Freedom. . 3413. Use with the GNU Affero General Public License. . 3414. Revised Versions of this License. 3415. Disclaimer of Warranty. . 3416. Limitation of Liability. . 3417. Interpretation of Sections 15 and 16. 35How to Apply These Terms to Your New Programs . 35LICENSE. 37Table of Contents – 2

Magestore Open Source POS – Magestore Open Source POS1 How to Download Magestore POS Open1. Access our main page for the Open Source POS: open-source-pos.magestore.com2. Click Magestore Open Source POS.3. Fill in your information to help us improve our product, then click the button DownloadPOS Open.You will receive an email with the package to download, so please make sure to leave thecorrect information.All your information will be safe and secured in our system and is only used for further supportand consultation.Your information Magestore Open SourceHow to Download Magestore POS Open – 3

Magestore Open Source POS – Magestore Open Source POS2 How to install the open source POS package How to Install Brand New Original Magestore POS via SSH How to Update Original Magestore POS via SSH2.1 How to Install Brand New Original Magestore POS via SSHOriginal Magestore POS Package is the package that only contains Magestore POSproduct originally (the package is built for widely usage base on Magento freshinstallation, not on any customer environment-specific, so it does not contain any specificfeatures/integration/bug fixing for your environment, some unexpected conflict with otherextensions may occur when installing or after the POS installed).NoticeThis guide applies to the brand new installation of Original Magestore POS on yourwebsite (you don’t have any Magestore POS installed on your website yet). In case thatyou want to migrate from the old Magestore POS system or upgrade across lines of POS,please contact with Magestore Support Team to get a suitable guideline.If you are looking for the guide to install the updated Original Magestore POS, it’shere.2.1.1 Compatibility CheckPlease check the link below to make sure that the POS version you are having is compatiblewith your current Magento version. Magestore POS Open Source Compatibility2.1.2 PrerequisiteMagestore POS Open Source requires MSI to be installed and enabled before installing thePOS. You can follow the guide Install Inventory inventory-management/) from Magento to install andenable MSI.2.1.3 POS Installation2.1.3.1 1. Take a backup of your websiteThe backup will help you recover faster in case that you are failed to install Magestore POS dueto some conflict with other extensions or unexpected incidents while installing the POS.How to install the open source POS package – 4

Magestore Open Source POS – Magestore Open Source POS2.1.3.22. Turn on Maintenancephp bin/magento maintenance:enable2.1.3.33. Turn off Magento Cronphp bin/magento cron:remove2.1.3.44. Turn on Developer modephp bin/magento deploy:mode:set developer2.1.3.5 5. Upload the package to Magento Root Directory Upload file via WinScp (Windows) (https://winscp.net/eng/docs/guide upload) 2.1.3.6Upload package via Filezilla (Windows, Ubuntu) (https://wiki.filezillaproject.org/FileZilla Client Tutorial (en))6. Extract the package and copy it to Magento Root Directorycd magento root directory tar -xf package name cp -R server/* ./2.1.3.77. Run upgrade (Install POS)php bin/magento setup:upgrade2.1.3.88. Deploy POS clientphp bin/magento webpos:deploy2.1.3.99. Run code compilationphp bin/magento setup:di:compile2.1.3.10 10. Install Laminas Barcodecomposer require laminas/laminas-barcode 2.8php bin/magento setup:upgrade2.1.3.11 11. Adjust Redis session configurationNote: This is an optional configuration if you are using Redis for Magento Session. Open file app/etc/env.php in your favorite editor Scroll down to the session section as belowHow to install the open source POS package – 5

Magestore Open Source POS – Magestore Open Source POSFigure 1 Redis configuration Edit the value max concurrency to a suitable number. Magento recommend we setthat number by 10% of the number of PHP processes. If you don’t know that then try inthe range from 6 to 24 is fine. For example 20.2.1.3.12 12. Install Magento Cronphp bin/magento cron:install2.1.3.13 13. Reindex Allphp bin/magento indexer:reindex2.1.3.14 14. Turn on Production modephp bin/magento deploy:mode:set production2.1.3.15 15. Turn off Maintenancephp bin/magento maintenance:disable2.2 How to Update Original Magestore POS via SSHOriginal Magestore POS Package is the package that only contains Magestore POSproduct originally (the package is built for widely usage base on Magento freshinstallation, not on any customer environment-specific, so it does not contain any specificfeatures/integration/bug fixing for your environment, some unexpected conflict with otherextensions may occur when installing or after the POS installed).How to install the open source POS package – 6

Magestore Open Source POS – Magestore Open Source POSNoticeThis guide applies to install the updated version of Original Magestore POS on yourwebsite (the major, minor, or the patch update of your current installed Magestore POS).In case that you want to migrate from the old Magestore POS system or upgrade acrosslines of POS, please contact with Magestore Support Team to get a suitable guideline.2.2.1 Compatibility CheckPlease check the link below to make sure that the POS version you are having is compatiblewith your current Magento version. Magestore POS Open Source Compatibility2.2.2 PrerequisiteMagestore POS Open Source requires MSI to be installed and enabled before installing thePOS. You can follow the guide Install Inventory inventory-management/) from Magento to install andenable MSI.2.2.3 Update the POS2.2.3.1 1. Take a backup of your websiteThe backup will help you recover faster in case that you are failed while updating MagestorePOS due to some conflict with other extensions or unexpected incidents.2.2.3.22. Turn on Maintenancephp bin/magento maintenance:enable2.2.3.33. Turn off Magento Cronphp bin/magento cron:remove2.2.3.44. Turn on Developer modephp bin/magento deploy:mode:set developer2.2.3.5 5. Terminating the magestore pos process orderTo prevent caching code in the started consumerpkill -f magestore pos process order2.2.3.6 6. Upload the package to Magento Root Directory Upload file via WinScp (Windows) (https://winscp.net/eng/docs/guide upload) Upload package via Filezilla (Windows, Ubuntu) (https://wiki.filezillaproject.org/FileZilla Client Tutorial (en))2.2.3.7 7. Extract the package and copy it to Magento Root DirectoryWe always distribute the full package to keep the consistency, the full package means itincludes all earlier releases of the current package that you are having.How to install the open source POS package – 7

Magestore Open Source POS – Magestore Open Source POScd magento root directory rm -rf app/code/Magestoretar -xf package name cp -R server/* ./2.2.3.88. Run upgrade command (Update POS)php bin/magento setup:upgrade2.2.3.99. Deploy POS clientphp bin/magento webpos:deploy2.2.3.10 10. Run code compilationphp bin/magento setup:di:compile2.2.3.11 11. Install Magento Cronphp bin/magento cron:install2.2.3.12 12. Reindex Allphp bin/magento indexer:reindex2.2.3.13 13. Turn on Production modephp bin/magento deploy:mode:set production2.2.3.14 14. Turn off Maintenancephp bin/magento maintenance:disable2.2.4 SummaryYou can use the below script for automating the update process.Make sure that you change the magento root directory and package name withthe suitable value cause it is the variable.How to install the open source POS package – 8

Magestore Open Source POS – Magestore Open Source POScd magento root directory php bin/magento maintenance:enablephp bin/magento cron:removephp bin/magento deploy:mode:set developerpkill -f magestore pos process orderrm -rf app/code/Magestoretar -xf package name cp -R server/* ./php bin/magento setup:upgradephp bin/magento webpos:deployphp bin/magento setup:di:compilephp bin/magento cron:installphp bin/magento indexer:reindexphp bin/magento deploy:mode:set productionphp bin/magento maintenance:disableHow to install the open source POS package – 9

Magestore Open Source POS – Magestore Open Source POS3 Getting started Quick guide for Admin to setup and config POS. Quick guide for Cashier to daily working on POS3.1 Quick Guide for AdminBelow is the quick guide for Admin to configure POS settings. How to Manage POS How to Manage Staff Users to Magestore POS How to Display Product on POS3.2 Quick Guide for CashierMagestore POS gives cashiers the tools and information to check out quickly. This guidewalks you through your basic sales operations, from opening shift to making salesthroughout the day. For more detailed instructions, check the linked articles.On this page Log in to POS Create orders Refund orders3.2.1 Log in to POSLog in with your username and password to start selling.POS using separate user management with Magento, If you never create a use, pleasefollow How to manage POS Staff User to create a new one.Getting started – 10

Magestore Open Source POS – Magestore Open Source POS3.2.2 Create ordersFollow these 6 steps to check out on POS:3.2.2.1 Step 1. Add productSearch and select the product to cart and the quantity.Getting started – 11

Magestore Open Source POS – Magestore Open Source POSFigure 2 Add product to cart on POS3.2.2.2 Step 2: Add customerSelect a customer for the order. You can use guest checkout, choose an existing customer,or create a new one new-customers-onpos/).Figure 3 Create a new customer on POS3.2.2.3 Step 3: Proceed to paymentOnce you’ve added products and customers, select the Amount button to proceed to payment.Getting started – 12

Magestore Open Source POS – Magestore Open Source POS3.2.2.4 Step 4: Apply discountYou can apply a discount -discount-onpos/) to the whole order with a coupon code, by an amount, or percentage.Figure 4 Apply discount to the whole order on POS3.2.2.5 Step 5: Take paymentUse one of the following options to take payment: Cash Offline credit card Custom paymentGetting started – 13

Magestore Open Source POS – Magestore Open Source POSFigure 5 Add payment methods on POSYou can use cash, credit card, or Square payment methods for one order and accept partialpayment.3.2.2.6 Step 6: Complete the orderAfter payment, complete the order and print the receipt.Getting started – 14

Magestore Open Source POS – Magestore Open Source POSFigure 6 POS receiptGetting started – 15

Magestore Open Source POS – Magestore Open Source POSYou can also use the Reorder button to quickly duplicate an existing order.If a customer doesn’t want to make a purchase yet, you can Hold their order and check outlater.Figure 7 List of hold order3.2.3 Refund ordersIn case you need to refund an order:1. Find the order and start the refund2. Select items to refund3. Make adjustments and review totals4. Select payment to refundGetting started – 16

Magestore Open Source POS – Magestore Open Source POS5. Complete refund and notify customersFigure 8 Refund items on POSGetting started – 17

Magestore Open Source POS – Magestore Open Source POS4 User Features Guide4.1 POS & User Management How to manage POS How to Manage Staff Users to Magestore POS4.1.1 How to manage POS1. Go to Magento Backend POS Manage POS.2. On the POS listing page, click on the Add POS or Edit POS button.3. Input POS Name and Location4.1.2 How to Manage Staff Users to Magestore POS1. Go to the Magento Backend POS in the Admin section, click Manage Staffs.2. To create a new user, click on Add Staff or Edit Staff button.3. Input User Info.4. Click SaveFigure 9 Staff listingUser Features Guide – 18

Magestore Open Source POS – Magestore Open Source POSFigure 10 Staff infomation4.2 Product Management4.2.1 How to show products on POS1. In the backend, go to Catalog Inventory Products.2. Select the product you want to change its visibility on POS & website. We take anexample of the product3. On the Product Details page, navigate to the attribute Visible on POS. By default, allproducts have this configuration set to YES with [Global] scope.4.2.2 How to Mass Visible Product on POS1. In the Backend, go to Catalog Inventory Products. Select all the product list.2. In the box Action, choose Update Attributes to change the visibility setting.User Features Guide – 19

Magestore Open Source POS – Magestore Open Source POS3. In the tab Attributes, scroll down to the Visible on POS field. Choose YES or NO to updateproducts’ visibility in bulk.And here is the final results on POS.User Features Guide – 20

Magestore Open Source POS – Magestore Open Source POS4.2.3 Why product doesn’t show on POSSometimes on the POS, you don’t see the product you created in the Magento backend. Hereare 4 common reasons why it happens:1. You set [Enable product] No in the backendIf you don’t enable the product, the product doesn’t show on the POS.Figure 11 disable product2. The configuration “Visible on POS” No in the product detailsIf you set the configuration [Visible on POS] No, the product doesn’t show on POS.3. Product is not updated yet to your local browserIn case the POS is running in offline mode, it will update data based on the time rangeconfigured in the POS setting.You can find these settings under Go to POS SETTINGS SYNCHRONIZATIONUser Features Guide – 21

Magestore Open Source POS – Magestore Open Source POSIn this example, we set the sync time to 5 mins. This means the POS will update product dataevery 5 mins, so any changes won’t be updated immediately. You can wait for the POS toupdate data or manually refresh the POS by pressing F5.4.2.4 How POS and Website Share StockThis open-source POS version only supports Default Stock. It means all locations (that link withthe POS you created) can only link to one default stock. All your stores using POS will share thesame inventory in one warehouse. The website also shares the default stock with locations(POS).To use multiple stocks for different warehouses and stores (omnichannel solution), pleaseupgrade to our Commerce plan.Below is the stock linking structure of the Open Source POS solution:4.2.5 How to Visible Products on POS Only but not Available onWebsite1. In Magento Backend Catalog Products, choose the Product then Edit.2. Toggle Visible on POS to Yes.User Features Guide – 22

Magestore Open Source POS – Magestore Open Source POS3. In Visibility, choose the option Not Visible Individually4. In Product in Websites, you still need to keep the checked box for Product inWebsite.Figure 12 visible on POS4.2.6 How to Sell Out of Stock Product on POS but Can not Sell onWebsiteIf you want to sell out of stock product on POS, without selling on the website. Please goto Backend POS Settings Checkout section and select setting Add out-of-stockproduct to cart is YESUser Features Guide – 23

Magestore Open Source POS – Magestore Open Source POSIf you don’t want to sell out of stock product on Website, please go to Store Configuration Catalog Inventory Product Stock Options and choose the setting Backorders is Nobackorder4.2.7 How to Avoid Limiting Display Long Product NameSometimes, a long product name is cut off while displaying. It is difficult to realize the productwhile adding to the cart. This problem is shown in the below Screenshot.To avoid this situation, please follow that guide:4.2.7.1 Method 1: Change device screen resolutionMaybe your device screen has low resolution. We suggest go to your OS setting screen to thesuitable resolution. The minimum required screen resolution is: 1400 (w) x 900 (h)User Features Guide – 24

Magestore Open Source POS – Magestore Open Source POS4.2.7.2 Method 2: Change the product nameMaybe the long product name is set into one word. It can no be displayed a long world on thePOS Screen.For example, the name “Dots Wandhaken-Eiche-L”, actually, has 2 words with. We suggest youchange the name to many single words by replacing the “-“ character to space character. Thelast result is “Dots Wandhaken Eiche L”4.3 Customer Management4.3.1 How to create a new customer on POSCreating customers right on your POS is the easiest way to get customer’s insights and boostcustomer experience.1. Login to POS Click on Guest Choose Create Customer. A popup will show up foryou to input your customer’s information.2. Input Information of your Customer then click SaveUser Features Guide – 25

Magestore Open Source POS – Magestore Open Source POSUser Features Guide – 26

Magestore Open Source POS – Magestore Open Source POS5 GNU GENERAL PUBLIC LICENSEVersion 3, 29 June 2007Copyright 2007 Free Software Foundation, Inc. https://fsf.org/ (https://fsf.org/) Everyone is permitted to copy and distribute verbatim copies of this license document, butchanging it is not allowed.5.1 PreambleThe GNU General Public License is a free, copyleft license for software and other kinds ofworks.The licenses for most software and other practical works are designed to take away yourfreedom to share and change the works. By contrast, the GNU General Public License isintended to guarantee your freedom to share and change all versions of a program--to makesure it remains free software for all its users. We, the Free Software Foundation, use the GNUGeneral Public License for most of our software; it applies also to any other work released thisway by its authors. You can apply it to your programs, too.When we speak of free software, we are referring to freedom, not price. Our General PublicLicenses are designed to make sure that you have the freedom to distribute copies of freesoftware (and charge for them if you wish), that you receive source code or can get it if youwant it, that you can change the software or use pieces of it in new free programs, and that youknow you can do these things.To protect your rights, we need to prevent others from denying you these rights or asking you tosurrender the rights. Therefore, you have certain responsibilities if you distribute copies of thesoftware, or if you modify it: responsibilities to respect the freedom of others.For example, if you distribute copies of such a program, whether gratis or for a fee, you mustpass on to the recipients the same freedoms that you received. You must make sure that they,too, receive or can get the source code. And you must show them these terms so they knowtheir rights.Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on thesoftware, and (2) offer you this License giving you legal permission to copy, distribute and/ormodify it.For the developers' and authors' protection, the GPL clearly explains that there is no warrantyfor this free software. For both users' and authors' sake, the GPL requires that modifiedversions be marked as changed, so that their problems will not be attributed erroneously toauthors of previous versions.Some devices are designed to deny users access to install or run modified versions of thesoftware inside them, although the manufacturer can do so. This is fundamentally incompatiblewith the aim of protecting users' freedom to change the software. The systematic pattern ofsuch abuse occurs in the area of products for individuals to use, which is precisely where it ismost unacceptable. Therefore, we have designed this version of the GPL to prohibit the practicefor those products. If such problems arise substantially in other domains, we stand ready toextend this provision to those domains in future versions of the GPL, as needed to protect thefreedom of users.Finally, every program is threatened constantly by software patents. States should not allowpatents to restrict development and use of software on general-purpose computers, but in thosethat do, we wish to avoid the special danger that patents applied to a free program could makeit effectively proprietary. To prevent this, the GPL assures that patents cannot be used to renderthe program non-free.The precise terms and conditions for copying, distribution and modification follow.GNU GENERAL PUBLIC LICENSE – 27

Magestore Open Source POS – Magestore Open Source POS5.2 TERMS AND CONDITIONS5.2.1 0. Definitions.“This License” refers to version 3 of the GNU General Public License.“Copyright” also means copyright-like laws that apply to other kinds of works, such assemiconductor masks.“The Program” refers to any copyrightable work licensed under this License. Each licensee isaddressed as “you”. “Licensees” and “recipients” may be individuals or organizations.To “modify” a work means to copy from or adapt all or part of the work in a fashion requiringcopyright permission, other than the making of an exact copy. The resulting work is called a“modified version” of the earlier work or a work “based on” the earlier work.A “covered work” means either the unmodified Program or a work based on the Program.To “propagate” a work means to do anything with it that, without permission, would make youdirectly or secondarily liable for infringement under applicable copyright law, except executing iton a computer or modifying a private copy. Propagation includes copying, distribution (with orwithout modification), making available to the public, and in some countries other activities aswell.To “convey” a work means any kind of propagation that enables other parties to make orreceive copies. Mere interaction with a user through a computer network, with no transfer of acopy, is not conveying.An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes aconvenient and prominently visible feature that (1) displays an appropriate copyright notice, and(2) tells the user that there is no warranty for the work (except to the extent that warranties areprovided), that licensees may convey the work under this License, and how to view a copy ofthis License. If the interface presents a list of user commands or options, such as a menu, aprominent item in the list meets this criterion.5.2.2 1. Source Code.The “source code” for a work means the preferred form of the work for making modifications toit. “Object code” means any non-source form of a work.A “Standard Interface” means an interface that either is an official standard defined by arecognized standards body, or, in the case of interfaces specified for a particular programminglanguage, one that is widely used among developers working in that language.The “System Libraries” of an executable work include anything, other than the work as a whole,that (a) is included in the normal form of pa

php bin/magento webpos:deploy 2.2.3.10 10. Run code compilation php bin/magento setup:di:compile 2.2.3.11 11. Install Magento Cron php bin/magento cron:install 2.2.3.12 12. Reindex All php bin/magento indexer:reindex 2.2.3.13 13. Turn on Production mode php bin/magento deploy:mode:set production 2.2.3.14 14. Turn off Maintenance