Security Enhancements

• This update contains security-related improvements to Clarify 5.x.
• For customer protection, Cleo does not disclose all security update details in release notes. For additional information, please contact Cleo Support. In cases where a critical security update is associated with a known exploit, Cleo will publish a security bulletin and notify impacted customers directly.
• Customers are encouraged to upgrade to v5.1.21 to take advantage of these security enhancements and ensure alignment with Cleo’s latest security standards.

File Monitor Reliability Improvements

• This release includes updates to improve the stability of File Monitors in Clarify 5.x.
• Certain restart or deployment scenarios could allow multiple instances of the same File Monitor to run concurrently, despite only a single instance appearing in the Resource Monitor within the Admin Console. This update resolves that behavior and improves the reliability of File Monitor deployment, startup and shutdown during routine application operations.
• No configuration changes are required. These improvements are applied automatically upon upgrading to v5.1.21.

What's new in this release

The latest release is 5.1.20. This release contains general enhancements and improvements, including infrastructure updates to support future capabilities and development.

General Enhancements and Fixes

• A "Filename" parameter can now be used in the HarmonyWithMetadata BP task to pass the filename directly to Harmony for when the file is sent via AS2 or SFTP.
• Fixed an issue in which errors were not logged when using the Run Transformation tool.
• Fixed an upgrade issue when going to Clarify 5.1.18 from 4.17 in which opening an active process within the Auditor log caused an internal error.
• Fixed an issue in which a user could not run a stored procedure with 'begin tran' and 'commit' in the SQL Statement.
• Fixed an issue in which Property Log Filter wasn't appearing in the Auditor.
• Fixed an issue in which you could not read an XML Element Attribute when the child tag had the same name.
• Fixed an issue in which the loading of AckCodes.xml would break Deploying ErrorActions on Routes.
• Fixed issues experienced in the Vault UI for Acumatica and Shopify Connectors.
• Fixed an issue that dealt with Salesforce Connector connectivity.
• Fixed a connection error (InvocationTargetException) in the MS Dynamics365 Connector.
• Improved the time it takes to execute a search request in NetSuite and Salesforce Connectors.
• Fixed an issue with Schema expansion in the MS Dynamics 365 Connector.

Cleo Products Compatibility

Please be aware of the following compatibility between the different Cleo products and this current Clarify release.

Cleo Dashboards

• Recommended: v3.3.6
• v3.3.4 is required for full compatibility with the Clarify v5.03 server (and above). It will work with older server versions.
• v3.3.2 is required for full compatibility with the Clarify v5 server.
• v3.2 is the minimum required version for use with a Single Server.

Cleo Harmony or Cleo VLTrader

• Recommended: 5.8
• Minimum: v5.4.1

Cleo VLProxy

• Recommended v3.9.0.4

What's new in this release

The 5.1.18 release contains general enhancements and improvements, including infrastructure updates put in place to support future capabilities and development.

• Shopify Schema update/enhancement.
• NetSuite & Salesforce context caching performance enhancement.
• Updated Jetty to version 9.4.43.
• Added scope to handling WS Consumer Refresh Tokens.

Dependencies Exist

There are dependencies between the latest Studio and Server updates. For this release functionality to operate fully, both server and studio should be at v5.1.18.  Do not mix deployments.

There is no Product upgrade or migration path from Clarify v4 to v5.0. Existing Projects (those created in Clarify v4) can be upgraded to work with Clarify 5.0.  See below, or you may contact Technical Support at +1 815-282-7894 or 1-866-444-CLEO (2536) for more information.

To use previous Clarify Projects

If you are currently using Clarify 4.x and would like to use those projects in Clarify 5.0, they must be manually upgraded in order to work with the 5.0 Studio and Server. To do so, use the Upgrade project configurations menu option for each Project to upgrade from your 5.x workspace.

Enhancements and fixes

• Fixed issue with WS Consumer not using substitution variables in URL.
• Fixed an NPE issue with SQL Access when using Insert or Delete with Output parameters.
• Fixed handling of NCHAR in v1 DB Adapter.
• Fixed an issue with Studio Scenario Deployment failing to update Local Test Server after changes are made.

Cleo Products Compatibility

Please be aware of the following compatibility between the different Cleo products and this current Clarify release.

 Cleo Dashboards

• Recommended: v3.3.6
• v3.3.4 is required for full compatibility with the Clarify v5.03 server (and above). It will work with older server versions.
• v3.3.2 is required for full compatibility with the Clarify v5 server.
• v3.2 is the minimum required version for use with a Single Server.

Cleo Harmony or Cleo VLTrader

• Recommended: v5.7.0.1
• Minimum: v5.4.1

Cleo VLProxy

• Recommended v3.9.0.1

 

 

 

 

Release v5.1.13

 

What's new in this release

The 5.1.13 release contains general enhancements and improvements, including infrastructure updates to support future capabilities and development. This release includes updates to both the Studio and Server. The latest (cumulative) version of the Studio/Server update can be obtained via the update functionality within the product.

Dependencies Exist

There are dependencies between the latest Studio and Server updates. For this release functionality to operate fully, both server and studio should be at v5.1.13.  Do not mix deployments.

There is no Product upgrade or migration path from Clarify v4 to v5.0. Existing Projects (those created in Clarify v4) can be upgraded to work with Clarify 5.0.  See below, or you may contact Technical Support at +1 815-282-7894 or 1-866-444-CLEO (2536) for more information.

To use previous Clarify Projects

If you are currently using Clarify 4.x and would like to use those projects in Clarify 5.0, they must be manually upgraded in order to work with the 5.0 Studio and Server. To do so, use the Upgrade project configurations menu option for each Project to upgrade from your 5.x workspace.

 

What’s new in this current release

The v5.0.9 release includes updates to both the Studio and Server. The latest (cumulative) version of the Studio/Server update can be obtained via the update functionality within the product.

Dependencies Exist

There are dependencies between the latest Studio and Server updates. For this release functionality to operate fully, both server and studio should be at v5.0.9. Never mix deployments!

There is no Product upgrade or migration path from Clarify v4 to v5.0. Existing Projects (those created in Clarify v4) can be upgraded to work with Clarify 5.0.  See below, or you may contact Technical Support at +1 815-282-7894 or 1-866-444-CLEO (2536) for more information.

To use previous Clarify Projects

If you are currently using Clarify 4.x and would like to use those projects in Clarify 5.0, they must be manually upgraded in order to work with the 5.0 Studio and Server. To do so, use the Upgrade project configurations menu option for each Project to upgrade from your 5.x workspace.

Before you update - recommended practices

• Always update the Studio first.
• Update the Local Test server next.
• Update all remaining servers (QA, PROD, etc.).

Other recommendations

• Make sure all Projects and related resources in your Workspace have been committed to an SVN repository.
• Stop any testing being done within your Studio; the update process requires a Studio restart. This means the Local Test server will be stopped.
• Back up your Studio installation directory.
• Temporarily stop external notifications being sent to Clarify during the update process; this includes the Clarify/Harmony messaging framework, if integrated.
• Reset your Studio Perspective. (Main menu | Window | Reset Perspective)

Ruleset Enhancements

Several enhancements have been made to Ruleset usage and performance.

The Choice label in the Ruleset editor

An enhancement to the Ruleset editor now includes the “Choice” label, which helps you identify those rules that can incorporate the use of Switch Rules and Methods. This visual cue lets you know that a Switch Rule should be used – something that’s not always obvious.

When a type has a sub-type (Choice type), then the Choice label will appear next to it in the source and/or target Schema pane of the editor, as shown here. This lets you know that you can use a Switch Rule on that Choice type using Type Guards to match on a specific sub-type. Type Guarding allows you to narrow down an object type within a conditional block.

Note: Some updates are required if using existing Connector Schemas (ObjSchema) or custom XML Schemas (v2) before this release.

For more information on this feature and possible update steps, please refer to the Switch Rules article available on the Solution Center.

Faster Load time in Type browser

Types now load faster in the Ruleset editor. No user interaction is required.

Application Connector Enhancements

Newer versions of several Application Connectors are now available in Clarify. These include Shopify, Magento, and Amazon MarketPlace Connectors. The process to create these Connectors has been simplified by removing the token requirement.

For those using Connectors built in previous v5 versions, there is no additional configuration required after updating to the v5.0.9 version of Clarify.

If you are upgrading from Clarify 4.x to v5.0.9, you won’t be able to use the older connector projects in v5.0.9. You would need to delete the existing connector projects and recreate new connectors from v5.0.9.

Enhancements and fixes

A timeout field has been added to the Database Adapter editor which allows you to set a given timeout (in seconds) at the interaction level (i.e. Select, Update, Delete, Insert).

This provides better control over the control of Clarify processes for timeout response. 

Other enhancements and fixes

• Fixed an issue with the Shopify Connector and the GetOrderById Schema not matching with the correct response.
• Created adapter and monitor objects to connect to and integrate with IBM MQ.
• Updated the link to Solution Center Release Notes from Clarify Studio update.
• Several documentation updates, mainly around Application Connectors.
• Improved Read File Adapter performance with mounted EFS location.
• Several improvements made to the Onboarding API.
• Improvements made to reduce Cluster Nodes from stopping during a Server update.
• Fixed an issue that displayed expired license errors.
• Fixed an issue in which the receiver would get stuck due to failures on job processing.
• Fixed an issue in which “String Length” Business Process task outputs Integer data type instead of Long.
• Fixed an issue in which Web Service Provider Status codes were incorrectly overwriting other Status Codes.
• Fixed a bug in which the Run OS Command returned Null Storage Nodes.
• An updated EULA is now available. 

Cleo Products Compatibility

Please be aware of the following compatibility between the different Cleo products and this current Clarify release.

 Cleo Dashboards

• v3.3.4 is required for full compatibility with the Clarify v5.03 server. It will work with older server versions.
• v3.3.2 is required for full compatibility with the Clarify v5 server.
• v3.2 is the minimum required version for use with a Single Server.

Cleo Harmony or Cleo VLTrader

• Recommended: v5.6.2
• Minimum: v5.4.1

Cleo VLProxy

 

What's new in this release

The v5.03 release contains general enhancements and improvements, including infrastructure updates to support future capabilities and development. The latest (cumulative) version of the Studio/Server update can be obtained via the update functionality within the product.

Dependencies Exist

There are dependencies between the latest Studio and Server updates. For this release functionality to operate fully, both server and studio should be at v5.0.3. Never mix deployments!

If currently using Clarify version 4x - Please Read First!

This current release can only be obtained by performing a system update from an existing version 5.0 Clarify install. This current version is not available for version 4 installs.  Please install Clarify v5.0 first in order to upgrade to v5.0.3.

There is no Product upgrade or migration path from Clarify v4 to v5.0. Existing Projects (those created in Clarify v4) can be upgraded to work with Clarify 5.0.  See below, or you may contact Technical Support at +1 815-282-7894 or 1-866-444-CLEO (2536) for more information.

To use previous Clarify Projects

If you are currently using Clarify 4.x and would like to use those projects in Clarify 5.0, they must be manually upgraded in order to work with the 5.0 Studio and Server. To do so, use the Upgrade project configurations menu option for each Project to upgrade from your 5.x workspace.

Before you update - recommended practices

• Always update the Studio first.
• Update the Local Test server next.
• Update all remaining servers (QA, PROD, etc.).

Other recommendations

• Make sure all Projects and related resources in your Workspace have been committed to an SVN repository.
• Stop any testing being done within your Studio; the update process requires a Studio restart. This means the Local Test server will be stopped.
• Back up your Studio installation directory.
• Temporarily stop external notifications being sent to Clarify during the update process; this includes the Clarify/Harmony messaging framework, if integrated.
• Reset your Studio Perspective. (Main menu | Window | Reset Perspective)

Other enhancements and fixes

• Several fixes and enhancements made to Ruleset editor functionality.
• Several enhancements made to improve Harmony/Clarify Integrations. This includes the new SendMessageToHarmonyWithMetaData Business Process task, which allows additional metadata to be passed into a Business Process.
• A fix was made to the FA Reconciliation report to correct the display of incorrect outbound FA documents related to inbound documents. This also included the display of disabled Schedule Processes that continued to appear as they were running.

Cleo Products Compatibility

Please be aware of the following compatibility between the different Cleo products and this current Clarify release.

 Cleo Dashboards

• v3.3.4 is required for full compatibility with the Clarify v5.03 server. It will work with older server versions.
• v3.3.2 is required for full compatibility with the Clarify v5 server.
• v3.2 is the minimum required version for use with a Single Server.

Cleo Harmony or Cleo VLTrader

• Recommended: v5.6.1
• Minimum: v5.4.1

Cleo VLProxy

• Recommended v3.8

 

These release notes describe new features, known issues, and other information related to the current Cleo Clarify 5 release.

Note:  This release is available as a new installation only. Currently, there is no Product upgrade or migration path from Clarify v4. However, existing Projects (those created in Clarify v4) can be upgraded to work with Clarify v5. See below, or you may contact Technical Support at +1 815-282-7894 or    1-866-444-CLEO (2536) for more information.

If using previous Clarify Projects

If you are currently using Clarify 4.x and would like to use those projects in Clarify 5, they must be manually upgraded in order to work with the v5 Studio and Server. To do so, use the Upgrade project configurations menu option (shown here) for each Project to upgrade from your 5.x workspace.

Dependencies

There are dependencies between the v5 Studio and Server. For this release’s functionality to operate fully, both server and studio must be at v5.  Never mix deployments! 

For Fresh Installs

Refer to the installation instructions provided in the Getting Started with the Cleo Clarify v5 Server/Studio install guides, available from the Support Portal on cleo.com.

What’s new in this current release

Clarify 5 represents a significant technical upgrade to the platform. New features and enhancements made to Ruleset and Business Process functionality form the basis of these changes, along with tech stack upgrades and improved deployment scalability.

Overview

Improvements to Ruleset functionality now allow for many-to-many transformations from a single Ruleset, since multiple source and targets can be defined. With this functionality, you can:

• build multiple request bodies for different APIs using one Ruleset.
• use multiple APIs to build a single document.
• use the data from a single source document to call multiple APIs.

New Business Process (BP) tasks have been created for easier API integration, providing the ability to read response data and create request data without necessarily using a Schema and Ruleset.  With new control flow BP tasks such as If/Then/Else, or For Each, you can retrieve data from simple API responses and then use it to call additional APIs.

An example could be the use of an API to retrieve a list of IDs. Using a For Each Business Process task, you could have Clarify loop through the list of IDs and then perform resulting actions – calling additional APIs to retrieve data associated with those IDs, and then possibly updating records using an API, as just one possibility.

The next sections of these Release Notes provide additional information on these features.

Ruleset Enhancements

Several enhancements have been made to Ruleset usage and performance.

Storage Node variable type an option in Ruleset Methods

In Clarify, a StorageNode represents data that may be defined by a Schema. The StorageNode variable type can be used as a source and/or target for a Ruleset Method. This means that the Ruleset Method can now transform data that is created/retrieved within the Ruleset itself. This data may use a different Schema than the Ruleset’s source and /or target Schema.

Many-to-Many Rulesets now possible using Methods

In previous versions, Rulesets were limited to a maximum of three Schemas: Source, Target, and Update. Now we can include additional Schemas by using Methods and StorageNodes. This allows you to transform more data without having to build multiple Rulesets to do so.

In addition to being able to define a StorageNode as the Source/Target of a Method, a user can define multiple sources and targets for a Method. This means that a user can map data from many sources to many targets within one Method. Rulesets can be used to produce multiple outputs in different formats. Many-to-many transformations are now possible using Ruleset Methods. Previously, this would have required several Methods and possibly additional Rulesets.

The Method Wizard has also been enhanced to allow for the selection of multiple Sources and/or Targets.  At least one Source is required.  Selecting the StorageNode type will present Schema selection pages similar to those used when creating a Ruleset. When you select a StorageNode, you will also define the syntax and select the Schema.

Mapped highlighting works for Ruleset Methods

Map highlighting is now working for Methods.  You can now select a Rule and see tick marks in the Schema views which correspond to mapped fields in the selected Rule.

Mapped highlighting works for Ruleset Methods

Map highlighting is now working for Methods.  You can now select a Rule and see tick marks in the Schema views which correspond to mapped fields in the selected Rule.

Additional validation over changing Transformation Connectors

Now that a Ruleset Method may have multiple StorageNodes and may require multiple Transformation Connectors, the Transformation Connector can be modified per StorageNode. There is now additional validation over Connectors in the Properties view’s Runtime Options section in the Ruleset editor. This validation helps ensure a compatible connector is selected. 

Additional information can be found in the Designing Integration Solutions | Transforming the Data section the Product Help.

Business Process (BP) Enhancements

The following new types can be used as parameters and variables in the Business Process editor.

• Dictionary: A collection containing key value pairs.
  • Tasks include: Create, Get, Has Key, Keys, Values, Put, Remove, and Size.
• List: A collection containing an ordered list of objects.
  • Tasks include: Create, Get, Add, Remove, Last, and Size.
• JSON: Data that is structured in the JSON format.
  • Tasks include: Read from Create, Type, Get, Set, To Dictionary, To List, and To StorageNode.

New control flow tasks

Several new control flow tasks (i.e. a task composed of several other tasks) are available that provide easier data looping and conditional constructs. The editor has also changed to reflect this structured flow. New tasks include:

For each: For each item in a list, a specified task is executed.

Do while: Executes a task while a specified condition is true. The specified task is executed before the condition is checked. This means that the specified task is always executed at least one time.  Then the condition is checked.  If the condition is true, then it executes again (then the condition is checked again). And so on.

While do: While a specified condition is true, a specified task is executed. The condition is initially checked before the given task is executed.  This means that the condition is checked first before the task is performed. So, if the condition isn't immediately true, then the task is never executed.

If/Then/Else: (Shown here) If a given condition is true, a specified task will be executed in the “then” block. If the given condition is false, the specified task will be executed in the “else” block. In the example below, different Business Processes will execute based on the result of the initial “If” statement. 

Using Pass/Fail Parameters with Control Flow tasks

Task labels and pass/fail parameters can still be still used to control the sequence of logic in a Business Process. While task labels and pass/fail parameters can be used at the control flow task level (If/Then/Else, for example) they cannot be used by the sub-tasks contained within control flow tasks themselves.

Force Step Failure task (typically used with If/Then/Else)

The Force Step Failure task can be used to force the entire step that it is contained within a control flow task to fail. When using control flow tasks, if a singular task does not complete successfully, the overall control flow task (If/Then/Else, for example) does not necessarily stop nor appear as failed in the Auditor.  By using the Force Step Failure task, an optional error message can be provided when the task is executed (thereby providing better troubleshooting).

For example, in the Business Process below the Force Step Failure task has been included within a While Do task. If the ReadLocationsFA (File Adapter) task fails, then the entire step fails, and an error message can be made to appear in the Auditor. 

Better Task Labeling

Actual names of Business Process tasks have been relabeled for better readability.  While new names appear on the left, the older legacy name is still shown in parentheses to the right, as shown below.

Both names are searchable in task filter.

Additional information on these Business Process enhancements can be found in the Designing Integration Solutions | Processing the Data | Business Processes section the Product Help.

Adding an AbstractTask

An AbstractTask is an abstract Java class that can be extended to add custom tasks to the Business Process task library.

To create a new task:

1. In the src folder of a Studio project, right-click -> New -> Java Class
2. Extend AbstractTask
3. Add an execute method
4. Wrap arguments using Variable interface
5. Return values should be specified as output arguments

The new task should now be available when adding a step to the script section of your Business Process.

Miscellaneous

The Business Process Diagram Editor is no longer available in this version of the Studio. 

Updated Tech Stack 

The following software components have been updated.

• Java updated to 8.0_202 (was 1.7.0_51)
• Eclipse updated to 11 (was 3.8)
• Xtext updated to 17.1 (was 2.3.1)
• Akka updated to 5.16 (was 2.4.20)
• Subclipse (replaces Subversive as SVN client in Studio)

Improved Deployment Scalability

Improved deployment scalability means more Projects can be deployed than had been the case for earlier Clarify server versions. There is no change in user experience or deployment processes.

Known Issues

The following known issues and related workarounds apply to this current Clarify release.

• If closing the Studio or switching workspaces with open Ruleset editors, the next time that workspace is opened those Rulesets must be closed and reopened; this is so that the types of source and target Schemas will correctly reload.
• The new Business Process editor won’t show an error in the Script section when no tasks have been created (as it did in earlier versions). While an error will appear in the Problems tab, it might not be apparent to the user should a deployment error occur (i.e. trying to deploy a blank Business Process).
• When adding multiple control flow tasks to the Business Process editor, the columns to the far left of the Script section my shrink to the point that error and navigational icons disappear.

Cleo Products Compatibility

Please be aware of the following compatibility between the different Cleo products and this current Clarify release.

 Cleo Dashboards

• 3.2 is required for full compatibility with the Clarify v5 server.
• 2 is the minimum required version for use with a Single Server.

Cleo Harmony or Cleo VLTrader

• Recommended: v6
• Minimum: v.4.1

Cleo VLProxy

• Recommended v8