Configuring the Connector in Exalead CloudView

This section describes how to prepare and configure the Proxem connector in Exalead CloudView, to use the Proxem categories as refinement.

This task shows you how to:

See Also
Supported Features
Installing the Connector in Exalead CloudView

Configure the Source Connector

You first have to configure a source connector to fetch, prepare, and push documents to the Proxem API.

Note: As the Proxem analysis can take time, you can optionally push documents directly to a Consolidation Server to get a quicker access to documents. For more information, see Configure the Consolidation Server.

  1. Open the Exalead CloudView Administration Console.
  2. Add a connector instance:
    1. Go to Connectors and click Add connector.
    2. For Name, enter a descriptive name for the connector, for example, filesToProxem.
    3. In Creation mode, select either new or copy if you want to copy an existing connector.
    4. In the Type list, select a source connector like Files.
    5. Click Accept.
  3. Configure the source connector. For example, for a Files connector, you have to define the paths to crawl in the Configuration tab.
  4. Go to the Advanced tab.
  5. Add a Document convert PushAPI Filter.

    Important: For the Conversion mode property, select Text.



  6. Add a Push to Proxem PushAPI filter.



    Property Description
    Proxem project ID ID of the Proxem project for which you want to index documents.
    Proxem user name User name to connect to the Proxem server.
    Proxem API key Specify the key of the Proxem external API.

  7. Click Apply.

For the standard workflow, you can now discard source connector documents to make sure that Exalead CloudView does not index them.

Discard Source Connector Documents

You can discard documents coming from the source connector to avoid indexing and seeing them in the Exalead CloudView interface.

You do not want to search on these documents but only on the documents analyzed by Proxem.

  1. Go to Data Processing and open your Analysis pipeline, for example, ap0.
  2. In the Document Processors tab, add a Discard Document Processor at the top of the Current processors list.
  3. Expand Condition tab, and configure for documents coming from the source connector (for example, filesToProxem).



  4. Click Apply.
  5. Go to the Home page and click Scan for the source connector.

You can now configure the Proxem connector.

Configure the Proxem Connector

You can now configure a Proxem connector to index the documents analyzed by the Proxem API.

  1. Open the Exalead CloudView Administration Console.
  2. Add a connector instance:
    1. Go to Connectors and click Add connector.
    2. For Name, enter a descriptive name for the connector, for example, proxem.
    3. In Creation mode, select either new or copy if you want to copy an existing connector.
    4. In the Type list, select Proxem.
    5. Click Accept.
  3. In the Configuration tab, configure your Proxem connector as required.

    Property Description
    Proxem base url URL of the Proxem environment. It must point to the API. For example, https://studio3.proxem.com/production4d/api/v1
    Proxem project ID ID of the Proxem project for which you want to index documents.
    Proxem user name User name to connect to the Proxem server.
    Proxem API key Specify the key of the Proxem external API.
    Source connector name Specify the name of the source connector that fetches documents to push them into the Proxem connector.

  4. Go to the Operation tab and schedule a full scan every 5 minutes.

    Note: This step is to make sure that the connector has up-to-date annotations.

  5. Click Apply.
  6. Go to the Home page, and click Scan for the Proxem connector.
    Documents will be indexed only after the first Proxem analysis. This can take time.

You can now configure the Index Data Model. For more information, see Configure the Exalead CloudView Data Model.

Configure the Exalead CloudView Data Model

You can now configure the Exalead CloudView data model to create the categories generated by Proxem.

Before you begin: See your Proxem Explore interface, to find the categories that you want to retrieve.
  1. In the Administration Console, go to Index > Data Model.
  2. Under Data model options, select Trace all metas
  3. Click Apply.
  4. Go to the Home page, click Scan for the connector.

    This saves all scanned metas to an internal database.

  5. Go back to Index > Data Model > Classes, click Add properties from traced metas.

    Exalead CloudView enables you to select multiple metas to save as properties.

  6. Select the Proxem categories (their technical names) that you want to index, and in their property configuration, select Category facet.



  7. Click Generate properties.
  8. Click Apply.
  9. As you have changed the Index Schema by adding new properties, you need to clear the documents in the build group and reindex your data:
    1. On the Home page, under Indexing, click Clear. Wait for the index to clear its documents.
    2. Under Connectors, click Scan for your Proxem connector.

    Important: In Index > Data Model , clear the Trace all metas option.

You can now test your Search Application. For more information, see Test Results in the Search Application.

Configure the Consolidation Server

Optionally, you can configure Exalead CloudView to use a Consolidation Server, that will receive documents directly from the Source Connector, and then from the Proxem Connector when the Proxem analysis is complete.

This is useful to save time and avoid waiting for the end of the analysis.

  1. Prepare both the Source Connector and the Proxem Connector to use the Consolidation Server:
    1. Open the connector, and go to the Deployment tab.
    2. For Push to PAPI server, select the Consolidation Server instance on which the connector must push its documents.
    3. Apply the configuration.
  2. Disable the Discard Document Processor configured in Discard Source Connector Documents.
    1. Go to Data Processing and open your Analysis pipeline, for example, ap0.
    2. In the Document Processors tab, for the Discard Document Processor, select Disable processor.
    3. Click Apply.
  3. Configure the Consolidation Server.
    1. Go to Index > Consolidation.
    2. Under Aggregation Processors, click Add processor.
    3. Select com.dassault_systemes.exalead.processor.proxem.ProxemAggregationProcessor ("Proxem Aggregation Processor")
    4. Click Apply.
  4. Rescan the impacted sources using the Consolidation Server:
    1. Go to the Home page.
    2. Under Indexing, click Clear to clear the index (as you have changed the Push to PAPI server property from a build group configuration to a Consolidation Server configuration).
    3. Scan your connectors.

You can now test your Search Application. For more information, see Test Results in the Search Application.

Test Results in the Search Application

You can now use the Proxem categories in your Search interface.

Important: When you modify one of the configuration properties, you must clear documents and start a Full Scan to synchronize all documents.