11.37 Harmony release notes
11.37 Harmony release
The 11.37 Harmony release is staggered based on the dates and times as listed below by component and region. For a more detailed explanation of the release cadence by component category, see the release schedule.
Note
The 11.35 and 11.36 releases were internal.
11.37 Sandbox Cloud Agent Group (SCAG) SDK connectors on 11.37 SCAG 11.37 Design Studio 11.37 cloud and private API gateway Cloud platform and applications Jitterbit Documentation site | 11.37 Docker private API gateway | 11.37 SCAG patch | 11.37 Production Cloud Agent Group (PCAG) SDK connectors on private agents and 11.37 PCAG 11.37 Windows and Linux private agents 11.37 Docker private agent | |
---|---|---|---|---|
APAC | January 7, 2025 (2 - 6 AM AEDT) | January 16, 2025 (10 PM AEDT) | January 18, 2025 (3 AM AEDT) | To be scheduled |
EMEA | January 7-8, 2025 (9 PM - 1 AM CET) | January 16, 2025 (12 PM CET) | January 17, 2025 (5 PM CET) | To be scheduled |
NA | January 8, 2025 (12 - 4 PM PST) | January 16, 2025 (3 AM PST) | January 17, 2025 (8 AM PST) | To be scheduled |
The 11.37 Harmony release also includes the release of App Builder 4.0.36098 (11.37) and Vinyl 3.3.36111 (11.37), whose release notes are provided separately.
Compilations of release notes for Production Cloud Agent Groups, Sandbox Cloud Agent Groups, and private agents are also available.
You can subscribe to maintenance notifications for web-based components at Jitterbit Trust. Locally installed components are available from the Downloads page (except for the Docker private agent and Docker private API gateway, which are available at Docker Hub). The end-of-life date for these components is one year after the release date.
New features
Agent
- Agent observability (Beta)
Remotely monitor a private agent’s performance and behavior in real time using Datadog or Elasticsearch. To enable agent observability, follow our setup instructions for your observability platform, then import one of Jitterbit’s pre-built dashboards from the Harmony portal Downloads page. To provide feedback on this beta feature, contact the Jitterbit Product Team.
Harmony portal and Jitterbit Documentation site
-
Jitterbit AI Bot (Beta)
Ask questions about using Jitterbit’s products and get tailored answers using generative AI. You can access the Jitterbit AI Bot (Beta) from either of these locations:- On the Harmony portal Home page using the AI icon in the top right.
- On the Jitterbit Documentation site using the Ask Jitterbit AI button in the top right.
To provide feedback on this beta feature, contact your Customer Success Manager (CSM).
Integration Studio
- Importing of individual project components (Beta)
A new Import (Beta) option in an open project’s actions menu provides the ability to select individual components of an exported source project to import into the current project. For beta access and to provide feedback, contact the Jitterbit Product Team.
Integration Studio SDK connectors
-
New connectors
The following new connectors are available to interact with the connected endpoint:- Avro: Query or create records or execute a procedure in Apache Avro using private agents.
- IBM Informix: Query, create, update, or delete records or execute a procedure in IBM Informix using private agents.
- SugarCRM v2 (Beta): Query, create, update, or delete records in SugarCRM using cloud or private agents. For beta access and to provide feedback, contact the Jitterbit Product Team.
Enhancements
Agent
-
New Jitterbit variables
The following new Jitterbit variables are available to use with agents 11.37 and later:jitterbit.scripting.hex.enable_null_support
: Set this variable totrue
upstream of using theHexToString
orStringToHex
functions for their conversions to support a null hex value.jitterbit.target.xml.include_nil_attribute
: Set this variable totrue
upstream of a transformation with JSON output to have null values and empty strings included in the target XML, matching the input.jitterbit.transformation.ignore_default_value
: Set this variable totrue
to ignore instances of embedded nested JSON that are being treated as default variables values when processing XSLT stylesheets, such as when using theRunXSLT
function.jitterbit.source.json.trim
andjitterbit.source.json.trim.option
: Setjitterbit.source.json.trim
tofalse
upstream of a transformation to preserve leading and/or trailing spaces in JSON source data. When this variable is set totrue
or not set (the default istrue
), you can setjitterbit.source.json.trim.option
to"trim"
(the default; trim both leading and trailing),"ltrim"
(trim leading), or"rtrim"
(trim trailing).
-
Additional OpenSSL cipher support
The Integration Studio FTP connector and Design Studio FTP sources/targets support additional OpenSSL encryption ciphers with agents 11.37 and later. -
New agent support tool commands
Two new agent support tool commands are available with private agents 11.37 and later:about
andenv-list
.
Agent and API gateway
- RHEL 9 support
Red Hat Enterprise Linux (RHEL) 9 has been verified to be supported on private agents and private API gateways 11.37 and later.
Agent, Integration Studio, and Design Studio
-
Salesforce API version 62 support
Salesforce API version 62 is now supported for these connectors:- The Integration Studio Salesforce, Salesforce Service Cloud, and ServiceMax connectors automatically use this API version with 11.35 or later agents.
- The Design Studio Salesforce connector supports this API version with the use of both 11.35 or later agents and an 11.35 or later version of Design Studio. When both these version requirements are met, an API upgrade dialog is shown when opening existing projects using this connector.
API Manager
- API Manager navigation menu removal
The API Manager navigation menu within each API Manager page has been removed. Instead, use the existing Harmony portal menu to navigate between API Manager pages, which provides a consistent experience across all Harmony web applications.
EDI
-
Manual archiving
You can now manually archive transactions on the Transactions page:- A new Archive icon is shown on a single transaction in its Actions column.
- After selecting multiple transactions, use the new Archive icon along the top of the transactions table.
Previously, transactions could only be archived automatically.
-
Ability to change EDI IDs
You can now delete and re-assign an existing Partner ID or Company ID on the Admin page’s EDI settings tab. Previously, once an ID was assigned it could not be changed. -
Admin page enhancements
The following enhancements have been made on the Admin page:- You can now search for and add a trading partner by entering its ID in the search bar.
- You can now change the logo for a new trading partner by using its actions menu icon to select Change Logo.
- There is now a confirmation message for deleting a workflow. In addition, the following workflow fields now have type-ahead functionality: Map Processing, Direction, EDI Standard, Document Type, and Version.
- The AS2 communication settings now have tooltips for the Certificate, My certificates, and Partner certificates fields.
Integration Studio
-
Optional redesigned UI
A Try the new UI toggle in the design canvas header provides the ability to switch to a redesigned user interface for the design canvas and design component palette. The new UI is selected per user rather than per organization. To provide feedback on the new design, contact the Jitterbit Product Team. -
Design component palette improved search experience
When searching in the design component palette’s Project endpoints and connectors tab, each category is now visually identified with an icon, the number of results in each subcategory is displayed, subcategories with no results are automatically collapsed, and search results are identified more clearly. -
Accessibility of operation validity errors from the design canvas
The invalid icon that is displayed on an invalid operation on the design canvas can now be clicked to show the reasons the operation is invalid. Previously, these errors were accessible only from the project pane. -
Operation log improvements
The following enhancements have been made to the operation logs page:- A search by operation name now returns results within the full child hierarchy of a parent operation. You can toggle the execution tree view on or off to show or hide the parents and children of the operation search results.
- Multiple log entries can now be browsed at once. In addition, logs stay expanded while parent-child operations are running.
-
Salesforce connector ability to copy and paste the activity configuration
New Copy activity configuration and Paste activity configuration icons are shown on steps 1 and 2 of configuration of a Salesforce, Salesforce Service Cloud, or ServiceMax Query activity. These allow you to copy and paste the activity configuration (including both steps) from another activity instance of the same type. -
Project variables list UX improvements
The project variables list now opens as a drawer along the bottom of the design canvas, allowing you to view the project design and project variable data at the same time. This design also shows more data at once on high resolution screens.
Integration Studio SDK connectors
-
HTTP v2 connector support for 3-legged OAuth
In an HTTP v2 connection, when OAuth is selected as the Authentication method, a new OAuth type menu provides the option to select either Client Credentials Grant (default existing) or Authorization Code Grant (newly supported). With the new option, you click Log in with OAuth to authenticate the connection using a registered private application. Requires cloud agents or private agent version 10.83 / 11.21 or later. -
HubSpot connector API V4 support
A HubSpot connection’s Optional settings has a new API version menu where you can select either HubSpot API version V3 (default existing) or V4 (newly supported). -
Epicor Kinetic connection support for request headers
An Epicor Kinetic connection’s Optional settings has a new Request Headers table where you can specify the Name and Value of additional headers to send in the request. -
JMS connector support for IBM MQ 9.4 and clarified support for topics
The JMS connector now supports IBM MQ 9.4 when IBM MQ is selected as the provider in a JMS connection. In addition, a JMS Consume activity has had its Queue name field updated to Queue or topic name to more accurately reflect that the activity can be used to consume either a queue or a topic, and not just a queue. -
Magento connector API 2.4.7 support
The Magento connector has been verified to support Adobe Commerce API version 2.4.7. -
Salesforce Einstein Analytics connector API version 62 support
The Salesforce Einstein Analytics connector has been verified to support Salesforce API versionv62.0
in its connection’s Version field. -
Salesforce Events connector API version 62 support
The Salesforce Events connector has been verified to support Salesforce API version62
in its connection’s API Version field. -
SAP Receive IDoc (Beta) activity
The SAP connector has a new Receive IDoc (Beta) activity that receives an outbound Intermediate Document (IDoc) from SAP. Prerequisites for this activity include a private agent version 11.37 or later that has been enabled for event listening, and required configuration in the SAP system. -
ServiceNow connector driver upgrade
The ServiceNow connector now uses version 24.0.9060 of the CData JDBC Driver for ServiceNow. -
Shopify connector API 2024-10 support
A Shopify connection's API Version menu now has REST Admin API version 2024-10 as a selection. -
Snowflake connector driver upgrade
The Snowflake connector now uses version 3.19.0 of the Snowflake JDBC driver.
Jitterbit Documentation site
-
New search engine
The new search engine on the Jitterbit Documentation site enables you to find documentation more quickly and easily. Features of the new search engine include saving top pages as favorites and seeing recently accessed pages. To limit your search to a certain product, include its name in quotes, such as"integration studio"
,"design studio"
, or"app builder"
. -
German language localization
Jitterbit documentation is now accessible in the German language. Use the Languages menu in the top right on the Jitterbit Documentation site to select Deutsch.
Management Console
-
Runtime Operations page improvements
The following improvements have been made to the Runtime Operations page:- The operation log query and selected timeframe are now included as URL parameters. This allows you to share an exact query with others by sharing its URL.
- A search by operation name now returns results within the full child hierarchy of a parent operation. In addition, you can now toggle the execution tree view on or off to show or hide the parents and children of the operation search results.
-
Operation ID visibility and link to open the operation
When a project is selected in the Projects page, its Operations tab now lists the GUID of each operation in a new Operation ID column. In addition, the Actions column now has a Go to operation link that opens the Integration Studio project with the operation selected. -
Agents page improved user experience
The display of agent groups on the Agents page has been changed from expandable groups to a tabular format. -
Remote agent configuration UX improved
When Remote agent configuration is enabled, warning messages no longer appear when the set value varies from the default value. Instead, for informational purposes, you can view the default value by hovering over each setting.
Fixes
Agent
-
OpenSSH format keys are now supported
Connecting to SFTP with an SSH key in OpenSSH format is now successful. -
Jitterbit AWS S3 Get plugin compatibility with TLS 1.3
The Jitterbit AWS S3 Get plugin (deprecated) no longer results in anInvalid SSL master secret
error due to incompatibility with TLS 1.3. This fix requires version 1.0.1.0 of this plugin, which is associated with cloud agent groups by default and can be associated with a private agent group through the Management Console Plugins page. -
Scheduled operations now run on the day of their end date
Schedules with a specified end date now execute all scheduled runs including the entire day of the specified end date. -
Process Engine reliability improved
The agent’s Process Engine service is more reliable and no longer crashes in certain circumstances.
API gateway
- Backslash in a basic auth password no longer prevents API access
API Manager APIs assigned a security profile with basic authentication that was created with a password that includes a backslash (\
) can now be accessed as expected. Previously, the password could be saved but it was not possible to log in with the account.
API Manager
-
Fixes to the API Logs and Analytics pages
The following fixes have been made on the API Logs and Analytics pages:- Data on the API Logs and Analytics pages can now be viewed for APIs whose user-defined Version Number consists of non-numeric characters.
- The Custom Period filter on the API Logs and Analytics pages now restricts users to select from dates within the past 90 days, which is the existing retention period for API logs and metrics. Previously, the filters allowed you select a time period outside this range but no data would be returned.
- Clicking the Download Payload button in a log on the API Logs page now downloads the payload as expected instead of returns an
[object Object]
error.
-
Custom API “last edited” fields no longer incorrectly update
When navigating between the steps of or closing a custom API configuration without making changes, the last-edited information is no longer incorrectly updated. For this fix to take effect in existing APIs, the API configuration must be opened and published at least once. -
Error messages are now shown a single time
Duplicate error messages that must be cleared before continuing are no longer shown on API configuration screens.
Integration Studio
-
Global connection validations improved
Additional validations have been added to prevent the scenario from occurring where a missing global connection could cause the errorCannot read properties of undefined
and result in a project not rendering. -
API SOAP Request and SOAP Response activities no longer cause file sync error
Running an API SOAP Request or SOAP Response activity configured with a WSDL shared by a different deployed SOAP Request or SOAP Response activity that has since been deleted no longer sometimes results in the errorThere is no file in the local file store
with a reported agent synchronization issue. -
Salesforce bulk activities can now map to nested child fields
Salesforce bulk activities now show the complete structure during the header mapping step. Previously, nested child fields were missing and could not be mapped to. -
Salesforce Query activity now supports the
LIMIT
keyword
ALIMIT
specified in the query statement of a Salesforce Query activity is now retained as part of the configuration. Previously, a specifiedLIMIT
was being removed after testing the query. -
SOAP connector no longer excludes certain namespace definitions
The schemas generated by the SOAP connector now include all namespaces defined in the provided WSDL. Existing SOAP activities that are missing namespace definitions must be replaced with new activities created from a new SOAP endpoint to apply this fix. -
Conflicting changes can no longer be overridden despite notification
A scenario can no longer occur where local changes could override those of another user despite a notification that conflicting changes could not be saved. The scenario was limited to when a logged-in user’s machine went into sleep mode while another user made changes to a component that the original user later returned to edit while still logged in without first refreshing the project.
Integration Studio SDK connectors
-
Active Directory v2 Query runtime error no longer occurs
An operation with an Active Directory v2 Query activity no longer fails when processing the operation. -
eBay Analytics connection test error improved
When testing an eBay Analytics connection is unsuccessful, the error message is now more descriptive of the problem. -
Epicor Kinetic connector now supports additional characters
Epicor Kinetic Post and Update activities now support encoding of Latin characters in the request payload using UTF-8. Previously, when passing an extended Latin character aNullPointerException
would occur at runtime. -
HTTP v2 connector base64 output for images is now correct
When using the HTTP v2 connection setting Get response content in base64 string, image files now no longer have a malformed base64 string output. -
Jira Create activity option to return error now works
The Jira Create activity optional setting Fail the operation on error now works as expected. Previously, operations that would otherwise be successful were resulting in an error even when the setting was unselected. -
Microsoft Excel v2 connector now supports parentheses
Using a Microsoft Excel v2 Query activity to query data whose column headers contain parentheses no longer returns an error reporting an invalid XML character.
Management Console
- Error enabling SSO no longer occurs
When enabling SSO for a Harmony organization, the errorSSO_CANNOT_BE_ENABLED_FOR_MEMBERS_ASSOCIATED_WITH_MULTIPLE_ORGS
no longer occurs due to a user’s prior membership in another SSO organization in which they are no longer an active user.
Notices
Agent, API gateway, and Design Studio
-
End of life for versions up to 10.82 / 11.20
As of January 18, 2025, these product versions have reached end of life and are no longer supported:- Private agent versions 10.79, 10.80, 10.82, 11.17, 11.18, and 11.20
- Private API gateway version 10.79, 10.80, and 10.82
- Design Studio version 10.82
We recommend that all users of any of these versions upgrade to the latest version as soon as practicable.
Agent
-
Private agent versions 10.x are no longer updated
Private agent version 10.87 was the last 10.x agent version distributed by Jitterbit and is intended to be the final supported 10.x agent version.Since Harmony release 10.63 / 11.1, both a 10.x and 11.x private agent version had been distributed with these differences:
-
11.x versions: In 11.1 and later versions, the PostgreSQL database bundled with the private agent is now version 14.5-1.
-
10.x versions: Supported 10.x versions are packaged with the existing 9.6.24-1 PostgreSQL. The distributed 10.x versions will continue to be supported in accordance with Jitterbit’s end-of-life policy.
Important
To continue to receive private agent updates, including new features, enhancements, security patches, and fixes, upgrading to an 11.x private agent is required.
Follow the instructions to upgrade from 10.x to 11.x agents:
-
Windows agent upgrade instructions (requires a complete uninstall)
-
NetSuite connector, Integration Studio, and Design Studio
-
HMAC-SHA1 deprecation and removal from the Integration Studio and Design Studio UI
NetSuite is deprecating HMAC-SHA1 as a valid signature algorithm as previously announced (see NetSuite HMAC-SHA1 deprecation). To support these changes, Jitterbit intends to remove the HMAC-SHA1 signature algorithm from the Integration Studio and Design Studio UI in an upcoming Harmony release.Warning
As the HMAC-SHA1 signature algorithm will no longer be supported by NetSuite or the Jitterbit Harmony NetSuite connectors, you should change any Jitterbit Harmony projects that are presently using HMAC-SHA1 as the signature algorithm to use HMAC-SHA256 as soon as possible to avoid issues with those integrations.
Security
- ISO 27018:2019 certification
Jitterbit has achieved certification for compliance with ISO 27018:2019.