PageAssist (glossary term, activate to view definition) setup
Introduction
This article provides instructions for admin users on how to configure PageAssist.
Setup
This section provides instructions on how to set up PageAssist.
Navigate to the Domain Overview page.
Click Action on the same row as the domain that you want to add PageAssist to and select Script Setup Guide from the expanded list of options.
The system opens the Set up your domain page.
Click to toggle Add PageAssist script to ON.
Click the Open PageAssist script settings link beside the button to go to the PageAssist script settings.
Configure the settings as per the instructions below and then copy the script and add it to the website HTML code. In the HTML editor, paste the script into the HEAD tag or place it before the </body> tag on every page.
This section provides instructions on how to set up the PageAssist widget icon.
PageAssist position on page: Click on the mini window to specify the location for the PageAssist icon to appear on the page.
The options are:
Top left
Top center
Top right
Middle left
Middle right
Bottom left
Bottom center
Bottom right
Margin from edge in pixels: Top, Right, Bottom, Left. These fields are populated automatically with the default margins as per the location selected in the previous step. Edit the fields as desired to customize the icon location even further.
Keep PageAssist on top: Tick to select this option. This ensures that the PageAssist icon is always visible and situated on top of other page elements.
Choose an Icon: Select an icon to represent the PageAssist feature on the website. The choices are:
Human figure with arms outstretched
Human figure in a wheelchair
Heart
Paintbrush
Icon shape: Click the drop-down list to select an icon shape. The choices are Circle and Rounded Box.
Widget design and text
This section provides instructions on how to set up the widget appearance. It is important to set up all of these items because if errors occur later on it might be difficult to determine which setting was missed.
Tip! The Acquia Color Contrast Checker is a quick way to test the color combinations on websites and pages.
Menu Theme: Click the drop-down arrow and select a menu theme. The choices are Light and Dark.
Main color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Text color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Link color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Button hover color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Color contrast ratio: This number indicates the contrast ratio for the selected colors, and lets the user know if the contrast between the buttons and text is Bad (0-3.99) or Good (4 and above).
Tip! The Color Contrast Checker is a quick way to test the color combinations on websites and pages.
Add icon border: Tick to select this option. An input field expands below the selection. Select a border color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Upload logo: Paste a logo image link (URL) into the field and then click Upload Link, or click Browse and navigate to the logo and then save it.
Button hover message: Enter a free-text message for users to see when they hover the mouse pointer over the PageAssist button. Click in the field to see the location on the mini-view to the right of this section.
Include Accessibility (glossary term, activate to view definition) Statement: Click to toggle the switch ON. The section expands with an upload field. Browse to and add an Accessibility Statement.
Include custom info text: Click to toggle the switch ON. The section expands with a free-text field. Add a custom message to users.
Included languages: Click the drop-down arrow and select the languages that are used on the website. Select as many as needed.
Default language: Click the drop-down arrow and select the default language that is used on the website.
: Click to toggle the switch
Script
This section provides instructions on how to find and add the PageAssist script to your website.
Scroll down to the script section at the bottom of the Set up your domain page.
In the script section, click Copy Script (icon of two papers) to copy the script.
Note
Configure all of the modules and then copy and paste the entire script only one time. Repeat for each URL.
The script is unique for each domain. It will not work to copy/paste from one to another. Websites ending in .com and .eu, for example, are considered different domains and it does not work to copy and paste the script. The script needs to be configured separately for each domain.
In the HTML editor, paste the script into the BODY tag of the website. Place the script on the pages to track - normally every page of the website.
Additional resources
For information about how your visitors can interact with PageAssist, visit:
PageAssist (glossary term, activate to view definition) setup
Introduction
This article provides instructions for admin users on how to configure PageAssist.
Setup
This section provides instructions on how to set up PageAssist.
Navigate to the Domain Overview page.
Click Action on the same row as the domain that you want to add PageAssist to and select Script Setup Guide from the expanded list of options.
The system opens the Set up your domain page.
Click to toggle Add PageAssist script to ON.
Click the Open PageAssist script settings link beside the button to go to the PageAssist script settings.
Configure the settings as per the instructions below and then copy the script and add it to the website HTML code. In the HTML editor, paste the script into the HEAD tag or place it before the </body> tag on every page.
This section provides instructions on how to set up the PageAssist widget icon.
PageAssist position on page: Click on the mini window to specify the location for the PageAssist icon to appear on the page.
The options are:
Top left
Top center
Top right
Middle left
Middle right
Bottom left
Bottom center
Bottom right
Margin from edge in pixels: Top, Right, Bottom, Left. These fields are populated automatically with the default margins as per the location selected in the previous step. Edit the fields as desired to customize the icon location even further.
Keep PageAssist on top: Tick to select this option. This ensures that the PageAssist icon is always visible and situated on top of other page elements.
Choose an Icon: Select an icon to represent the PageAssist feature on the website. The choices are:
Human figure with arms outstretched
Human figure in a wheelchair
Heart
Paintbrush
Icon shape: Click the drop-down list to select an icon shape. The choices are Circle and Rounded Box.
Widget design and text
This section provides instructions on how to set up the widget appearance. It is important to set up all of these items because if errors occur later on it might be difficult to determine which setting was missed.
Tip! The Acquia Color Contrast Checker is a quick way to test the color combinations on websites and pages.
Menu Theme: Click the drop-down arrow and select a menu theme. The choices are Light and Dark.
Main color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Text color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Link color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Button hover color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Color contrast ratio: This number indicates the contrast ratio for the selected colors, and lets the user know if the contrast between the buttons and text is Bad (0-3.99) or Good (4 and above).
Tip! The Color Contrast Checker is a quick way to test the color combinations on websites and pages.
Add icon border: Tick to select this option. An input field expands below the selection. Select a border color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
Upload logo: Paste a logo image link (URL) into the field and then click Upload Link, or click Browse and navigate to the logo and then save it.
Button hover message: Enter a free-text message for users to see when they hover the mouse pointer over the PageAssist button. Click in the field to see the location on the mini-view to the right of this section.
Include Accessibility (glossary term, activate to view definition) Statement: Click to toggle the switch ON. The section expands with an upload field. Browse to and add an Accessibility Statement.
Include custom info text: Click to toggle the switch ON. The section expands with a free-text field. Add a custom message to users.
Included languages: Click the drop-down arrow and select the languages that are used on the website. Select as many as needed.
Default language: Click the drop-down arrow and select the default language that is used on the website.
: Click to toggle the switch
Script
This section provides instructions on how to find and add the PageAssist script to your website.
Scroll down to the script section at the bottom of the Set up your domain page.
In the script section, click Copy Script (icon of two papers) to copy the script.
Note
Configure all of the modules and then copy and paste the entire script only one time. Repeat for each URL.
The script is unique for each domain. It will not work to copy/paste from one to another. Websites ending in .com and .eu, for example, are considered different domains and it does not work to copy and paste the script. The script needs to be configured separately for each domain.
In the HTML editor, paste the script into the BODY tag of the website. Place the script on the pages to track - normally every page of the website.
Additional resources
For information about how your visitors can interact with PageAssist, visit:
PageAssist setup | Web Governance | Acquia Product Documentation
Frequently asked questions
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Enter a title for the PageAssist menu: Click in the field to see the location on the mini-view to the right of the section.
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Title Text: Enter a free-text description of the PageAssist menu for users. Click in the field to see the location on the mini-view to the right of the section.
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Reset Design: Click to discard changes and revert to the default settings.
Add Skip to PageAssist
ON
. This option adds a button that allows users to skip directly to PageAssist.
Click OK to save the settings. The window closes and the Set up your domain page is visible, with the Script section updated.
In the CMS (or the website template files), add the copied code to the HEAD tag or place it before the </body> tag.
Tip: It is also possible to insert the code just before or after any Google Analytics™ script or other utility scripts. After installation, browse the sites to ensure that the script loads correctly.
Save and commit the changes as needed.
Return to the platform and refresh the page.
Open the Domain Settings page (gear icon). The column Script shows the message Script Installed.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Enter a title for the PageAssist menu: Click in the field to see the location on the mini-view to the right of the section.
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Title Text: Enter a free-text description of the PageAssist menu for users. Click in the field to see the location on the mini-view to the right of the section.
Note
Remember that this message appears in the language as entered on all pages, it is not translated automatically.
Reset Design: Click to discard changes and revert to the default settings.
Add Skip to PageAssist
ON
. This option adds a button that allows users to skip directly to PageAssist.
Click OK to save the settings. The window closes and the Set up your domain page is visible, with the Script section updated.
In the CMS (or the website template files), add the copied code to the HEAD tag or place it before the </body> tag.
Tip: It is also possible to insert the code just before or after any Google Analytics™ script or other utility scripts. After installation, browse the sites to ensure that the script loads correctly.
Save and commit the changes as needed.
Return to the platform and refresh the page.
Open the Domain Settings page (gear icon). The column Script shows the message Script Installed.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Web Governance