# Apache UIMA Ruta™ v3.1.0 Release Notes

## Contents

1. What is UIMA Ruta
2. Major Changes in this Release
3. How to Get Involved
4. How to Report Issues
5. List of JIRA Issues Fixed in this Release

## 1. What is UIMA Ruta?

Apache UIMA Ruta™ is a rule-based script language supported by Eclipse-based tooling. The language is designed to enable rapid development of text processing applications within Apache UIMA™. A special focus lies on the intuitive and flexible domain specific language for defining patterns of annotations. The Eclipse-based tooling for Ruta, called the Ruta Workbench, was created to support the user and to facilitate every step when writing Ruta rules. Both the Ruta rule language and the Ruta Workbench integrate smoothly with Apache UIMA.

## 2. Major Changes in this Release

This release provides compatibility to UIMA v3. An upgrade from UIMA Ruta v2 to this version requires also an update to UIMA v3 of the overall application or Eclipse installation. Please refer to the UIMA v3 user's guide for detailed information: https://uima.apache.org/d/uimaj-3.0.0/version_3_users_guide.html

UIMA Ruta Language and Analysis Engine:

- New config parameter for internal indexing strategy.
- New config parameter for indexing all debug information.
- New config parameter for type disambiguation.
- TextSeeder is the new default seeder (faster, no MARKUP annotations).
- Improved null check using label expression.
- Improved conjunctive and disjunctive rule elements.
- Improved conjunct rules.
- Improved implementation of SPLIT, FILL, ADD, REMOVE, AFTER.
- Improved documentation.

UIMA Ruta Workbench:

- Fixed problems launching script using newer Java versions (LayerInstantiationException).
- Fixed console logging when launching scripts.
- Improved compatibility with dark mode.

UIMA Ruta Maven Plugin:

- Fail on error by default.

## 3. How to Get Involved

The Apache UIMA Ruta project really needs and appreciates any contributions, including documentation help, source code and feedback. If you are interested in contributing, please visit https://uima.apache.org/get-involved.html.

## 4. How to Report Issues

The Apache UIMA project uses JIRA for issue tracking. Please report any issues you find at https://issues.apache.org/jira/browse/uima

## 5. List of JIRA Issues Fixed in this Release

Click issuesFixed/jira-report.html for the list of issues fixed in this release.