SearchBlox

SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Documentation

Active Directory Integration

Configuration for Active Directory in SearchBlox

SearchBlox versions 8.2 and later are pre-installed with Advanced Integration. It can be accessed from http://localhost:8080/mcf-combined-service/login.jsp.

The default username and password are admin|admin. This can be changed in ManifoldCF properties file.

Steps for Advanced Integration with Active Directory

Start SearchBlox and create a custom collection. This collection should be linked with ManifoldCF, and the files can be indexed and searched from this collection.

Configuring/Creating Advanced Integration for Active Directory

Configuring Active Directory involves the following steps.

1. Creating a Transformation Connection
A transformation connection is a connection to an engine where documents fetched from various repositories can be manipulated. This typically involves metadata extraction or mapping. Click on List Transformation Connections in the menu, and click the Add a new transformation connection button to create a new transformation connector.

Enter any name that is relevant for the transformation connection. Then move to the next tab, Type.

From the Type tab, select the Connection type as “Tika content extractor” and click the Continue button, and then click the Save button. This returns to List Transformation Connections, where the transformation connector created will be available.

2. Creating an Output Connector
An output connection is a connection to a system or place where documents fetched from various repositories can be written to SearchBlox.

Click on List Output Connections in the menu, and click the Add a new output connection button to create a new output connector.

Enter a name for the output connector and move to the Type tab. Select the Connection type as “Searchblox”. Click the Continue button.

After clicking Continue, two more tabs will appear. Click the SearchBlox Settings tab.
Specify the API key from the admin page from SearchBlox. When finished, click the Save button.

3. Creating an Authority Group
An authority group is a collection of authorities that all cooperate to furnish security for each document from repositories that the user selects.

Click on List Authority Groups from the menu, and click the Add a new authority group button to create a new authority group.

Enter a name and Save the authority group.

4. Creating an Authority Connector
Click on the List of Authority Connections from the menu, and click the Add a new connection button to create a new output connector.

Enter a name and move to the Type tab and select the Connection type as “Active Directory”. Select the Authority group that has been previously created.

After clicking Continue, more tabs will appear. Click the Domain Controller tab.

Enter the Domain controller name, Domain suffix and Admin username and password, and click Add to End. For Domain controller or Domain suffix details, contact the system administrator. After clicking Save Connection status, the status will read “Connection working”. If the connection does not work, the domain controller is not correct.

5. Creating Repository Connections
Click on List Repository Connections from the menu, and click the Add a new connection button to create a new repository connector.

Enter a name and move to the Type tab. Select the Connection type as “Windows shares” and select the Authority group previously created.

After clicking the Continue button, two more tabs will appear that will navigate to the Server tab. Enter the server details and click save. For server details, contact the system administrator.

6. Creating a Job
Click on List all Jobs from the menu, and click the Add a new job button.
Enter the name and click the Connection tab.

Select the Connection name and Output from the select box and click the Add output button. Then select the transformation and click Insert transformation before.

Select the path from the Paths tab, and add that paths that need to be indexed.

Enter the collection name from SearchBlox in the SearchBlox settings tab. Add some boosting if required for the fields.

Navigate to the Status and Job Management menu from the left side. Jobs created will be displayed here. Start the job by clicking the Start button.

Once the job execution has been finished, documents will be updated in the SearchBlox server.

Searching Securely Using Searchblox

Please enable Active directory secure search under Search → Security settings as shown below:
Secure Search can be used based on active directory configuration by enabling the checkbox for Secured Search and giving the required settings:

  • Select Enable Secured Search
  • Give the Active directory details

LDAP URL

LDAP URL that specifies base search for the entries.

Search Base

Search Base for the active directory.

Username

Admin username.

Password

Password for the username.

Filter-Type

Filter type could be default or document.

Enable document filter

If you need to filter search results based on users, then enable this option.

  • Test for a successful connection.

Perform secure search.

The instructions above are applicable for versions 8.5 and later.
For versions prior to 8.5, please go to ../webapps/searchblox/WEB-INF/secured.yml and enter your credentials.

url: ldap://198.50.196.176:389
search-base : "DC=ad,DC=searchBlox,DC=com"
username: Administrator@searchblox.com
password: Domain@2016
#There are two types 1. Default 2. document
type: document
#Filter search result with SSID,
document-filter: true

Note

If you need to filter search results based on users, then please enter true for document-filter.

Restart the server once you make the changes.

For help with configuration details, contact the system administrator.
Navigate to the URL below and log in with the system username and password. From there, search the accessible files.
http://localhost:8080/searchblox/search/login_securesearch.jsp

Scheduling Indexing

By default, in Advanced Integration documents are scanned once while indexing. Indexing can also be scheduled for a specific time. The default settings are shown below:

Indexing can be scheduled to work continuously by selecting schedule type to Rescan documents dynamically, and setting the re-crawl interval and re-seed interval to 1440 minutes.

Admin Access to File Share

If the SMB file share is available on another server on the same network and requires permission, run the SearchBlox server service with Admin access and enter the credentials as listed in the screenshot below. Running as admin account or account with access to files only will help successfully index files from the share.

Also please make sure to run the network crawler service as Admin.

Active Directory Integration