Cloud Software Group, Inc. EBX®
TIBCO EBX® Documentation

6.2.1

6.2 service packs

6.2.1

6.2.1 has been built on March 19, 2025. Overview of this service pack:

Indexing performance improvements

Optimized index rebuild chain: An index rebuild now skips steps to shorten rebuild chains, improving the rebuild duration and index structure by reusing base indexes more effectively. This change reduces rebuild times for intermediate snapshots; however, accessing skipped snapshots might take slightly longer, as their indexes must be rebuilt incrementally from the nearest available point.

Dynamic assessment of incremental rebuild viability: EBX® now estimates the "distance" between table revisions to determine whether to perform an incremental, or a full index rebuild. A full rebuild is initiated when the difference between the base and target index is too large. This adjustment leads to faster rebuilds and more efficient indexing. Accessing a snapshot older than this breaking point can take longer, as a new rebuild chain must be computed from scratch.

Batch processing for index rebuilds: Index rebuild operations are now batched, grouping deletion and creation actions for greater efficiency.

Configurable multi-threaded rebuilds: The ebx.index.threads property allows you to control the number of threads used during index rebuilds. Increasing the number of threads can accelerate index rebuilds, especially in contexts with many large indexes after update, migration, or significant data model changes. However, for normal operations, the default setting of '2' threads is recommended.

For additional details, see Architecture and design in the Performance and tuning chapter.

Core engine

The memory footprint of the probabilistic filter used to speed up primary key lookups has been reduced by raising its false positive probability. The better accuracy was not worth the additional memory consumption and hash functions to check.

Some operations have been improved to avoid loading heavy objects that represent datasets when it is not necessary. This can enhance for instance requests on foreign key and inherited fields that need to access to datasets to resolve the target table of the involved relationships.

Query limitations

Performance was optimized when managing all fields in an inherited dataset.

See Query limitations for more information.

EBX® Script

It's now possible to create dataset triggers. A dataset trigger defines procedures that are implicitly and automatically executed when some operations are performed on the dataset.

See Dataset trigger for more information.

Single Sign-On (SSO)

EBX® now supports both SAML 2.0 and OpenID Connect protocols. To enable these features, EBX® should be declared as an application in the Identity Provider and configured depending on the enabled protocol.

See Single Sign-On (SSO) for more information.

SCIM feature

Built-in support for SCIM (System for Cross-domain Identity Management) was added. The SCIM feature automates the provisioning, management, and synchronization of user identities and roles between an IdP (Identity Provider) and EBX®.

See Enabling the SCIM feature for more information.

EBX® Container Edition

It's now possible to configure Single Sign-On (SSO), Bearer authentication, the SCIM feature, LDAP built-in directory, and custom directory using environment variables.

See SSO SAML 2.0 connectivity, SSO OpenID Connect connectivity, Bearer Authentication, SCIM feature, LDAP connectivity and Directory connectivity for more information.

Data Services

It's now possible to use 'Bearer Authentication Scheme method' with the built-in RESTful services, SOAP operations and custom REST services (built using REST Toolkit).

The REST Toolkit Exception handling section was updated with the description for a custom exception mapper.

See REST authentication and SOAP authentication for more information.

Supported databases

Support for the following database was added: Microsoft Azure Database for PostgreSQL (compatible with PostgreSQL 16 or higher).

PostgreSQL 17 is now supported and PostgreSQL 12 is no longer supported. The minimum supported version of PostgreSQL is now 13.

See Supported databases, for more information.

User interface validation

A new option has been added to customize the behavior of APV.

Security - Login page

When a user logs in or out and a custom URL is provided, EBX® appends a resume query parameter. It is now possible to disable this behavior by using the following properties:

  • ebx.security.loginPage.appendResumeUrl

  • ebx.security.exitPage.appendResumeUrl

  • ebx.security.exitErrorPage.appendResumeUrl

See Security configuration for more information.

Security - HTML headers

New options have been added in order to include additional JavaScript files or to customize the CSP.

  • ebx.security.csp.script-src

  • ebx.security.csp.style-src

  • ebx.security.csp.img-src

  • ebx.html.header.javascript

See Security configuration and HTML headers for more information.

History view of a record on the sidebar

It is now possible to display both simple and complex data types, including multi-valued list types.. Additionally, it is possible to filter the history transactions by field.

HTML input

Previously, CKEditor was the library used for HTML inputs.

For security and licensing reasons, it was replaced by a widget based on the open source tool TipTap.

As a consequence, the look and feel has changed. As outlined below, some features were moved or deleted:

Look & feel

  • Overall style has been reviewed

  • Editor size is not fixed anymore, it now adapts to its content.

    Limits can be customized with the following four new settings in the UI administration's Ergonomics and layout: Forms: minimum width of HTML editor, Forms: maximum width of HTML editor, Forms: minimum height of HTML editor, and Forms: maximum height of HTML editor.

  • Editor height cannot exceed the workspace content height.

  • Typing assistance has been added, for example if a user types "- foo", it transforms the text into an itemized list.

Toolbar

  • Font size menu has been removed in favor of a heading menu in which user can choose between different heading levels.

  • A strike-through text style button was added.

  • The copy/cut/paste toolbar was removed (keyboard shortcuts and contextual menus are still supported).

  • The link toolbar was removed, but links are still supported. This is now transparent for users.

    Links are now created via copy/paste. If a user pastes a link while selecting text, the selection become a link. If the user does not have a text selection, a link is created with its text as the link value.

  • A block quote text style button was added.

  • Text background and foreground color menus were reviewed.

  • The print and preview buttons were removed.

  • The maximize button was removed.

  • The image menu was moved inline with the editor content; it appears when the user clicks on an image.

  • Toolbars can no longer be expanded; it was reduced to a single line.

Background tasks

Configured tasks can now run in the background, which can free up users to continue working in EBX® without having to wait for the task to complete. A centralized user interface (background task sidebar) allows users to view and access these tasks.

See Background tasks for more information.

Validation policy for table view

It is now possible to define a validation policy to be used when displaying records in table view. This option can be specified in the default view of the associated table and/or in the global properties of the data model for all tables.

For more information, see :

Highlight of the quick search results

The quick search results are now highlighted for better visibility.

New software delivery site

You can now download EBX® software from TIBCO eDelivery. If you have an existing eDelivery account, your existing credentials can be used to login to the new software delivery site.

Known issues

See 6.2.1 Known issues section.

Closed issues

See 6.2.1 Closed issues section.

Java API

The Java API was improved on the following topics:

Note: 6.2.0 has been built on June 21, 2024.

Workflows

Notable points done for workflows:

Workflow views performance

  • Improvement of performance for specific columns in Data workflows views. Specific columns should be sortable and filtering on them is now faster. But a tradeoff was made: Built-in workflow variables are no longer supported, only data context variables are supported. The expression is now evaluated each time the workflow data context is updated, not on display but the result should be seemless for the user with the previous behavior.

  • New property added to replace Label (dwfLabel) for Workflow related tables (Active/Completed workflows and in Workflow administration).

    New property added to replace Current publication name (dwfPublicationLabel) for publication in publication related tables (Publication and in Workflow administration).

    The new properties take the current previous property localized label while the old are added deprecated. The new properties are now correctly filterable but still not sortable. The filtering is now faster.

    Some other properties are impacted by those changes: Data workflows in Inbox/Work item view, Publication label in Inbox,Work item, Active/Completed Workflows and Workflow Parent in Active/Completed Workflows views. They are mapped on the new properties and are faster to filter but sorting is still not resolved, for the time being the sort is done by primary key by default.

    When using a filter like contains that search a part of label you might try doing a AND filter with the second filter being a search filter with the same value. It might return a result faster.

Workflow history

Fixed the service "clear from workflows selected" and "Clean from a date" available in Workflow history administration. Only records in workflow table were cleared since 6.0, some related data to it were ignored causing the history to grow bigger without the knowledge of the users. We still recommend to regularly launch a standard purge task as mentioned in workflow administration documentation.

Performance

A prefilter can now be defined for an AdaptationFilter or TableRefFilter to improve query performance or table reference validation.

See their Java documentation or the Improving the performance with prefilters section for more information.

Data validation

This service pack improves the performance of creating a child dataspace from a dataspace that contains many datasets with validation reports. As part of this improvement, the validation report metadata schema was changed. As a result, all validation reports will be reset when upgrading from EBX® 6.0, or 6.1 to 6.2 or later. The stale data in the reset validation reports will be removed during the next purge.

Application servers

This section describes application servers changes for architecture modernization.

Servlet and JSP container

EBX® now supports Jakarta EE 9 or above. This change will require an upgrade to several third party libraries, such as Servlet 5.0 or greater, JSP 3.0 or greater, JMS 3.0 or greater, and Mail 2.0 or greater. See the links below for more information on requirements for specific components.

Developers of EBX® 6.2.x onwards should be aware that, as a result of the move from Java EE to Jakarta EE, the primary package name for all implemented APIs has changed from javax.* to jakarta.*. This will almost certainly require code changes to enable modules or other libraries to migrate from EBX® 6.1 and earlier to EBX® 6.2 and later.

See Supported application servers, Java Message Service (JMS), JMS for distributed data delivery (D3) and Installation notes for more information.

Java Compile time Environment

EBX® sources are now compiled with JDK 17. JRE 11 is no longer compatible. We recommend upgrading your JRE to a recent LTS version to take advantage of its performance improvements.

See Supported application servers for more information.

Data services

The following sections describe new feature and improvement to data services.

REST Toolkit APIs

The REST Toolkit now supports Jakarta RESTful Web Services 3.1.

Built-in RESTful services

The built-in RESTful services were improved in the following area:

Business Object

Improves select business object operation using data-bo and data-compact-bo and now returns content of one to many relation ship of business objects. As the response may be large, the maximum size can be overloaded on the EBX® server using the ebx.dataservices.rest.bo.maxResponseSizeInKB property. In fact, if the response approaches or exceeds the max size value a HTTP 206 Partial Content response is returned with a number of records lower than requested, including a consistent paging context, all are in a well-formed JSON response.

See ebx.dataservices.rest.bo.maxResponseSizeInKB, backward compatibility for built-in RESTful services, Performance and Select operation for more information.

Built-in LDAP directory

A built-in support for LDAP (Lightweight Directory Access Protocol) has been added and designed as a custom directory implementation. This feature enables integration of an existing LDAP directory with EBX®.

See LDAP directory and Configuring built-in LDAP directory, for more information.

Improving the performance with prefilters

Programmatic filters can include a combination of simple checks and more complex Java code. Under certain conditions, the simple checks can be converted to a prefilter in the form of an XPath predicate. The prefilters can then be used by EBX® to optimize queries. The prefilter must satisfy a consistency condition and it should satisfy certain other conditions for performance reasons. See the Java documentation of the relevant functions.

The interface PrefilteredAdaptationFilter has been added for adding a prefilter to an AdaptationFilter.

A TableRefFilter can define an XPath prefilter during the setup of the table reference filter. See TableRefFilterContext.setPrefilter

EBX® Container Edition

The Container Edition was improved on the following topic:

Java SE Development Kit

The JDK has been upgraded to LTS version 21.

See Overview for more information.

EBX® Script IDE

This release introduces the Script IDE, a web-based development environment that allows you to create and manage scripts written in the EBX® Script Language (ESL). The web-based IDE simplifies scripting tasks such as writing functions and procedures applied to basic data manipulation, automated triggers, and even complex workflow tasks.

The Script IDE helps avoid the overhead associated with writing, compiling, and deploying custom modules. The combination of ESL and the new Script IDE make programmatic data management tasks more accessible to those without a Java programming background.

The Script IDE provides many of the features you would expect to find in an IDE, such as:

Home page

This release introduces the home page, a new customizable entry point to EBX®.

See also

Metadata management

This release introduces support for metadata management, offering a suite of new features:

Additionally, you can connect to and integrate with a variety of external data sources to extract, discover, and manage your metadata. These enhancements aim to improve your ability to manage data efficiently and make informed decisions based on reliable, well-governed data.

Business user and administrative features are accessible from two pre-defined perspectives: Metadata and Metadata administration. These built-in perspectives are available only if the metadata module is deployed.

Attention

As of this release, metadata management features are only available for the TIBCO EBX® Container Edition.

History view of a record on the sidebar

Users can now view record transaction history on the sidebar. This view shows a list of transactions, modified field values, the record modifier, and timestamp. Transactions are sortable by date and time.

Product migration

This release contains an updated Migration Guide that provides instructions for migrating from EBX® version 5.9.x to 6.x.

Limitations for this release

Hierarchy limitations

On allowed dimension for new dependencies:

Query limitations

The performance of these features is not yet optimized:

The following cases do not rely on Lucene indices. This has two consequences: first, performance is not optimized; second, Quick search behaves like a 'contains', rather than a full-text search:

More specific cases not benefiting from index optimization are described in the following section.

Value-labeling limitations

Search and sort using the value-labeling feature have a few limitations described in section Value-labeling.

Data validation limitations

Version upgrade

In addition to the information provided in this release note, the chapter 6.2 Java API changes provides an exhaustive list of the new Java APIs published since the release of the 6.1 version.

New Web Application Resource (WAR) files

ebx-ide.war

This is the WAR for the new Integrated Development Environment.

ebx-hub.war

This is the WAR for the new Hub web application.

See also

Changes on supported environments

The chapter Supported environments has been updated to reflect the necessary upgrades detailed below.

Hana DB support

Support for SAP HANA as a back-end database engine for EBX® is discontinued as of this release.

WebLogic AS support

Currently, no version of WebLogic AS supports JDK 17, or 21 LTS and Jakarta EE 9. Please be aware that, according to Oracle's Statement of Direction, future versions of supported software might not be compatible with EBX®.

Upgrading from an existing EBX® 6 environment

The internal versioning mechanism of indices has been improved and the Lucene library version has been bumped to 9.9.1, causing modifications to the index format. As a consequence, the directory holding the indices is going to be automatically deleted during the product upgrade. Thus, a delay at the first access to each table can be expected to rebuild the indices. Some minor changes in search behavior can also be observed.

The upgrade process crawls all the records in the G_BLK database table to ensure their size is optimal by removing potential wasted space and splitting entries that became bigger than necessary. This one-shot process may significantly delay the first startup on large repositories.

Backward compatibility

Nested procedure use of its parent's ProcedureContext

A nested procedure now cannot use the ProcedureContext of its parent procedure to alter the parent's dataspace. Modifications made by the nested procedure are confined to its own dataspace. This restriction is in place due to concerns about data consistency, as changes made in the nested procedure might rely on unfinalized or cancelled changes in the parent procedure.

Attempts to operate on the ProcedureContext of the parent procedure will now result in an IllegalStateException.

Data validation

Internal validation framework has been enhanced to minimize the number of snapshots created to validate data. It now uses as-of transaction time to compute the delta between records, tables, datasets or dataspaces. This simplifies the validation process by avoiding to create snapshots for functional dataspaces involved in this process. This optimization also improves purge execution time by considerably reducing the number of snapshots that will be deleted.

As a consequence, theses changes will have the following impacts:

  • The validation reports created by EBX® versions prior to 6.2.1 are not compatible and will be reset. The stale data for the reset validation reports will be removed during the next purge.

  • The validation reports are no longer copied when a dataset is duplicated. It will therefore be fully validated for the first time.

  • An error can be raised if a constraint that is being checked during the validation of a dataset or a table execute a procedure in the same dataspace.

Optimization of matches predicate

As a consequence of the bug fix CP-26571 related to the processing of matches and matches-case-insensitive predicates, certain operations with these predicates are no longer optimized using Lucene. The reason for this is that Lucene's regular expression engine does not support certain Java regex constructs, such as ^ (beginning of line) or $ (end of line). Predicates using these operators were incorrectly optimized and returned incorrect results in previous versions. Therefore if the matches pattern contains such unsupported features, or if it cannot be determined (e.g. the pattern is a dynamic parameter whose actual value is unknown at the optimization phase), then the operation cannot be optimized using Lucene and the performance can be impacted.

Association with inconsistent definition

If an association is not consistent in the context of a specific dataset then it is now considered as read-only from a permissions standpoint, instead of being hidden as in previous versions. The association is read-only in the user interface and it is not possible to create, delete, attach, detach or move an associated record. It is possible to modify an existing associated record.

As a consequence of this change an exception is no longer raised in the existing API that compute the result of the association.

See AssociationLink.getAssociationResult and AssociationLink.getTargetTable

For more information, see Association.

Built-in RESTful services

In business objects selection, the one to many relationship is no longer navigable through HATEOAS links, but is directly included in the JSON response.

Redirection to HTTPS is based on a new option

Since EBX® 6.1.3 HF-1, when users accessed the login screen using HTTP and the property ebx.servlet.http.useHttpsSettings was set to true, they could be redirected to the HTTPS page. This behavior is now disabled by default because it could cause issues if EBX® is behind a reverse proxy. To re-enable this behavior, you need to set the new property ebx.servlet.http.authentication.redirectToHttps to true.

See TIBCO EBX® main configuration file for more information.

Logs to the console are more verbose

All logs, that are not for monitoring or auditing, sent to files are now also sent to the console.

6.2.1 Known issues

User Interface

6.2.1 Closed issues

Container Edition

Core Engine

Data Modeling

Data Services

Data Workflows

Documentation

Hierarchies

Import/Export

Infrastructure

Metadata

Scripting

Staging

User Interface

Users & Permissions

6.2.0 Closed issues

Container Edition

Core Engine

Data Modeling

Data Services

Data Validation

Data Workflows

Hierarchies

Infrastructure

Scripting

Team Up

User Interface

Users & Permissions