Skip to main content
 

How can we help?

Search

Articles in this section

Admin Guide

  • Updated

System Setup

Set Up Single Sign-On

Before you can use Acrolinx for AEM, you'll need to set up SSO for Acrolinx. To do this, follow the process in our article on setting up Acrolinx for single sign-on.

Connect to Acrolinx

Before you can check your content, you'll need to configure AEM to route internal checking requests to Acrolinx. When you enable AEM to connect to Acrolinx, you also activate batch checking for both Sites and Guides.

To enable AEM to connect to Acrolinx, follow these steps:

  1. Navigate to Tools > Operations > Web Console to open the Adobe Experience Manager Web Console.

  2. Click the row Acrolinx Connection Settings. In the dialog box that appears, make the following changes:

    • Enter your Acrolinx URL in the Acrolinx Platform URL field.

    • In the General Access Token field, enter the generic password that you configured when you set up Acrolinx for single sign-on.

  3. (Optional) Select Forward Cookies to Acrolinx to forward cookies to your Acrolinx Platform. If your users have difficulty authenticating, try selecting this option.

  4. (Optional) Select Turn on HTTP Proxy to forward Acrolinx requests via a custom HTTP proxy.

  5. Click Save.

You can now run single checks and batch checks in AEM with Acrolinx!

Configure Access to AEM Resources

Notice

Use this to configure Acrolinx access to AEM tenants. The regex configuration affects both batch and Sidebar checking.

By default, Acrolinx will be visible for both Sites and Guides. You can change the configuration in the AEM Web Console. The default regex is .*.

Make Acrolinx Available for One Site

If you only want to use Acrolinx with a certain site, you can add a regular expression that matches the name of the corresponding site.

To make Acrolinx available for only one site, for example the we-retail site and its subsites, do the following:

Set the input field to:

we-retail

In the Sites admin console, you can batch check the we-retail site root page and its subsites. Acrolinx will only show up for resources that include we-retail.

For example, editor.html/content/we-retail>/language-masters/en/experience.html.

Make Acrolinx Available for Several Sites

To configure several sites, do the following:

Set the input field to:

we-retail|wknd-events

This prompts the Sidebar to show up for resources that include both wknd-events and we-retail. You’ll now see it for editor.html/content/we-retail>/language-masters/en/experience.html and editor.html/content/wknd-events.html.

Make Acrolinx Unavailable for a Specific Component

To disable the AEM Guides Sidebar and Batch Check in Assets, do the following:

Set the input field to:

(libs/fmdita/|content/dam/)

To disable the AEM Guides Sidebar alone, do the following:

Set the input field to:

(libs/fmdita/)

Add Acrolinx System User

The XML/DITA (Guides) Batch Check option in AEM Assets lets you check multiple XML-based files directly in the AEM console. But to run a batch check, you'll need to create one system user on the AEM server.

Tip

Before you get started, make sure you're signed in to the admin account.

  1. Go to http://<yourserver>:4502/crx/explorer/index.jsp.

  2. Click User Administration > Create System User.

  3. Add the following information in the Properties tab, and click Submit to create the user.

    • UserId (UserId of system user you want to assign) - acrolinxSystemUser

    • Intermediate Path - /home/users/system

    Notice

    Path where you want to store system user. If there's no path, AEM will store the user in some arbitrary node. This field is optional, but it's always best to provide a path so you can track the user more easily.

  4. Navigate to http://<yourserver>:4502/useradmin and double-click the administrators user group in the left panel. Open the Members tab.

    Tip

    Before you open the administrators user group, go to acrolinxSystemUser > Groups to make sure that the system user doesn't already belong to the administrators group

  5. Click drag the acrolinxSystemUser to the Members tab, and click Save.

Disable Acrolinx in Sites

To stop using Acrolinx in Sites, do the following:

  1. In AEM Cloud Manager, go to Environments and choose Acrolinx Exchange Partner Program.

  2. Click Configuration > Add/Update to open the Environment Configuration dialog.

  3. Enter the following details:

    • Name: ACROLINX_SIDEBAR_SITES

    • Value: false

    • Service Applied: All

    • Type: Variable

    Click Add.

  4. Click Save. After you save, you'll see the status Updating at the top of the table and next to the newly added variable. Once the update is complete, you'll see the new environment variable in the Environment Configuration table.

Once you've added the variable, the Acrolinx Sidebar will no longer be visible in Sites.

Tip

To re-enable the Acrolinx Sidebar, set Value to true.

Advanced Settings

Configure components

Edit your AEM Content Profile to define components that you want Acrolinx to include or exclude. To do this, identify any components that you use in your website and add them to your AEM Content Profile.

Notice

If you want to batch check XML and DITA files in AEM, you'll need to add your components to the XML and DITA Content Profiles.

To identify your components and update your Content Profile, we recommend that you do the following:

  1. In AEM, go to Tools > CRXDE Lite to open CRXDE Lite.

  2. Go to apps > [your AEM website] > components > content. You'll see a list of all the components that you've enabled in your website.

  3. In a separate browser tab, sign in to the Acrolinx Dashboard.

  4. Go to Guidance Settings > Content Profiles.

  5. Open your AEM, XML, or DITA Content Profile and go to the Extraction tab.

  6. Add any components to the Content Profile. For example, to include content from the image component, you'd enter the following:

    AEM_Content_Profile_Example.png

Tip

To include a component from AEM, set:

  • Filter mode = include

  • Break Level = sentence

Configure batch check scheduler

You can configure how many check requests Acrolinx processes in parallel during a batch check. Acrolinx processes 5 requests at a time by default.

To configure the number of check requests that are processed during a batch check, do the following:

  1. In AEM, go to Tools > CRXDE Lite to open CRXDE Lite.

  2. Go to apps > [your AEM website] > config > org.apache.sling.event.jobs.QueueConfiguration~checkDitaJobConsumer to open the Properties list.

  3. Find the property queue.maxparallel and set how many check requests you want Acrolinx to process in parallel.

Configure outgoing network request timeouts

You can set the default timeouts for outgoing network requests in Acrolinx.

To configure the timeout for outgoing network requests, do the following:

  1. Go to Acrolinx Connection Settings on http://localhost:4502/system/console/configMgr.

  2. Enter your preferred value under HTTP(S) Timeout. This is set to 1 second by default.

    You can set the following:

    • Connection request timeout = HTTP_TIMEOUT * 5

    • Connection timeout = HTTP_TIMEOUT

    • Socket timeout = HTTP_TIMEOUT * 5

  3. Click Save.