Connectors UI

Connectors UI

The Connectors UI in SearchBlox lets you index content from applications not supported by standard collections. It provides an easy way to connect to external sources, set up indexing, and make their data searchable in SearchBlox. This helps SearchBlox work with more types of data.

Locate Connectors UI in SearchBlox:

The Connectors UI files are found in the connectors folder inside your SearchBlox installation directory.

Run Connectors UI as a service in Windows

• Navigate to Connectors Directory

  C:\\SearchBloxServer\\connectors
  

• Install the Service
  Execute:

  sbconnector-service.exe install
  

• In the Task Manager service tab start the sbconnector service

Run Connectors UI as a service in Linux

1. Download Service File: Obtain sbconnector.service and place it in the systemd directory:

   cd /lib/systemd/system
   wget https://d2fco3ozzrfhhd.cloudfront.net/v10.0/sbconnector.service
   

2. Set Permissions: Assign ownership and execute permissions:

   chown searchblox:searchblox sbconnector.service
   chmod 755 sbconnector.service
   

3. Start Service: Initiate the connector service:

   systemctl start sbconnector.service
   

4. Stop Service: Halt the connector service:

   systemctl stop sbconnector.service
   

5. Check Status: View the current status of the service:

   systemctl status sbconnector.service
   

Please find the following list of data sources, on clicking the link you would be redirected to the help page
Alfresco Data Source
Amazon S3 Data Source
Azure Blob Data Source
Azure File Data Source
Box Data Source
CSV Data Source
Confluence Data Source
Drupal Data Source
DocuSign Data Source
Generic Entity Updater Data Source
GitHub Data Source
Google Drive Data Source
Google Sites Data Source
JIRA Data Source
One Drive Data Source
Salesforce Data Source
SharePoint 2010 Data Source
Sharepoint 2013 Data Source
SharePoint Online Data Source
URL Data Source
Zendesk Data Source

Starting and Accessing Connectors UI (Windows)

• Start Service: Open Task Manager, go to the Services tab, and start the sbconnector service.
• Access UI: Open a web browser and go to https://localhost:8446. By default, the Connectors UI uses port 8446.
• Port Configuration: To change the port, edit the config.xml and sbconnector-service.xml files in the SearchBlox/connectors/ folder.

Create an account

• Click the “Create an account” button on the home page.
• Enter a username and password.
• Click “Create an account now” to finish.

Create an endpoint

• After creating an account, click the "+" icon at the top right to create a new endpoint.

📘

NOTE:

Please create a folder users in <SearchBlox-Installation-path>\connectors before creating a endpoint.

• Enter the following details to create the endpoint:
  1. Endpoint Name: Must be unique for each endpoint.
  2. URL: The SearchBlox endpoint (e.g., https://localhost:8443/). You can replace "localhost" with the IP address where SearchBlox is installed.
  3. API Key: The API key of the SearchBlox instance.
  4. Private Key: Found in the SearchBlox User tab for SBAdmin or Admin users.
     Make sure the SearchBlox server is running before creating the endpoint, otherwise an error will occur.

Create a new Data Source

• Click “Setup a new Data Source” to create a new data source with your chosen connector.

• Select the type of Data Source you want to use for indexing documents.

• Fill in all mandatory fields and click Create & Index.
• Make sure there is a corresponding Custom Collection in the SearchBlox server to store the indexed documents.

• The state will show RUNNING while the connector is indexing the documents.

• Once the state changes to DONE, go to the SearchBlox server and check if the documents are indexed in the selected Custom Collection.