AEM Connector 12.12

# Install AEM Connector on Windows

To install the AEM Connector on Windows, use the following procedure.

To install the AEM Connector

1. Run the AEM Connector installation program.

   The installation wizard opens.

2. Read the installation instructions and click Next.

   The License Agreement dialog box opens.

3. Read the license agreement. If you agree to its terms, click I accept the agreement and click Next.

   The Installation Directory dialog box opens.

4. Choose an installation folder for AEM Connector and click Next.

   The Service Name dialog box opens.

5. In the Service name box, type a name to use for the connector’s Windows service and click Next.

   The Service Port and ACI Port dialog box opens.

6. Type the following information, and click Next.

   Service port | The port used by the connector to listen for service actions.
   ACI port | The port used by the connector to listen for actions.

   The License Server Configuration dialog box opens.

7. Type the following information, and click Next.

   License server host | The host name or IP address of your License server.
   License server port | The ACI port of your License server.

   The IDOL database dialog box opens.

1. In the IDOL Database box, type the name of the IDOL database that you want to index data into, and click Next.

   The Proxy Server dialog box opens.

2. If a proxy is required to communicate with the repository from the machine on which you are installing the connector, type the following information and then click Next.

   Proxy host | The host name or IP address of the proxy server to use to access the repository.
   Proxy port | The port of the proxy server to use to access the repository.
   Proxy username | The user name to use to authenticate with the proxy server.
   Proxy password | The password to use to authenticate with the proxy server.

   The AEM Connection dialog box opens.

3. Enter the following information, and click Next.

   Use secure connection | To communicate with AEM over HTTPS, select this check box.
   AEM Host | The host name or IP address of the AEM server.
   AEM Port | The port number for the AEM server.
   AEM Username | The user name to use to access the AEM repository.
   AEM Password | The password to use to access the AEM repository.

   The CFS dialog box opens.

4. Choose whether to install a new CFS or use an existing CFS.

   - To install a new CFS, select the Install a new CFS check box and click Next.

     The Installation Directory dialog box opens. Go to the next step.

   - To use an existing CFS, clear the Install a new CFS check box and click Next.

     The CFS dialog box opens. Type the Hostname and Port of your existing CFS. Then, click Next and go to Step 16.

1. Choose an installation folder for the Connector Framework Server and then click Next.

   The Installation name dialog box opens.

2. In the Service name box, type a unique name for the Connector Framework service and click Next. The name must not contain any spaces.

   The CFS dialog box opens.

3. Type the following information, and click Next.

   Service port | The port used by CFS to listen for service actions.
   ACI port | The port used by CFS to listen for actions.

4. Type the following information and click Next.

   IDOL Server hostname | The host name or IP address of the IDOL server that you want to index documents into.
   ACI port | The ACI port of the IDOL server.

   The Pre-Installation Summary dialog box opens.

5. Review the installation settings. If necessary, click Back to go back and change any settings. If you are satisfied with the settings, click Next.

   The connector is installed and the Advanced Configuration dialog box opens.

1. The installation program can run the connector, query the repository, and help you to configure what to synchronize.

   - To configure what to synchronize, select the Perform advanced connector configuration check box and click Next.

     The connector queries the repository to obtain a list of services that you can retrieve information from. Go to the next step.

   - To configure the connector manually, clear the Perform advanced connector configuration check box, and click Next.

     The installation is complete. Click Finish.

2. In the ServiceMustHaveRegex and ServiceCantHaveRegex boxes, type regular expressions to choose the services that you want to retrieve information from.

   ServiceMustHaveRegex | A regular expression to choose the services to crawl. An AEM service name must match the regular expression, otherwise the service is ignored.
   ServiceCantHaveRegex | A regular expression to choose the services to crawl. If an AEM service name matches the regular expression, the service is ignored.

   Then, in the Next action list, choose one of the following options and click Next:

   - Test parameters - filter the list of items, using the parameter values you entered.
   - Finish configuration - save the configuration and end the configuration process.
   - Continue configuration - continue configuring the connector.

   If you choose to continue configuring the connector, the connector queries the repository for entities that can be crawled and indexed. The Entity Identifiers dialog box opens, and shows a list of the entities that exist in the repository (up to 2 levels from the root). Before each entity is a prefix, `[IGNORE]` or `[INDEX]`, which shows whether the connector will index the item with the current settings. Following the prefix is the entity class, for example `[content/page]` and then the entity path.

3. In the text boxes, type parameter values to choose the entities to crawl and index.

   If you exclude an entity from being crawled, the entity and any child entities are not processed or indexed by the connector.

   CrawlEntityClassMustHaveRegex | A regular expression to choose the AEM entities to crawl. The class name of an AEM entity must match the regular expression, otherwise the entity is ignored.
   CrawlEntityClassCantHaveRegex | A regular expression to choose the AEM entities to crawl. If the class name of an AEM entity matches the regular expression, the entity is ignored.
   CrawlEntityPathMustHaveRegex | A regular expression to choose the AEM entities to crawl. The path of an AEM entity must match the regular expression, otherwise the entity is ignored.
   CrawlEntityPathCantHaveRegex | A regular expression to choose the AEM entities to crawl. If the path of an AEM entity matches the regular expression, the entity is ignored.
   IndexEntityClassMustHaveRegex | A regular expression to choose the AEM entities to index. The class name of an AEM entity must match the regular expression, otherwise the entity is not indexed.
   IndexEntityClassCantHaveRegex | A regular expression to choose the AEM entities to index. If the class name of an AEM entity matches the regular expression, the entity is not indexed.
   IndexEntityPathMustHaveRegex | A regular expression to choose the AEM entities to index. The path of an AEM entity must match the regular expression, otherwise the entity is not indexed.
   IndexEntityPathCantHaveRegex | A regular expression to choose the AEM entities to index. If the path of an AEM entity matches the regular expression, the entity is not indexed.
   Max crawl depth | The maximum crawl depth. This does not affect the task configuration but you can modify the value to show more or fewer entities in the list of items.

   Then, in the Next action list, choose one of the following options and click Next.

   - Test regexes - filter the list of items, using the regular expressions you entered.
   - Finish configuration - save the configuration and complete the configuration process.

   When you finish configuring the connector, the Connector Configuration Completed dialog box opens.

4. Click Next, and then click Finish.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.12 | Last updated June 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL AEM Connector 12.12

Topic Title: Install AEM Connector on Windows