Introduction
The release notes provide a high-level overview of the new features, fixed issues, known issues, and prerequisites for HaloCAD for PLM. Before installing HaloCAD for PLM, review these release notes to understand the changes, known limitations, and requirements that apply to this release.
Product Description
HaloCAD for PLM integrates with supported Product Lifecycle Management (PLM) applications and Microsoft Purview Information Protection (MPIP) to protect CAD files throughout their lifecycle. It automatically applies MPIP sensitivity labels based on predefined rules during download and removes protection during upload, returning the unprotected file to the PLM vault. This provides seamless file handling, end-to-end security, and complete traceability.
Prerequisites
Before installing HaloCAD for PLM, ensure that the following prerequisites are met:
-
An active Microsoft 365 subscription is available.
-
A Web application is registered with Microsoft Entra ID.
-
Access to the required Microsoft service URLs is enabled.
-
TLS 1.2 or later is enabled on all client workstations.
For detailed prerequisite and configuration information, refer to the Technical Reference Manual.
System Requirements
The following table lists the system requirements for installing and running HaloCAD for Windchill.
|
Components |
Details |
|---|---|
|
Supported Operating Systems |
Windows Server 2022 and above with updates installed. |
|
Supported file types |
|
|
Other requirements |
Install HaloENGINE GenNXT and HaloCAD for Windchill separately on Windows servers. |
Requirements
Supported PLM software for HaloCAD for Windchill
HaloCAD for Windchill 3.0 is the first version to use HaloENGINE GenNXT. Versions earlier than 3.0 use the legacy HaloENGINE platform. For release information about these earlier versions, refer to the corresponding HaloCAD for Windchill Release Notes.
|
Windchill PLM Software |
HaloCAD Component Version |
|---|---|
|
3.0 |
PLM software and HaloCAD component version
Code Quality and Security
Secude focuses on software quality and security. This is accomplished by adhering to and exceeding best practices in development, testing, and quality control. Secude has chosen SonarQube as the first building block for building and implementing a robust continuous code quality assurance (QA). SonarQube is a platform for static code analysis for continuous inspection of code quality. It performs automatic reviews of code to detect bugs, code smells, unit test coverage, and security issues in 29 programming languages.
SonarQube is utilized throughout the development process at Secude, and only the highest marks are accepted for a product to be released. It helps to regulate code quality from the beginning of development, find and repair issues promptly, and improve overall software stability.
Each build report can be found under its relevant version heading in this release notes.
Reliability Rating
-
A = 0 Bugs
-
B = at least 1 Minor Bug
-
C = at least 1 Major Bug
-
D = at least 1 Critical Bug
-
E = at least 1 Blocker Bug
Security Rating
-
A = 0 Vulnerabilities
-
B = at least 1 Minor Vulnerability
-
C = at least 1 Major Vulnerability
-
D = at least 1 Critical Vulnerability
-
E = at least 1 Blocker Vulnerability
Security Review Rating
The Security Review Rating is a letter grade based on the percentage of Reviewed (Fixed or Safe) Security Hotspots.
-
A = >= 80%
-
B = >= 70% and <80%
-
C = >= 50% and <70%
-
D = >= 30% and <50%
-
E = < 30%
Maintainability Rating
A=0-0.05, B=0.06-0.1, C=0.11-0.20, D=0.21-0.5, E=0.51-1
The Maintainability Rating scale can be alternatively stated by saying that if the outstanding remediation cost is:
-
<=5% of the time that has already gone into the application, the rating is A
-
Between 6 to 10%, the rating is a B
-
Between 11 to 20%, the rating is a C
-
Between 21 to 50%, the rating is a D
-
Anything over 50% is an E
Build 3.0
This chapter provides an overview of the updates and quality insights included in this release. It covers the fixed issues, improvements, limitations, new features, and known issues, along with a summary of SonarQube’s key parameters to highlight code quality metrics and analysis results.
Improvements
This section lists improvements added to the current release.
-
Starting with this release, HaloCAD for Windchill supports integration with HaloENGINE GenNXT and its features, replacing the legacy HaloENGINE integration. HCADWCL-753
-
Removed the System ID field and renamed Customer ID to Profile Name in the HaloCAD for Windchill Configuration tool.
-
HaloENGINE GenNXT communicates over HTTPS and supports self-signed and CA-signed certificates. Clients connecting to HaloENGINE GenNXT must install the appropriate certificate in Trusted Root Certification Authorities:
-
For a self-signed certificate, install the public key.
-
For a CA-signed certificate, install the Root CA.
-
-
Removed the Certificate Name and Password fields from the Configuration Tool. HCADWCL-811
Limitations
This section lists the limitations of the current release.
-
An authorization error occurs while downloading a file configured with a security label in Windchill. HCADWCL-149
-
Multiple log entries get updated for a single file download if no action rule is configured and the Fail-safe mode is Strict. HCADWCL-216
-
It is not possible to retrieve the
User_Roleif the Site Administrator logs into Creo. Hence, the User_Role is not logged in the audit log while the file is downloaded/uploaded. However, if the Site Administrator logs in via the browser, the user roles are fetched properly. HCADWCL-240 -
Protecting a new file based on metadata
SYSTEM_CONTEXTis not possible until the background scheduler revaulting process in the Windchill Server is completed, as configured by the site administrator. Once the scheduler is invoked, the file gets protected, and you can see the details of it in the audit log. However, this limitation does not occur in already uploaded files. HCADWCL-283 -
When downloading files from the Replica Server, the following metadata, such as
Product_Name,Library_Name, andProject_Namedo not work; instead,System_Contextmetadata is utilized to protect the files. Please note that only the Main Server supports the metadataProduct_Name,Library_Name, andProject_Name. HCADWCL-422, HCADWCL-412 -
The metadata
Workspace_namedoes not function while downloading files from the Replica Server. -
When you switch to a different language, such as Chinese or German, the
project_name,library_name,product_name,workspace_name, andsystem_contextentries in the Method Server log will show incorrect values. HCADWCL-504 -
Non-office or non-CAD files downloaded from the Windchill Workspace/Windchill browser will be protected according to the HaloENGINE GenNXT rules, but their extension will not be changed to
.ptxtor.pfile. For instance, theText.txtandImage.jpgfile extensions stay the same even after protection. This is expected behavior. HCADWCL-84, HCADWCL-86
Fixed Issues
This section provides a list of the fixed issues in the current release.
-
Fixed an issue where the Monitor log was not updated in the secondary HaloENGINE GenNXT when the primary HaloENGINE GenNXT was down. HCADWCL-673
-
Fixed an issue where a file was downloaded and opened without protection in Creo after the HaloENGINE GenNXT service was stopped, even when Fail-Safe Mode was configured as Strict in the Windchill master. HCADWCL-718
-
Fixed an issue where files were not encrypted for duplicate requests in Creo, causing the export operation to fail. HCADWCL-794
-
Fixed an issue where protected image files (GIF, TIF, TIFF, JPEG, JPG, and PNG) could not be uploaded to Windchill Commonspace because of a decryption error. HCADWCL-766
-
Fixed an issue where the Before Size and After Size values were identical in the HaloENGINE GenNXT Monitor log when uploading or downloading files to or from a Windchill workspace with encryption or decryption. HCADWCL-790
-
Fixed an issue where an upload failed, and a protected ASM file with a dependent PRT file could not be checked in when connected to a replica server. HCADWCL-797
-
Fixed an issue where an already protected ASM file with dependent files could not be checked in to Windchill when using the Import to Workspace option. HCADWCL-800
-
Fixed an issue where the Before Size was updated correctly, but the After Size was displayed as
0in the Monitor log when uploading an unprotected file to a Windchill workspace. HCADWCL-809 -
Fixed an issue where multiple Monitor log entries were created for a single downloaded file when the action rule was configured as Block, and duplicate entries were created for a single file upload or download when the action rule was configured as Label. HCADWCL-810
-
Fixed an issue where the file path value was intermittently not updated in the HaloENGINE GenNXT Monitor log. HCADWCL-815
Known Issues
This section describes the known issues with the current release.
-
When an error occurs while uploading the files into Windchill, the audit log file gets updated with improper field values for fname and file type. HCADWCL-163
-
If a text file is downloaded, the file gets protected as per the rule configured in HaloENGINE GenNXT, but the extension is saved in native format (i.e.,
.txt) instead.ptxt. HCADWCL-151 -
The field value
dusergets updated as "null" while uploading a file to the Windchill workspace. HCADWCL-250 -
The audit log updates file downloads only when files are downloaded multiple times using the Export from Workspace option. HCADWCL-252
-
When an assembly file with a sub-assembly file and a dependent part file is downloaded via the Export from Workspace option, there will be a log entry only for sub-assembly and dependent part files, excluding the main assembly file. HCADWCL-255
-
When an assembly file with a dependent part file is downloaded via the Export from Workspace option, there will be a log entry for the assembly and dependent part files. HCADWCL-256
-
The incorrect value gets updated in
HaloENGINE_Monitor.logfile forfnameandfile typefields while uploading a large assembly file. HCADWCL-257 -
When you download a top-level ASM file using the Open in Creo option, the label on the top-level file is applied uniformly to all its dependent files. This is the expected behavior. However, if you export the top-level ASM file directly from the Export from Windchill option, the downloaded top-level file and its dependent files will be asymmetric. For example, if an action rule is defined for DRW and PRT file-dependent files, the exported DRW and PRT files are assigned the label specified in the rule engine rather than the label of the top-level file. HCADWCL-512
-
A file is blocked if the HaloENGINE GenNXT block action is configured correctly. However, an incorrect message will appear as 'This site can't be reached', and then immediately redirect to the Windchill Error page with the incorrect message. HCADWCL-664
-
If the Save Structure/Save Representation option is used when downloading a file, the file will be blocked. However, an incorrect message, such as 'This site can't be reached' will appear. HCADWCL-659
-
The log is updated twice in the Method Server log during Windchill startup. HCADWCL-674
-
The connected Windchill user is set as the owner during file download when the owner is configured as a service. HCADWCL-745
-
Files are not blocked and open as unprotected when the action rule is configured as Block for the
server_namemetadata. HCADWCL-817
Quality Gate Report
Please see the table below for a list of SonarQube's key parameters for this version. Refer to the "Code Quality and Security" section for more information on rating definitions.
|
Metric |
Value |
|---|---|
|
Coverage |
80.6% |
|
Maintainability Rating |
A* |
|
Reliability Rating |
A* |
|
Security Hotspots Reviewed |
A* |
|
Security Rating |
A* |
Quality Gate Report