quick start

Quick start

Welcome to the quick start guide.

The goal of this guide is to run Assimbly gateway and create your first flow!

Prerequisites

Download

Get the latest Assimbly release.

Java

The standalone version only needs Java (Version 21). The version of a Java can be checked with the command:

java -version

If you see something like:

java version "21" 2023-09-19
Java(TM) SE Runtime Environment (build 21+35-3456)
Java HotSpot(TM) 64-Bit Server VM (build 21+35-3456, mixed mode, sharing)

You are good to go. Otherwise, download Java at https://adoptium.net.

Note: Assimbly 4.x also support Java 11+

Run Assimbly

• Open a terminal.
• CD to the directory which contains “gateway-[version].jar” (for example: cd C:\users\user\Download).
• Start the application:

java -jar gateway-[version].jar

Result:

After start you should see something like this:

The gateway can be reached at the following URL:

http://localhost:8080

To use another port:

java -Dserver.port=8888 -jar gateway-[version].jar

The terminal needs to stay open to keep the application running.

First flow

At first login, you can use username/password: admin/admin

Now we will create a new flow. This flow picks up files from one directory and drops the files into another directory.

1. First create three directories on your local computer. For example, on Windows:

                C:\messages\in
                C:\messages\out
                C:\messages\error

or on Linux/Mac:

                /messages/in
                /messages/out
                /messages/error

In the “in” folder create a file test.txt

2. In Assimbly click on the Menu button and choose “New flow”. Name the flow “TestFlow”.

3. Create from, to, and error endpoints. All you need to do is select the File component and add the directories to the path field as shown in the following image:

4. As the last step, 'Save' the flow. This will bring you back to the main page. Your new flow should be listed there.

Run and Test

1. Click on the start button to run the flow. If the flow turns green, the flow is started.

2. Messages in the “in” directory are now picked up by the from endpoint and should appear in the “out” directory. In case anything goes wrong, messages are sent to the error endpoint (In this example, the 'C:\messages\error' directory).

Next step

Now you can discover Assimbly on your own, read the user guide or follow one of the tutorials.