Introduction¶

There are two levels of access for end users of the Acquia Optimize UI:

• Regular
• Admin.

New users are created either by your account representative or by an admin user on your account. During this setup phase, it is possible to designate users with Regular or Admin permissions. Admin users have a higher level of access.

This article gives instructions on how to perform admin tasks.

Admin user roles¶

Admins can interact with the following elements that regular users cannot. This section gives guidance on the features that only admins can access, as well as links to the instructions on how to perform the actions.

For more information, see the user guide article:

User roles

Add a new domain¶

Admin users can add domains with this function.

1. Click Admin Settings (gear icon) on the main toolbar to reach the Domain Settings page..

   

2. Click Add New Domain on the top right side of the page.

   
3. The New Domain pane opens.
4. Fill in the required information.

For full instructions, see the user guide article:

Add, edit, or remove domains

Admin Settings¶

1. Click Admin Settings (gear icon) on the main toolbar to open the Domain Settings page.

2. Click Action on the same row as the domain that you want to work with. A drop-down list opens.

   
3. Admin users can select an action to perform, as described in the following sections.

Go to the Dashboard¶

1. Select Go to the Dashboard in the Action menu to go back to the main dashboard view.

   

Script Setup Guide¶

This is an admin setup wizard to help you get the script that you need to add to the HTML of your site for certain modules and features.

1. Select Script Setup Guide in the Action menu to go to the Set Up Your Domain page.

See the relevant user guide articles for instructions on each of the actions:

• Enable Statistics: See Statistics.
• Add Heatmaps: See Heatmaps.
• Add Acquia Optimize Consent Manager: See Consent Manager
• Edit Domain: See Add, Edit, or Remove Domains
• Statistics excluded IP addresses: See Statistics
• Start on-demand scan: See Configure Domain Scans
• Clone: Clone the domain.
• Open PageAssist (only visible if this module is included in the customer package): See:
  • PageAssist
  • PageAssist Basic Tracking
  • PageAssist Advanced Configuration
  • PageAssist CSS Selector Basics
• Update Domain Groups: See Configure Groups
• Remove Domain: See Add, Edit, or Remove Domains

Edit Domain¶

Admin users can edit domain details with this option.

1. Select Edit Domain from the drop-down list.

   

   The Edit Domain page opens.

For full instructions, see the user guide article:

Add, Edit, or Remove Domains

Statistics excluded IP addresses¶

Admin users can view statistics on excluded IP addresses with this option. This option is only visible if you have excluded certain IP addresses from being tracked in the Statistics module.

1. Select Statistics Excluded IP Addresses from the drop-down menu.

   

   The Excluded IP addresses from statistics pane opens.

2. View a list of IP addresses that have been excluded from the statistics calculations.

For full instructions, see the user guide article:

Statistics

Start On-Demand Scan¶

Admin users can start an unscheduled scan with this option.

1. Select Start on-demand scan.

   

For more information, see the user guide article:

Configure Domain Scans

Clone¶

This section gives instructions for admin users on how to create a new domain based on an existing domain.

1. Click Clone to create a clone of the domain.

   
2. The New Domain setup wizard opens with all of the fields pre-filled with details from the original domain.
3. Make any changes that are needed and save the new domain.

For full instructions on the fields, see the user guide article:

Add, Edit, or Remove Domains

Update Domain Groups¶

This section gives instructions on how to update group changes without entering the setup pages. Use this option to update domain groups without performing a new scan.

1. Click Update Domain Groups in the Action menu.

   
2. A dialog box informs, “Updating groups can take more than 30 minutes. During the operation you will not be able to create and update groups.”
3. In the dialog box, click Cancel to cancel the update, or OK to continue. 
   Acquia Optimize pulls the appropriate pages from the current inventory of pages, as identified from the most recent scan.

Any changes that have been made to domain groups will show up on the next scheduled or on-demand scan.

For full instructions, see the user guide article:

Configure Groups

Remove Domain¶

This section gives instructions on how to remove a domain from Acquia Optimize.

1. Select Remove Domain.

   

2. A dialog box asks for confirmation. "You are about to delete the domain (domain name) please type Delete to confirm this action".

   
3. Type the word "Delete" in the text box and then click OK to remove the domain. Click Cancel to close the dialog without removing the domain.

The dialog closes and the domain and all related domain groups are gone from the list.

For more information, see the user guide article:

Add, Edit, or Remove Domains

Stop a Scan¶

If a scan is in progress, up to a certain point of completion the admin can choose to stop the scan. 
The button only appears in this menu when it is possible to do this action.

1. Select Stop a Scan from the Action menu.
2. The scan stops.

For more information, see the user guide article:

Configure Domain Scans

Left Menu¶

This section gives instructions on how to perform the actions from the left menu bar of the Admin Settings page.

The options in the menu are:

• Domains
• Users
• Labels
• Audit Log
• Source Code Excludes
• Company Info
• Account Settings
• Shortcuts
• API Users
• Performance
• EULA.

Domains¶

Click Domains on the left menu bar to go to the landing page and view the domains that you are admin for.

From here you can view the scan status and perform admin functions on domains.

For more information, see the user guide article:

Add, Edit, or Remove Domains​

Users¶

Click Users on the left menu bar to view the actions you can take in setting up users.

Alternatively, click Users (people icon) on the top menu bar.

Admin users can add, edit, and remove users and also set user access. This section gives guidance on where to find the instructions on how to do these tasks.

• Configure Users: Add, edit, and delete users, and assign user access permissions.
• Configure Groups: Create a group of users for access permissions.
• API User Creation and Usage: Set up API user permissions.

For full instructions, see the user guide articles:

• Create and Configure Users
• User Roles.

• See the Acquia Optimize for Developers article for the most updated information about API user setup:

  Acquia Optimize API.

Labels¶

Click Labels on the left menu bar.

Admins can create labels and add them to domains, pages, users, and issues. This section gives guidance on where to find the instructions on how to do these tasks.

For more information, see the user guide article:

Create and apply labels

Audit Log¶

Use the audit log to view changes made to the website with Acquia Optimize.

Click Audit Log on the left menu bar.

The audit log tracks the following:

• Date: The date of the change
• User ID: The identifier for the user account that made the change
• Domain: The domain that was changed
• Module: The Acquia Optimize module that was used to make the change
• Target: The issue that the change was targeted to fix
• Identifier: The edited code snippet
• Explanation: If any, hover the cursor over the (i) icon to view the reason the user made the changes.
• Show Details/See Changes: Click to view more details about the changes
• Action:
  • Show Details
  • Undo check review.

For full instructions, see the user guide article:

Audit Log

Source Code Excludes¶

Acquia Optimize allows users to set up source code exclusions for snippets that they do not want to include in the scan.

Click Source Code Excludes on the left menu bar.

The links below are guides with instructions on how to set up a source code exclusion. CSS selectors can find and filter elements by tagname, class, id, and attribute, Combine the elements as needed.

For full instructions, see the user guide articles:

• Source code exclusions
• Source code exclusions with CSS selectors.

Company Info¶

Edit your company details here.

1. Click Company Info on the left menu bar.

   

2. Review your company information.

   

3. Click Edit Company Settings on the top right corner of the page.

   

4. Edit as needed.

   
   • Name: Edit the company name
   • Address: Edit the company address
   • Zip Code: Edit the zip code (postal code)
   • State: Edit the state
   • Country: Use the drop-down menu to select the country
   • VAT no: Enter the VAT number
   • Use Legacy Compliance on summaries and history center: Turn ON to use the Legacy Compliance on summaries and history center. 
     ​Note: This setting will be removed in the future as the settings are obsolete.
   • Use Legacy Compliance calculation on individual checks: Turn ON to use the legacy compliance calculation on individual checks.
     ​Note: This setting will be removed in the future as the settings are obsolete.

Account Settings¶

Select various legacy options for account settings. Note: These settings will be removed in the future as they are obsolete.

1. Click Account Settings to view or make changes to the following settings.

   
2. Select to turn on the following options.
   • Use Legacy Compliance
   • Use Legacy Compliance Calculation on Individual Checks
   • Is Using Legacy Compliance Calculation on Individual SEO Issues.

Shortcuts¶

Here you can set up company-wide shortcuts that will show up on the Shortcuts list for all users.

1. Click Shortcuts from the menu on the left side of the Domain Settings page.

   

For full instructions, see the user guide article:

Create Shortcuts.

API Users¶

API stands for Application Programming Interface and is a connection between computers or between computer programs.

In contrast to a UI (user interface), which connects a computer to a person, an API connects computers or pieces of software.

WARNING: API tokens allow access to the domain code. APIs are not intended to be used directly by individuals (end users). Only a programmer or developer should use APIs, when they need to implement the Acquia Optimize API on other applications or CMS systems, for example.
​
​Always verify the user identity and role before sending out an API token to an individual.

1. Click API Users from the menu on the left side of the Domain Settings page.

Acquia Optimize supports API use. The API can be based on the customer's location. Our API list is kept up-to-date on the following article:

Acquia Optimize for Developers API

To use our API, your application has to present user credentials (the token) in an authentication software program (such as Postman). The API user account can only be used for API access. It is recommended to create a new user account specifically for this purpose and assign the API user scope to it via the free-text field.

For more information, see the user guide article:

API Users.

Performance¶

The Performance module can be adjusted to fit the profile of specific targeted user groups. Admin users can set up profiles to track with this module.

1. Click Performance from the menu on the left side of the Domain Settings page.

   

   Alternatively, to navigate to this page during the New Page Creation steps, click Add Profile.

   

   The Profile Setup pane opens.

2. Fill in the details for the new profile.

For more information and full instructions, see the user guide article:

Performance.

EULA¶

Click EULA to view the end-user license agreement between your company and Acquia Optimize.

Additional Resources¶

See Acquia Optimize for Developers for documentation containing advanced help files for developers.