Previous: Installing Up: Features Next: JSON API

Running Spring Batch Admin

If you are deploying Spring Batch Admin as a WAR file (either the sample or one you rolled yourself), just deploy it as normal to a servlet container like Pivotal tcServer.

If the WAR file is called spring-batch-admin-sample.war (it may have a version number appended), then when you load the application in a browser at http://localhost:8080/spring-batch-admin-sample)) it should show a listing of the contents of the application:

Home page screenshot

This page is a list of URLs, or URL patterns, along with the HTTP method (GET, POST, etc.) that you need to use to carry out an operation on that resource. If the URL is a pattern it has braces ({}) in it to represent the value of a parameter that needs to be supplied by the user. Users of Spring REST support in MVC will recognise this convention, and also the idea that a GET represents a request for information, and a POST is an "insert" operation. So, for example, to request a list of all running Job executions you must GET the resource at /jobs/executions (relative to the batch/ servlet in the application). And to launch a new job execution you POST to /jobs/jobName (with "{jobName}" replaced with the name of a launchable job).

Links on the home page that are not parameterised and require a GET method are clickable in the browser and take you to that page in the application. The others are all navigable from there.


The basic menus for the application out of the box are

  • Home - the URL list or site map listing the interface for the application
  • Jobs - list and launch jobs. Only jobs which are either configured in the application or have been executed in other processes against the same database show up here.
  • Executions - view and interact with running Job and Step executions.
    • Files - upload and list input files and configuration files for jobs.

You can learn how to extend the content of the application including the menus in a later section of this guide.

Previous: Installing Up: Features Next: JSON API