|Symphony Java Toolkit|
Spring Bot is a set of Spring Boot starters designed for building chat bots in Java & Kotlin.
What Is It?
- Spring Bot provides a simple annotation-based way to create chat bots.
- It currently supports Symphony and Microsoft Teams.
- It allows you to build your chatbot using annotations, binding messages to methods in a similar way to Spring Web MVC
Why Is This Important?
🧑🏽🤝🧑🏽 Multiple Platforms
Like it or not, most of us find ourselves working in environments with multiple chat platforms. As bot developers, we need to be able to reach users irrespective of which platform they are on.
Developers of chat-bots are not well-supported with Open-Source tooling. Too much effort gets spent on low-level message-handling, which could easily be done by a library.
Most bot development tools are commercial. If you build bots with them you are locked into paying license fees forever. For example, the Microsoft Bot Framework support multiple chat platforms at the expense of locking you into the Azure ecosystem.
How Does It Work?
This is best described at springbot.finos.org. This takes you through the process of building several example bots from scratch.
What Are The Benefits?
✔️ Build Bots that run on multiple platforms
By using Spring Bot's abstractions, you can target both Symphony and Microsoft Teams. Depending on demand (or contributions) further platforms may be supported in the future. In the tutorials we show how to build a claim processing bot which runs a workflow concurrently on Teams and Symphony.
✔️Focus On Business Logic
Spring Bot handles marshalling from/to the underlying message formats on your platform.
✔️ Advanced Templating
Templates are automatically generated for any Java objects (POJOs) that you want to send to the chat platform. This allows users to read/edit objects and send them back to your bot. Additionally, templates are fully customizable on a per-platform basis, currently using Freemarker and Thymeleaf.
✔️Annotations Make It Super-Easy
As the tutorials show, you just drop a few annotations into your application to enable it to read and send chat messages.
✔️ A Mature Ecosystem
By building bots in a mature ecosystem like Java, you avoid all of the usual issues with no-code and low-code environments. Java is a mature language with every conceivable library, a wealth of Stack-Overflow QA's and a convincing DevOps/Deployment story (Java runs anywhere).
✔️ Avoid The Lock-In Trap
Most low-code / no-code platforms are a trap: they are looking to lock-in customers and revenue streams by persuading you to build your business with them as a dependency. Spring Bot is open-source so this is literally a non-issue.
Watch It In Action
Plenty Of Example Bots To Learn From
This project contains various example bots that were (originally) written at Deutsche Bank in response to real use-cases. However, we felt they were general enough to warrant Open-Sourcing and including as code to work from.
🤖 Poll Bot
A bot for running polls in a Symphony/Teams chat room.
🤖 News (RSS) Bot
A bot for feeding news into a Symphony/Teams chat room.
🤖 Reminder Bot
Reads the contents of a room and creates reminders based on future events mentioned therein.
Plenty of Tutorials / Demo Code
/demos directory you can see three example bots:
demo-bot: The "Hello World" of Spring Bot
todo-bot: Runs a simple todo-list inside a chat room on Teams or Symphony.
room-bot: A room broadcasting bot, that shows how to use the chat dropdown, and address messages across Teams and Symphony.
claim-bot: An example of an expense-claim workflow running across Teams and Symphony concurrently.
custom-help-bot: Shows you how you can override built-in beans (like the
HelpController) to change the functionality of Spring Bot.
Tutorials for building these and the reference guide are found here: Spring Bot
Copyright 2022 FINOS
Distributed under the Apache License, Version 2.0.
Vulnerabilities / Security
Please see our Security Policy.
There are two main branches:
spring-bot-master: new code for the multi-platform Symphony / Microsoft Teams bot builder
symphony-java-toolkit-master: legacy code for when this project only supported symphony.
The spring bot roadmap is a number of tagged issues that we are working on next.
You can view the roadmap issues here.
Releasing This Project
In order to do a release:
- Update this file to include details of the release.
- On Releaser's machine:
# on spring-bot-master branch mvn clean test -P symphony-ci mvn versions:set -DnewVersion=<our breaking change no>.<minor version no>.<our-patch-version-no> -DartifactId=\* -DgroupId=\* mvn -DskipTests clean test source:jar javadoc:javadoc deploy -P symphony-release mvn versions:set -DnewVersion=<our breaking change no>.<symphony-api-version>.<our-release-no+1>-SNAPSHOT -DartifactId=\* -DgroupId=\* # then push to git (spring-bot-develop branch)
- Update this with new version numbers if needed.
- Close the Staging Repository
- Release it.
- Perform release on github with same number