Intercax is excited to announce the release of Syndeia 3.6 Service Pack 1 (3.6 SP1).
In this section, the availability, downloads, and the list of improvements in Syndeia 3.6 SP1 are presented.
Availability
Syndeia 3.6 SP1 is available for download starting Oct 21, 2024.
Syndeia 3.6 SP1 includes:
Syndeia Cloud 3.6 SP1, including Syndeia Web Dashboard
Syndeia Cloud REST API 3.6 SP1
Syndeia local clients 3.6 SP1
Syndeia MagicDraw/Cameo plugin
Syndeia Rhapsody plugin
Syndeia Standalone
Downloads and Installation
Existing Syndeia users with an active subscription can request downloads for Syndeia 3.6 SP1 by opening a request on our helpdesk.
For Syndeia local clients, follow the instructions under the Installation sections.
MagicDraw/Cameo plugin - Installation - Syndeia for MagicDraw | Cameo
Rhapsody plugin - Installation - Syndeia for Rhapsody
Standalone - Installation - Syndeia Standalone
For Syndeia Cloud, follow the instructions here: Deployment & Maintenance
New users, who are downloading Syndeia for the first time, should directly get started with Syndeia Cloud 3.6 SP1. Refer to: Automated Deployment
Users working with Syndeia Cloud 3.5 SP2 or 3.6 can upgrade to 3.6 SP1. Refer to: /wiki/spaces/IN/pages/3566305281
Improvements
1. Syndeia Cloud Infrastructure Upgrades
1.1/ Syndeia 3.6 SP1 includes major infrastructure upgrades. It requires newer versions of infrastructure components, such as Java, Cassandra, JanusGraph, Kafka, and Zookeeper, compared to Syndeia 3.6 / 3.5 SP2. The use of newer infrastructure components facilitates expansion of Syndeia capabilities and stronger cybersecurity. The list below shows the older → newer version requirements for each infrastructure component.
Java: 1.8.0 → 11.0.23
Cassandra: 3.11.X → 4.1.0
Janusgraph: 0.5.3 → 1.0.0
Zookeeper: 3.6.3 → 3.8.4
Kafka: 3.2.1 → 3.7.0
Java JMX: 1.8.0 → 11.0.23
Users deploying Syndeia Cloud for the first time will use the Automated Deployment approach that will install the new versions of infrastructure components. Users upgrading from Syndeia Cloud 3.5 SP2 / 3.6 will be using the Upgrade process where the infrastructure components will be upgraded to the new versions.
Specific improvement/tasks: SYN-4677, SYN-2829, SYN-4357, SYN-4681, SYN-4682, SYN-4683, SYN-4684, SYN-4685
1.2/ JWT tokens for FIPS mode - Starting with Syndeia 3.6 SP1, Syndeia IT admins may select RS256 instead of the default HS256 as the signing algorithm for JWT tokens generated by Syndeia Cloud during authentication. This may be especially required for enabling FIPS mode. Refer to the following section for details: https://intercax.atlassian.net/wiki/spaces/SYN36/pages/3330189176/Post-Deployment+Optional+Application+Configuration#JWT-Token-Signing-Algorithm-3.6-SP1.
Specific improvement/tasks: SYN-4668, SYN-4598, SYN-4752
1.3/ Windows Server - Syndeia Cloud 3.6 SP1 deployment is not natively supported on Windows Server. Newer versions of infrastructure components, especially Cassandra 4+, are not supported on Windows Server. Syndeia Cloud 3.6 SP1 requires Cassandra 4.1, as listed above in 1.1. Most Syndeia Cloud deployments are on Linux, esp. RHEL. However, teams that are still running Syndeia Cloud on Windows Server are encouraged to open a request on our helpdesk for assistance, and discuss potential path forward. Note that this only applies to Syndeia Cloud. Syndeia Web Dashboard and Clients (Cameo / Rhapsody plugins, and Standalone) are supported on Windows, Mac OS X, and Linux.
For more details, refer to the following page: Appendix W - Windows Server Support.
2. Syndeia Cloud Web Dashboard Improvements
1/ Display of pie charts in the Jira and Jama reports in the Digital Thread Project dashboard was improved. An issue was noted where the pie charts labels were intersecting with the color keys.
Specific improvement: SYN-4733
2/ Few issues were noted in the dialog for creating reference relations. These issues have been resolved.
2.1/ The Select direction drop-down was hiding under the tree for certain repository types, specifically Teamcenter, DS-E3, DS-CR, and GENESYS. This has now been resolved, as shown below.
Specific improvement: SYN-4624
2.2/ The Create Reference Relationship dialog when launched from search results for certain repositories, specifically Teamcenter, DS-CR, and DS-E3, would not close after the user created the relation. This issue has been resolved.
Specific improvement: SYN-4616
2.3/ The Create Reference Relationship dialog was selecting the incorrect source artifact when switching between artifacts for certain repositories, specifically Teamcenter, DS-CR, and DS-E3. This issue has been resolved.
Specific improvement: SYN-4581
3/ An issue was noted for Workspace → Tree View → Relations tab where the list of relations was not updating when a user switches from one Digital Thread Project to another, as shown below. This issue has been resolved.
Specific improvement: SYN-4582
4/ An issue was noted for Workspace → Tree View → Relations tab where the list of relations was not updating when a user switches from one Digital Thread Project to another, as shown below. This issue has been resolved.
Specific improvement: SYN-4582
6/ An issue was noted with the Add User Privileges dialog box when assigning privileges to users for a specific Digital Thread Project. The delete (trash icon) was not functioning in the specific dialog for certain scenarios. This issue has now been resolved.
Specific improvement: SYN-4732
7/ If a user does not have RELATION_WRITE privileges on a Digital Thread Project, the Create relationship menu available when right-clicking an artifact from the search results was active (instead of being inactive). However, even though the menu was active, the user was unable to create a relation due to limited privileges, as expected. This issue has been resolved and the menu will now be inactive, as shown below.
Specific improvement: SYN-4615
8/ The following fixes and improvements were made for graph query results under the Digital Thread Project → Explore → Queries tab.
8.1/ An issue was noted in the table view of graph query results. When the results were a collection of values (not nodes or edges), the table view was showing duplicate entries even though the JSON view was showing the correct entries. This issue has now been resolved.
Specific improvement: SYN-4759
8.2/ When the query was incorrect or there was a problem in executing the query, the results card would show “No data found”. That has now been updated to show the detailed error response from the Syndeia Cloud Graph Service.
Specific improvement: SYN-4722
9/ Buttons in the node displays for fetching only incoming or outgoing relations (→) for Jira artifacts in the Digital Thread Explorer were fetching both the incoming and outgoing relations. This has been resolved.
Specific improvement: SYN-4717
3. Integration Improvements
Syndeia 3.6 SP1 comes with significant improvements to existing integrations. These improvements are listed below and organized alphabetically by the integrated applications.
3.1. Aras
Syndeia Cloud 3.6 SP1 includes the following improvements for the Aras integration API endpoints in the Syndeia Cloud REST API.
POST and PUT endpoints for creating and updating Aras artifacts (items) and relations are now available.
Specific improvements: SYN-4291, SYN-4038
Bug related to fetching Aras artifacts by external id has now been resolved.
Specific bug: SYN-4665
3.2. Artifactory
Syndeia Cloud 3.6 SP1 includes the following improvements related to Artifactory integration.
Syndeia Cloud 3.6 SP1 will not show remote Artifactory repositories linked on an Artifactory server. Remote repositories in Artifactory are caching proxies for repositories managed at a remote URL, including another Artifactory server, which may have their own authentication and authorization controls. Using Syndeia Cloud 3.6 SP1, users can browse and access contents of any local repositories managed by the given Artifactory server if the users are successfully authenticated to that Artifactory server and are authorized to view the contents of those local repositories.
Specific improvement: SYN-4736
3.3. Bitbucket
Syndeia Cloud 3.6 SP1 includes the following improvements related to Bitbucket integration.
For certain Git repositories managed on a Bitbucket server, users may have faced issues expanding the list of Modified files in a given commit. This issue is not resolved with Syndeia Cloud 3.6 SP1.
Specific improvement: SYN-3620
3.4. Confluence
Syndeia Cloud 3.6 SP1 includes the following improvements related to Confluence integration.
If a Confluence repository deployed at an organization allows for anonymous access (i.e. without any user credentials), the native Confluence API returns a success response (status code 200) and ignores the user id and credentials. Due to this behavior, the /test endpoint of the SC Confluence integration API was returning a success response for the same scenario.
With 3.6 SP1, this behavior has been improved such that the /test endpoint in the SC Confluence integration API will now return an Unauthorized (401) response if the user id and credentials are invalid, even if the Confluence repository allows for anonymous access and returns a success response.
Specific improvement: SYN-4529
3.5. DOORS NG
Syndeia Cloud 3.6 SP1 includes the following improvements related to DOORS NG integration.
1/ An issue in the Web Dashboard related to fetching large sets of requirements in a requirement collection is now resolved. The issue surfaced when clicking on the cloud icon for loading the next page of requirements in a requirement collection.
Specific improvement: SYN-4835
2/ An issue related to the synchronization of artifact properties typed by a multi-valued enumeration is now resolved. Users will be able to compare and sync multi-valued enums from SysML → DOORS NG using the Syndeia client plugins for Cameo/Rhapsody.
Specific improvements: SYN-4710, SYN-4430, IHD-3975
3/ Artifact types and their attribute definitions in a DOORS NG project or component may include URIs that are blocked by enterprise firewalls, e.g. https://example.com/ns/rm/IntercaxEnumAttributeDataTypeInUri. As a result, any attempt to fetch additional details for the given artifact type or attribute definition using the URIs will timeout.
As a general recommendation, digital engineering and requirements management teams that add URIs to artifact type and attribute definitions in DOORS NG must ensure that those URIs are resolvable in their enterprise network. However, if the URIs are not resolvable, Syndeia 3.6 SP1 includes the following workaround.
If artifact type and attribute definitions have URIs that do not share the same domain as the DOORS NG repository, then the URIs are ignored unless the Syndeia admin explicitly sets the allowExternalUrlFetches to true in the application.conf of the SC DOORS NG microservice and provides a list of external domain URLs that are resolvable in the organization’s network.
allowExternalUrlFetches: true allowedExternalDomainsIfFetchingExternalUrls: [example1.com, example2.com]
Specific improvements: SYN-4628, IHD-4217, IHD-3975
4/ API endpoints to get artifacts by external key (GET /artifacts/{externalKey}) and external id (POST /artifacts/external/id) had an issue with returning attributes when a list of specific attributes were requested using the includeAttributes query parameter. Users could only either fetch all attributes or none. This issue has been resolved. Users can now fetch all, none, or a specific list of attributes of artifacts by passing values for the includeAttributes query parameter. Refer to the SC API Swagger doc for details.
Specific improvements: SYN-4589, IHD-4177
5/ Requirement collections in DOORS NG can only have one level of nested requirements and not nested requirement collections. However, this is not enforced by the DOORS NG / OSLC API. An issue was found where Syndeia clients (e.g. Cameo/Rhapsody plugin) were generating multiple levels of nested requirement collections in DOORS NG. This issue has been resolved. Syndeia clients will only generate 1 level of nested requirements under a requirement collection during SysML → DOORS NG model transformation, as allowed and supported by DOORS NG.
Specific improvements: SYN-4571
6/ In the Syndeia Web Dashboard, switching from artifact search to container (project) search for the DOORS NG repository was not updating one of the fields in the search form. This issue has been resolved.
Specific improvements: SYN-4530
7/ Adding and updating DOORS NG artifact types and their attribute definitions in the Mapping tab of the Syndeia Client dashboard was improved.
Specific improvements: SYN-2210
8/ An issue was noted when mappings defined in Syndeia 3.5 or earlier were used with Syndeia 3.6 for either Non-CM or CM projects in DOORS NG. This issue was resolved by adding improved exception handling.
Specific improvements: SYN-4780
3.6. DS-E3 and DS-CR
1/ An issue was noted with DS-CR and DS-E3 model transformations to SysML models where the relations created between SysML and DS-CR / DS-E3 elements was not being persisted in certain scenarios. This issue has been resolved.
Specific improvements: SYN-4648
3.7. GENESYS
Syndeia Cloud 3.6 SP1 includes the following improvements related to GENESYS integration.
1/ Syndeia Cloud 3.6 SP1 adds supports for GENESYS 2023 and any later version that conforms to the GENESYS REST API v2. Support for older versions of GENESYS, conformant to GENESYS REST API v1, has been dropped. Refer to the Syndeia Integration Compatibility matrix for details in the future.
Specific improvements: IHD-4284, SYN-4748, SYN-4689, SYN-4667, SYN-3720
3.8. GitHub
Syndeia Cloud 3.6 SP1 includes the following improvements related to GitHub integration.
1/ A problem related to expansion of Issues in certain GitHub repositories was resolved.
Specific improvements: SYN-4770
2/ An issue related to expanding models (e.g. Simulink models) located under folders with spaces in names on a GitHub repository has been resolved.
Specific improvements: SYN-4169
3/ An issue related to expanding XML files managed in GitHub repositories was noted in the Syndeia Web Dashboard. This has been resolved.
Specific improvements: SYN-4826
3.9. GitLab
Syndeia Cloud 3.6 SP1 includes the following improvements related to GitLab integration.
1/ All Artifact Type endpoints in the SC GitLab integration API now include an additional query parameter includeAttributeDefinitions which is set to false by default. Only when set to true, will the artifact type endpoints return all attribute definitions for a given artifact type. This gives the choice to Syndeia API clients to control the size of the response payload, requesting attribute definitions only when needed for specific use cases.
GET …/types/artifact
GET ../types/artifact/{externalKey}
POST ../types/artifact/external/id
Specific improvements: SYN-4623
2/ The Intercax team found and reported an issue related to the pagination of tags in GitLab projects to the GitLab team. Read details here. The GitLab team resolved the issue and deployed the fix to GitLab.com and made it available in GitLab release 17.3. Due to this issue, Syndeia users would notice the cloud icon (for pagination) on the Syndeia Web Dashboard when browsing tags in a GitLab repository even though there are no additional pages to fetch. With the resolution done by the GitLab team, Syndeia users working with GitLab.com or using Gitlab release 17.3 will no longer face this issue.
Specific improvements: SYN-4439 (Intercax), Issue 471566 (GitLab)
3.10. Jama Connect
Syndeia Cloud 3.6 SP1 includes the following improvements related to Jama integration.
1/ The icon for Jama Connect repositories has not been updated. Thanks to the Jama Software team for providing the new icon. Syndeia users will notice the new icon on the Syndeia Web Dashboard and Client Dashboards (Cameo/Rhapsody plugin and Standalone).
Specific improvements: SYN-4749, SYN-4782
2/ An issue was found with the native Jama API related to OAuth authentication response. Read details here. As a result of this change, OAuth authentication requests to Jama by Syndeia Cloud were affected. This issue has now been resolved after the Jama Software team confirmed the change.
Specific improvements: SYN-4690
3.11. Jira
Syndeia Cloud 3.6 SP1 includes the following improvements related to Jira integration.
1/ An issue was noted with digital thread exploration of Jira issues linked to Zephyr Scale test artifacts on older versions of Jira servers (on-prem) where accountId field for Jira issue assignee and reporters is absent. This issue has been resolved and digital thread exploration between Jira issues and Zephyr scale test artifacts is restored with the resolution.
Specific improvements: SYN-4838
2/ An issue related to Jira reports for Digital Thread Projects was found in which the JQL query sent to Jira for fetching the latest status of issues was not filtering out a specific type of Zephyr Scale test artifacts. This issue has been resolved. This only affected Digital Thread Projects with relations to both Jira issues and Zephyr Scale test artifacts.
Specific improvements: SYN-4568, SYN-4773
3/ An issue related to the sync of SysML element properties/tags → Jira issue attributes was found wherein Jira attributes (e.g. priority) were failing to update when using basic authentication (username/password) with Jira. This issue did not affect OAuth-based authentication. The issue has been resolved.
Specific improvements: IHD-4404, SYN-4696, SYN-4588
4/ An issue related to the compare/sync of SysML elements and Jira issues was noted if the Jira issue has been deleted. An exception was being thrown for certain variants of this scenario instead of a message. This issue has been resolved.
Specific improvements: IHD-2637, SYN-2889
5/ An issue related to the sync of new sub-tasks from Jira → SysML was noted wherein the SysML element corresponding to the new Jira sub-task was successfully created but Syndeia client was attempting to add a duplicate relation which was rightfully being rejected by Syndeia Cloud. This issue has been fixed in the Syndeia client.
Specific improvements: SYN-4553
3.12. MySQL
Syndeia Cloud 3.6 SP1 includes the following improvements related to MySQL integration.
1/ An issue related to the sync of SysML elements in Rhapsody → MySQL table rows was noted in the case when the value properties on a block are not typed by a ValueType. This issue has been resolved.
Specific improvements: SYN-2705
3.13. Simulink Requirements
Syndeia Cloud 3.6 SP1 includes the following improvements related to Simulink Requirements integration.
1/ A clarification was added in the SysML → Simulink requirements sync tutorial document (Exercise 10.8, 1a1 - Step 9). When a Simulink requirement model is already open in the Requirements Editor and a user performs a sync from SysML → Simulink requirements, the Requirements Editor must be closed and reopened for the changes to be visible. This is the behavior of Simulink Requirements Editor.
Specific improvements: IHD-4152, SYN-4607
3.14. RESTful Integration
Syndeia Cloud 3.6 SP1 includes the following improvements related to the Generic RESTful integration.
1/ An issue was noted with Content-Type header value being passed by Syndeia to a RESTful repository. The Content-Type header value is generally derived from the type of payload (e.g. Text, JSON) in the body of the request but if a user explicitly provides the Content-Type header with a RESTful request, it should take precedence. This was not happening, and has now been resolved.
Specific improvements: IHD-3459, SYN-4762
2/ An issue was noted where header values sent by an API client to Syndeia Cloud RESTful integration service were overriding the header values specified for a RESTful request for all authentication types (e.g. Basic Auth, Bearer Auth, API Keys, and Dynamic Auth). This issue has been resolved.
Specific improvements: IHD-3459, SYN-4731
3/ Users can optionally specify a name for the artifact returned in response to a RESTful request. However, this field was considered to be mandatory in the RESTful integration API. This issue has been resolved. RESTfulRequestCreate.responseName is no longer a mandatory field.
Specific improvements: SYN-4630
3.15/ Teamcenter Integration
Syndeia Cloud 3.6 SP1 includes the following improvements related to the Teamcenter integration.
1/ Documentation related to gathering Teamcenter library (jar files) for all supported versions of Teamcenter was significantly improved.
Single page with simplified instructions for collecting Teamcenter library from one location: Appendix G2a - Gather Teamcenter library (jar files)
Using the Teamcenter library in Syndeia Cloud: Appendix G2 - Configuring Teamcenter
Using the Teamcenter library in Syndeia Cameo Plugin: Using Syndeia with Teamcenter
Using the Teamcenter library in Syndeia Rhapsody Plugin: Using Syndeia with Teamcenter.
Specific improvements: SYN-4860
2/ An issue was noted with the Teamcenter integration where relations created from/to Teamcenter artifacts via Syndeia Client in Syndeia 3.5 and earlier were not showing up for the same artifacts on Syndeia Web Dashboard in 3.6. Note that Teamcenter integration was introduced on Syndeia Cloud and Web Dashboard in 3.6. This issue has now been resolved.
Specific improvements: SYN-4853
3/ A related issue (to the above) was noted where creation of relations to Teamcenter artifacts in 3.6 was causing issues if the same Teamcenter artifacts were participating in relations created in Syndeia 3.5 or earlier. This issue has been resolved.
Specific improvements: SYN-4799, SYN-4777
4/ An issue was noted with the direction of the arrows in the Intra-model relation table when a BOM View Revision artifact was selected on the Syndeia Web Dashboard. The arrows indicate the parent → child relation in the BOM tree. This issue has now been resolved.
Specific improvements: SYN-4627
5/ In the Digital Thread Explorer of the Syndeia Web Dashboard, an issue was noted when expanding Teamcenter artifacts and fetching intra-model (within Teamcenter) relations if the navigation starts from a non-Teamcenter artifact. This issue has been resolved.
Specific improvements: SYN-4580, SYN-4834, SYN-4828
3.16/ Teamwork Cloud Integration
1/ An issue was noted in the signOut endpoint of the Syndeia Teamwork Cloud Integration API wherein the existing session for a given user was not being closed correctly, resulting to problems downstream. This issue has now been resolved.
Specific improvements: IHD-3417, SYN-3707, SYN-3044
3.17/ TestRail Integration
1/ The following endpoints in the Syndeia TestRail Integration API were returning incorrect HTTP status codes for exception scenarios. This issue has been resolved.
GET artifacts or artifact types by external key - Status code 500 was being returned instead of 404 (Not Found).
POST (get) artifacts or artifact types by external id - Status code 500 was being returned instead of 404 (Not Found).
POST/PUT to create/update artifacts - Status code 500. was being returned instead of 400 (Bad Request).
Specific improvements: SYN-4661
3.18/ VOLTA Integration
1/ An issue was noted with expanding VOLTA projects where the metadata field was populated. This issue has been resolved.
Specific improvements: IHD-4285, SYN-4666
3.19/ Windchill Integration
1/ An issue was noted with container search in Windchill. This has been resolved.
Specific improvements: SYN-4691
4. Syndeia Client Dashboard Improvements
The following improvements were done on the Syndeia Client Dashboard, available via Syndeia Cameo / Rhapsody plugins and Syndeia Standalone.
1/ The user flow for managing RESTful repositories when using Dynamic authentication is significantly improved in the Syndeia Client Dashboard, and works at par with the Syndeia Web Dashboard.
Specific improvements: SYN-4427, SYN-4426
2/ An issue was noted with loading certain repositories in the Syndeia Client Dashboard when a user switches from Cloud mode to Local mode. This has been resolved.
Specific improvements: SYN-4693, SYN-4592
3/ An issue was noted with the progress bar when launching the Syndeia Client Dashboard on Mac OS X. This has been resolved.
Specific improvements: SYN-4655
4/ An issue was noted with the right-click menu for cloning a Mapping in the Mappings tab of the Syndeia Client Dashboard. This issue was resolved.
Specific improvements: SYN-4594, SYN-4556
5/ Many integrations on Syndeia Client are available via Syndeia Cloud. The Integration Compatibility page here Syndeia 3.6 - Integration Compatibility includes the “Requires Syndeia Cloud” phrase for each such integration. The notification for informing users about this requirement has been improved. If Syndeia Client is being used in Local Mode (perhaps for evaluation purposes), then users will see the following warning when attempting to add a repository whose integration requires Syndeia Cloud.
Specific improvements: SYN-4561
6/ Due to incompatible changes in the Cameo API between 19.0 and 2021x R2, we provide two different installations of Syndeia Plugin for Cameo - one for 19.x and another for 2021 R2 and above. However, some users would mix the Cameo version and the corresponding Syndeia Cameo plugin version. An improvement is added where incompatible combinations of Syndeia Cameo Plugin version and Cameo version will prevent users from installing Syndeia, and they will see a notification message as below.
Specific improvements: SYN-4739
5. Other Improvements
In addition to the specific improvements listed above, Syndeia 3.6 SP1 includes significant improvements related to the following.
Syndeia Documentation (this site)
Syndeia Cloud REST API Documentation - Swagger doc
Syndeia Cloud Deployment
Syndeia Web Dashboard usability