Fusion Connectors

Version 5.1
How To
    Learn More

      Fusion Connectors

      The steps for installing a connector have changed in newer releases; see Install A Connector - 5.2 and Above.

      In Fusion 5.1, connectors are installed using the Connector Plugins Repository API, which accesses Fusion’s built-in repository of plugins.

      How to install a connector in Fusion 5.1
      1. List the connectors in Fusion’s repository:

        curl -u admin:Password123 http://fusion-cluster:6764/connectors/repository
      2. In the output, find the ID of the connector you want to install:

        [ {
          "id" : "lucidworks.fs",
          "version" : "2.1.0",
          "sdkVersion" : "2.0.0",
          "location" : "com/lucidworks/connector/plugins/lucidworks.connector.fs/2.1.0/lucidworks.connector.fs-2.1.0.zip"
          "id" : "lucid.twitter-search",
          "version" : "5.2.0",
          "sdkVersion" : "5.2.0",
          "location" : "com/lucidworks/connector/plugins/lucid.twitter-search/5.2.0/lucid.twitter-search-5.2.0.zip"
        } ]

        In this example, we will install the Local Filesystem V2 Connector, whose ID is lucidworks.fs.

      3. Send the connector ID to the API:

        curl -u admin:Password123 -X POST "http://fusion-cluster:6764/connectors/plugins?id=lucidworks.fs"
          "pluginId" : "lucidworks.fs",
          "status" : {
            "action" : "INSTALL",
            "status" : "SUCCESS",
            "message" : "Plugin lucidworks.fs was installed successfully."

      After you install a connector, you can Configure A New Datasource.

      You can view and download all current and previous V2 connector releases at plugins.lucidworks.com. If you have downloaded a connector, you can install it using the blob store manager.
      1. In your Fusion app, navigate to Indexing > Datasources.

      2. Click Add.

      3. Select your connector.

        The connector configuration panel appears. The specific configuration options vary depending on the connector.

        If you do not see your connector in the list, you may need to install it:

      4. Configure your connector’s options:

        1. Enter a useful name for your datasource in the Datasource ID field.

        2. You can leave the Pipeline ID and Parser fields as-is to start with the defaults, or select different ones if you have them.

        3. Configure the connector-specific options.

          Refer to your connector’s configuration reference topic for details about each option.

      5. Click Save.

      6. Test your datasource configuration:

        1. Navigate to the Index Workbench at Indexing > Index Workbench.

        2. Click Load…​.

        3. Select the datasource ID you specified when you created the datasource.

          Now you can see your datasource configuration and a simulation of the results you can expect when you run this datasource job to index your data.

        4. Adjust the configurations of your datasource, parsers, and index pipeline until the simulated results are satisfactory.

        5. Click Save.

      7. Index your data:

        1. In the Index Workbench, click Start Job.

          Start Job

        2. When the job status is Finished, navigate to the Query Workbench at Querying > Query Workbench to view the indexed documents and configure your query pipeline.

      Lucidworks provides a Connectors SDK in a public repository on GitHub with all the resources you need to develop custom connectors. Clone the repository to get started:

      git clone https://github.com/lucidworks/connectors-sdk-resources

      It includes the Random Content connector, which generates random documents and serves as an example project that you can use as a model for your own custom connector projects.

      Currently, only Java is supported. See the Javadocs.

      These topics provide details about developing custom connectors for Fusion: