Skip to main content

Quick start

Let's get you started! In less than 10 minutes you'll be up and running your first service 🙂.

For demonstration purposes, we'll create a very minimalist ApplicationReorg maintenance service. We'll configure it to do - well, actually nothing! But executing even the simplest service will test the application starts correctly and loads the default configuration and the service file. The working database will be created automatically and we'll see that the jobs and logs are working.

Install the application​

In fact, the application doesn't need to be installed - it's a self-contained executable JAR.

Just copy dataspot-connector.jar to a directory of your choice.

Note

A Java 17 JRE (Java Runtime Environment) is required to start the application.

Other than that, the application has no further prerequisites - everything is contained in the delivered bundle.

Configure the application​

Conveniently, the ApplicationReorg service doesn't require any specific application configuration! 😉

The application will load the default configuration on startup.

Nevertheless, you might still want to check out the application configuration and create application.yaml or application.properties in your working directory. For example, you could change the working database or the dump directory.

connector:
  config:
    database:
      file: ./database/dsconnector
    dump:
      directory: ./dump
Tooltip

Find more configuration examples here.

Create your first service​

In your working directory, create a service file, for example myservices.yaml, where you define the service MyService and select the service type ApplicationReorg:

services:
  MyService:
    type: ApplicationReorg

That's all - you're ready to try out your service!

Execute your first service​

You can execute your service by starting the CLI application:

java -jar dataspot-connector.jar --service=MyService --file=myservices.yaml

Hopefully, your service completed successfully ✅.

If not 😢, check the logs. You might also want to read the details on starting the application and configuring a service.

Next steps​

Now, you could take a look at the basic connector architecture.

As soon as you're familiar with services and service configurations, pick a connector of your choice, explore some of the examples....

...and get connected!