All Collections
Ecommerce Integrations
Magento
Magento: Set up & Module installation
Magento: Set up & Module installation
Rikke Søndergaard avatar
Written by Rikke Søndergaard
Updated over a week ago

Magento: Module Installation


In this Article


About the Module Installation

To perform the Magento Connector installation, you must have an Administrator role in Magento.

The module installation requires user access to file server and expertise in running commands in the Linux Bash terminal: we strongly recommend that this is done by a developer.

Please ensure that the file server user has permissions to execute commands and is able to transfer files.

The installation of the Magento module can be done via Composer, FTP, or GIT. Regardless of your Magento version, the installation process is the same.

After installing the Magento Connector, follow the steps described under Initial Connector Setup.


Working with Multiple Stores or Websites?

The module supports multiple Stores.

Profiles in Magento are either shared in all Stores within a website (per website), or in all websites (global). These settings can be configured in Magento in the Customer Configuration - Account Sharing Options tab.

Events in Magento are performed on a store level, but are associated with the Profile that performed the Events. If you need to send Events to different Sections mapped with specific stores, then you can set-up the account on the store scope with a 1:1 configuration to the Section.

By default, a Profile is set per website in Magento, meaning that the Profile will be available on all stores in the parent website. If this is the option you are using and want to keep data from all Magento stores within a website in one Section in APSIS One we recommend that the Efficy markting/APSIS Magento plugin is set-up on website scope as well. If you have only one website, then the plugin can be set-up on the default scope.

A Profile that is set to Global in Magento will be available across all websites in the Magento account. If you are using this option and want to keep data from all websites in one Section in APSIS One, we recommend to set-up the account on the website scope for each website.


Composer Installation

Watch the video or follow the steps described below to get started!

Plan your installation carefully. In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again.

Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

How to Install via Composer

  1. Set up the correct path for Composer, or keep Composer within the Magento root.

  2. Run the following command in the Magento root: composer require apsis/module-one

  3. Then run php bin/magento module:enable Apsis_One

  4. Run php bin/magento setup:upgrade

  5. If you have a single website and store, run the following command in the Magento root: php bin/magento setup:di:compile

Otherwise, if you have multiple websites and stores, run php bin/magento setup:di:compile-multi-tenant

6. Clear the cache. All set!

How to update

The process for updating with Composer is almost the same as installation.

Using your command line shell, navigate to the Magento root directory and run the command composer require apsis/module-one:^NEW_VERSION NEW_VERSION should be replaced with the latest version number which can be found on packagist

Example: composer require apsis/module-one:^1.9.5

After this, follow steps 4-6 of the installation process

Continue setting up the integration: Enable Magento


FTP Installation

Plan your installation carefully. In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again.

Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

How to Install via FTP

If installing the Magento module via FTP, then you must first install the dependency found in this library in order for us to sync the phone number in Magento with the APSIS One Mobile Attribute.

1. Download the files to the connector from GitHub. Download as a ZIP and unzip the file.

2. Create the directory structure in Magento at Magento_Root/app/code/APSIS/One

3. Drop all the content inside the unzipped folder to the following directory: Magento_Root/app/code/APSIS/One

4. Run the following command in the Magento root: php bin/magento module:enable Apsis_One

5. Then run php bin-magento setup:upgrade

6. If you have a single website and store, run the following command in the Magento root: php bin/magento setup:di:compile

Otherwise, if you have multiple websites and stores, run: php bin/magento setup:di:compile multi-tenant

7. Clear the cache. All set!

How to update

Download the latest version (steps 1-2 of the installation process) and update manually (steps 4-8 of the installation process)

Continue setting up the integration: Enable Magento


GIT Installation

Plan your installation carefully. In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again.

Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

How to Install via GIT

If installing the Magento module via GIT, then you must first install the dependency found in this library in order for us to sync the phone number in Magento with the APSIS One Mobile Attribute.

1. Create the directory structure for GIT in Magento at Magento_Root/app/code/Apsis

2. Clone repository into the directory with the following command in the Magento root: git clone https://github.com/ApsisInternational/module-one One

3. Run the following command in the Magento root: php bin/magento module:enable Apsis_One

4. Then run php bin-magento setup:upgrade

5. If you have a single website and store, run php bin/magento setup:di:compile

Otherwise, if you have multiple websites and stores, run php bin/magento setup:di:compile-multi-tenant

6. Clear the cache. All set!

How to update

The process for updating with git is almost the same as installation

Using the your command line shell, navigate to the module's directory and pull the changes from the repo using the command git pull

After this, follow steps 4-6 of the installation process.


Next Step

Did this answer your question?