Sitecore

About APSIS One's Sitecore Integration

"Sitecore creates human connections between brands and their customers with rich end-to-end content, seamless commerce, and always-on personalization so brands can thrive in a world where, without a digital experience, there is no product."

Read more on Sitecore's website.

 

The APSIS Sitecore Connector Module enables Sitecore editors to use Segments created in APSIS One for personalisation rules in Sitecore. Segments are created and maintained in APSIS One and automatically transferred to Sitecore so that they can be used in combination with other Sitecore conditions.

The Connector Module is integrated into the Sitecore Rules engine, so it is possible to leverage the standard functionality, including combined rules.

integrations2.jpg

 


Summary 

Here's a summary of the process of integrating Sitecore with your APSIS One account. Click to jump right to a section in the article for a more detailed run-down.

You will need an APSIS Administrator role in order to administer the connector and synchronisation. 

1. Install the correct Sitecore version.

2. Install the connector either on a Single Server System or a CD Server.

3. Synchronise your Segments with your APSIS One account. 

 


 

Prerequisites

To make use of APSIS One's CMS Integration features, your user should have an editor role. For administering the connector and synchronization, your user should be an administrator.

Make sure you've installed one of the following Sitecore versions:

Sitecore CMS 7.2:

7.2 rev.140228, 7.2 rev.140314, 7.2 rev.140526, 7.2 rev.141226, 7.2 rev.150408, 7.2 rev.151021 or 7.2 rev.160123.

Sitecore Experience Platform 7.5:

7.5 rev.141003, 7.5 rev.150130 or 7.5 rev.150212.

Sitecore Experience Platform 8.0:

8.0 rev. 141212 (8.0 Initial Release), 8.0 rev. 150121 (8.0 Update-1), 8.0 rev. 150223 (8.0 Update-2), 8.0 rev. 150427 (8.0 Update-3), 8.0 rev. 150621 (8.0 Update-4), 8.0 rev. 150812 (8.0 Update-5), 8.0 rev. 151127 (8.0 Update-6) or 8.0 rev. 160115 (8.0 Service Pack-1, originally released as 8.0 Update-7).

Sitecore Experience Platform 8.1:

8.1 rev. 151003 (8.1 Initial Release), 8.1 rev. 151207 (8.1 Update-1), 8.1 rev. 160302 (8.1 Update-2), 8.1 rev. 160519 (8.1 Update-3).

Sitecore Experience Platform 8.2:

8.2 rev. 160729 (8.2 Initial Release), 8.2 rev. 161115 (8.2 Update-1), 8.2 rev. 161221 (8.2 Update-2), 8.2 rev. 170407 (8.2 Update-3), 8.2 rev. 170614 (8.2 Update-4) or 8.2 rev. 170728 (8.2 Update-5).

Sitecore Experience Platform 9.0:

9.0 rev. 171002 (9.0 Initial Release), 9.0 rev. 171219 (9.0 Update-1), 9.0 rev. 180604 (9.0 Update-2).

 


 

Module Overview

The APSIS One Connector Module installs the following files in your website root. Even though the .DLL files all have ProfileCloud in their names, they are fully compatible with APSIS One.

Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisAPI.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisObjects.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisProfile.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.Caching.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.Settings.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.SitecoreFoundation.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisConditionHarvester.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisRules.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisSegmentSynchronization.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisSegmentValidation.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Project.Environment.dll
App_Config\Include\module.ApsisConnector\ApsisConnector.config

 

The Connector Module also creates items in the following paths in Sitecore:

/sitecore/templates/System/Apsis connector
/sitecore/system/Modules/Apsis Connector
/sitecore/system/Settings/Rules/Definitions/Match Operators
/sitecore/system/Settings/Rules/Definitions/Tags/Apsis
/sitecore/system/Settings/Rules/Definitions/Elements/Apsis
/sitecore/system/Tasks/Commands/Apsis Synchronization
/sitecore/system/Tasks/Schedules/Apsis Synchronization 

 


 

Before you begin

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

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

All Sitecore versions are compatible with the Sitecore Connector Module. Our images correspond with Sitecore 8.2.

Sitecore15.jpg

 


 

Installing the Connector

The installation process varies according to your servers.

The connector is delivered as a standard Sitecore package. It can be installed using the installation wizard on the CM server, but manual steps are required when installing on CD servers.

To see the CM installation guide, read Single Server System below.

Otherwise, jump to CD-Servers for more details on how to install the connector on CD servers. 

  Plan your installation carefully

When installing the Sitecore Connector Module, your Sitecore server will restart, as the module includes DLL and configuration files. Carefully plan your installation on a production environment in case your website goes offline until Sitecore is running again.

Before performing the installation, we strongly suggest that you back up your Sitecore databases and your website.

 


 

Single Server Systems

1. As an Administrator, open the Sitecore desktop.

2. Open the Sitecore start menu, hover over Development Tools and click Installation Wizard.

Sitecore1.jpg

 

3. Click Upload package.

Sitecore2.jpg

 

4. Click Choose File.

Sitecore3.jpg

 

5. Locate and choose the APSIS One connector package. The original name of the file is Apsis One Connector-x.x.ZIP, the last digits vary depending on the version.

Sitecore4.jpg

 

6. Click Next.

Sitecore5.jpg

 

7. Tick the checkbox next to Overwrite existing files.

This will only overwrite the module installation package and no other files, and only if you have used a previous version of the Sitecore Connector Module before.

Sitecore6.jpg

 

8. Click Upload, then Close.

Sitecore7.jpg

  

9. Click Next.

Sitecore5.jpg

 

10. Click Install.

As mentioned above, this installation will restart your Sitecore server. We suggest that you plan your installation beforehand.

Sitecore9.jpg

 

Once the installation is complete, click Close.

Restarting the Sitecore client is optional, but recommended. This will not restart the Sitecore server again.

Sitecore10.jpg

 


 

CD-Servers

After following the steps described in the Single Server Systems guide, copy the files below to each CD server from the CD server.

As mentioned above, this installation will restart your Sitecore server. We suggest that you plan your installation beforehand.

 Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisAPI.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisObjects.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.ApsisProfile.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.Caching.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.Settings.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Foundation.SitecoreFoundation.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisConditionHarvester.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisRules.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisSegmentSynchronization.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Feature.ApsisSegmentValidation.dll
Bin\Apsis.ProfileCloud.SitecoreConnector.Project.Environment.dll
App_Config\Include\module.ApsisConnector\ApsisConnector.config

 


 

Initial Setup

1. As an administrator, open a browser and navigate to:

http://[YOUR_URL]/sitecore/admin/ApsisOneConnectorInstallation.aspx 

You will be prompted for your Sitecore password. Use an account with full administrator rights, such as the built-in admin user or similar.

 

2. Fill in the Client ID and Client Secret.

If you haven't yet, head over to the API Management tab to generate your API credentials before you set up Sitecore.

Sitecore12.jpg

 

3. Select the Time Zone that matches the server.

Sitecore13.jpg

 

Please note that Token Endpoint, Segments Endpoint and Evaluations Endpoint should not be changed without an instruction from our APSIS Support team.

Sitecore11.jpg

 

4. Click Start setup.

Sitecore14.jpg

 

That's it!

You will see a success message indicating that your segments were successfully synchronised with Sitecore. If you encounter any issues, or see a different message, please take a look at your Sitecore log file together with your development team to investigate any possible mishaps before you contact APSIS Support.

Once the setup is done, all files and items mentioned in Connector Module Overview above will have been added, along with an initial synchronisation of your APSIS One segments with your Sitecore account.

To verify that segments have been created, navigare to /sitecore/system/Modules/Apsis Connector/Segments in the Sitecore Content Editor.

 

No segments?

Try these steps before you contact APSIS Support:

  1. Refresh the node.
  2. Check the Sitecore log file.
  3. Head over to APSIS One's Audience and verify the segments in your account.

Sitecore15.jpg

 


 

Adjust Segment Sync

The /sitecore/system/Tasks/Schedules/Apsis Synchronization item controls how often segments are synchronized with APSIS One. By default, your segments will sync every 5 minutes:

Sitecore16.jpg

 

Note that the synchronization interval cannot override the frequency set on the global Sitecore task runner. You may need to adjust the frequency in the Sitecore configuration file. Locate this option in the frequency section in your file, as shown below:

<!-- SCHEDULING -->
<scheduling>
<!-- Time between checking for scheduled tasks waiting to execute -->
<frequency>00:10:00</frequency>

In this example, the frequency is set to every 10 minutes. The default settings vary between Sitecore versions, so it's a good idea to coordinate your Sitecore frequency setting with your segment sync interval.

 

Was this article helpful?