Syndeia 3.4 SP1 - Improvements

Owned by Manas Bajaj
Last updated: Oct 15, 2021

In this section, availability, downloads, and the list of improvements in Syndeia 3.4 Service Pack 1 (SP1) are presented.

Availability

  1. Syndeia 3.4 SP1 is available for download starting Oct 15, 2021.

  2. Syndeia 3.4 SP1 includes:

    1. Syndeia Cloud 3.4 SP1, including Syndeia Web Dashboard

    2. Syndeia Cloud REST API 3.4 SP1

    3. Syndeia local clients 3.4 SP1

      1. Syndeia MagicDraw/Cameo plugin

      2. Syndeia Rhapsody plugin

      3. Syndeia Standalone

Downloads and Installation

  1. Existing Syndeia users with an active subscription can request downloads for Syndeia 3.4 SP1 by opening a request on our helpdesk.

  2. For Syndeia local clients, follow the instructions under the Installation sections.

    1. MagicDraw/Cameo plugin - https://intercax.atlassian.net/wiki/spaces/SYN34/pages/2407361761

    2. Rhapsody plugin - https://intercax.atlassian.net/wiki/spaces/SYN34/pages/2409176948

    3. Standalone - https://intercax.atlassian.net/wiki/spaces/SYN34/pages/2409189178

  3. For Syndeia Cloud, follow the instructions here.

    1. New users, who are downloading Syndeia for the first time, should directly get started with Syndeia Cloud 3.4 SP1.

    2. Users working with Syndeia Cloud 3.4 can upgrade to 3.4 SP1.

    3. Users working with Syndeia Cloud 3.3 can directly migrate to Syndeia Cloud 3.4 SP1.

Improvements

1. Syndeia Cloud REST API

Syndeia Cloud 3.4 SP1 includes several updates to the OpenAPI specification for the REST API, as workarounds for polymorphism limitations in OpenAPI Generator. This includes updates for referenced objects, such as type and external/internal identities, in the artifact and container response JSON, and updates to the response from the graph query endpoint. The OpenAPI specification is used for generating Python and Scala/Java clients for Syndeia Cloud REST API. Existing users of Syndeia Cloud API clients, especially the Python conda package, will greatly benefit from these updates.

Issues resolved: SYN-2217, SYN-2225, SYN-2276, SYN-2316, SYN-2353

2. Connection Generator documentation and support for Zephyr Scala (TM4J)

Connection Generator provides the ability to auto-generate connections (inter-model relationships) between existing elements based on attribute filters and criteria defined for source and target artifacts, e.g. bulk generation of connections between SysML requirements and Jira issues where custom tags in SysML requirements have values that match specific Jira issue fields (e.g. key). The Connection Generator capability was made available as an experimental feature in Syndeia 3.4 for Jira and Jama. Step-by-step tutorials for this feature are now available in Syndeia 3.4 SP1 release. Additionally, Zephyr Scale (formerly TM4J) is now supported in the Connection Generator capability. To learn more, refer to the links below.

  • Connection Generator for Syndeia MagicDraw plugin -

  • Connection Generator for Syndeia Rhapsody plugin -

Issues resolved: SYN-1709, SYN-2235, SYN-2278

3. Improvements to GitHub, TestRail, and Artifactory integrations in Syndeia Cloud

Syndeia Cloud 3.4 SP1 includes bug fixes and improvements when formulating artifact, artifact type, container, and container type URLs in Syndeia Cloud API for GitHub, TestRail, and Artifactory integrations. This is especially applicable to on-premise or virtual private cloud deployments of these repositories with custom URLs.

Issues resolved: SYN-2301, SYN-2333

4. Filtering relations by types and improvements to search endpoints in Syndeia Cloud Windchill API

Syndeia Cloud 3.4 SP1 includes the following bug fixes and improvements to the Windchill integration endpoints in the Syndeia Cloud REST API.

  • GET Relations endpoint /external/windchill/{repoKey}/relations, now includes type.externalKey query parameter that can be populated with UsageLink or OccurrenceLink to get only usage links or occurrence links for a part. If the query parameter is not populated, the response will include both usage and occurrence links for a part.

  • Artifact and Container search endpoints, e.g. /external/windchill/{repoKey}/artifacts/search, will now return a sequence of artifacts/containers instead of a single object.

  • Artifact and Container by external id endpoints, e.g. /external/windchill/{repoKey}/artifacts/external/id, will now return a single artifact/container instead of a sequence.

Issues resolved: SYN-2331

5. Improved support for Jira and Jama fields for model transformations, compare, and sync

Syndeia 3.4 SP1 includes improved support for single and multi-valued fields, both standard and custom (user-defined), that are enumerations or selections of pre-defined values. In addition, for Jira, there is improved support for date/time, numeric, URL, and user field types. Similarly, for Jama, there is improved support for multi-valued pick lists, Release, and Rollup/Calculated, and Item Type fields. Model transformation, compare, and sync operations will be able to populate, compare, and update a broader range of standard and user-defined fields in both Jira and Jama.

6. Improved error messages when using repository integrations that require Syndeia Cloud

Starting with Syndeia 3.4, our goal has been to build all new integrations on Syndeia Cloud (server) and make them available via the Syndeia Cloud REST API for automation. New integrations added in Syndeia 3.4 - Aras, Bitbucket, Confluence, GitLab, Teamwork Cloud - require Syndeia Cloud. Users can access these repositories from Syndeia local clients, e.g. MagicDraw and Rhapsody, but require Syndeia Cloud backend. In Syndeia 3.4 SP1, we have improved the error messaging and notification for scenarios when users try to access these repositories using Syndeia local clients but don't have access to Syndeia Cloud (server).

Issues resolved: SYN-2292, SYN-2298

7. Improvements in DOORS NG integration

Syndeia 3.4 SP1 includes several updates to DOORS NG integration.

  • Syndeia Web Dashboard and Syndeia Cloud REST API

    • SYN-2143 / IHD-1729 / IHD-1780 - Users will now be able to paginate through large sets of artifacts (e.g. requirements) under DOORS NG modules, collections, and folders.

    • SYN-2302 / IHD-1738 - Users will now be able to view the hierarchical structure of requirements in the context of a module.

  • Syndeia local clients (MagicDraw/Rhapsody plugins)

    • SYN-2324 / IHD-1811 / IHD-1840 - Users will now be able to transform the hierarchical module structure between SysML and DOORS NG when using custom (user-defined) mappings. This was already supported with default mappings but has been extended for custom mappings.

    • SYN-2291 (IHD-1715) - Users will now be able to work with enumerated values in DOORS NG artifact fields during model transformation, compare, and sync operations.

    • SYN-2282 (IHD-1751) - Users will now be able to view and recursively expand modules at the root level of a project. This was already supported for modules in a folder.

These updates apply to both Configuration Managed (CM) enabled and non CM enabled projects on DOORS NG.

Issues resolved: Listed above with each improvement.

8. Others

In addition to the improvements listed above, Syndeia 3.4 SP1 includes several minor improvements, bug fixes, documentation updates, and improved error handling in Syndeia Web Dashboard and local clients, as well as in the installation and configuration of Syndeia Cloud (server).