# Introduction and Goals

The OpenWMS.org Common Service provides essential functionality to deal with `Locations`, `LocationGroups` and `TransportUnits`. An example often referred to is the ability to move a `TransportUnit` from a `Location` A to a `Location` B. Beside this also other secondary resources like `TransportUnitTypes` or rulesets like the `PlacingRule` to define what kind of `TransportUnit` can be put on what type of `Location` are managed by this service.

## Requirements Overview

The required and demanded functionality of the Common Service is comprised by the issues tracked in GitHub issue tracker. All open issues that are assigned to an upcoming milestone are accepted for implementation and will likely be implemented and released.

Open pending issues

<table>
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr>
<th style="text-align: left;">Issue ID</th>
<th style="text-align: left;">Planned Milestone</th>
<th style="text-align: left;">Title</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><p><a href="https://www.github.com/openwms/org.openwms.common.service/issues/4">4</a></p></td>
<td style="text-align: left;"><p>3.0.0</p></td>
<td style="text-align: left;"><p>Migrate to SpringBoot 3.2.5</p></td>
</tr>
</tbody>
</table>

All functionality that is currently included, has already been implemented have issues assigned that are closed. A list of all closed issues with their resolved milestone release is shown below. Notice that issues may be closed but the implementation has been rejected.

Closed issues, either implemented or rejected.

<table>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr>
<th style="text-align: left;">Issue ID</th>
<th style="text-align: left;">State</th>
<th style="text-align: left;">Assigned Milestone</th>
<th style="text-align: left;">Title</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><p><a href="https://www.github.com/openwms/org.openwms.common.service/issues/3">3</a></p></td>
<td style="text-align: left;"><p>closed</p></td>
<td style="text-align: left;"><p>2.1.0</p></td>
<td style="text-align: left;"><p>API for deletion of Locations and LocationGroups</p></td>
</tr>
<tr>
<td style="text-align: left;"><p><a href="https://www.github.com/openwms/org.openwms.common.service/issues/2">2</a></p></td>
<td style="text-align: left;"><p>closed</p></td>
<td style="text-align: left;"><p>2.1.0</p></td>
<td style="text-align: left;"><p>Migrate to Java 21</p></td>
</tr>
<tr>
<td style="text-align: left;"><p><a href="https://www.github.com/openwms/org.openwms.common.service/issues/1">1</a></p></td>
<td style="text-align: left;"><p>closed</p></td>
<td style="text-align: left;"><p>2.1.0</p></td>
<td style="text-align: left;"><p>Split into lib, ui and wrapper</p></td>
</tr>
</tbody>
</table>

## Quality Goals

<table>
<colgroup>
<col style="width: 6%" />
<col style="width: 13%" />
<col style="width: 20%" />
<col style="width: 26%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr>
<th style="text-align: left;"><strong>Priority</strong></th>
<th style="text-align: left;"><strong>Characteristic</strong></th>
<th style="text-align: left;"><strong>Scenario</strong></th>
<th style="text-align: left;"><strong>Activity</strong></th>
<th style="text-align: left;"><strong>Risk</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><p>HIGH</p></td>
<td style="text-align: left;"><p>Interoperability</p></td>
<td style="text-align: left;"><p>The service must be operated in a service mesh of services of arbitrary technologies</p></td>
<td style="text-align: left;"><p>The service API is implemented with HTTP and JSON exchange format</p></td>
<td style="text-align: left;"><p> — </p></td>
</tr>
<tr>
<td style="text-align: left;"><p>HIGH</p></td>
<td style="text-align: left;"><p>Performance</p></td>
<td style="text-align: left;"><p>The service must respond in less than 100ms</p></td>
<td style="text-align: left;"><p>This needs to be considered with the choice of the persistency mechanism</p></td>
<td style="text-align: left;"><p>Scalability: Increasing datasets could have an impact</p></td>
</tr>
<tr>
<td style="text-align: left;"><p>MEDIUM</p></td>
<td style="text-align: left;"><p>Accessability</p></td>
<td style="text-align: left;"><p>The service may run in a multi-tenant environment and all functions must be aware of multi-tenancy</p></td>
<td style="text-align: left;"><p>All API functions, services and persistency mechanisms must be aware of the tenant</p></td>
<td style="text-align: left;"><p>Performance: With increasing tenants this could have a negative impact on the performance with regarding data isolation</p></td>
</tr>
</tbody>
</table>