GettingStarted

• Installation on Windows systems
  • Install as a service
  • Install without service
• Installation on Non-Windows systems
• Add database drivers to your installation
• Test your installation
• Adding your own developed batch, triggers an miscellaneous plugins to the giServer
• Server configuration basics
  • Create a new tenant
  • Add a datasource
  • Add queues
  • Add a schedule
  • Add a trigger
  • Check the tenant configuration

Installation on Windows systems

For windows system there is a setup available that can either install the giServer as as service or simple for manual start.

First choose the right setup for your Windows system (x64 or x86).

Install as a service

Follow the instructions of the setup wizard.

On the components page you have the choice to install the server as a service:

If you have trouble starting the service on your system, check the log files in the "logs" folder of your giServer installation.

There is also a configuration utility for fine tuning and trouble shooting of the service. You can start it by running the "giServerService_x64w.exe" or "giServerService_x86w.exe" in the installation folder.

Install without service

Use the Windows Setup and deselect "Install windows service" from the "Choose Components" page. If you have already installed the service you can remove it by running the "uninstall_service_xXX.bat" Script in the installation folder. You can start the giServer by running the "giServer_start.bat" Script.

Installation on Non-Windows systems

You can extract the contents of the platform independent archive into the folder of your choice.

Assuming, your JRE is added to the run path on your system, you can start the giServer by running in the installation folder:

java -cp lib/* de.gadiv.integration.server.ServerMain

The giServerManager can be started by running:

javaw -cp lib/* de.gadiv.integration.client.ClientMain

Add database drivers to your installation

Before you can setup a datasource for an MS-SQL Server for example you need to copy the database driver to the "ext" folder of your giServer installation folder. The driver will then be automatically added to your classpath.

The following table shows an overiew of the currently support databases and if the drivers need to be installed or not.

Database	Type	Included in giServer setup
MS-SQL	JDBC-Driver	No (download and copy to ext folder)
DB/2	JDBC-Driver	No (download and copy to ext folder)
MySQL	JDBC-Driver	No (download and copy to ext folder)
HSQL	JDBC-Driver	Yes
MongoDB	MongoDB-Driver	No (download and copy to ext folder)

Test your installation

To test your server installation you can check the log files in the "logs" folder.

You can also start the giServerManager and try to connect to the server. You can start the giServerManager through the start menu on Windows, or by running the batch script "giServerManager_start.bat". This will launch the UI and prompt for your login data.

When you first setup the server a default server database will be generated in the "data" folder. There is also a default server admin account, that can be used for further configuration.

Use the following data for your first login:
User: 'sa'
Password: 'testtest'

Don't forget to change this password to something else!

After your successfull login, you should create a test queue. Start the queue edit dialog by selecting 'Queues...' in the 'Manage' menu. Then add a new queue. In the edit dialog you can give your new queue a name and a description. After you hit 'OK', the queue is ready to use.

Now you can start an example batch job to test if your queue and the server is running correctly. Click on 'New batch...' to launch the manual batch dialog.

Select the batch 'ExampleBatch' and your queue name. Leave the parameters field empty, as this batch does not need any configuration. You can leave the Log-Level on 'INFO'. When you hit start, the batch will run immediately in the selected queue. If you add more batches to the same queue the batches will wait until it's their turn.

Now, back in the main view, you can hit the 'Search' button to check the status of your batch jobs. Hit the checkbox 'Show pending batches', if you want to see the waiting batches too.

Adding your own developed batch, triggers an miscellaneous plugins to the giServer

New batches, triggers and other plugins can easily be added to the giServer by copying their JAR archives to the "ext" folder of the giServer. The server needs to be restarted to register the new plugins.

You can check if your plugin is registered by opening the plugins dialog in the giServer Manager:

If your plugin is missing, check the log (/server-log/giServer.log) if there was an error loading the plugin.

Server configuration basics

This chapter gives you some short examples how to setup the giServer for a tenant. It's also possible to work without tenants, you will just need to leave the "Tenant" field empty in the edit dialogs. Non-tenant datasources, queues etc. can only be accessed by non-tenant users.

Create a new tenant

The fist stept for the configuration should be the creation of a new tenant. Of course only if you need to seperate between different tenants, otherwise you can leave the tenant configuration empty.

In the Manage menue select "Tenants...", this will open the tenants list. Here you can add a new tenant, the edit dialog looks as follows:

You must insert a unique name for the tenant and can add some descriptive text to describe the role of the tenant. The areas for the bound configuration evelements are still empty and will become filled later.

In the "Data folder" field you can insert a server local directory path. This will get automatically passed to every batch job of this tenant. This can be usefull for tenant specifiy data folders.

The parameters in the "Parameters" text area get added to each batch job started for this tenant too. They will be added to the parameters list of each batch job.

Add a datasource

For easy and centralized access to databases from your batch jobs, you will need to create datasources.

The edit dialog can be accessed via Manage->Datasources... in the giServerManager. It looks as follows:

If you add a new datasource you need to insert a unique name for it. The following table gives an explanation of the input fields:

Field	Description
Name	Unique name for the datasource
Tenant	Choose the tenant, that will get acceess to this datasource
Access-Type	DIRECT - Direct access to the database instance via TCP/IP (adequate for most use cases)
	REMOTESERVER - This is unique for MS-SQL Server if you need to connect via remote servers
DB-Type	Database type to use
DB-Host	Hostname of the database server
DB-Port	Port of the database instance
DB-Name	Name of the database
DB-Scheme	Name of the scheme. If left empty, the default scheme will be used.
DB-User	Database username
DB-Password	Password of the user
Linked server	This is for REMOTSERVER access only. Specifies the remote server name to use
Linked server DB-Type	This is for REMOTSERVER access only. Specifies the database type of the remote server
JDBC-Driver	Class of the database driver to use
Connection-URL	Connection URL template (will be generated automatically for the selected database)
Properies	List of additional properties that will be added to the connection URL.

Please note, that you will need to copy the database driver JAR to the "ext" folder to get the datasource working.

You can test the connection if you select the newly created datasource and click on the "Test connection" button.

Add queues

To add new batch processing queues you can use the queue edit dialog in Manage->Queues...

You will need to enter a unique name for the queue. Select the tenant you want to bind the queue to. It's also possible to insert a description.

Directly after you add the queue, a new thread gets spawned and is ready to accept new batch jobs.

Add a schedule

If you want to start batches automatically on predefined times you can add a new schedule. This dialog is available in Manage->Schedule...

Field	Description
Name	Unique name for the schedule
Tenant	The tenant the scheduled batch job will run for
Batch	The batch to execute
Log-Level	Level of loggin output information that will be written to the batch logfile
Queue	The queue the batch job will be submitted to
Starting parameters	Parameters that will get passed to the batch job
First/Last execution	Here you can specify a time range in that the schedule will get executed.
Type	ONE TIME - Execute the batch just one time
	INTERVAL - Repeatly execute the batch at the given interval
	WEEKLY - Execute the batch at the selected week days
Description	Here you can insert some more details on the schedule
Activated	If this is unchecked the schedule will be stopped until it gets activated again.

Add a trigger

Triggers are usefull to react on events (e.g. incoming data files) and automatically start batch jobs.

Triggers are plugins and need to be programmed using the giServer-API. The created JAR files need to be put into the "ext" folder of the giServer. On the next server restart the new trigger plugins will be registered. Please see the developer guide for more details on programming triggers.

The trigger plugins that are added in this dialog will get executed continuously to check for events.

A new trigger can be added by calling Manage->Triggers...

Field	Description
Name	Unique name for the trigger
Tenant	The tenant the trigger will run for
Trigger class	The trigger plugin to execute
Param.-Trigger	Parameters that will get passed to the trigger plugin each time it gets executed
Description	Here you can insert some more details on the trigger
First/Last execution	Here you can specify a time range in that the trigger will get called.
Activated	If this is unchecked the trigger will be stopped until it gets activated again.

Check the tenant configuration

To see an overview of the bound configuration for your tenant you can call the tenant edit dialog again.
It will now look similar to this: