Cumulative Update 2 for Neuron ESB 3.5 (KB351-0226151)
Posted by Marty Wasznicky on 26 February 2015 10:45 PM
Cumulative Update 2 for Neuron ESB 3.5 (KB351-0226151)
Cumulative Update 2 (CU2) for Neuron ESB 3.5 resolves issues that were found in Neuron ESB 3.5 since the software was released. Additionally, several new features are introduced in CU2. This update rollup is highly recommended for all Neuron ESB 3.5 customers. This rollup release can be used to upgrade existing installations of Neuron ESB 3.5.x to Neuron ESB version 22.214.171.124
Released Version CU2 can be applied to:
Neuron ESB builds 126.96.36.199 to 3.5.1.x.
*This patch requires PowerShell 4.0. Microsoft PowerShell 4.0 can be downloaded and installed from the following location: http://www.microsoft.com/en-us/download/details.aspx?id=40855
Prior to installation, the NeuronPatch_3.5_CU2.zip file should be extracted to the local file system of the machine running Neuron ESB 3.5. As part of the update process only Neuron ESB files that have changed are backed up to Backup-NeuronESB_3.5_CU2 folder. This folder is listed at the end of the log created when InstallPatch.ps1 is executed. You need to ensure that you have at least 50MB free disk space available plus 30MB for each instance that will be updated. The files for the update requires another 70MB of disk space. If you were updating a single instance, then you will need a total of 150MB. For two instances a total of 180MB.
Fixes Included in CU2:
CU1 fixes and enhancements
NEW – Business Process Designer - There is a new “Undo” button on the toolbar which will undo all changes to the current Business Process. A Business process will store all changes even after the tab is closed. The “Undo” button will allow users to remove those changes.
NEW – Business Process Designer – When a change is detected in the Business Process Designer, an asterisk (“*”) will appear on the workflow’s tab to indicate that there have been edits made to it.
NEW – Business Process Designer – Users can now make a copy of the entire process. A “Copy” option has been added to the right click context menu of the Processes library.
MOD – Set Property Process Step – If a custom value was entered but not enclosed in double quotes, the property would not be set. Now Neuron will treat values that are not string literals, dates, or a special name in the existing list as if they were a string literal. So saving "myValue" and myValue as the Value in the Expression Collection Editor will display differently but will be treated as a string literal.
MOD – Split Process Step – Previously, when the Synchronous property was set true, if an exception occurred during individual message process, the exception would never propagate beyond the Steps block. This would require a user to use an enclosing Exception process step within the Steps block to report on any errors that would occur. This has been changed so that the exception will be thrown. However, if the Synchronous property is set to false, then an Exception Process Step should be added to catch the exceptions that may occur at the individual message processing level.
FIX – Adapter Endpoint Process Step – Would throw the following exception when used within a Split Process Step (Steps Block):
FIX – Adapter Endpoint Process Step – When using the process step in a process hosted by an application other than the Neuron ESB runtime (i.e. Party hosted in a .NET application), a null reference exception could occur.
FIX – Business Process Designer – When working on a process within the Business Process designer, if there is a validation error reported when hitting the apply button (specifically with Transform Process Step), the apply button becomes disabled but the save button is not enabled.
FIX – Business Process Designer – When using a mouse wheel to navigate within the Business Process Designer, the following exception may occur:
FIX – Audit Process Step – Will now throw an error if the Source ID property is missing from the message header.
FIX – Transform Process Step - When deleting the XSLT and saving, the XSLT is not removed from the step.
FIX – Exporting out a Process to its .npx format would cause a SerializationException
FIX – Apply button would not be enabled if code was changed in a Decision Process Step.
FIX – ODBC Process Step - removed the persistence of connection string, prefix, namespace, row and root name as returned message context properties when a reply message is returned. This could cause the wrong database from being called or results returned if executing multiple times sequentially within a process.
FIX – Service Process Step - Calling Service Process step in 3.5 with Restore Headers = true would cause an object reference exception due to the introduction of the new SOAP Header message collection.
FIX – Query Process Step – If users opened a Query Process step that was previously configured with Parameters, it would be empty.
NEW – Workflow Activity – a new “Timeout” workflow activity has been added. This activity can contain other workflow activities and be configured with a specific period of delay. The configured period of delay is the amount of time the user wants to allocate for all the workflow activities contained within the Timeout activity to complete their execution. The Timeout activity can be used to “Timebox” one or more activities. The Timeout activity will cause the existing workflow instance to unload into the database. Once the timer expires, the workflow instance will be reloaded and continue running where it left off. Users can inspect the “Result” argument after the Timeout activity has fired to determine its state. A good example of using this is the following. User sends out document to be approved by a manager. However, the manager only has 3 days to approve before it needs to be escalated to a director.
NEW – Users can now make a copy of the entire Workflow definition. A “Copy” option has been added to the right click context menu of the Processes library.
NEW – Workflow Correlation Dialog – This has been enhanced to auto expand selections once the dialog opens. Also, a description of the current correlation properties are now summarized within the status bar of the dialog.
NEW – Workflow Designer - The “Apply” button for the Workflow Designer is now disabled until a change is detected.
NEW – Workflow Designer – When a change is detected in the Workflow designer, an asterisk (“*”) will appear on the workflow’s tab to indicate that there have been edits made to it.
NEW – Workflow Designer – Error messages can now be copied from the Errors tab of the Workflow Designer.
NEW - Workflow Activity - a new “MessageCorrelationScope” activity has been introduced. This activity will register a correlation set for the workflow so that the workflow can use the “ReceiveMessage” activity to receive messages without having to use a “PublishMessage” activity to first publish a message and register the correlation scope. Very useful in non-correlated workflows.
MOD – Workflow Activity – The PublishRequestMessage now will clone requests before sending the request and assign a new message identifier to each request.
MOD – Workflow Activity – The Delay activity is now a persistent Delay. This means that after 60 seconds of delay, the workflow will be serialized into the database. Once the delay period expires, Neuron ESB will reload the workflow into memory and complete execution of the workflow.
MOD – Workflow Exceptions – Reporting has been augmented on capturing and logging exceptions.
MOD – Workflow Activity - Transform workflow activities were outputting XML encoded as UTF-16. This has been changed to UTF-8.
FIX – Workflow Activity - PublishRequestMessage did not work correctly, causing a System.ArgumentException exception, when used in multiple branches of a Parallel activity.
FIX – Workflow Activity - The ExecuteProcess workflow activity would report that it could not find and load the referenced process at runtime. It would also report a System.NullReferenceException during design time testing.
FIX – Workflow Testing/Simulation – When testing workflow using the Edit Test Message dialog, the message and header properties submitted would reflect the outcome of the previous test run. Now all messages are cloned before submitting them for testing.
FIX – C# Code Workflow Activities would not recognize Assembly References added to the parent workflow.
FIX – Inline C# code edit window – Apply button would not be enabled even after edit.
NEW – Workflow Tracking – There is now a new tab under the Workflow Tracking called “Messages”. This will display all messages pending workflow instance activation. This allows users to manage the messages that will start workflow instances. Users can suspend, resume, delete or move to message history and move to failed messages.
MOD – Workflow Tracking context menu commands – The context menu commands (i.e. Cancel, Suspend) have been changed to a synchronous model and set to update the UI automatically.
FIX - Aborted or cancelled workflows sometimes were not being removed from the list of actively running workflows.
FIX - The Neuron ESB Explorer window was not in focus when Workflow Tracking Detail modeless window is closed.
FIX – The Start, Suspend, Cancel and Resume context menu commands could fail under specific circumstances.
FIX - Workflow Availability Groups and Endpoints - All Workflow Availability Groups and Endpoints will restart several time if a save is made to just one definition that one workflow endpoint is assigned to.
FIX - If there are completed workflow instances in the database, when the Neuron ESB service is restarted the following error may be logged to the Neuron ESB Event Log: you will see several errors in the event log like the below error:
An exception was reported on the workflow runner thread for workflow endpoint "<Endpoint Name>".
FIX – Stopping a workflow endpoint may result in the following error being logged:
Collection was modified; enumeration operation may not execute.
FIX – Editing and Saving a Workflow definition when the Availability Group it’s assigned under is running may cause the following exception:
FIX – Availability Group throws error on Restart after SQL Server comes back online after previously going offline.
FIX – Cannot write to a closed TextWriter – When shutting down the Availability Group’s underlying host, the following exception may occur:
Exception: Cannot write to a closed TextWriter
FIX – Attempting to stop an Availability Group may cause the underlying Availability Group host exe to crash. This could happen if there were currently executing workflows that were taking too much time to unload. This has been corrected.
FIX – Editing and saving changes to an Availability Group while closely followed by the shutting down of the runtime could cause the following errors to be reported:
Exception: Object reference not set to an instance of an object.
FIX – Duplicate workflow instances could be started for a single message under specific scenarios.
FIX – When shutting down the Neuron ESB runtime and an Availability Group was running, the following exception may be reported:
Exception: Collection was modified; enumeration operation may not execute.
FIX – REST based Service Connectors - Setting the url dynamically for REST based service connectors did not work using:
MOD - If we can't set the firewall rules on startup, we will log an informative message.
Neuron ESB Runtime
NEW – REST API – The current Neuron ESB deployed version has been added to the REST API call:
MOD – MSMQ Channel – On startup, if the runtime cannot set the registry key to allow cross domain msmq access, an informational message will be logged rather than a warning.
MOD - MSMQ Poison Queue handler which automatically moves all messages found in the Poison Queue to the Neuron ESB Failed Message table would only start if the Topic’s MSMQ network property, Direct, was set to true.
MOD – MSMQ Receive Service was removed from the runtime. This was deprecated in 3.0. This was necessary in previous releases to support remote transactions using MSMQ 3.0. MSMQ 4.0 (not 3.0) is supported as a Topic transport in Neuron ESB version 3.x.
FIX – When running the Neuron ESB runtime under a user account and setting an ACL to a Party associated with Endpoint, the following exception may occur:
Exception: Unable to cast object of type 'System.Security.Principal.GenericPrincipal' to type 'System..Security.Principal.WindowsPrincipal'.
FIX – When the Neuron ESB service starts up and a Solution is not assigned to the runtime, Neuron ESB will now log and present an informational message letting the user know how to fix.
FIX – Management Service – if an endpoint was unable to update its statistics, an error would be written but the endpoint name was excluded from the message
FIX – Management Service – The following exception may be reported in rare circumstances:
Exception: Violation of PRIMARY KEY constraint 'PK_ActivitySession'. Cannot insert duplicate key in object 'dbo.ActivitySession'.
FIX - Some error messages appear may appear in the Neuron logs indicating that a party was not connected to a bus or could not publish to a topic, but there was no indicator which party could not connect because it was not included in the error message.
FIX – Named Pipes – Parties may fail to connect to a Named Pipe topic if they’re app.config file contains or is missing a Neuron ESB runtime Instance name.
FIX – Modifying Service Endpoint during runtime may log the following exception:
Error while unloading appdomain. (Exception from HRESULT: 0x80131015)
Neuron ESB Explorer
NEW – Users can now delete 1 or more messages from Message History and Failed Messages Reports as well as from the Message Viewer when called from Message History or Failed Messages. This is exposed as right click context menu.
MOD – Users could not query against the same database if a different instance of the Neuron ESB Explorer is used, versus the runtime instance that created the database entry. Previously when installing a Neuron ESB Instance, instance aware client tools (Neuron ESB Explorer) were also installed. Being instance aware prevented someone from querying any database type report where the database entries were created by a different runtime instance. Now the Neuron ESB Explorer is instance agnostic in respect to the database.
FIX – Message Viewer – When deleting a message, the underlying list would be refreshed with a message from the underlying report.
FIX – User Property Cache Corruption – If the user property cache (used to store a user’s preferences) becomes corrupt do to moving back and forth between installed versions of Neuron, or for any other reason, the following unhandled exception may occur when the Neuron ESB Explorer is opened, closed or when a solution is being saved:
System.ArgumentException: The parameter 'sectionGroupName' is invalid.
This has been changed so a dialog is presented with instructions on how to manually clear the user cache.
FIX – Creating Neuron ESB Database – If the Sql Server Agent service was stopped at the time when a user attempts to create a database through the Neuron ESB Explorer, the following exception may result:
System.FormatException: Input string was not in a correct format.
This has been changed to show a dialog directing the user how to correct.
FIX – Neuron ESB Explorer may not close when a user attempts to close through the control box function due to a background process that was running on the UI thread.
FIX – Saving an XSLT with a function can generate an error. On save, Neuron ESB would validate the literal string that's being passed in. Now the Neuron ESB Explorer will display a dialog alerting the user that the XSLT could not be validated but save the document to the repository.
FIX – Message History and Failed Message Reports – Clicking either the "Reply to Session ID" or “Workflow Instance ID” column to sort would generate the following unhanded exception:
FIX – Message History and Failed Message Reports – Clicking either the "To" or “From” column to sort would generate the following unhanded exception:
System.Data.SqlClient.SqlException (0x80131904): Incorrect syntax near the keyword “N”
FIX – Loading Solution with non-Neuron XML files in solution structure would throw the following exception:
System.InvalidOperationException: There is an error in XML document (1, 2)
Neuron will now report a specific error with steps to correct as well as filter out all non *.xml files in the solution folder.
FIX – Workflow Endpoints – Endpoint Health would list the correct number of Workflow Endpoints started, but all would be the same name.
FIX – Unhandled Exception could occur while viewing the Endpoint Health monitor while shutting down the Neuron ESB runtime.
FIX - Workflow Endpoints could get locked into a "Starting..." state after an Availability Group was assigned to the running deployment group in the Deployment Settings tab of the Availability Group.
FIX – Availability Group reverts to Stopped State – After the first time the Neuron ESB Service is started, if an Availability Group is restarted in endpoint health, the workflow endpoints will eventually restart and go green. The Availability Group will also change to a Started state and go green however, it will then revert to a Stopped state and RED.
FIX – Using setup.exe to install an x86 runtime instance AFTER an x64 runtime instance was installed would fail.
MOD – SalesForce - Added a timeout property to the Salesforce.com subscription adapter to allow to the retrieval of very large data sets or images.
MOD – SalesForce – Max Number of Connections property has been added. Enhancements to underlying proxy management has been added with additional verbose logging.
FIX – ActiveMQ - Fixed an issue where the adapter does not reconnect to ActiveMQ once there was is disconnect (i.e. the ActiveMQ server stops).
FIX – ODBC - removed the persistence of connection string, prefix, namespace, row and root name as returned message context properties when a reply message is returned. This could cause the wrong database from being called or results returned if executing multiple times sequentially within a process.
FIX – Purge an archive could fail due to an inverted comma and lack of a database name.
FIX – Azure Service Bus database support has been updated for workflow support. A clustered index to the dbo.EndpointStatus table was recreated and several new tables and stored procedures that were added to support the new Workflow features and enhancements included in CU2.
The update could make changes to Test Client configuration which could be different than custom settings you might have set. To correct this:
To manually install this update, do the following:
NOTE: You must be logged into the Neuron ESB Support Center to view downloadable files.
The Neuron ESB 3.5 CU2 Update patch package can be downloaded directly from the Neuron ESB Support Center's 3.5 download section. Title: Neuron ESB 3.5 Cumulative Update 2 (CU2) - Patch, Filename is :NeuronPatch_3.5_CU2.zip Size: approx. 72MB
Alternatively, the Full Neuron ESB 3.5 CU2 installation package can be downloaded. This can be found in the Neuron ESB Support Center's 3.5 download section. Title: Neuron ESB 3.5 Cumulative Update 2 (CU2) - Full Install, Filename is: NeuronInstall_3.5_CU2.zip , Size: approx. 178MB