Skip to content

Commit

Permalink
Update information about the installation process
Browse files Browse the repository at this point in the history
  • Loading branch information
xylodev committed Jul 28, 2020
1 parent 39bb55e commit 4f762ac
Show file tree
Hide file tree
Showing 12 changed files with 98 additions and 33 deletions.
11 changes: 11 additions & 0 deletions changelog.rst
@@ -1,6 +1,17 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Changelog
=========

Version 3.0.20
--------------

Fixes
~~~~~

* Fix array to string conversion error in IPN logger

Version 3.0.18
--------------

Expand Down
4 changes: 4 additions & 0 deletions configuration.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

.. _configuration:

Configuration
Expand Down Expand Up @@ -200,6 +203,7 @@ You will need to reach out to Amazon Pay in order to receive your `Public Key ID
Configure your carriers using the `Carrier codes` form by selecting your available carriers and assign them to the matching one in the Amazon Pay carrier list.

.. image:: /images/configuration_screenshot_11.gif

----


Expand Down
3 changes: 3 additions & 0 deletions customization.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Design customization
====================

Expand Down
3 changes: 3 additions & 0 deletions faq.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

.. _faq:

Frequently Asked Questions
Expand Down
3 changes: 3 additions & 0 deletions index.rst
Expand Up @@ -10,6 +10,9 @@ Proudly provided by:
.. image:: /images/creativestyle_logo.png
:align: center

.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

.. toctree::
:maxdepth: 3

Expand Down
87 changes: 55 additions & 32 deletions installation.rst
@@ -1,3 +1,9 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

.. note::
If you are looking for the information on how to migrate from the dropped Magento Connect / Marketplace please refer to :ref:`migrating-from-magento-connect` section.

.. _installation:

Installation
Expand All @@ -15,23 +21,42 @@ Pre-installation steps
Installation process
--------------------

* In your browser, open the `Magento Marketplace <https://marketplace.magento.com/creativestyle-creativestyle-amazonpayments.html>`_ page, add it to your cart, and go to checkout (this will be free of charge). On the order confirmation page click on :guilabel:`Install` to receive the access key (you may need to log in with your Magento account). Copy the access key.
.. _installation-magento-connect-manager:

.. image:: /images/1.7.2/installation_step_1.png
Installation via Magento Connect Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.

.. image:: /images/1.7.2/installation_step_1.png

.. image:: /images/1.7.2/installation_step_2.png

* In the `Install New Extensions` section enter **Login and Pay with Amazon** extension key obtained from `Magento Marketplace <https://marketplace.magento.com/creativestyle-creativestyle-amazonpayments.html>`_ page and click :guilabel:`Install` button. Magento will display information about the extension you are about to install and after making sure this is the right version click `Proceed` button.
* In the :guilabel:`Install New Extensions` section paste the following extension key:

.. centered:: `http://connect.creativestyle.de/Creativestyle_AmazonPayments`

and click :guilabel:`Install` button. Magento Connect Manager will validate the key and check the extension dependencies and will display a pre-installation summary. Click :guilabel:`Proceed` button to start the installation.

.. image:: /images/1.7.2/installation_step_3.png

* Installation will start and after successful install it will show a message. Optionally, you can click on `Refresh` button to see if **Login and Pay with Amazon** (identified as `Creativestyle_AmazonPayments`) is listed on list of the installed extensions.
* After the successful installation, please click on :guilabel:`Refresh` button to refresh the list of the installed extensions and assure that **Login and Pay with Amazon** (identified as `Creativestyle_AmazonPayments`) is listed on that list.

.. image:: /images/1.7.2/installation_step_4.png

* Proceed to the post-installation steps.
* Proceed to the :ref:`post-installation-steps`.

Manual installation
~~~~~~~~~~~~~~~~~~~

* Go to `Creativestyle Magento 1.x connect channel <https://connect.creativestyle.de/Creativestyle_AmazonPayments>`_ and download the recent installation package of the extension. Unpack the downloaded file to your Magento root directory.

.. note::
If you are using any VCS (git, svn, mercurial) for versioning your shop basecode, you can also commit the content of the downloaded file to the VCS repository and next deploy it to your shop.

* Proceed to the :ref:`post-installation-steps`.

.. _post-installation-steps:

Post-installation steps
-----------------------
Expand All @@ -53,46 +78,44 @@ Pre-upgrade steps
1. Create a backup of your shop before proceeding to upgrade.
2. If your shop utilises compilation (you can check it in :menuselection:`System --> Tools --> Compilation`), disable it please before proceeding to upgrade.

.. _migrating-from-magento-connect:

Version 2.0.x (installed after September 2017) to 3.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Migrating from Magento Connect / Marketplace
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note:: **In a nutshell**: You can simply use Magento Connect to upgrade to the most recent plugin version.
.. note:: **In a nutshell**: You have to uninstall the previous plugin version first. Then install the most recent version with a new extension key: `http://connect.creativestyle.de/Creativestyle_AmazonPayments`.

**Required steps:**
* Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.

1. Log in to the admin area of your Magento 1 shop.
2. Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.
3. Click on :guilabel:`Check for Upgrades` within the :guilabel:`Extensions` tab.
4. For the module `creativestyle+Creativestyle_AmazonPayments` select the most recent version and click on :guilabel:`Commit changes`.
5. After installation go back to admin area (link on top :guilabel:`Return to Admin`).
6. Go to :menuselection:`System --> Cache Management`.
7. Click on the button :guilabel:`Flush Magento Cache` (top right).
8. Click on the button :guilabel:`Flush JavaScript/ CSS Cache` (bottom left).
9. If you have disabled compiler in pre-installation stage, you can go now to :menuselection:`System --> Tools --> Compilation`, recompile and enable compiler again.
10. Logout from the Magento admin and login again.
11. Test if you can place an order with Amazon Pay. If you have any trouble please contact our support.
.. image:: /images/1.7.2/installation_step_1.png

.. image:: /images/1.7.2/installation_step_2.png

* On the list of the installed extensions please find `Creativestyle_AmazonPayments`, select :guilabel:`Uninstall` in the corresponding action dropdown list and click :guilabel:`Commit changes` button.
* After the successful uninstallation from the previous source, install it from the `Creativestyle Magento 1.x connect channel <https://connect.creativestyle.de/Creativestyle_AmazonPayments>`_ as described in the :ref:`installation-magento-connect-manager` section.


Upgrade process
~~~~~~~~~~~~~~~

Version 1.x (installed before September 2017, including version 2.0.0) to 3.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.

.. image:: /images/1.7.2/installation_step_1.png

.. note:: **In a nutshell**: You have to uninstall the previous plugin version first. Then install the most recent version with a new extension key obtained from Magento Marketplace.
.. image:: /images/1.7.2/installation_step_2.png

* Click :guilabel:`Check for Upgrades` button in the :guilabel:`Manage Existing Extensions` section. If the newest version of Amazon Pay is available, the Creativestyle_AmazonPayments extension on the list will be highlighted with the yellow color. In the corresponding action dropdown list please select :guilabel:`Upgrade to X.X.X (stable)` option and click :guilabel:`Commit changes` button.

**Required steps:**
* After the successful upgrade, please click on :guilabel:`Refresh` button to refresh the list of the installed extensions and assure that **Login and Pay with Amazon** (identified as `Creativestyle_AmazonPayments`) was upgraded to the desired version.

1. Log in to the admin area of your Magento 1 shop.
2. Go to :menuselection:`System --> Magento Connect --> Magento Connect Manager` and enter your admin credentials to get logged in.
3. Search the package `creativestyle+Creativestyle_AmazonPayments`, select :guilabel:`Uninstall` as action, then click on the :guilabel:`Commit changes` button below.
4. Install the most recent version according to our installation guide: :ref:`installation-process`.
5. Test if you can place an order with Amazon Pay. If you have any trouble please contact our support.
* Proceed to the :ref:`post-upgrade-steps` section.

.. _post-upgrade-steps:

Post-upgrade steps
~~~~~~~~~~~~~~~~~~

.. attention:: The following instruction concerns the shops that rely on the order workflow (eg. 3rd party ERP implementation, etc.) and upgrades the extension from version either 1.x or 2.x to 3.x. Version 3.0.2 does not bring any changes to the templates or layout definitions. The only frontend related change has been introduced in the main JS application `js/creativestyle/amazonpayments.min.js` file. Please refer to the changelog or contact the support in case of any doubts.

Version 3.0.2 comes with a significant change to the payment processing workflow. Prior to version 3.x the payment authorization was requested during placing the order (i.e. right after clicking :guilabel:`Save order` button in the checkout), thus in synchronous and optimized (when there wasn't transaction timed out decline) authorization mode, the order ended up with the immediate authorization result.
Version 3.0.2 comes with a significant change to the payment processing workflow (comparing to versions 1.x and 2.x). Prior to version 3.x the payment authorization was requested during placing the order (i.e. right after clicking :guilabel:`Save order` button in the checkout), thus in synchronous and optimized authorization mode (assuming there wasn't transaction timed out error), the order ended up with the immediate authorization result.

Since the Strong Customer Authentication (derived from the PSD2 directive) was introduced in version 3.0.2, the authorization is requested after the order is actually placed. Thus, it may happen that the order payment remains unauthorized for a longer time unless the buyer finishes his Multi-Factor Authentication challenge. This change has to be considered for passing the order to the fulfillment process, to avoid fulfilling the orders that haven't been actually paid. As stated in :ref:`workflow-authorization` section, it is always advised to start fulfilling the order after the authorization is confirmed, which, in the default configuration, is reflected by the "Processing" order status.

Expand Down
3 changes: 3 additions & 0 deletions login.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Login with Amazon
=================
**Login with Amazon** allows users to login to your shop using their Amazon user name and password. All available data needed for creating an account or placing an order in your Magento shop (including name, email address, and zip code) are fetched automatically from customer's Amazon account.
Expand Down
5 changes: 4 additions & 1 deletion overview.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Overview
========

Expand All @@ -9,7 +12,7 @@ The extension is a pure payment solution. No item level is communicated to Amazo
Getting the extension
---------------------

In your browser, open the `Magento Marketplace <https://marketplace.magento.com/creativestyle-creativestyle-amazonpayments.html>`_ page, add it to your cart, and go to checkout (this will be free of charge). On the order confirmation page click on `Install` to receive the access key (you may need to log in with your Magento account). Copy the access key.
You can install the extension either via Magento Connect Manager or manually, downloading the installation package from `Creativestyle Magento 1.x connect channel <https://connect.creativestyle.de/Creativestyle_AmazonPayments>`_.

Refer to the :ref:`installation` section to get more details concerning installation procedure.

Expand Down
3 changes: 3 additions & 0 deletions prerequisites.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Prerequisites
=============

Expand Down
3 changes: 3 additions & 0 deletions testing.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Testing your integration
========================

Expand Down
3 changes: 3 additions & 0 deletions troubleshooting.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

Troubleshooting
===============

Expand Down
3 changes: 3 additions & 0 deletions workflow.rst
@@ -1,3 +1,6 @@
.. note::
This extension is under the active development even though Adobe dropped the support for Magento 1.x e-commerce platform (Jul 1st, 2020). Creativestyle will provide the necessary updates and support for this extension as long as this extension will be used by the active Amazon Pay merchants.

.. _workflow:

Order & payment workflow
Expand Down

0 comments on commit 4f762ac

Please sign in to comment.