logo
Magento® Extensions Guide
Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors

Magento 2 FAQ Module – Installation Guide

by

Installation Guide
Version 1.0.0

  1. Introduction

1. INTRODUCTION

  • After purchasing the ‘Rootways FAQ’ extension you will receive an email from us with your Domain License Key. Use this Domain and License Key to activate the extension for your Magento website. If you don’t receive an email please contact our support team by emailing us at [email protected] (NOTE: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. After connecting to your website, using FTP, create a “Rootways” directory under app/code/ then create a “Faq” directory under app/code/Rootways.
  • After creating these directories, extract the extension zip file and upload it under app/code/Rootways/Faq directory.
  • After uploading this, run this command from SSH php bin/magento setup:upgrade
  • After running the above script you will be able to see the new FAQ tab in admin.

NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 Moneris Payment Module – Installation Guide

by

Installation Guide
Version 1.0.0

  1. Introduction

1. INTRODUCTION

  • After purchasing the ‘Rootways Moneris Payment Module’ extension you will receive an email from us with your Domain License Key. Use this Domain and License Key to activate the extension for your Magento website. If you don’t receive an email please contact our support team by us emailing at [email protected] (Note: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. After connecting to your website, using FTP, create a “Rootways” directory under app/code/ then create a “Moneris” directory under app/code/Rootways.
  • After creating these directories, extract the extension zip file and upload it under app/code/Rootways/Moneris directory.
  • After uploading this, run this command from SSH php bin/magento setup:upgrade
  • After running the above script you will be able to see the Moneris Payment method in the Payment method section of admin.

NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 Elavon/Coverage Module – Installation Guide

by

Installation Guide
Version 1.0.1

  1. Introduction

Introduction

  • After purchasing the ‘Rootways Elavon Credit Card Payment Module’ extension you will receive an email from us with your Domain License Key. Use this Domain and License Key to activate the extension for your Magento website. If you don’t receive an email please contact our support team by emailing at [email protected] (Note: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. Unzip the extension package file into the root directory of your Magento 2 website installation.
  • After unzipping the extension file, you will be able to see the “Elavon” directory at app/code/Rootways/.
  • After uploading this, run this command from SSH php bin/magento setup:upgrade.
  • Then, run this command from SSH only if your Magento 2 website is in “Production” mode php bin/magento setup:static-content:deploy.
  • After running the above script, you will be able to see the Elavon payment method in the payment method section of admin.

License Activation

How to activate the extension?

  • Go to your Magento website admin -> STORES -> Configuration -> ROOTWAYS EXTENSIONS -> Elavon Payment.
  • Here you will be able to see the “License Key” text field. Enter the license key sent by us to your registered email.
  • Here you’ll see another field “Is Multi Store”. Set it to “Yes” if your Magento website is a multi-store setup with different URLs at the front-end. (NOTE: If your website is multi-store setup but does not has different URLs based on store view or website, set it to “NO”)
  • Click the “Save Config” button and if your license key is valid for your domain then the Status will appear as Extension Activated
  • Now you can enable the extension from Admin -> STORES -> Configuration -> SALES -> Payment Methods -> Elavon Payment Method – By Rootways Inc.

How to Get API Details

    Follow the steps below to get below Converge/Elavon APIs details

  • Account ID
  • User ID
  • PIN
  • Step 1: Login to your account using this link

    • https://www.myvirtualmerchant.com/VirtualMerchant/login.do

  • Step 2: View the screenshot below to get “Account ID”
  • Step 3: Go to USER > Find/Edit (NOTE: If you have not created a user before then Create a new user)
  • Step 4: Click the Find button
  • Step 5: Click on your username.
  • Step 6: From here take “User ID” and “Pin”
  • If still you have any question on how to get Converge (Elavon) APIs details then please email Elavon support at [email protected]
  • NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 CardConnect Payment Module – Installation Guide

by

Installation Guide

  1. Introduction

Introduction

  • After purchasing the ‘Rootways CardConnect Payment Module’ extension, you will receive an email from us with your Domain License Key. Use this Domain and License Key to activate the extension for your Magento website. If you don’t receive an email please contact our support team by emailing at [email protected] (Note: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. Unzip the extension package file into the root directory of your Magento 2 website installation.
  • After unzipping the extension file, you can see the “CardConnect” directory at app/code/Rootways/.
  • After uploading it, run this command from SSH php bin/magento setup:upgrade.
  • Then, run this command from SSH only if your Magento 2 website is in “Production” mode php bin/magento setup:static-content:deploy.
  • After running the above script, you will be able to see the CardConnect payment method in the payment method section of admin.

License Activation

How to activate the extension?

  • Go to your Magento website admin -> STORES -> Configuration -> ROOTWAYS EXTENSIONS -> CardConnect Payment.
  • Here you will see the “License Key” text field. Enter the license key sent by us to your registered email.
  • Here you will be able to see another field: “Is Multi Store”. Set it to “Yes” if your Magento website is a multi-store setup with different URLs at the front-end. (NOTE: If your website is a multi-store setup but does not have different URLs based on store view or website, set it to “NO”)
  • Click the “Save Config” button and if your license key is valid for your domain then the Status will appear as Extension Activated
  • Now you can enable the extension from Admin -> STORES -> Configuration -> SALES -> Payment Methods -> CardConnect Payment – By Rootways Inc.
  • NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 Purolator Shipping module – Installation Guide

by

Installation Guide
Version 1.0.0

  1. Introduction

1. INTRODUCTION

  • After purchasing the ‘Rootways Purolator Shipping Module’ extension, you will receive an email from us with your Domain License Key. Use this Domain and License Key to activate the extension for your Magento website. If you don’t receive an email, please contact our support team by emailing at [email protected] (Note: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. After connecting to your website, using FTP, create a “Rootways” directory under app/code/ then create a “Purolator” directory under app/code/Rootways.
  • After creating the above directories, extract the extension zip file and upload under app/code/Rootways/Purolator directory.
  • After uploading, run this command from SSH php bin/magento setup:upgrade
  • After running the above script, you will be able to see the Purolator Shipping method in the shipping method section of admin.

NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 Canada Post Shipping Module – Installation Guide

by

Installation Guide
Version 1.0.0

  1. Introduction

1. INTRODUCTION

  • After purchasing the ‘Rootways Canada Post Shipping Module’ extension you will receive an email from us with your Domain License Key. Use this Domain and License Key for activating extension for your Magento website. If you haven’t received any email please contact our support team by emailing at [email protected] (NOTE: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. After connect to your website using FTP create “Rootways” directory under app/code/ then create “Canadapost” directory under app/code/Rootways.
  • After creating directories, extract extension zip file and upload under app/code/Rootways/Canadapost directory.
  • After uploading, run this command from SSH php bin/magento setup:upgrade
  • After running above script you can see Canada Post Shipping method at shipping method section of admin.

NOTE: If you are still having any issues or have questions about our extension, please feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 PSIGate Payment Module – Installation Guide

by

Installation Guide
Version 1.0.0

  1. Introduction

1. INTRODUCTION

  • After purchasing the ‘Rootways PSiGate Payment Module’ extension you will receive an email from us with your Domain License Key. Use this Domain and License Key for activating the extension for your Magento website. If you don’t received an email, please contact our support team by us emailing at [email protected] (Note: Please read our License Terms and Conditions carefully before using our products.)
  • Use FTP Client (e.g. FileZilla or WinSCP) to upload all files and folders of the extension to your Magento site. After connecting to your website, using FTP, create a “Rootways” directory under app/code/ then create a “Psigate” directory under app/code/Rootways.
  • After creating these directories, extract the extension zip file and upload under app/code/Rootways/Psigate directory.
  • After uploading this, run this command from SSH php bin/magento setup:upgrade
  • Run this command from SSH php bin/magento setup:static-content:deploy
  • After running the above script, you will be able to see the PSiGate payment method in the payment method section of admin.

NOTE: If you are still having any issues or have questions about our extension, feel free to email us at [email protected] with all your questions and we will be more than happy to assist you.

Magento 2 PSIGate Payment Module – User Guide

by

User Guide
Version 1.0.0
Table of Contents

1. INTRODUCTION

  • Magento PSiGate payment gateway extension specializes for capturing payment from credit card to your PSiGate account.
  • Rootways PSiGate Extension is quite easy to install and configure. Just enable payment method, add your PSiGate information and you can use PSiGate Payment Method for your website or Magento store.
  • No technical knowledge required!

Features Listing:

  • Choose payment action as Authorize Only or Authorize and Capture (Sale)
  • Refund payment from Magento admin.
  • Secure payment method
  • Easy to install and configure.
  • User Friendly Interface.
  • Reliable and Prompt Support by Rootways

2. HOW TO USE AND CONFIGURE

This section will guide you to configure Rootways PSiGate Payment Gateway Extension. It is quite easy and fast!

2.1 License Key Settings:
  • Log in to Admin Panel and then click STORES -> Configuration -> ROOTWAYS EXTENSIONS -> PSiGate Payment -> Settings
  • Below is the screen shot of PSiGate Payment Gateway license key settings. Please enter license key for this extension emailed to you by us after your purchase.
2.2 PSIGate Payment Method Management:
  • Go to STORES -> Configuration -> SALES -> Payment Methods -> PSiGate Payment Method – By Rootways Inc.
  • You can see below screen. Fill up all required detail and save it.
  • Enable: You can enable/disable this payment method using this option.
  • Title: Title of the payment method to be visible at front side.
  • PSiGate Store ID:Add store ID of your PSiGate account.
  • PSiGate Passphrase:Add passphrase of your PSiGate account.
  • Test Mode:Choose whether to enable/disable the test mode.
  • Credit Card Verification: If set to ‘No’ then CVC will not be checked while placing order
  • Payment Action: Choose whether it is Authorized Only or Sale.
  • Credit Card Types: Choose type of credit cards that you want to display at front-end
  • Email Customer: If set to ‘Yes’ then email will send to customer
  • Merchant Email: Add merchant email.
  • New order status: Choose whether new order status is pending or processing
  • Debug: If set to ‘Yes’ then you can check log of it.
  • Payment from Applicable Countries: Choose whether you want to allow payment method for all or specific countries only.
  • Payment from Specific Countries: Select countries in which you want to allow this payment method.

Front End:

  • After setting up PSiGate Payment Method you can see it on the checkout page, as in the screenshot below. Now you can capture ample amount of orders using PSiGate extension.
  • That’s how easy it is to use PSiGate Payment Gateway extension/ by Rootways. Please contact us for any queries regarding Magento and custom web-development of E-commerce websites.

Magento 2 FAQ Module – User Guide

by

User Guide
Version 1.0.0
Table of Contents

1. INTRODUCTION

  • FAQ stands for ‘Frequently Asked Questions’, a well written and organized FAQ page has the same order of importance as Home and other main CMS pages. If you spend too much time and money on website emails & customer-service calls answering the same set of questions to your customers about your services or products; then including Rootways FAQs in your website can benefit you in many ways financially and also make your website’s user experience better than ever!
  • Rootways Stripe Extension is very easy to install and configure. Just enable payment method, add your Stripe information and you can use Stripe Payment Method for your website
  • No technical knowledge required!You can flexibly set up your FAQ page as per your requirements.
  • You don’t need to worry about your site speed. Rootways FAQs. doesn’t affect your site speed.
  • Let’s take a look at its Features below:

Features Listing:

  • Manage Categories of FAQs and edit it anytime from admin.
  • Sort orderof Categories to display accordingly on FAQ page on front end.
  • Enable/Disablespecific Category of FAQs in a single click.
  • Set minimum and maximum order total for allow payment method
  • Add FAQ Titleand its Answers in Description to display it on front end.
  • Group the FAQs by assigning them Categories..
  • Most FAQs: Tell your users which questions are most frequently asked by assigning the questions to this Category.
  • Display Q&A in collapsible pull-out panels making space for more questions.
  • Refer specific topic by keyword search for FAQs which shows keywords not only in questions but also answers.
  • Easy to Install and Configure,User FriendlyInterface.
  • Reliable and Prompt Supportby Rootways to help you solve any difficulties in using FAQs extension.

2. HOW TO USE AND CONFIGURE

This section will show you how to configure Rootways FAQs Extension. It’s very easy and fast!

2.1 General Settings:
  • This section will show you how to manage FAQs from Configuration settings.Log in to Admin Panel and then click STORES->Configuration->ROOTWAYS EXTENSIONS->FAQs.See the below Screen shot of FAQs Settings and along with detailed description of each setting.
  • Enable: Enable/Disable FAQs using this setting.
  • License key: Enter license key that was sent to you by Rootways via email.
  • Number of FAQs per page: Add the number of FAQ you want to display on each page.
  • Page Title: Enter the title of the FAQ page on front end.
  • Meta Keywords: Add all relative keywords for your FAQ page that can also help with your website’s SEO.
  • Meta Description: Here you can add Meta description for your front end FAQ page.
2.2 FAQs Management :
    • This section will show you how to manage FAQs.Go to ROOTWAYS FAQS->Manage FAQ.
    • Add FAQs: Click on “Add New FAQ” button from top right to add new FAQs, when you click on button you will see a page like screenshot as below.
    • There are 6 fields under FAQ General Tab.
    • Status: Select ‘Enabled’ to display the question on front end and ‘Disabled’ if you don’t want to display the question.
    • Title: Title of the Question.
    • Description:Answer to the specific question, introduction of your product or particular service.
    • Most Frequently:Select ‘Yes’ to feature all the questions that are most frequently asked by the users otherwise ‘No’. This category will display above all other categories.
    • Category:Select the category for the question and group that categories’ questions together.
    • Store View: Select in which store you want to display this FAQ.
    • Sort Order:Enter the order you want this question to be displayed at.
    • After filling all required information for FAQs click on ‘Save FAQ’ or ‘Save and Continue Edit’.Now check the front-end of your website, reload it and you’ll be able to see the group of category for FAQs, Search bar for keyword search and FAQs in collapsible manner.
Manage FAQ List From Admin::
    • You can see the list of all FAQs underAdmin->ROOTWAYS FAQS->Manage FAQ.You can search FAQs by Title, Description, Category, Most Frequently, Sort Order and Status. You can edit FAQ by clicking on edit action or click on any FAQ. Default order of FAQs is based on ascending Sort Oder of FAQs. Below is the screenshot that features FAQs list:
    • You can also delete any FAQ. To delete any question, edit or click on the question and then’Delete’ button. You can see the ‘Delete’ button in screenshot below:
Manage FAQ Categories From Admin::
  • You can organize questions for particular topic by assigning them to a category. You can manage FAQ categories fromAdmin->ROOTWAYS FAQS->Manage Category.You can Add, Edit and Delete any category of FAQ from this tab. Add sort order and status of the Category. Categories will be shown as per sort order and you can set ‘Enabled’/’Disabled’ status for the category if you want it to be displayed or temporarily removed from the categories list.
  • You can also delete any FAQ Category. To delete any category, edit or click on the category and then ‘Delete’ button. You can see the ‘Delete’ button in screenshot below:

FRONT END

    • After successfully install our FAQ extension, automatically generate URL for FAQ page at front end and you can access FAQ page using below URL.

http.//YOUR_DOMAIN/index.php/faq

    • All the categories that you have added for the FAQs will be shown in the Left sidebar.Simply click on the Category name to see all the FAQs related to that particular category on the right side. All the FAQs are listed on the right side in collapsible pull-out manner meaning the answers for the questions will be revealed when clicked on the question.
    • Want to refer particular topic without having to go through all the questions?! Then just search the keyword related to the topic in the Search bar above the questions. You’ll be able to see the questions with that keyword as well as answers featuring the keyword.
    • Rootways FAQs extension gives you the facility to include Pagination in your FAQ page without having to write a single line of code! Just add how many questions you want to be shown in a page from ‘ROOTWAYS FAQS’->’Configuration’->’Number of FAQs per page’ field.
    • Another unique feature of Rootways FAQs extension is that the FAQ page of your website is changed using AJAX without the whole page being loaded. Use of AJAX for the FAQ page greatly improves your website’s performance as it delivers quick responses.
RESPONSIVE FAQs Page:
  • Rootways FAQs Extension is fully Responsive and flexible. Our Fully Responsive FAQs Extension refers that your website will have the same user experience on any device having different screen sizes. It suggests that our extension is adjustable to any screen size.
  • That’s how easy it is to use FAQs extension by Rootways. Please contact us for any queries regarding Magento and custom web-development of E-commerce websites.

Magento 2 Canada Post Shipping module – User Guide

by

User Guide Version 1.0.0 Table of Contents

2.3 Store Information

 

1. INTRODUCTION

    • Integrate Canada Post API with Magento 2 to provide your customers with the real time Canada Post shipping rates using our Magento 2 Canada Post Shipping extension. Our extension auto-calculates live shipping cost based on shipping source and delivery destination. Also, it imparts quick and the easiest way to get the shipping charges from the Canada Post APIs.

Let’s take a look at its Features below:

Features:

  • Get real time Canada Post shipping rates.
  • Get shipping rates for the addresses within Canada and outside Canada also.
  • Generate shipping labels from the Magento admin.
  • Get a shipping tracking code
  • Display the expected delivery date along with the shipping method at the front-end
  • Add Handling Fees from the Magento admin.
  • Set Free Shipping Methods.
  • Get shipping rates including or excluding tax
  • Choose from the Magento admin whether you want to display all shipping methods or specific for your website.
  • Enter default box dimensions from the Magento admin.
  • Choose the reason for the export of products from the Magento admin.
  • Choose the language of error messages from English or French.
  • Display shipping rates including or excluding tax.
  • Fully manageable from Magento admin
  • Easy to set up and use.
  • Support by Rootways – any questions we are here to help you.

2. HOW TO USE AND CONFIGURE

This section will show you how to configure Rootways Canada Post shipping extension from the Magento admin.

2.1 Shipping Method Settings:
  • Log in to Admin Panel and then click STORES -> Configuration -> SALES -> Shipping Methods.
  • Status : If extension is activated successfully then you will see “Extension Activated” here, if this message is not there then something is wrong with your extension license key. Please contact us at [email protected]for license key related issues.
  • Enable : Enable/Disable this shipping method from here.
  • Mode : If your Canada Post APIs details are of sandbox account then set it to “Development” otherwise set it to “Production”.
  • Local : Choose in which language you want to display shipping label.
  • API Key : Add your Canada Post account API username here. Check below screenshot for your reference. Also, check this link how you can get API Keys,https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/gettingstarted.jsf
  • Password : Add Canada Post API password here, check above screenshot to know from where you can get Password.
  • Customer Number : Add your Canada Post account customer number here
  • Allowed Shipping Services : Select Canada Post shipping methods which you want to display at checkout steps.
  • Show Estimated Delivery Date : Choose whether you want to display estimated delivery date along with shipping method at the checkout or not. Check below screenshot for your reference.
  • Handling Fee Type : If you want to add extra fees to shipping rates then you can do it with our module, select whether you want to add fees as “Fixed” amount or in “Percentage”
  • Handling Fee : Add amount of fees here, this amount will be added in the shipping cost.
  • Rates Price Type : Choose whether you want to display shipping rate with or without tax at the front-end.
  • Maximum Package Weight: Set maximum weights for shipment, any order total weight more than this will not display shipping rates at the front-end.
  • Default Box Width : Add default box width here, this will be passed while fetching shipping rates at the front-end. If this value is blank, then shipping rate are retrieved based on weight only.
  • Default Box Length : Add default box length here, this will be passed while fetching shipping rates at the front-end. If this value is blank, then shipping rate are retrieved based on weight only.
  • Default Box Height : Add default box height here, this will be passed while fetching shipping rates at the front-end. If this value is blank, then shipping rate are retrieved based on weight only.
  • Enable Free Shipping Threshold : If you want to give free shipping then set it “Enable”
  • Free Shipping Amount Threshold : Enter amount (subtotal) here for free shipping method, if subtotal is equal or grater than this amount then you can see free shipping method at the front-end.
  • Free Method for Canada : Select shipping method that you want to display as free shipping method at the front-end. This method is displayed as free only when customer shipping address is in Canada.
  • Free Method for US : Select shipping method that you want to display as free shipping method at the front-end. This method is displayed as free only when customer shipping address is in USA.
  • Free Method for International : Select shipping method which you want to display as free shipping method at the front-end. This method is displayed as free only when customer shipping address is other than Canada and US.
  • Reason for Export : If you are shipping outside Canada then please select reason for your export here.
  • Ship to Applicable Countries : Choose from here whether you want to display this shipping method for all countries or for specific countries
  • Ship to Specific Countries : If above option is set to “Specific Counties” then you must select counties here in which you want to display this shipping method.
  • Show Method if Not Applicable : Set to “Yes” if you want to display error message at the front-end when this shipping method is not applicable for the customer current cart items.
  • Show Error Message from Canada Post Response : If set to “Yes” then you can see error message exactly send by Canada Post response API. This error message may not be user friendly, so we recommended to set it to “Yes” on the development website only. If it set to “No” then the error message entered in below “Displayed Error Message” text area will be displayed at the front-end when no shipping method is available.
  • Displayed Error Message : Write error message that you want to display at the front-end when shipping method is not applicable.
  • Sort Order : Enter sort order of this shipping method at checkout page.
2.2 Shipping Origin Settings:
  • Log in to Admin Panel and then click STORES -> Configuration -> SALES -> Shipping Settings.
  • Add address from where you will ship your products to customers. This address must be valid Canadian address only
2.3 Store Information:
  • Log in to Admin Panel and then click STORES -> Configuration -> GENERAL -> General.
  • Enter your store information here. Without this detail, our extension cannot generate shipment rates from the admin

Front End:

  • You can see Canada Post shipping rates at front-end based on your origin address and shipping address entered by customer on checkout page. Shipping address entered on the checkout page must be correct address to get shipping rates from the Canada Post.

Admin

  • You can generate shipment (shipping label) directly from the Magento admin order. You can see “Create Shipping Label” checkbox while you are generating shipment from the admin, just check that check box and you can generate shipping label along with the Magento shipment. Check below screenshots for more clarification.