DownloadsDocumentationAPI ReferenceChangelogOpen A TicketContact

# **Configuring SearchBlox**

Before using Confluence Connector, install SearchBlox successfully and create a **Custom Collection**.

1036


# **Configuring Confluence Connector**

## **Important points to note before running the connector**

  • Fresh run confluence connector has to be run first.

  • All the files related to the connector should be available in the same folder that is, all files should be extracted into the same folder.

  • Create a data folder on your drive where the files would be temporarily stored and mention in yml files.

  • Download the zoneinfo file and create a system variable as mentioned in the following prerequisites section

## **Steps for encrypting password**

  • Password can be encrypted using a utitilty encrypt.exe available in the downloaded archive.

  • Run the exe file in command prompt as administrator and provide your password, the encrypted password would get generated.

  • Please copy the password and give it in your yml file instead of actual password. (Please refer the sample yml files in the downloaded archive)

771


## **Prerequisites**

**For Windows:**

  1. Download zoneinfo.zip into any directory (preferably C drive). [https://sbgoclient.s3.amazonaws.com/confluence/confluence_refresh/zoneinfo.zip](🔗)

  2. Add a system variable named ZONEINFO, and the value should be the path of zone info zip. For example, System variable name ZONEINFO and value= C:\zoneinfo.zip

  3. Save the Environment variable.

**Linux**

  1. Download zoneinfo.zip into /usr. [https://sbgoclient.s3.amazonaws.com/confluence/confluence_refresh/zoneinfo.zip](🔗)

  2. Go to bash_profile file using the following command: vi ~/.bash_profile

  3. Add the following in the file and save: _export ZONEINFO=/usr/zoneinfo.zip _

Note:

These steps are mandatory for the connectors to refresh the data. The preceding setup has to be done before running fresh connector.

Contact [[email protected]](🔗) to request the download link for SearchBlox Confluence connector. The following steps include the example paths for both Windows as well as Linux. In Windows, the connector would be installed in the _C drive_. In Linux, the connector has to be installed in _/opt_.

## **Steps to Configure and Run the Confluence Fresh Run Connector**

  • Download the SearchBlox Confluence connector. Extract the downloaded zip to a folder.

  • Unzip the archive under _C:\* or _/opt*.

Note:

In Linux, make sure that necessary permissions have been provided to the folder /opt by using the CHMOD command for writing log files and executing jar files.

  • Configure the confluence.yml file which includes confluence properties and SearchBlox properties as listed in the following:

Column Title
Column Title
usernameUser Name for Confluence account
passwordEncrypted Password for Confluence account
data-directoryData Folder where the data needs to be stored. Make sure it has write permission.
api-keySearchBlox API Key
colnameThe name of the custom collection in SearchBlox.
urlSearchBlox URL
confluenceurlConfluence URL
exclude-formatsFile formats to exclude. Please give the extension of the file with dot operator as in the example Example: .war,.zip Note: regex not allowed
exclude-foldersFolders to exclude in confluence. The subpath folder in the confluence URL to be excluded. example: folder1, folder2 Note: regex not allowed, full folder name has to be provided
max-folder-sizeMaximum size of static folder after which it should be sweeped in MB.
log-file-maxSizeMegabytes after which new file is created.
og-file-maxBackupsNumber of backups after which log file should be deleted.
log-file-maxAgeNumber of days after which log files should be deleted.
Url, servlet url & delete-api-url:Make sure that the port number is right. If your SearchBlox runs in 8080 port the URLs should be right.

  • The content details of confluence.yml are provided here: 


  • Start running the confluence_fresh.exe file for Windows and ./confluence_fresh_linux32 or ./confluence_fresh_linux in Linux
  • A file named last_run_date_time.yml will be generated in the folder where the executables are available. This file is important to run the refresh connector
## **Steps to Configure and Run the Confluence refresh run Connector**
  • Configure confluence_refresh.yml file similar to how the fresh run connector yaml file is configured. As mentioned above it includes both confluence and SearchBlox properties. The only additional field is time zone:
customer-confluence-timezone: EST
ref: [https://searchblox.s3.amazonaws.com/Connectors/timezone_confluence.txt](🔗)
This is the timezone in which the confluence server is running.
Column Title
Column Title
customer-confluence-timezoneThe timezone in which the confluence server is running.
example: UTC, EST, CST, etc
customer-confluence-timezone: UTC
Please refer the following file for the zones to be given
[https://searchblox.s3.amazonaws.com/Connectors/timezone_confluence.txt](🔗)
The contents of the file will look like this: 

  • Start running the confluence_refresh.exe file for Windows and ./confluence_refresh_linux32 or ./confluence_fresh_linux in Linux