Installing the Acquia Personalization module¶

Prerequisites¶

For proper installation and configuration the Acquia Personalization module, ensure that:

• Your Drupal website runs on Drupal 9.2 or later.

• You have administrative access to your Drupal website.

• You have an active Acquia Personalization subscription with Profile Manager credentials provided by your Acquia Account Manager.

Installing 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 following checkboxes to enable the modules:

   • Acquia Connector

   • Acquia Personalization (Perz)

   • Acquia Personalization (Perz) Push

   

5. If the system prompts you for two more module dependencies, click Continue.

Connecting to Acquia Cloud¶

After installing the Acquia Personalization module, we will connect to your Acquia Subscription.

1. Sign in to your website as an administrator.

2. Go to the Acquia Connector module settings by using [site_URL]/admin/config/services/acquia-connector.

3. Click Authenticate with Acquia Cloud.

   

4. On the next page, enter your email address and password to login to Acquia Cloud.

5. On the next page, select the application from the dropdown and click Set Application.

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

   To find and enter the credentials:

   1. Open a new window and sign in to Personalization as an administrator.

   2. Click Sites > Add New Site.

      The page displays the required credentials on the right:

      

   3. Copy the displayed API key, secret key, and Account ID credentials from Personalization, and paste them to your Drupal site.

7. Select your region from the dropdown.

8. Click Save configuration.

Configuring your site ID¶

1. In your Drupal site, navigate to the Acquia Personalization Settings page by using [site_URL]/admin/config/services/acquia-perz/settings.

2. In Acquia Personalization Site ID , enter a site ID for your site and click Save Configuration.

   The site ID serves as a reference 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.

   

3. Create a new customer site in your Acquia Personalization account.

   After creating the new site, ensure to enter the Site ID that you created in the previous step into the corresponding Site ID field.

   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.

Configuring content for Personalization¶

1. For each Drupal entity type you want to leverage with Personalization, go to the Manage display setting and select the display mode that you want to use in the application.

2. Scroll to the Acquia Personalization section and select the Available to Personalization checkbox.

   

3. Click Save.

If an export error occurs for entities that are set to be available in Personalization, the entity causing the error is kept in a queue. After the error is resolved, you can export it again through the Export feature in Acquia Personalization Settings of the Drupal module at /admin/config/services/acquia-perz/export, or with the Drush command drush acquia:perz-process-queue.

From this point onwards, any creation or modification to these entities is sent to Personalization and made available for use in your campaigns.

You can now start building your campaigns in Personalization. Entities are automatically pushed into Personalization and made available in Experience Builder.

Troubleshooting¶

If you encounter any issues during the installation or configuration of the Acquia Personalization module, do the following:

1. Verify module installation: Ensure that you have installed the Acquia Personalization module and its dependencies correctly. To do this, navigate to the Extend page (admin/modules) and ensure that the Acquia Connector, Acquia Personalization (Perz), and Acquia Personalization (Perz) Push checkboxes are selected.

2. Check Acquia Connector configuration: Ensure that you have correctly authenticated with Acquia Cloud and entered the API key, secret key, Account ID, and region. To check this, navigate to the Acquia Connector module settings page (admin/config/services/acquia-connector) and verify that the correct credentials are entered.

3. Check Site ID configuration: Verify that you have correctly configured the Site ID in both Drupal and Personalization. Ensure that the Site ID in Drupal matches the Site ID in Personalization.

4. Check content configuration: Ensure that you have correctly configured the content types, block types, taxonomies, and applicable entities for Personalization. To do this, navigate to the Manage display settings page for each Drupal entity that you want to expose to Personalization, select the Display mode that you want to make available, and ensure that the Available to Personalization checkbox is selected.

5. Clear cache: If you have made any changes to the configuration, clear the Drupal cache to ensure that the changes took effect. To do this, navigate to the Performance page (admin/config/development/performance) and click Clear all caches.

6. Check for error messages: If you encounter any error messages during the installation or configuration process, take note of them and try to identify the cause. The error messages may provide valuable information that can help you troubleshoot the issue.

7. Disable conflicting modules: If you have installed other modules that may conflict with the Acquia Personalization module, try disabling them temporarily and see if the issue persists. You can also try disabling the Acquia Personalization module and its dependencies and then re-enabling them.

8. Check for updates: Ensure that you are using the latest version of the Acquia Personalization module and its dependencies. Check for any available updates and apply them if necessary.

9. Seek assistance: If you are still unable to resolve the issue, contact Acquia Support. Provide as much detail as possible regarding the issue and the steps you have taken to troubleshoot it. This will help others to better understand the issue and provide more targeted assistance.