1. Introduction

To guarantee high software quality and to ensure that the CaaS module runs in all supported configurations, regular tests are carried out within the scope of quality assurance. Reference configurations are used to perform these quality tests. In a real scenario, however, usually certain deviations from the reference configurations will exist.

In order to provide planning security for a company introducing new software for this case as well, a more extensive number of system configurations are defined as actively supported. But, unlike the reference configurations, not all actively supported system configurations are tested regularly for functionality. However, e-Spirit assures that if problems occur with a configuration defined as being actively supported, measures will be taken to solve them.

In addition, there is a range of passively supported system configurations. These are not actively tested by e-Spirit, but are successfully in use by our customers or partners or were supported in previous versions.

In a few cases, incompatibilities with certain system configurations have been noticed. These system configurations are defined as not supported.

This Technical Data Sheet is valid for CaaS module version 2.0 and above.

2. Terminology

As mentioned in the introduction, real life systems will often not match the reference configurations, which is why a distinction between actively/passively supported and unsupported configurations is necessary. Therefore the following terminology is used in this document.

Reference

To ensure that incompatibilities are detected prior to delivery, CaaS is regularly tested with this configuration, for which no restrictions are imposed. Furthermore, if necessary, mechanisms which avoid occurring errors in third party products and, thus, prevent problems during interaction with CaaS will be integrated into CaaS for reference system configurations.

Actively supported

This (or a very similar) system configuration has been tested by e-Spirit and assessed as being functional. However, due to the time required, the relevant tests are carried out regularly but cannot be performed completely with each release (unlike Reference). We maintain the necessary infrastructure in-house, so that we can quickly carry out our own tests and if necessary debugging.

Prerequisites for the elimination of errors are:

  • Reproducibility of the problem

  • Current maintenance contract

    If error elimination is not possible (e.g. for technical reasons), the system configuration will be defined as Not supported in the next version of the Technical Data Sheet.

Passively supported

This (or a similar) system configuration is or has been successfully operated by a customer/partner and reported as being functional; however, this statement has not been checked by e-Spirit. In general, a corresponding system configuration does not exist at e-Spirit, so internal tests are not possible. e-Spirit can take debugging steps on the basis of error messages (if a current software maintenance agreement exists); however, only within a limited time frame – but the customer has no claim to this.

Especially within the scope of the further development of CaaS, new product functions can result in system configurations that were previously passively supported being declared explicitly not supported, although an adjustment of CaaS to the passively supported system configuration would be technically feasible.

Not supported

The system configurations listed are known to lead to problems or are highly likely to cause problems. e-Spirit will not take measures to eliminate possibly occurring problems. If a system configuration is not listed here, it does not mean that it is supported, but only that there is no specific information at present.

3. System requirements

The following subchapters resume the system requirements for CaaS module. While the first subchapter just provides a brief overview, detailed information about references, recommendations, and restrictions etc. can be found in the second subchapter.

3.1. Brief overview

This chapter resumes the most important system requirements for CaaS module in a brief overview. Detailed information about references, recommendations, and restrictions etc. are contained in the following subchapter.

  • FirstSpirit server 2019-03 or higher

  • Java 8 or 11

3.2. Detailed overview

This chapter describes in detail the system configurations CaaS module is able to run with.

The CaaS module is the component that needs to be installed on the FirstSpirit server. The functions of this module enable messages to be created and transmitted to the CaaS Platform.

Details regarding the module and its functions can be found in the CaaS Module Documentation.

Reference

The CaaS module is built and tested against FirstSpirit server version {firstspirit.version} with Java 8 and Java 11. This server version determines further requirements regarding supported operating systems, Java versions etc.

Actively supported

Reference configuration

Passively supported

Even though it is technically possible to install the module in previous FirstSpirit versions, some functionality may produce errors at runtime, so earlier server versions of FirstSpirit are not supported actively or passively. Later versions of FirstSpirit 5.2 may show the very same issue if interfaces change drastically. However, supporting the latest FirstSpirit version is one of our priorities, so we support them passively.

4. Recommended hardware configurations

The CaaS module exists completely in your FirstSpirit server’s Java process. In addition to the system requirements of FirstSpirit, your machine must meet the module’s requirements. The CaaS generation schedule does not differ from other FirstSpirit generations and is therefore comparable with your other schedules in regard to memory and cpu consumption.

4.1. CPU requirements

CPU consumption of a CaaS deployment depends on the complexity of your templates and the amount of generated elements.

A system with an i7-4710MQ CPU can easily deploy 3000 simple entities into the CaaS platform in approximately 25 seconds with a parallelism of 8.

The parallelism can be configured in the service configuration. Please note that the duration of the CaaS schedule depends on your network performance.

4.2. RAM requirements

Memory consumption of the CaaS module depends heavily on the size of your media assets, and the amount of generated elements. Media assets are put into the main memory during generation once they are referenced. For this reason, the worst case memory requirement correspond to the size of your largest media files multiplied with the configured parallelism.

For example if your five largest assets are 100MB of size, and your configured parallelism is 3, you need more than 300MB of main memory for your schedule. Otherwise, the FirstSpirit server could produce Out of Memory errors. The parallelism can be configured in the service configuration.

5. Help

The Technical Support of the e-Spirit AG provides expert technical support to customers and partners covering any topic related to the FirstSpirit™ product. You can get and find more help concerning relevant topics in our community.

6. Disclaimer

This document is provided for information purposes only. e-Spirit may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. e-Spirit specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.