Manual Installation

• Download latest stable version here : Splash Modules
• Copy all module files on your Magento app folder (app/*)
• Enable & Configure the module

Requirements

• PHP 7.2+
• Magento 1.9.x
• An active Splash Sync User Account

Enable the Module

Splash Module should be automatically enabled when you copy files on Magento.

If it doesn’t, follow these two steps:

• Clear Magento cache from System » Cache Management » Configuration Cache

• Check Module declaration file is present on your server

If you have “404 Error” when accessing module configuration page, just Logout & Login in order to update ACL configuration.

Configure the Module

Splash Module configuration is located on System » Configuration then Services » Splash Sync Connector.

Connect to your Splash Account

First, you need to create access keys for you module in our website. To do so, on Splash workspace, go to Servers » Add a Server and note your id & encryption keys.

Then, enter the keys on Plugin’s configuration (take care not to forget any character).

Default Language

Select which language package module should use for communication with Splash Server.

Setup default Parameters

To work correctly, this module need few parameters to be selected.

Default User

Enter Login & Password of the user that will be used for all actions executed by Splash Module.

We highly recommend creation of a dedicated user for Splash.

Be aware Splash Module will take care of Users rights policy, this user must have appropriated right on Magento.

Fields Translation

With Splash, it is possible to sync Multilingual fields. This is mainly used for Products Catalogs synchronization.

If your store only uses a single language, leave this parameter to No and select your store language.

If you have a multilingual store, select Yes and an option will be shown on each Store View to select associated language.

Customers Synchronization

If you decide to import Customers from another site, you must define here the website Splash should use on Magento to create their profiles.

If you have multiple servers, it is also possible to select multiple websites, this is done on at website level configuration.

The server number is the one in the # column of your server list.

Products Synchronization

If you decide to import Products from other sites, you must select their default parameters.

• Default Attribute set
• Default Warehouse

Check results of Self-Tests

Once your module is ready, or each time you update your settings, you have to check your configuration.

To do so, goes to Module’s Web Service page : System » Web Services » SOAP - Splash Sync

Each time you update your configuration, module will verify your parameters and ensure communication with Splash is working fine.

Ensure all tests are passed… this is critical! Also check the rest of your configuration, mainly Languages & Websites mapping.

Note If you server wasn’t connected yet, this will be done when loading this page.

You want to try this module? Adjust it to your needs? Or develop new features? Ok! Let’s build a DEV environment!!

Using Docker & Docker Compose, you can start a full developer project.

For each module, we predefined most common possible installations.

Requirements on Local System

• Git git-scm.com
• Php Composer getcomposer.org/
• Docker & Docker-Compose www.docker.com/
• No active Splash Sync User Account is needed!

Clone Module Sources

First, you need to download the sources and compile the module locally.

$ git clone https://github.com/SplashSync/Magento1 myModule
$ cd myModule
$ composer install --no-dev

Build whole Docker Compose Environment

Then, just build the docker environment.

$ docker-compose up

This may take a while but in the end, you should have all your environment working!

Access your Environment

To facilitate access to your instances, we fixed all containers IPs on docker-compose.yml file.

In this file, you should find a comment with target IPs of your environment containers.

I.e. for Prestashop:

################################################################################
# Docker Compose File
#
# This Docker File intend to Create a Complete Dev Environment 
# for Splash Modules on Prestashop
#
# To us different PS Version coinfigured, you need to add hosts to /etc/hosts
# 
# 172.102.0.10        latest.prestashop.local
# 172.102.0.16        ps1-6.prestashop.local
# 172.102.0.17        ps1-7.prestashop.local
# 172.102.0.100       toolkit.prestashop.local
#
################################################################################

So, if you browse IP 172.102.0.10, you should find your App working!!

All usefull details of the installtion are visible on docker-compose.yml file.

For an easier usage, you can cut/paste all IPs to your /etc/hosts. This will make the App available from Url, not only IP.

Test, Develop & Debug using our toolkit

Have you seen this last container available? It’s Splash ToolKit!!

It’s done for developpers and should already be pre-setuped for you Apps!

Just browse the url, and log with user “admin” and password “admin”!

Clear cache?

If your configuration changed, you may have a pretty error… you need to clear the cache!

How? Just run this docker command:

$ docker-compose exec toolkit rm -Rf var/cache/*

Test your connector locally??

Yes, you can! All you need to run our complete core test sequence is already provided by Splash Toolkit.

How? Just run phpunit using this docker command:

$ docker-compose exec toolkit vendor/bin/phpunit