Install XL Ingest as a Windows Service

1. Download the XL Ingest ZIP file:

   https://bryteflow.com/release/singlestore/ixl/24_b122/xlingest.zip

   Unzip the file into a directory at the same level as the Ingest directory.

2. Change the directory to the xlingest folder and open xlingest.xml file in a Notepad. Change the following lines as per your requirements.

   <id>SingleConnect-XL-Ingest</id>	This tag is used as an unique ID in Windows services. Each XL Ingest pipeline has its own ID.
   <name>SingleConnect XL Ingest</name>	This tag is a display name in the Windows services. It must be brief and descriptive.
   <description>SingleConnect XL Ingest</description>	This tag specifies a description of the XL Ingest service.

3. Install XL Ingest as a Windows service.

   1. Open a command prompt as an Administrator.

   2. Navigate to xlingest folder and run the Install-SingleConnect-XL-Ingest-Service.bat file using the following command.

      Shell

      Copy

      Install-SingleConnect-XL-Ingest-Service.bat

      This batch file runs commands to install the service. Once the command is completed, close the command prompt.

4. The XL Ingest service must appear in the Windows services list like SingleStore-XL-Ingest. The name must be similar as shown in step 2.

5. The XL Ingest service starts automatically upon installation and must be running. You can start, stop, or restart the XL Ingest service like other Windows services.

6. Open Chrome and navigate to http://localhost:8084. If the application is installed on a server, navigate to http://<server-ip-address>:8084 instead.

7. Navigate to Configuration > License, and enter the license key.

Install XL Ingest in Non-Windows Environment

1. Download the XL Ingest ZIP file:

   https://bryteflow.com/release/singlestore/ixl/24_b122/xlingest.zip

   Unzip the file into a directory at the same level as the Ingest directory.

2. To start XL Ingest, run the following Java command from the directory where the files have been unzipped. To include external libraries, skip to the next step.

   Shell

   Copy

   java -jar xlingest.jar

3. To include external libraries, use the following command instead.

   Windows

   Shell

   Copy

   java -cp "other_lib.jar;xlingest.jar" cirus.Run

   Linux

   Shell

   Copy

   java -cp "other_lib.jar:xlingest.jar" cirus.Run

4. The default port for XL Ingest is 8084. You can change this port from the user interface (UI). The new port setting takes effect after the next run.

Apply the License Key

The Flow suite of products comes with a validity period specific to each customer's agreement. Be sure to obtain valid license keys to begin using the software. Each software product has its own unique product ID when set up individually.

To obtain a valid license contact SingleStoreSales with the Product ID. Navigate to Configuration. In Licence Key, enter the license key, and then select Save to save the settings.

To retrieve the Product ID, go to your XL Ingest instance, navigate to Configuration > Licence, and copy the ID from the 'Product Id'.