This extension transforms the order success page into a tool to increase customer loyalty and sales.
This is the installation and user manual for the 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 through email: contact@solidewebservices.com
The zip package you have downloaded from the webshop of Solide Webservices contains 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.
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.
php -f bin/magento module:enable SolideWebservices_Customsuccesspage --clear-static-content
php -f bin/magento setup:upgrade
php -f bin/magento setup:static-content:deploy
php -f bin/magento setup:upgrade
php -f bin/magento setup:static-content:deploy
Installation of modules is done through the command line as well, for more information please have a look at the Magento2 documentation.
php -f bin/magento module:disable SolideWebservices_Customsuccesspage --clear-static-content
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".
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. |
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".
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 both registered as non-registered users can print their order straight away. |
| 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. |
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".
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. |
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".
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. |
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".
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. |
In this section you will find answer to common issues.
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.
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
Social Media Integration
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 SOCIAL MEDIA INTEGRATION
Use these settings to configure the integration of social media share button which can be shown at the top of the custom success page for sharing the website or per ordered item to share the ordered product.