Acrolinx IQ. Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor Installation Guide Version: 2.9

Transcription

1 Acrolinx IQ Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor Installation Guide Version: 2.9

2 2 Contents Overview 3 About this Guide...3 Acrolinx IQ and CQ Editor...3 Installation 4 Single Sign-on Configuration...4 Configuring the SSO Properties...5 Uploading and Installing the Acrolinx IQ Plug-in Package...6 Enabling the Acrolinx IQ Plug-in...6 Configuring the Connection to the Acrolinx IQ Server...9 Upgrading the Acrolinx IQ Plug-in...9

3 3 Chapter 1 Overview About this Guide Purpose The Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor Installation Guide is designed to help you install and configure the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor. Audience The Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor Installation Guide is intended for technical support staff who install, configure, and provide administration for the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor. Acrolinx IQ and CQ Rich Text Editor The CQ Rich Text Editor is a WYSIWYG text editor that is included in several of the standard CQ components such as "Text", "Table" and "Text image". The CQ Rich Text Editor is available whenever you add these components to web pages and edit the text in the components. You can integrate Acrolinx IQ functionality into the CQ Rich Text Editor so that you can check for content issues when editing text blocks or tables. For more information about CQ Rich Text Editor, visit the Adobe CQ website. The Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor has been tested with CQ Rich Text Editor versions 5.4, 5.5. Other versions might work but have not been tested. The Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor works in most web browsers that are supported by Adobe CQ with the exception of Google Chrome and Apple Safari. Currently, the plug-in shortcut menu does not work correctly when editing flags in these web browsers.

4 4 Installation Chapter 2 Installation You install the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor by uploading and installing the Acrolinx IQ Plug-in package in the Adobe CRX package manager. To complete the Acrolinx IQ Plug-in installation, you must also make several changes in the CRX Development Environment Lite (CRXDE Lite), and the Adobe CQ5 web console. The installation consists of the following major steps: 1 Enable single-sign on for Acrolinx IQ. 2 Obtain the installation package for the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor. 3 Upload the installation package for the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor and install the package. 4 Configure the connection to the Acrolinx IQ Server. Single Sign-on Configuration If your web applications run in a single sign-on environment, you can configure the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor to work in your single sign-on environment as well. You configure single sign-on by updating the CQ5 Web Console and the Acrolinx IQ core server properties. What is Single Sign-on? Single sign-on (SSO) is a user authentication process. When single sign-on is deployed, users provide their login details once to access multiple applications. This process ensures that users do not have to enter their login details again when they switch applications. The network administrator can configure the single sign-on software so that users can only access specific applications. Web single sign-on works only with applications accessed with a web browser. The request to access a web resource is intercepted either by a component in the web server, or by the application itself. Unauthenticated users are diverted to an authentication service and returned only after a successful authentication. Which Single Sign-on Methods Does Acrolinx IQ Support? You can configure Acrolinx IQ to search for a SSO identifier in the request header sent by the browser. How Does Acrolinx IQ Work with Adobe CQ When Authenticating Users?? When users log into the Adobe CQ and run a check with Acrolinx IQ, the user login details are passed on to the Acrolinx IQ Server. If the user already exists, no further action is required. If the user does not yet exist, the user is automatically created in the Acrolinx IQ database with the same login details that they used to log into the Adobe CQ.

5 5 Configuring the SSO Properties To integrate Acrolinx IQ into your single sign-on configuration, you must configure the Acrolinx IQ Server to search for SSO identifier in the request header. â To configure the SSO properties, follow these steps: 1 Open the core server properties file and add the following property: singlesignon.method=header 2 Configure the generic password that is used in your single sign-on configuration, by adding the following property: singlesignon.genericpassword=<password> Example: singlesignon.genericpassword=sus5abut Generic passwords remove the need to configure a password for users in each application. If you configure a generic password, Acrolinx IQ users will be created without passwords. If some users need to access the Acrolinx IQ term contribution form, you must configure a password for these users. The term contribution feature is not included in the Acrolinx IQ support for single sign-on. If you edit a user and add a password in the Acrolinx IQ Dashboard, this password will be required for the term contribution form, but will be ignored when authenticating a user in an Acrolinx IQ web client. The generic password is used for client authentication instead. 3 To restrict single sign-on to a set of configurable hosts, add the following property: singlesignon.allowedremoteaddresses=<addresses> In the following example, a comma delimited list of secured remote addresses has been entered by using regular expressions: singlesignon.allowedremoteaddresses=10\.10\..*\..*,192\.168\..*\..* NOTE: You must enter regular expressions in the Java regular expression syntax. However, range quantifiers such as \d{1,3} are not supported because they contain commas that interfere with how the property is interpreted. 4 Define the names of the user name and password keys by adding the following properties: singlesignon.usernamekey=<user_name_key> singlesignon.passwordkey=<password_key> For example, if the user name and password are sent with parameters that are named username and password, enter the properties as follows: singlesignon.usernamekey=username singlesignon.passwordkey=password The following example shows all properties required for the SSO configuration together.

6 6 Installation singlesignon.method=header singlesignon.genericpassword=sus5abut singlesignon.usernamekey=username singlesignon.passwordkey=password singlesignon.allowedremoteaddresses=10\.10\..*\..*,192\.168\..*\..* 5 Save the core server properties file and restart the core server. Uploading and Installing the Acrolinx IQ Plug-in Package To install the key components of the Acrolinx IQ Plug-in, upload and install the installation package in the Adobe CRX package manager. You must be logged as an administrator to perform this function. â To upload and install the Acrolinx IQ Plug-in package, follow these steps: 1 Navigate to Welcome Page Packages and click Upload Package You can also open the Adobe CRX Package manager entering the following URL in your Web Browser: 2 In the Upload Package dialog box, select the Acrolinx IQ Plug-in installation package and click OK. 3 After the package has uploaded, click Install. 4 When the installation is complete, enable the Acrolinx IQ plug-in (see "Enabling the Acrolinx IQ Plug-in" on page 6). Enabling the Acrolinx IQ Plug-in To ensure that the Acrolinx IQ toolbar is visible in the CQ Rich Text Editor, you must add the plug-in as a dependency in the WCM core configuration. You must also add overlay copies of the relevant foundation components and add nodes for the Acrolinx IQ plug-in to each component. TIP: You can skip these steps and quickly test the Acrolinx plug-in with a sample configuration package that is available on request. When you upload and install this package in the CQ package manager, all required configurations are added automatically. However, the installation process will overwrite any previous configurations made to the CQ Rich Text Editor and will add all available editing features. For this reason, we recommend that you use the sample configuration in test environments only. To obtain the sample configuration package, contact your Acrolinx project consultant. â To enable the Acrolinx IQ plugin, follow these steps: 1 Open CRXDE Lite by clicking Develop in the CQ package manager or by navigating to Welcome Page CRXDE Lite.

7 7 You can also open CRXDE Lite by entering the following URL in your Web Browser: 2 Add the Acrolinx IQ plug-in as a core client-library dependency. a) Locate and select the following folder your repository: /apps/wcm/core/clientlibs/edit If this folder does not yet exist in your installation, create the location /apps/wcm/core/clientlibs/ first, save your changes, then copy the folder /libs/wcm/core/clientlibs/edit to /apps/wcm/core/clientlibs/. To copy or paste items, right-click a node or folder. In the context menu that appears, select Copy or Paste. b) With the edit folder selected, browse the Properties tab and double click the Dependencies row. c) In the Edit Dependencies window, click +, add the dependency acrolinx.rteplugin, and click OK to save your changes. 3 Add the Acrolinx IQ plug-in as a CQ Rich Text Editor plug-in for each text-based component. For example, to add the Acrolinx IQ plug-in to the CQ Rich Text Editor in the "Text" component, follow these steps: a) Locate the following node your repository: /libs/foundation/components/text/ This node defines the behavior and appearance of the CQ Rich Text Editor b) Copy the node and paste the node at the following location. /apps/foundation/components/ If this folder does not yet exist in your installation, create the location /apps/foundation/components/ first, save your changes, then paste the node. c) In the node you just pasted, locate the following sub node. /apps/foundation/components/text/dialog/items/tab1/items/text/rteplugins d) Create a new sub node underneath the rteplugins node with the name acrolinx and the type nt:unstructured. To create a node, right-click the parent node or folder. In the context menu that appears, select Create Create Node... e) Select the node you just created and add a new property with the following attributes: Name Type Value features String check, options, remove-flags, report, help, about To enter multiple values, ensure that you click the Multi button when adding the property. You can omit some of these values if you do not want the users the corresponding buttons.

8 8 Installation Alternatively, you can also enter * to include all features that are configured in the current version of your plug-in. Ensure that the Multi button is deselected if you the * character. To add new properties, edit the fields in the bottom row of the Properties tab and click Add. If you are adding multiple values, enter the values in the dialog box that appears. Click + to add each value. f) Repeat the previous steps from step "a" for the "Text Image" and "Table" components which you can copy from the following locations. Text Image /libs/foundation/components/textimage/ You copy this node to the folder /apps/foundation/components/ add an acrolinx node underneath the node /apps/foundation/components/textimage/dialog/items/tab1/items/text/rteplugins. Table /libs/foundation/components/table/ You copy this node to the folder /apps/foundation/components/ add an acrolinx node underneath the node /apps/foundation/components/table/dialog/items/table/rteplugins. 4 Add the Acrolinx IQ plug-in stylesheet as an external stylesheet for each text-based component. For example, to add the Acrolinx IQ plug-in stylesheet as an external stylesheet for the "Text" component, follow these steps: a) Locate the following node: /apps/foundation/components/text/dialog/items/tab1/items/text/ b) Create a new sub node underneath the text node with the name externalstylesheets and the type nt:unstructured. c) Double click the node you just created and add a new property with the following attributes: Name Type Value acrolinx-cq-rte-plugin-content String /apps/acrolinx/clientlib/css/acrolinx.css d) Repeat the previous steps from step "a" for the "Text Image" and "Table" components. You add the externalstylesheets node to the following locations: Text Image /apps/foundation/components/textimage/dialog/items/tab1/items/text/. Table /apps/foundation/components/table/dialog/items/table/. 5 Click Save All to save your changes.

9 9 The Acrolinx IQ toolbar should now be visible whenever you use the rich text editor. For example, the toolbar should be visible when you edit a text component in a web page. 6 Configure the connection to the Acrolinx IQ Server. (see "Configuring the Connection to the Acrolinx IQ Server" on page 9) Configuring the Connection to the Acrolinx IQ Server To enable the checking functionality in the Acrolinx IQ Plug-in for Adobe CQ Rich Text Editor, you must configure the Adobe CQ application platform to route the internal checking requests to your Acrolinx IQ Server installation. â To configure the connection to the Acrolinx IQ Server, follow these steps: 1 Open the Adobe CQ5 Web Console by navigating to Welcome Page OSGi Console or by entering the following URL in your Web Browser. 2 Click the row Acrolinx Adobe CQ Proxy and in the dialog box that appears, make the following changes: In the Acrolinx Server URL field, enter the address of your Acrolinx IQ Server. In the Generic Password field, enter your generic password. This password must match the generic password that you configured in the core server properties file when Enabling single-sign on for Acrolinx IQ (see "Single Sign-on Configuration" on page 4). 3 Click Save. You should now be able to use Acrolinx IQ to run checks in the rich text editor. Upgrading the Acrolinx IQ Plug-in It is not necessary to remove the previous plug-in version before installing a newer version. You can upload and reinstall the new plug-in package over the top of the old one. You must be logged as an administrator to perform this function. â To upgrade the Acrolinx IQ Plug-in: 1 Navigate to Welcome Page Packages and click Upload Package You can also open the Adobe CRX Package manager entering the following URL in your Web Browser: 2 In the Upload Package dialog box, select the Acrolinx IQ Plug-in installation package, select Force Overwrite and click OK.

10 10 Installation 3 After the package has uploaded, click Reinstall. 4 Check that the upgrade has been correctly installed. a) Open an instance of the rich text editor and press CTRL + F5 to refresh the page. b) Click the About Acrolinx button in the Acrolinx IQ toolbar and check that the plug-in version number in the version information matches the version of the plug-in that you just installed. If the new plug-in version is still not visible, clear your browser cache and try again.

11 Index 11 Index A About this Guide 3 C Configuring the Connection to the Acrolinx IQ Server 9 Configuring the SSO Properties 5 E Enabling the Acrolinx IQ Plug-in 6 I Introduction 3 U Uploading and Installing the Acrolinx IQ Plug-in Package 6