Endpoint Index Start Point
Heureka's default index path begins at the directory where user files are usually stored: Windows "C:\Users", Mac OSX "/Users", Debian "/home". This start point is configurable, however this step should be completed before the installation process begins so-as to not waste time on the initial index scanning unnecessary files.
Editing Windows Index Start Point
If you have obtained your "install.bat" file listed in step three below, please make a copy of it before editing the file.
Using a text editor, open the "install.bat" file and locate the line beginning with "-DCRAWL_ROOT=". You will be editing the information directly after the equal sign "=". In the example at the right, you can see that the start location for indexing is a folder named "Example Folder" located on the desktop of the computer.
Please keep in mind that if there are any spaces in the path, it must be enclosed in quotation (") marks.
DO NOT alter any other information inside the "install.bat" file. Once your path is changed, save and close your "install.bat" file.
Editing Macintosh Index Path
If you have obtained your "agent.config" file listed in the Macintosh Instructions > step five below, please make a copy of it before editing the file.
Using a text editor, open the "agent.config" file and locate the line beginning with "endpoint.indexer.crawlPaths=". You will be editing the information directly after the equal sign "=". In the example at the right, you can see that the start location for indexing is a folder named "Test Folder" located on the desktop of the computer.
DO NOT alter any other information inside the "install.bat" file.
Once your path is changed you need to verify that the TextEdit program has not changed your file into Rich Text Format (rtf). Go to Format > Make Plain Text and then save/close your "agent.config" file. Your file should not have a ".rtf" extension on the end.
Install.bat example showing custom folder path
| Info | ||
|---|---|---|
| ||
Before installing an endpoint service you must have a valid license file provided by Heureka Software. |
Installing the Windows endpoint service for cloud-based installation
Create a folder on your desktop named "HeurekaAgent"Once provided, move the "install.bat" file into the same folder as the downloaded executable file obtained in step 2.
Right-click the "install.bat" file and select "Run as Administrator" and select "Yes" when prompted to allow the program to make changes to the computer.
As a reminder, this is a silent install so you may not see prompts on screen. Navigate to your Task Manager > Services. You should now see a service running called "Indexing Service".
To verify that the installation has occurred, launch the task manager, select the "Processes" tab at the top and scroll until you are viewing "Background Processes". Windows 7 users should see "HeurekaAgent.ext *32" and "HeurekaAgentHelper.exe *32" running. In Windows 8+ please look for "Java(tm) Platform SE binary (32 bit). Expand this process and you should see "HeurekaAgent" running.
Image showing downloaded .exe file and install.bat
Step 7 showing Indexing Service running in Windows 8+
Step 8 showing Indexing Service process running in Windows 10
Step 10 showing Interrogate > Configuration > Endpoint agent Crawled Date
| Info | ||
|---|---|---|
| ||
Before installing an endpoint service you must have a valid license file provided by Heureka Software. |
Installing the Macintosh endpoint service for cloud-based installation
Open a terminal window on your Macintosh. This can be found in MacintoshHD > Applications > Utilities > Terminal or type "Terminal" in the search tool in the upper right corner.
Type the following command into your terminal window: sudo mkdir -p /usr/local/opt/heureka-agent/conf You will be prompted for your password in the terminal window.
In your terminal window, type open /usr/local/opt/heureka-agent/conf. Your folder should appear in a finder window.
Obtain the installer package (usually downloadable from an email link from a Heureka Support Representative) and place in the conf folder created in step 2.
Contact Heureka to obtain your agent.config file. This file contains the information necessary to configure the endpoint service to talk to Heureka's backend services.
Once provided, move the "agent.config" file into the conf folder with your installer. (You may be required to authenticate the move into the folder). Click "Authenticate" and then enter your password if prompted.
Double-click the "heureka-agent.pkg" installer and follow the prompts to install. You will be required to re-enter your password.
If successful, you should see the "Installation was completed successfully" message in the installer. Click "Close" to close the installer. You will notice that the installer created several additional files in your conf folder. Open a console window (type "console" in your spotlight search) and expand the /var/log directory. Look for the com.heurekasoftware.agent.log and click on it. You should see information scrolling in the window verifying that your index process has begun. Close the console window.
Depending on the start point of your index, the initial index will take some time to complete. Once finished, you will see a "Crawled Date" in Interrogate > Configuration > Endpoints.
Step 2 - Image showing terminal window with sudo command
Step 5 - Image showing conf folder with agent.config and downloaded heureka-agent.pkg
Step 8 - Image showing successful installation screen
Step 10 showing Interrogate > Configuration > Endpoint agent Crawled Date