Table of Contents
Custom Success Page v2.x Installation and User Manual
| Latest version: | 2.0.3 |
|---|---|
| Compatibility: | Magento 2.2.x, 2.3.x,2.4.x |
Disclaimer
This is the installation and user manual for the Magento Custom Success Page v2.x extension created by Solide Webservices. Although great care has been taken to ensure the accuracy and completeness of this manual, Solide Webservices is unable to accept any legal responsibility concerning errors or ommisions in this document.
You are not allowed to copy or edit the content or the layout of this document. If you would like to redistribute the content of this document please contact Solide Webservices.
Installation, Upgrade and Deinstallation
Installation for extensions purchased throught the Magento Marketplace
If you purchased the extension through the Magento Marketplace, please follow the steps to install the extension as described in the Magento Docs here: https://docs.magento.com/marketplace/user_guide/buyers/install-extension.html
Installation for extensions purchased on https://solidewebservices.com
The zip package you have downloaded from the webshop of Solide Webservices contains a link to this manual and a folder called upload. This upload folder contains the files of the extension and will be used to install the extension through (s)FTP.
System Requirements
- Magento version 2.x or higher
- PHP version 5.6.0 for 2.x or 2.1 or PHP 7.1 for Magento 2.2
Installation through command line
Installing modules is a little different in Magento 2 and requires some technical knowledge. If you are unfamiliar with this please read the Magento2 documentation.
Follow the steps below to install the extension for the first time.
- Backup your web directory and webshop database;
- Disable caching;
- Extract the zipfile you have downloaded after your purchase and copy the content of the 'upload' folder to the root of your webshop (for instance using an FTP client);
- Navigate to your webshop root in the console of your SSH client and execute the following command:
php -f bin/magento module:enable SolideWebservices_Customsuccesspage --clear-static-content
- Then run the following command:
php -f bin/magento setup:upgrade
- Flush the cache en reenable it. Log out from the backend and log in again to refresh autorisations for the new transactions.
In case you are running a configuration different then the Magento recommended server configuration it may be required to run the following command to deploy the new static files:
php -f bin/magento setup:static-content:deploy
Upgrading through command line
- Backup your web directory and webshop database;
- Disable caching;
- Extract the zipfile you have downloaded after your purchase and copy the content of the 'upload' folder to the root of your webshop (for instance using an FTP client);
- Navigate to your webshop root in the console of your SSH client and execute the following command:
php -f bin/magento setup:upgrade
- Flush the cache en reenable it. Log out from the backend and log in again to refresh autorisations for the new transactions.
In case you are running a configuration different then the Magento recommended server configuration it may be required to run the following command to deploy the new static files:
php -f bin/magento setup:static-content:deploy
Uninstallation through command line
Installation of modules is done through the command line as well, for more information please have a look at the Magento2 documentation.
- Backup your web directory and webshop database;
- Disable caching;
- Navigate to your webshop root in the console of your SSH client and execute the following command:
php -f bin/magento module:disable SolideWebservices_Customsuccesspage --clear-static-content
- Flush the cache en reenable the cache again.
- Remove the folder called 'Customsuccesspage' located at /app/code/SolideWebservices/. If you have no other extension of Solide Webservices installed you can also remove the folder called 'SolideWebservices' in /app/code/.
Frontend
In this section you can see most of the functionality how it can be shown on the frontend of your Magento webshop. These are just examples but will give you a good idea of the endless posibilities.
Custom Success Page
Success page viewer
This extension comes with an option that will allow you to view the success page without having to place an actual order. Very confenient when you are customizing the success page and want to see the result.
Order summary and ordered items details
Display full order summary including shipping details and/or details about the products that have been ordered allowing customers to verify that their order has been processed correctly and building your customers trust.
Newsletter subscription
Have your customers directly subscribe to your newsletter, straight after their order allowing them to keep up to date with any news.
Feedback form
Feedback allows for continuous improvement. A feedback form on the success page allows for customers to share their shopping experience with you are directly ask questions after their order.
Related products
Use the success page to generate extra sales by showing extra products a customer might be interested in. These products are related to the ordered products and can be the related and/or cross sell products.
Social Media
Integration with several social media networks allowing customers to share your website or the actual products they have ordered.
Use variables in CMS blocks
You can add virtually any information you want on the success page by using CMS blocks. This extension allows you to use certain variables that relate to the order allowing you to further personalize the success page for your customers.
Backend Settings
The extension settings for the Custom Success Page v2.x extension can be found through the Magento backend menu under “Stores > Settings > Configuration > Solide Webservices > Custom Success Page”.
FIELDSET GENERAL
Use these settings to control the behaviour of the extension.
| Setting | Value | Description |
|---|---|---|
| Enable Extension | Yes / No | This allows you to enable or disable the extension on a global level. If “No” is selected here the default order success page will be used and all other configuration options will be hidden. |
| Enable Custom Success Page Viewer | Yes / No | The Custom Success Page Viewer allows you to directly view the order success page. It allows you to setup this page to your liking without having to place an order every time. Only use this for testing purposes as it discloses sensitive customer data. |
| Custom Success Page Viewer Order ID | Number | Only visible when the Custom Success Page Viewer is enabled. Set the ID of the order to be viewed. If left empty the latest order will be selected. |
| Custom Success Page Viewer Access | IP addresses | Only visible when the Custom Success Page Viewer is enabled. Comma seperated list of IP address that have access to the Custom Success Page viewer, empty allows everyone. This allows you to restrict access when testing on a live environment. |
| Link To Custom Success Page | Info | Shows a link to the Custom Success Page Viewer. Opens in a new window. |
FIELDSET PAGE SUMMARY
Use these settings to configure some general settings of the Custom Success Page.
| Setting | Value | Description |
|---|---|---|
| Page Title | Text | Configure a custom page title which is shown at the top of the custom success page. |
| Show Order Print Button | Yes / No | Show a print button at the right top of the Custom Success Page where logged in users can print their order straight away. This button is only shown to logged in users. |
| Intro Text | HTML | Configure a custom intro text using the rich text editor. You can use certain tags which will be replaced with the corresponding data on the custom success page. The tags are outlined in the comment field of the text editor. |
| Continue Shopping Button Link | URL | Set the URL of the Continue Shopping button at the bottom of the custom success page. If left empty the default value will be used which is the homepage of the webshop. |
| Show Registration Button | Yes / No | Show a button below the intro text which allows non-registered users to register an account. This is a default Magento template and can not be customized. |
| Select Page Summary Right Block | Custom Select | This field allows you to choose what block you want to show at the top right of the Custom Success Page. You can choose between any custom CMS block, a feedback form or the order summary which is the default for this block. |
FIELDSET NEWSLETTER
Use these settings to configure the newsletter subscription field on the Custom Success Page.
| Setting | Value | Description |
|---|---|---|
| Show Newsletter Subscription Form | Yes / No | Choose to show the newsletter subscription field on the Custom Success Page. It will be shown below the page summary intro text. |
| Newsletter Subscription Form Title | Text | Set the title which is shown above the subscription form. |
| Newsletter Subscription Intro Text | Text | Add an intro text above the newsletter subscription form. Use it to inform your clients why to should register for your newsletter Success Page. You can choose between any custom CMS block, a feedback form or the order summary which is the default for this block. |
FIELDSET ORDERED ITEMS
Use these settings to configure the ordered items section which shows details of the ordered products on the Custom Success Page.
| Setting | Value | Description |
|---|---|---|
| Show Ordered Items | Yes / No | Choose to show the ordered items section on the custom success page. |
| Section Sort Order | Number | Only visible when “Show Ordered Items” is set to “Yes”. Set the sort order of this section. Together with the sort order of the related products and cms blocks sections this will determine the order in which these sections are shown on the Custom Success Page. |
| Ordered Items Section Title | Text | Only visible when “Show Ordered Items” is set to “Yes”. Here you can set a custom title for this section. |
| Show Ordered Items Grand Totals | Yes / No | Only visible when “Show Ordered Items” is set to “Yes”. Choose to show the grand totals of the items ordered in this section. |
| Show CMS Block Next To Ordered Items | Custom Select | Only visible when “Show Ordered Items” is set to “Yes”. Allows you to show a block besides to ordered items. This block can be a CMS block of your choice, a feedback form or the order summary. |
FIELDSET RELATED PRODUCTS
Use these settings to configure the related products section which shows related and/or cross-sell products based on the items ordered on the custom success page.
| Setting | Value | Description |
|---|---|---|
| Show Related and/or Cross-Sell Products Section | Yes / No | Choose to show the related products section on the custom success page. |
| Section Sort Order | Number | Only visible when “Show Related and/or Cross-Sell Products Section” is set to “Yes”. Set the sort order of this section. Together with the sort order of the ordered items and cms blocks sections this will determine the order in which these sections are shown on the Custom Success Page. |
| Related Products Section Title | Text | Only visible when “Show Related and/or Cross-Sell Products Section” is set to “Yes”. Here you can set a custom title for this section. |
| Select Which Related Products To Show | Custom Select | Only visible when “Show Related and/or Cross-Sell Products Section” is set to “Yes”. Determine which product relations will be shown in this section. This can be related products, cross-sell products or both in relation to the ordered items. |
| Number Of Related Products To Show | Number | Only visible when “Show Related and/or Cross-Sell Products Section” is set to “Yes”. This configures the maximum number of products that will be shown in this section. |
| Show CMS Block Next To Related Products | Custom Select | Only visible when “Show Related and/or Cross-Sell Products Section” is set to “Yes”. Allows you to show a block besides to related products. This block can be a CMS block of your choice, a feedback form or the order summary. |
FIELDSET CMS BLOCKS
Use these settings to configure the cms blocks section which shows the selected CMS blocks on the custom success page. You can use certain tags in yoru CMS blocks which will be replaced with the corresponding data on the custom success page. The tags are outlined at the top of this fieldset.
| Setting | Value | Description |
|---|---|---|
| Show CMS Blocks Section | Yes / No | Choose to show (extra) CMS blocks on the Custom Success Page. |
| Section Sort Order | Number | Only visible when “Show CMS Blocks Section” is set to “Yes”. Set the sort order of this section. Together with the sort order of the ordered items and related products sections this will determine the order in which these sections are shown on the Custom Success Page. |
| Select CMS Block 1 To Show | Custom Select | Select the CMS block which you would like to show on the Custom Success Page. |
| Select CMS Block 1 Size | Custom Select | Select the width of the selected CMS block. You can use this settings to show 2 or even 3 CMS blocks beside each other. |
| Select CMS Block 2 To Show | Custom Select | Select the CMS block which you would like to show on the Custom Success Page. |
| Select CMS Block 2 Size | Custom Select | Select the width of the selected CMS block. You can use the settings to show 2 or even 3 CMS blocks beside each other. |
| Select CMS Block 3 To Show | Custom Select | Select the CMS block which you would like to show on the Custom Success Page. |
| Select CMS Block 3 Size | Custom Select | Select the width of the selected CMS block. You can use the settings to show 2 or even 3 CMS blocks beside each other. |
| Select CMS Block 4 To Show | Custom Select | Select the CMS block which you would like to show on the Custom Success Page. |
| Select CMS Block 4 Size | Custom Select | Select the width of the selected CMS block. You can use the settings to show 2 or even 3 CMS blocks beside each other. |
FIELDSET SOCIAL MEDIA INTEGRATION
Use these settings to configure the cms blocks section which shows the selected CMS blocks on the custom success page. You can use certain tags in yoru CMS blocks which will be replaced with the corresponding data on the custom success page. The tags are outlined at the top of this fieldset.
| Setting | Value | Description |
|---|---|---|
| Show Global Social Buttons | Yes / No | Choose to show social media share buttons at the top right of the Custom Success Page. These buttons will share the website main URL and will also show share counts if available and enabled. |
| Show Global Social Share Count | Yes / No | Only visible when “Show Global Social Buttons” is set to “Yes”. This enabled or disables showing a share count. |
| Global Social Share Text | Textarea | Only visible when “Show Global Social Buttons” is set to “Yes”. Set the default text which will be pre-filled when sharing the website on Twitter and Pinterest. You can use the tag website to replace it with the website name. |
| Show Facebook Button | Yes / No | Choose to show the Facebook share button when social media buttons are enabled. |
| Show Twitter Button | Yes / No | Choose to show the Twitter share button when social media buttons are enabled. |
| Show Pinterest Button | Yes / No | Choose to show the Pinterest share button when social media buttons are enabled. |
| Show Google+ Button | Yes / No | Choose to show the Google+ share button when social media buttons are enabled. |
FIELDSET FEEDBACK FORM
Use these settings to configure the feedback form which can be added on the Custom Success Page. The feedback form can be added by selecting it as a block to show in the page summary right, besides the ordered items or related products or as block in the CMS section. Feedback will be send to the same email address as the Magento contact form.
| Setting | Value | Description |
|---|---|---|
| Feedback Form Title | Text | Title to show above the feedback form. |
| Intro Text | WYSIWYG editor | Here you can change the intro text which is shown above the feedback form. |
| Redirect Submitted Form To | Custom Select | Set the location a customer is redirected to after submitting the feedback form. |
Troubleshooting
In this section you will find answer to common issues.
I recieve a 404 error after installing the extension and going to one of the extension menu options.
This is a common issue when installing Magento extensions. It is caused because the permission for using the new extension havent been set for the currently logged in admin user. The solution is to logout and login again in the admin backend.
I installed the extension but it's not visible under the “Stores > Settings > Configuration” menu.
Make sure you have followed the installations steps and every one of them. Check if the extension has been installed under “System > Tools > Web Setup Wizard > Component Manager”. The extension should be listed as registered and enabled under this list. If this is not the case and you did upload the extension files as described in the installation steps you could try to run the following commands through a SSH client.
php -f bin/magento module:enable SolideWebservices_Customsuccesspage --clear-static-content php -f bin/magento setup:upgrade