Stardust Release 4.0.0

Release 4.0.0 is the Stardust contribution to Neon. It is a combined feature and maintenance release.

• Supported Platforms
• New Features and Improvements
• Stardust API Changes
• Known Issues and Restrictions with this Release
• Upgrading from a Previous Release
• Previous Releases

Supported Platforms

The following tables list all supported micro versions for:

• Supported Portal Platforms
• Supported Database Servers
• Supported Application Servers
• Supported Java Runtime
• Other System Dependencies
• Reference Test Platforms

Note
We do not expect any problems in all micro versions covered in the following tables of supported platforms, but we cannot strictly guarantee correct end-to-end system functionality in other platform versions than the Reference Test Platforms, as bugs in the platform code and problems introduced by combining different unforeseen micro-level versions of the different platform components could in rare cases introduce incorrect system behavior that is beyond our control. Refer to section Reference Test Platforms for a list of fine grained version information for our regression test platforms.

Supported Portal Platforms

The Stardust portals are currently supported on the following user agents:

Supported Database Servers

The following database servers are currently supported by Stardust:

Supported Application Servers

The following application servers are currently supported by Stardust:

If you don't see your favorite database or application server in this list, please send a request to us. We continuously update the list of supported databases and application servers.

Supported Java Runtime

Other System Dependencies

Reference Test Platforms

The following tables provide fine grained version information for our regression test platforms.

Reference Test Database Servers

The following database servers are currently tested as reference:

Reference Test Application Servers

The following application servers are currently tested as reference:

New Features and Improvements

The following new features and bug fixes have been introduced with this release:

• Engine Error Code Message Enhancements
• Document centric Access Control Evaluation
• Newly introduced Properties
• Business Process Modeler Preview Functionality
• New Features and Bug Fixes

Engine Error Code Message Enhancements

Engine Error Code messages have been enhanced with more details like offering access to variables in their context.

Document centric Access Control Evaluation

This release introduces document centric access control evaluation. In case access control has been set for files individually, access control is now evaluated separately without folder hierarchy inheritance.

Please refer to chapter Controlling User Access of the End User Handbook for details.

Newly introduced Properties

The following properties have been introduced with this release:

• Stardust.Engine.Data.WriteHistoricalDataToDb - determines if to write historical data to the AuditTrail database
• Carnot.Engine.Tuning.Query.HistoricalDataPrefetchBatchSize - determines the prefetch batch size for the historical data

Please refer to chapter Server Side Properties for details on these properties.

Business Process Modeler Preview Functionality

The following functionality of the Business Process Modeler is still customer technology preview only. Note that these previews may not be functionally complete and are not intended for production use.

• Process Diagram Canvas - Main Toolbar
  • Flip Orientation
  • Separator Mode
  • Decoration
• My Process Models panel - Context Menu for Model - Clone Model. Allows to store an XPDL model as BPMN 2.0 and vice versa.

The Stardust Portal provides a configuration switch to show or hide features that are provided as technology preview.

New Features and Bug Fixes

The following main features and bug fixes have been introduced with this release:

Stardust API Changes

• Deprecated API
• API Changes

Deprecated API

The following API methods are deprecated:

• WorkflowService

  Method	Return Value	Parameter
  getModel	DeployedModel	-
  performAdHocTransition	ActivityInstance	long activityInstanceOid, TransitionTarget target, boolean complete
  spawnPeerProcessInstance	ProcessInstance	long processInstanceOid, String spawnProcessID, boolean copyData, Map<String, ? extends Serializable> data, boolean abortProcessInstance, String comment

• AdministrationService

  Method	Return Value	Parameter
  deployModel	DeploymentInfo	String model, int predecessorOID
  overwriteModel	DeploymentInfo	String model, int modelOid
  deployModel	DeploymentInfo	String model, String configuration, int predecessorOID, Date validFrom, Date validTo, String comment, boolean disabled, boolean ignoreWarning
  overwriteModel	DeploymentInfo	String configuration, int modelOID, Date validFrom, Date validTo, String comment, boolean disabled, boolean ignoreWarnings

• QueryService

  Method	Return Value	Parameter
  getAllModelDescriptions	List<DeployedModelDescription>	-
  getAllAliveModelDescriptions	List<DeployedModelDescription>	-
  getActiveModelDescription	DeployedModelDescription	-
  getActiveModel	DeployedModel	-
  findFirstDocument	Document	DocumentQuery query
  getAllDocuments	Documents	DocumentQuery query

• UserService

  Method	Return Value	Parameter
  isInternalAuthentified	boolean	-
  invalidate	User	String account

• DocumentManagementService

  Method	Return Value	Parameter
  versionDocument	Document	String documentId, String versionLabel
  updateDocument	Document	Document document, boolean createNewRevision, String versionLabel, boolean keepLocked
  updateDocument	Document	Document document, byte[] content, String encoding, boolean createNewRevision, String versionLabel, boolean keepLocked
  findDocumentsByName	List<Document>	String namePattern
  findDocuments	List<Document>	String xpathQuery

• Activity

  Method	Return Value	Parameter
  getDefaultPerformerID	String	-
  getDefaultPerformerName	String	-

• AttributeOrder

  Method	Return Value	Parameter
  getAttribute	String	-

• DmsPrincipal

  Method	Return Value	Parameter
  DmsPrincipal	constructor	String name

• ExternalUserConfiguration

  Method	Return Value	Parameter
  getGrantedModelParticipants	Collection	-

• HistoricalState

  Method	Return Value	Parameter
  getPerfomer	Participant	-
  getOnBehalfOf	Participant	-

• LoginProvider - Interface is deprecated

• Note

  Method	Return Value	Parameter
  getUserOid	long	-

• Participant

  Method	Return Value	Parameter
  getPartitionOID	short	-
  getPartitionId	String	-
  getModelOID	int	-
  getElementOID	int	-
  getAllSuperOrganizations	List	-
  getNamespace	String	-

• ParticipantAssociationFilter

  Method	Return Value	Parameter
  forModelParticipant	ParticipantAssociationFilter	String participantID
  forModelParticipant	ParticipantAssociationFilter	String participantID, boolean recursively
  inUserGroup	ParticipantAssociationFilter	String groupID
  forUser	ParticipantAssociationFilter	String account
  forTeamLeader	ParticipantAssociationFilter	String roleId

• PerformingInBehalfOfFilter

  Method	Return Value	Parameter
  forModelParticpants	PerformingOnBehalfOfFilter	Set<String> participantIDs
  forModelParticpant	PerformingOnBehalfOfFilter	String participantID, boolean recursively
  forModelParticpant	PerformingOnBehalfOfFilter	String participantID
  forUserGroup	PerformingOnBehalfOfFilter	String groupID

• PerformingParticipantFilter

  Method	Return Value	Parameter
  USER_ROLES_AND_ORGANIZATIONS	static field	-
  forModelParticipant	PerformingParticipantFilter	String participantID
  forModelParticipant	PerformingParticipantFilter	String participantID, boolean recursively
  forUserGroup	PerformingParticipantFilter	String groupID
  PerformingParticipantFilter	constructor	String participantID
  PerformingParticipantFilter	constructor	String participantID, boolean recursively
  PerformingParticipantFilter	constructor(private)	Kind filterKind, final String participantID, boolean recursively

• ProcessInstanceQuery

  Method	Return Value	Parameter
  STARTING_DOMAIN_OID	static field	-
  CURRENT_DOMAIN_OID	static field	-

• UnsupportedFilterException

  Method	Return Value	Parameter
  UnsupportedFilterException	constructor	String message
  UnsupportedFilterException	constructor	String message, FilterCriterion filter

• User

  Method	Return Value	Parameter
  getRealmOID	long	-
  getRealmID	String	-
  addGrant	void	String id
  removeGrant	void	String id

• WorkflowExceptiom

  Method	Return Value	Parameter
  getRootCause	PublicException	-

API Changes

The following API changes have been performed with this release:

• New WorkflowService spawnPeerProcessInstance method is introduced with changed parameters
• New policy to include or exclude historical data from process instance detail queries
• New PropertyProvider interface method

New WorkflowService spawnPeerProcessInstance method is introduced with changed parameters

The spawnPeerProcessInstance method of the WorkflowService is introduced with changed parameters.

workflowService.spawnPeerProcessInstance(long processInstanceOid, String spawnProcessID, SpawnOptions options)

The SpawnOptions is a container class for options that controls how the spawning operation has to be performed. The old implementation is now marked as deprecated, please see section Deprecated API.

New policy to include or exclude historical data from process instance detail queries

A new evaluation policy HistoricalDataPolicy has been introduced to determine if historical data should be fetched for process instance data or not. Please refer to section Including or excluding Historical Data from a Process Instance Query of chapter Building Queries for details on this policy.

New PropertyProvider interface method

The following method has been introduced for interface PropertyProvider:

Deprecated Functionality

The XML Data type integration is deprecated and will not be provided in the Eclipse modeler in future releases. You can use the External Reference structured data type instead, which is equivalent to the XML Data type, with the difference that it supports XSD schema exclusively (no DTD specification). Please refer to section Using External XSD Types of chapter Defining Structured Types for details.

Upgrading from a Previous Release

This section covers upgrading necessary for upgrading from releases earlier than 4.0.

• Runtime upgrading
• Using DOCX Files (Templating) with a jackrabbit-jca-2.6.1-infinity01.rar File Configuration
• Using a custom Skin in an Upgrade Scenario
• GroupId and ArtifactId Changes in Templating Artifacts
• Using Audit Trail Databases created with Versions earlier than 3.1.0 for Deployments in RAD

For upgrading issues introduced with earlier releases, please refer to chapter Upgrading to Later Versions. There you find all upgrading steps necessary for your specific version.

Runtime upgrading

A runtime upgrade will be necessary to operate against audit trails created with earlier versions in order to account for the schema changes, which have been performed in this release. Please refer to section Runtime Upgrades of chapter Upgrading to Later Versions for details on how to upgrade an audit trail to a later version.

Schema changes

The following schema changes have been performed in this release:

• A new table DATA_VALUE_HISTORY to store all historical values of the workflow data manipulated during process execution has been introduced with the following entries:
  • OID
  • MODEL
  • DATA
  • STRING_VALUE
  • NUMBER_VALUE
  • DOUBLE_VALUE
  • TYPE_KEY
  • PROCESSINSTANCE
  • MODIFICATION_TIMESTAMP
  • MODIFICATION_USER
  • MODIFICATION_AI_INSTANCE

Using DOCX Files (Templating) with a jackrabbit-jca-2.6.1-infinity01.rar File Configuration

Note that in case you like to use DOCX files, e.g. for templating, and you have a local jackrabbit-jca-2.6.1.rar, which was downloaded via the earlier jackrabbit-jca-2.6.1-infinity01.rar file version, do the following:

1. Exclude Apache POI, ooxml-schemas and xmlbeans from the WAR deployment and use the one from the Jackrabbit RAR.
2. Drop the poi-ooxml-schemas JAR and put ooxml-schemas into it.

Using a custom Skin in an Upgrade Scenario

If you use a custom skin in your Portal, which was applied in a version earlier than 4.0, you have to re-select it in the Portal Configuration to apply internal changes for default skin preferences.

Please refer to section Selecting the Portal Skin of chapter Configuring general Portal Components in the End User Handbook for details on how to select custom skins.

GroupId and ArtifactId Changes in Templating Artifacts

In version 4.0 groupId and artifactId of the Camel Templating artifacts have been changed. Apply these changes to your environment in case you upgrade from a version earlier than 4.0. Replace the groupId and artifactId names in your POM files with the new groupId and artifactId accordingly.

The following table provides an overview on the groupId and artifactId changes for the particular projects:

Please refer to section Upgrading from Versions earlier than 4.0 of chapter Upgrading to Later Versions for details.

Using Audit Trail Databases created with Versions earlier than 3.1.0 for Deployments in RAD

If you use an audit trail database in RAD that has been created with Stardust version earlier than 3.1, you have to deselect and select the database from the server configuration page. Republishing the server updates the Tomcat server.xml file with the new resource definition entry for embedded database usage.

Known Issues and Restrictions with this Release

• Known Issues
• Known Restrictions

Known Issues

• Incorrect Login skin appears with a custom skin used in an upgrade scenario
• Running into Timeouts when using the Benchmark Daemon
• Partially loaded or improperly formatted pages
• MSSQL - Issues occur when using MSSQL XA driver with disabled usage of prepared statements
• Cross Modeling: Renaming an imported Structured Data from a referenced Model might cause Issues
• M2Eclipse - Missing HttpServlet class error occurs after creating a new Maven project based on archetypes
• JBoss 7.1 - javax.ws.rs.NotFoundException is thrown on server start-up
• Exception occurs during a JBoss Deployment with MySQL version 5.6
• No Exception is thrown by modifyUser method when executed in mixed mode
• ActiveMQ message server does not work with Java 8
• Portal - Exception occurs when expanding a repository folder with a large number of child nodes in a JBoss environment
• HTML5 color picker is not supported in Internet Explorer for Benchmark categories
• Logging for Portal WAR deployment on WebLogic misses information
• Process name not available in the Process Filter

Incorrect Login skin appears with a custom skin used in an upgrade scenario

An incorrect Login skin might be displayed if you use a custom skin, which was applied in a version earlier than 9.2. In this case re-select the custom skin in the Portal Configuration to apply internal changes for default skin preferences.

Running into Timeouts when using the Benchmark Daemon

If you run into timeouts when you are using the Benchmark daemon, this might happen due to low batch size values. In that case increase the timeout value of the daemon queue via the property benchmark.daemon.BatchSize in your server-side carnot.properties file.

Additionally make sure that the default transaction timeout for your Daemon queue is at least equal to the value of property benchmark.daemon.Periodicity.

Please find details on properties benchmark.daemon.Periodicity and benchmark.daemon.BatchSize in section Daemon of chapter Server Side Properties.

Partially loaded or improperly formatted pages

If you experience partially loaded or improperly formatted pages, clear your Browser cache.

MSSQL - Issues occur when using MSSQL XA driver with disabled usage of prepared statements

Issues occur when you use an MSSQL XA driver and you do not have enabled the usage of prepared statements. Use prepared statements in combination with a native MSSQL XA driver to avoid these issues.

Cross Modeling: Renaming an imported Structured Data from a referenced Model causes Issues

Renaming an imported structured data from a referenced model in a cross-model scenario might lead to inconsistent behavior.

M2Eclipse - Missing HttpServlet class error occurs after creating a new Maven project based on archetypes

After creating a new project based on archetypes, a missing HttpServlet class error is displayed in the Problems view due to an issue with the m2e-wtp Eclipse plugin. The plugin enables the JavaServer Faces project facet, because it identifies JSF dependencies, and thus also applies additional files to the project. To avoid this issue, deselect the JSF Configurator option in the Maven preferences as described in section Deselecting the JSF Configurator option to avoid Missing HttpServlet class error of chapter Creating a Stardust Runtime Environment with Apache Maven.

JBoss 7.1 - javax.ws.rs.NotFoundException is thrown on server start-up

In case you get a java.lang.NoClassDefFoundError: javax.ws.rs.NotFoundException during server start-up with JBoss 7.1, make sure to upgrade the shipped RESTEasy stack to version 3.x. Upgrading to the new RESTEasy stack version prevents that the Stardust jax-rs 2.0 is overwritten by the JBoss 1.0 jax-rs API during deployment, which otherwise happens due to issue https://issues.jboss.org/browse/WFLY-1304.

Exception occurs during a JBoss Deployment with MySQL version 5.6

The MySQL 5.6 installation comes with the MySql Connector/J in version 5.1.34. If you deploy this JAR into JBoss as a module and include it in the standalone.xml file, you are facing a DuplicateServiceException.

This is a known issue for JBoss versions earlier than 8 (Module for MySQL JDBC driver with version 5.1.30+ needs <driver-class> in standalone.xml). As a workaround you can define a specific driver-class in the standalone.xml in the driver section as follows:

   <driver name="mysql" module="com.mysql">
      <driver-class>com.mysql.jdbc.Driver</driver-class>
      <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class>
   </driver>
   

For details please refer to section Restrictions for a Deployment with MySQL Version 5.6 in the JBoss chapter of the Deployment Guide.

No Exception is thrown by modifyUser method when executed in mixed mode

If the modifyUser API is invoked in mixed mode (external and internal Authentication) to change the password and user information of an existing user, no Exception is thrown. The user information remains unchanged even though a successful response is provided.

ActiveMQ message server does not work with Java 8

Note that the ActiveMQ message server currently does not work with Java 8.

Portal - Exception occurs when expanding a repository folder with a large number of child nodes in a JBoss environment

If you expand a repository folder having a number of child nodes that exceeds a maximum number of about 500 and you are using a JBoss server, the following Exception might occur:

JBWEB000065: HTTP Status 500 - JBWEB002004: More than the maximum number of request parameters (GET plus POST) for a single request (512) 
   were detected. Any parameters beyond this limit have been ignored. To change this limit, set the maxParameterCount attribute 
   on the Connector.

To resolve this issue, add the following property to your JBoss configuration:

<system-properties>
   <property name="org.apache.tomcat.util.http.Parameters.MAX_COUNT" value="1000"/> 
</system-properties>

HTML5 color picker is not supported in Internet Explorer for Benchmark categories

Note that the HTML5 color picker is not supported in the Internet Explorer for Benchmark categories. The color can be set for the category by entering the hexadecimal code for that color in the Internet Explorer.

Logging for Portal WAR deployment on WebLogic misses information

If you perform a standard Stardust portal WAR deployment on WebLogic, the produced log might miss some details like bootstrapping information from the Spring Framework or route tracing from the Camel Context.

To provide a proper logging, copy the slf4j-api-1.5.11.jar and slf4j-log4j12-1.5.11.jar libraries to the lib folder of your WebLogic domain.

Process name not available in the Process Filter

The filter list for process won't display the process. You need to logout and login again to view the updated filter list. For more information, please refer the known issue section Process name not available in Process Filter of the chapter Troubleshooting.

Known Restrictions

• Restriction for spawning into multiple activities joined by an inclusive OR
• Restrictions in the Business Process Modeler
• Technical Rules editor code restriction
• UI Mashup application restrictions
• Limitations with JBoss 7.1
• Limitations with JBoss 7.1 for EJB3 Deployment
• Limitation with refresh of Worklist view
• Limitation with Audit Trail Import/Export functionality

Restriction for spawning into multiple activities joined by an inclusive OR

Due to the synchronous operation of a relocation, spawning into multiple activities, e.g. as resulted from an AND split, might not work as expected in the following scenario:

• the activities are joined by an inclusive OR and
• between at least one of the spawned activity instances and the OR join there is no transaction demarcation (either by interactive activities, initially hibernated activities or fork on traversal transitions)

Please refer to chapter Relocating Activities in the Programming Guide for details.

Restrictions in the Business Process Modeler

• Some functionality and elements supported in the Eclipse modeler are not supported in the Business Process Modeler yet. Please refer to chapter Compatibility and Analogy of Models of the Business Process Modeling Handbook for details.
• Usage in Chrome: Flyout menu does not work sometimes

For a list of all known restrictions in the Business Process Modeler, please refer to section Restrictions in Modeler Functionality of chapter Compatibility and Analogy of Models.

Technical Rules editor code restriction

For the time being, you need to append _field to each variable in the code editor of a technical rule in the Rules Management perspective. Refer to chapter Defining Technical Rules for details.

UI Mashup application restrictions

UI Mashup applications have the following restrictions:

• Boolean values are not getting saved correctly
• Time with Dates is not supported
• Client side date format is not supported
• Special characters in Data Mappings/Path Ids, e.g. "." or space are not supported
• Table on UI is not rendered properly for multi-cardinality mappings, if value has only one entry (one row)
• Nested dialogs for multi-cardinality are not supported

Limitations with JBoss 7.1

The following modifications need to be applied in the JBoss 7.1 server:

Due to an issue, the JBoss default JSF implementation cannot be changed as parameter WAR_BUNDLES_JSF_IMPL is not working in JBoss 7.1.1. (WAR file using WAR_BUNDLES_JSF_IMPL embedded in an EAR file fails deployment). This is caused by the issue: JSF Version retrieved from deployment unit instead of top level deployment unit.

As a workaround, in com/sun/jsf-impl/main module in jsf-impl-2.1.7-jbossorg-2.jar/META-INF: the .tld files have to be renamed to e.g. *-tmp.tld.

Limitations with JBoss 7.1 for EJB3 Deployment

While deploying JBoss 7.1 for EJB 3, the following exception may occur: org.jboss.msc.service.ServiceNotFoundException: Service service jboss.ejb.default-resource-adapter-name-service not found

For a successful deployment, add the following under <subsystem xmlns="urn:jboss:Domain:ejb3:1.4"> in the standalone.xml file.

   <mdb>
      <resource-adapter-ref resource-adapter-name="hornetq-ra"/>
      <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/>
   </mdb>

Limitation with refresh of Worklist view

Worklist will not refresh itself automatically when the View is activated by tab switch or by clicking on it. It will refresh only when any activity was previously activated from the Worklist View. Note that this is not related to auto-refresh settings of worklist configuration. The auto-refresh settings would still refresh at specified time interval.

CMIS DMS Provider repository search restriction

Filtering the CMIS DMS Provider repository is currently restricted to filter searches by Document name only.

Limitation with Audit Trail Import/Export functionality

When audit trail import / export functionality is configured to be active, for some runtime platforms, interactions involving asynchronous engine operations may be delayed.

Previous Releases

• Stardust 3.1.1
• Stardust 3.1.0
• Stardust 3.0.1
• Stardust 3.0.0
• Stardust 2.1.1
• Stardust 2.1.0
• Stardust 2.0.1
• Stardust 2.0.0
• Stardust 1.1.1
• Stardust 1.1.0
• Stardust 1.0.1
• Stardust 1.0.0