Information for: DEVELOPERS   PARTNERS   SUPPORT

Acquia Personalization module (Limited Availability)

Important

Acquia currently supports two different Personalization modules. The instructions on this page are intended for subscriptions based in the US region.

For instructions intended for subscriptions based in APJ and Europe regions, see Installing Personalization for Drupal 9. If you are unsure of your subscription’s region, contact your account manager.

The Acquia Personalization service decouples the existing Acquia Personalization from Content Hub, and enables customers’ Drupal sites to directly communicate with the Personalization API. To use this service, you must install and configure the Acquia Personalization module and its dependencies.

Installing and configuring the module

  1. Install the Acquia Personalization module and its dependencies from Drupal.org.

  2. Sign in to your website as an administrator.

  3. In the administrative menu, click Extend.

  4. Select the Acquia Connector, Acquia Personalization (Perz), and Acquia Personalization (Perz) Push checkboxes to enable the modules.

    enable-modules

    The system prompts you for two more module dependencies.

  5. Click Continue.

  6. In the Acquia Connector module settings, do the following:

    1. In Enter the email address you use to login to the Acquia Subscription, enter the email address of your Service Cloud or Cloud Platform.
    2. In Enter your Acquia Subscription password, enter the password of your Service Cloud or Cloud Platform.

    acquia-connector

  7. Click Next.

  8. Select your relevant Cloud subscription and click Next.

    product-specific-settings

  9. On the resulting page, enter your API key, secret key, and Account ID credentials.

    1. To find your credentials, open a new window and sign in to Personalization as an administrator.

    2. Navigate to Sites > Add New Site.

      The page displays the required credentials on the right:

      site-details

  10. Navigate back to your Drupal site to copy and paste the displayed API key, secret key, and Account ID credentials from Personalization.

  11. Click Save configuration on your Drupal site.

  12. In your Drupal site, navigate to the Acquia Personalization Settings page.

  13. In Acquia Personalization Site ID, enter a site ID for your site.

    The site ID serves as a reference found throughout Personalization.

    Important

    If this is a development site, Acquia recommends appending _dev or any relevant environment name to the site ID. Acquia does not recommend appending _prod to your production sites. For example, when a production site is named phoenix_project, Acquia recommends the name of the development site as phoenix_project_dev.

    The site ID can only contain numbers, lowercase letters, and underscores.

    personalization-settings

  14. In the Personalization interface, click Sites > Add New Site and do the following:

    1. In Name, enter the name of the site.

    2. In Site ID, enter the exact same Site ID that you created in the previous step.

      Important

      If you do not use the exact Site ID from the previous step, Personalization cannot correctly collect data and apply campaigns to the site.

    3. In URL, enter the website URL.

    4. Click Create.

      create-new-site

  15. For each Drupal content type or block type that you want to expose to Personalization, check the settings to make it available for use in the application, and click Save.

    manage-display

    From that point onwards, any creation or update of those types of content is sent to Personalization, and made available for use in campaigns.

  16. To apply this retroactively to all your older content:

    1. Navigate to the Acquia Personalization Settings page of your site.
    2. On the Export tab, click Enqueue content and Process queue.

After these steps, you can start building your campaigns in Acquia Personalization. Content types selection is automatically pushed into Personalization and made available in Experience Builder as you build the personalized experiences for your site.

Frequently Asked Questions

How can I change the label that is displayed in the Experience Builder search interface?

You can add a text field containing a label to appear in the search interface to an entity type bundle exported to Personalization. Once this field exists, open the Manage Display tab that corresponds to the bundle (for example, content type article) and select your newly created field in the Personalization Label drop-down menu. After the form is saved, all relevant entities must re-export the relevant entities by resaving them or enqueue and export your content at admin/config/services/acquia-perz/export.

Caution

Only text fields of the Text (plain) type are supported.

Does Personalization support reusable Site Studio Component contents?

Yes. You can enable the Make all Site Studio Component contents available to Personalization Service checkbox at admin/config/services/acquia-perz/export.

Important

Personalization does not support all Site Studio components but supports reusable component content.

How can I delete all content from my Personalization account?

Caution

The following operation is destructive and cannot be reverted.

The following Drush command deletes all content from your Personalization account:

acquia:perz-purge-all

Known issues and limitations

  • Origin and Tag filters are unavailable in Experience Builder.
  • For content recommendation campaigns, the Most viewed content algorithm is currently unavailable.