This section contains supplementary information.
Classification Rule Use Cases
The following use cases illustrate how you can configure classification rules to block or protect files based on file type, server, project, or user. You can also use other metadata in classification rules based on your business requirements. These examples also demonstrate how multiple conditions and Pre-Expressions can be combined to meet specific business requirements.
|
Use Case |
Classification Rule |
Action |
Result |
|---|---|---|---|
|
Block PDF files |
|
Block |
When the file type matches |
|
Protect files from a specific server |
|
Label: |
When the server name matches |
|
Protect a specific file type except for a specific user |
|
Label: |
When the file type is |
|
Protect project files except for a group of users |
Note: |
Label: |
When the project name is |
|
Protect final documents except for documents from specific workspaces |
Note: |
Label: |
When the lifecycle state is |
Sample Logs
The following sample logs illustrate the information recorded for Block, Label, and Exclude events.
Sample log
Reset Administrator Password
HaloENGINE GenNXT lets you change or reset your password. You can change the password when you know the current password. If you have forgotten the current password, you could reset (create a new) password using the tool.
Use the following procedure to reset, update, or change your administrator password.
-
Copy
haloengine-password-config-<version>.zipfile to the desktop and extract it. -
Open Command Prompt with administrator rights and change directory to
haloengine-password-config-<version>\bin. -
Type
haloengine-password-config.bat -hto display the help information.
For example:
haloengine-password-config.bat -confPath <Full path of HaloENGINE config directory> -newPwd <new password for the login>
haloengine-password-config.bat -confPath "C:\Program Files\Secude\HaloENGINE\config" -newPwd TestHalo!2345
Metadata Definition
The following section provides a table of built-in metadata for PLM and PDM clients.
Windchill
The table below lists the Windchill metadata available in the HaloENGINE GenNXT.
|
Windchill metadata |
Use |
|---|---|
|
server_name |
Derivation from the server name (FQDN of the Windchill server). (For example, |
|
user_name |
Derivation from the logged-in Windchill user. (For example, John and Derek) |
|
file_name |
Derivation from the file name. |
|
project_name |
Derivation from the project name. (For example, Windchill) |
|
product_name |
Derivation from the product name (For example, Windchill). |
|
lifecycle_template |
Derivation from the lifecycle of a file. Lifecycle provides an overview of how business items develop and serves as a model for the commercialization process. The lifecycle templates may be of the following types: Approval, Basic, Default, and so on. (For example, |
|
user_role |
Derivation from the user role. (For example, Designer and Engineer) |
|
lifecycle_state |
Derivation from the lifecycle of a file. Each phase of a lifecycle template is associated with a lifecycle state. There are different kinds of lifecycle states.
(For example, |
|
security_label |
Derivation from the Windchill access control policy. For more details, please refer to the online PTC Windchill documentation. (For example, Export Control, Corporate Proprietary, and Third Party Proprietary) |
|
file_type |
Derivation from the file type (Creo file types and MS Office native file types). (For example, sec, prt, asm, xlsx) |
|
library_name |
Derivation from the library name. (For example, Density, Wheel, and Pipeline) |
|
workspace_name |
Derivation from workspace. (For example, Generic_computer and Drive System) |
|
system_context |
Derivation from the origin of the data. (For example, Generic_computer, and Drive System) |
|
preexpression_custom_pre-expression |
Derivation from custom pre-expression.
|
Windchill metadata
Teamcenter
The table below lists the Teamcenter metadata available in the HaloENGINE GenNXT.
|
Teamcenter metadata |
Use |
|---|---|
|
user_role |
Derivation from the user role. Multiple roles may be assigned to a single user. (For example, Designer and Engineer) |
|
user_def_group |
Derivation from a group of users who log in. (For example, a user from the Engineering group) |
|
gov_clearance |
Derivation from a specific object based on value or licensing value. (For example, secret - single value field) |
|
ip_clearance |
Derivation from intellectual property (IP) classification values and clearance levels assigned to data objects and users for IP access evaluation. (For example, super-secret - single value field) |
|
user_name |
Derivation from Teamcenter logged-in users. (For example, John and Derek) |
|
file_type |
Derivation from file type and Teamcenter object data. (NX file types and MS Office native file types) (For example, prt, asm, and XLSX) |
|
gov_classification |
Derivation from a Teamcenter object based on its value or license value. (For example, secret - single value field) |
|
obj_project_names |
Derivation from Teamcenter object data. The object could be used in several projects. (For example, project1; project2- multi-value- field) |
|
ip_classification |
Derivation from Teamcenter's intellectual property (IP). (For example, secret, internal, and confidential - single value field) |
|
preexpression_custom_pre-expression |
Derivation from custom pre-expression.
|
Teamcenter metadata
Autodesk Vault
The table below lists the Autodesk Vault metadata available in the HaloENGINE GenNXT.
|
Autodesk Vault Metadata |
Use |
|---|---|
|
lifecycle_state |
Derivation from the lifecycle of Autodesk Vault data. (For example, work-in-progress, review, and released) |
|
file_type |
Derivation from file type. File types of AutoCAD, Inventor, and MS Office native file types. (For example, |
|
folder_name |
Derivation from the folder name in the Autodesk Vault server. (For example, |
|
preexpression_custom_pre-expression |
Derivation from custom pre-expression.
|
Autodesk Vault metadata
SOLIDWORKS PDM
The table below lists the SOLIDWORKS PDM metadata available in the HaloENGINE GenNXT.
|
SOLIDWORKS PDM Metadata |
Use |
|---|---|
|
author_name |
Derivation from the Web2 client interface Items author. |
|
domain_name |
Derivation from the network domain name associated with the current user. (For example, |
|
file_type |
Derivation from file type. File types of SOLIDWORKS. |
|
user_name |
Derivation from machine logged-on user. (For example, John and Derek) |
|
client_hostname |
Derivation from the computer where SOLIDWORKS PDM is installed. (For example, |
|
current_state |
Derivation from the file's status as set in SOLIDWORKS PDM. (For example, Approved and Waiting for approval) |
|
project_name |
The name of the project from which the saved file is derived. (For example, CMS Turbo Engine) |
|
ad_group |
Derivation from the domain groups. (For example, Domain Users and Superusers) |
|
folder_path |
Derivation from folder name in SOLIDWORKS PDM server. (For example, Please note that files cannot be encrypted if the folder name ( |
|
preexpression_custom_pre-expression |
Derivation from custom pre-expression
|
SOLIDWORKS PDM metadata
Third-Party Libraries
Third-party software/code is included or bundled with Secude's products according to its appropriate license. Secude tests third-party products to ensure they are compatible with, and perform as intended in, Secude applications.
The third-party libraries and dependencies used by HaloENGINE GenNXT are shown in the table below.
|
Library names |
Version |
Source Code URLs |
License Links |
Library names |
|
org.eclipse.angus:angus-activation |
2.0.2 |
EDL 1.0 |
||
|
org.antlr:antlr4-runtime |
4.13.0 |
BSD-3-Clause |
||
|
org.aspectj:aspectjweaver |
1.9.22.1 |
Eclipse Public License - v 2.0 |
||
|
org.attoparser:attoparser |
2.0.7.RELEASE |
The Apache Software License, Version 2.0 |
||
|
net.bytebuddy:byte-buddy |
1.14.19 |
Apache License, Version 2.0 |
||
|
com.fasterxml:classmate |
1.7.0 |
Apache License, Version 2.0 |
||
|
commons-codec:commons-codec |
1.16.1 |
Apache-2.0 |
||
|
org.apache.commons:commons-collections4 |
4.4 |
Apache License, Version 2.0 |
||
|
org.apache.commons:commons-compress |
1.25.0 |
Apache-2.0 |
||
|
commons-io:commons-io |
2.21.0 |
https://mvnrepository.com/artifact/commons-io/commons-io/2.21.0 |
Apache-2.0 |
|
|
org.apache.commons:commons-math3 |
3.6.1 |
Apache 2.0 |
||
|
com.github.virtuald:curvesapi |
1.08 |
BSD License |
||
|
org.hdrhistogram:HdrHistogram |
2.2.2 |
https://github.com/HdrHistogram/HdrHistogram |
BSD 2-Clause |
https://github.com/HdrHistogram/HdrHistogram/blob/master/LICENSE.txt |
|
org.hibernate.common:hibernate-commons-annotations |
6.0.6.Final |
GNU Library General Public License v2.1 or later |
||
|
org.hibernate:hibernate-community-dialects |
6.6.4.Final |
GNU Library General Public License v2.1 or later |
||
|
org.hibernate.orm:hibernate-core |
6.5.3.Final |
GNU Library General Public License v2.1 or later |
||
|
org.hibernate:hibernate-validator |
8.0.1.Final |
Apache License 2.0 |
||
|
com.zaxxer:HikariCP |
5.1.0 |
Apache 2.0 |
||
|
com.sun.istack:istack-commons-runtime |
4.1.2 |
Eclipse v 1.0 |
||
|
com.fasterxml.jackson.core:jackson-annotations |
2.17.3 |
Apache 2.0 |
||
|
com.fasterxml.jackson.core:jackson-core |
2.17.3 |
Apache 2.0 |
||
|
com.fasterxml.jackson.core:jackson-databind |
2.17.3 |
Apache 2.0 |
||
|
com.fasterxml.jackson.datatype:jackson-datatype-jdk8 |
2.17.3 |
Apache 2.0 |
||
|
com.fasterxml.jackson.module:jackson-module-parameter-names |
2.17.3 |
Apache 2.0 |
||
|
jakarta.activation:jakarta.activation-api |
2.1.3 |
EDL 1.0 |
||
|
jakarta.inject:jakarta.inject-api |
2.0.1 |
https://github.com/eclipse-ee4j/injection-api |
Apache 2.0 |
|
|
jakarta.persistence:jakarta.persistence-api |
3.1.0 |
https://github.com/jakartaee/persistence |
EPL 2.0 / BSD 3 (EDL 1.0) |
|
|
jakarta.transaction:jakarta.transaction-api |
2.0.1 |
https://github.com/eclipse-ee4j/jta-api |
EPL 2.0 / GPL 2.0 |
|
|
jakarta.validation:jakarta.validation-api |
3.0.2 |
Apache 2.0 |
||
|
jakarta.xml.bind:jakarta.xml.bind-api |
4.0.2 |
Eclipse v 1.0 |
||
|
org.jboss:jandex |
3.1.2 |
https://github.com/jboss/jboss-parent-pom |
Public Domain |
|
|
com.sun.xml.bind:jaxb-core |
4.0.5 |
Eclipse v 1.0 |
||
|
org.glassfish.jaxb:jaxb-runtime |
4.0.5 |
Eclipse v 1.0 |
||
|
org.jboss.logging:jboss-logging |
3.5.3.Final |
Apache License 2.0 |
||
|
io.jsonwebtoken:jjwt-api |
0.12.6 |
Apache 2.0 |
||
|
io.jsonwebtoken:jjwt-impl |
0.12.6 |
Apache 2.0 |
||
|
io.jsonwebtoken:jjwt-jackson |
0.12.6 |
Apache 2.0 |
||
|
net.java.dev.jna:jna |
5.13.0 |
Apache 2.0 / LGPL 2.1 |
https://github.com/java-native-access/jna/blob/master/LICENSE |
|
|
org.slf4j:jul-to-slf4j |
2.0.16 |
MIT License |
||
|
org.latencyutils:LatencyUtils |
2.0.3 |
Public Domain, per Creative Commons CC0 |
||
|
com.javax0.license3j:license3j |
3.3.0 |
Apache 2.0 |
||
|
org.apache.logging.log4j:log4j-api |
2.24.2 |
Apache-2.0 |
||
|
org.apache.logging.log4j:log4j-core |
2.25.3 |
Apache-2.0 |
||
|
org.apache.logging.log4j:log4j-to-slf4j |
2.23.1 |
Apache-2.0 |
||
|
ch.qos.logback:logback-classic |
1.5.12 |
EPL 1.0 / LGPL 2.1 |
||
|
ch.qos.logback:logback-core |
1.5.12 |
EPL 1.0 / LGPL 2.1 |
||
|
io.micrometer:micrometer-commons |
1.13.8 |
Apache 2.0 |
||
|
io.micrometer:micrometer-core |
1.13.8 |
Apache 2.0 |
||
|
io.micrometer:micrometer-jakarta9 |
1.13.8 |
Apache 2.0 |
||
|
io.micrometer:micrometer-observation-test |
1.13.8 |
Apache 2.0 |
||
|
com.microsoft.sqlserver:mssql-jdbc |
12.8.1.jre11 |
https://github.com/Microsoft/mssql-jdbc |
MIT License |
|
|
com.mysql:mysql-connector-j |
9.3.0 |
GPL 2.0 |
https://github.com/mysql/mysql-connector-j/blob/release/9.x/LICENSE |
|
|
org.apache.poi:poi |
5.2.5 |
https://github.com/AlfrescoArchive/poi |
Apache 2.0 |
|
|
org.apache.poi:poi-ooxml |
5.2.5 |
https://github.com/AlfrescoArchive/poi |
Apache 2.0 |
|
|
org.apache.poi:poi-ooxml-lite |
5.2.5 |
Apache 2.0 |
||
|
org.slf4j:slf4j-api |
2.0.16 |
MIT License |
||
|
org.yaml:snakeyaml |
2.2 |
https://github.com/yaml |
Apache 2.0 |
|
|
com.zaxxer:SparseBitSet |
1.3 |
Apache 2.0 |
||
|
org.springframework:spring-aop |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-core |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-beans |
6.1.15 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-actuator |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-actuator-autoconfigure |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-autoconfigure |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-devtools |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-actuator |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-aop |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-data-jpa |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-jdbc |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-json |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-logging |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-security |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-thymeleaf |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-validation |
3.3.6 |
Apache 2.0 |
||
|
org.springframework.boot:spring-boot-starter-web |
3.3.6 |
Apache 2.0 |
||
|
org.springframework:spring-context |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-core |
6.1.15 |
Apache 2.0 |
||
|
org.springframework.data:spring-data-commons |
3.3.6 |
https://github.com/spring-projects/spring-data-jpa |
Apache 2.0 |
|
|
org.springframework.data:spring-data-jpa |
3.3.6 |
https://github.com/spring-projects/spring-data-jpa |
Apache 2.0 |
|
|
org.springframework:spring-expression |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-jcl |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-jdbc |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-orm |
6.1.15 |
Apache 2.0 |
||
|
org.springframework.security:spring-security-config |
6.3.5 |
Apache 2.0 |
||
|
org.springframework.security:spring-security-core |
6.3.5 |
Apache 2.0 |
||
|
org.springframework.security:spring-security-crypto |
6.3.5 |
Apache 2.0 |
||
|
org.springframework.security:spring-security-web |
6.3.5 |
Apache 2.0 |
||
|
springframework:spring-tx |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-web |
6.1.15 |
Apache 2.0 |
||
|
org.springframework:spring-webmvc |
6.1.15 |
Apache 2.0 |
||
|
org.xerial:sqlite-jdbc |
3.47.1.0 |
Apache 2.0 |
https://github.com/xerial/sqlite-jdbc/blob/master/LICENSE |
|
|
org.thymeleaf:thymeleaf |
3.1.2.RELEASE |
Apache 2.0 |
||
|
org.thymeleaf.extras:thymeleaf-extras-springsecurity6 |
3.1.2.RELEASE |
https://github.com/thymeleaf/thymeleaf-extras-springsecurity |
Apache 2.0 |
|
|
org.thymeleaf:thymeleaf-spring6 |
3.1.2.RELEASE |
Apache 2.0 |
||
|
org.glassfish.jaxb:txw2 |
4.0.5 |
Apache 2.0 |
||
|
org.unbescape:unbescape |
1.1.6.RELEASE |
Apache 2.0 |
||
|
org.apache.xmlbeans:xmlbeans |
5.2.0 |
Apache 2.0 |
Third-party libraries
Uninstalling the HaloENGINE GenNXT
Before uninstalling, ensure that you export the current configuration. The exported configuration file can be imported during reinstallation to retain existing settings, reduce configuration effort, and minimize the risk of misconfigurations or errors.
When you no longer use the service, you may uninstall the application. Uninstalling removes all files and registry settings added to your computer during initial installation.
-
Click Start menu > go to Control Panel > Programs > Programs and Features > Uninstall a Program > select HaloENGINE GenNXT application from the list > right-click and select Uninstall option, or double-click on the installer
HaloENGINEGenNXT_Setup.exe. -
Depending on your Windows security settings, you may see a security warning asking, "Do you want to allow the following program to make changes to this computer?" If you get this security warning, click the Yes button to confirm that you want to uninstall the application.
-
The following confirmation message appears.
Uninstall message #1
-
Click Yes to confirm that you want to remove it from the computer.
-
The application is uninstalled successfully.
Uninstall message #2
-
Click OK to close the dialog.
Remove the Database Files Manually
Uninstallation does not automatically remove the database files from the configuration folder.
-
For MySQL and MSSQL, select the database created for HaloENGINE GenNXT, right-click it, and select Delete.
-
Manually delete all files from the following folder:
%HaloENGINE_HOME%\HaloENGINE\config.