HaloENGINE

Appendix


This section contains supplementary information.

Uninstalling the HaloENGINE

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.

Method #1 

When you no longer use the service, you may uninstall the application. Uninstalling removes all files and registry settings that were added to your computer during the initial installation.

  1. Click Start menu > go to Control Panel > Programs > Programs and Features Uninstall a Program > select HaloENGINE application from the list > right-click and select Uninstall option or double-click on the installer HaloENGINE_Setup.exe. 

  2. Depending on your Windows security settings, you may get a security warning as "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.

  3. The following confirmation message appears:

    Uninstall message #1.png

    Uninstall message #1

  4. Click Yes to confirm that you want to remove it from the computer. 

  5. You will be prompted to save a backup of the configuration files.

    Uninstall message #2.png

    Uninstall message #2

  6. Click Yes to save and continue with the uninstallation (The previous configuration files will be kept in the same location) or choose No to proceed with the uninstallation without saving.

    Uninstall message #3.png

    Uninstall message #3

  7. Click OK to close the message.  

Method #2 

The application can be removed using the command line, as illustrated in the sample below.

  1. Open a command prompt.

  2. Navigate to the application installer's directory.

  3. Use the following commands to uninstall:
    Example #1: uninstall and keep the configuration files
    HaloENGINE_Setup.exe -uninstall -keepconfig true
    Example #2: uninstall and delete the configuration files
    HaloENGINE_Setup.exe -uninstall -keepconfig false

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.

Windchill metadata

Use

server_name

Derivation from server name (FQDN of the Windchill server).

(For example, svin0007.secude.local)

user_name

Derivation from Windchill logged-in users.

(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 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, Pipeline.prt - Default)

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.

  1. Approval (template): In work, under review, approved (states)

  2. Basic (template): Basic: In work, released, canceled (states)

  3. Default (template): Default: In work, under review, released (states)

(For example, Pipeline.prt- Default-released)

security_label

Derivation from 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 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.

  1. Yes

  2. No

Windchill metadata

Teamcenter


The table below lists the Teamcenter metadata available in the HaloENGINE.

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.

  1. Yes

  2. No

Teamcenter metadata


Autodesk Vault

The table below lists the Autodesk Vault metadata available in the HaloENGINE.

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, dwg, ipt, and iam)

folder_name

Derivation from the folder name in the Autodesk Vault server. (For example, $/DESIGNS/INVENTOR FILES/Jet Engine Model/Workspace/Design Accelerator)

preexpression_custom_pre-expression

Derivation from custom pre-expression.

  1. Yes

  2. No

Autodesk Vault metadata

SOLIDWORKS PDM

The table below lists the SOLIDWORKS PDM metadata available in the HaloENGINE.

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, SZVLU100.com)

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, SZVLU100.com)

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, C:/<Folder>).

Please note that files cannot be encrypted if the folder name (folder_path) is specified with a backslash "\", such as C:\folder1\folder2. Therefore, it is advised to configure with a forward slash "/”, such as C:/folder1/folder2.

preexpression_custom_pre-expression

Derivation from custom pre-expression

  1. Yes

  2. No

SOLIDWORKS PDM metadata

Third-Party Libraries 

Third-party software/code is included or bundled with Secude's products according to its appropriate license. Secude conducts testing to make sure the third-party products are compatible with and perform as intended with Secude applications.

The third-party libraries and dependencies used by HaloENGINE are shown in the table below.

Library

Version

Source Code

License Name

License Link

jakarta.xml.bind:jakarta.xml.bind-api

3.0.1

https://mvnrepository.com/artifact/jakarta.xml.bind/jakarta.xml.bind-api/3.0.1

CDDL-1.0

https://javaee.github.io/glassfish/LICENSE

jakarta.xml.ws:jakarta.xml.ws-api

3.0.1

https://mvnrepository.com/artifact/jakarta.xml.ws/jakarta.xml.ws-api/3.0.1

CDDL-1.0

https://javaee.github.io/glassfish/LICENSE

javax.annotation:javax.annotation-api

1.3.2

https://github.com/javaee/javax.annotation

CDDL-1.0

https://github.com/javaee/javax.xml.soap/blob/master/LICENSE

com.sun.activation:javax.activation-api

1.2.0

https://repo1.maven.org/maven2/javax/activation/javax.activation-api/1.2.0/

CDDL-1.0

https://github.com/javaee/activation/blob/master/LICENSE.txt

com.sun.activation: jakarta.activation

1.2.2

https://github.com/javaee/activation

CDDL-1.0

https://javaee.github.io/glassfish/LICENSE

org.slf4j:slf4j-api

2.0.+

http://www.slf4j.org/download.html

MIT

http://www.slf4j.org/license.html

com.sun.xml.bind:jaxb-impl

2.3.5

https://github.com/javaee/jaxb-v2

CDDL-1.1

https://github.com/javaee/jaxb-v2/blob/master/LICENSE

jakarta.xml.bind:jakarta.xml.bind-api

2.3.3

https://github.com/eclipse-ee4j/jaxb-api

BSD 3

https://github.com/eclipse-ee4j/jaxb-api/blob/master/LICENSE.md

joda-time:joda-time 

2.12.7

https://github.com/JodaOrg/joda-time

Apache 2.0

https://github.com/JodaOrg/joda-time/blob/master/LICENSE.txt

net.iharder:base64 

2.3.9

http://iharder.sourceforge.net/current/java/base64/

Public Domain

http://iharder.sourceforge.net/current/java/base64/

org.graylog2:syslog4j

0.9.61

https://github.com/graylog-labs/syslog4j-graylog2

LGPL 2.1

https://github.com/graylog-labs/syslog4j-graylog2/blob/master/LICENSE

ch.qos.logback:logback-classic 

1.5.18

https://github.com/qos-ch/logback

LGPL 2.1

https://github.com/qos-ch/logback/blob/master/LICENSE.txt

ch.qos.logback:logback-core

1.5.18

https://github.com/qos-ch/logback

LGPL 2.1

https://github.com/qos-ch/logback/blob/master/LICENSE.txt

com.googlecode.json-simple:json-simple

1.1.1

https://github.com/fangyidong/json-simple  

Apache 2.0

https://github.com/fangyidong/json-simple/blob/master/LICENSE.txt

org.apache.commons:commons-lang3

3.13

https://github.com/apache/commons-lang

Apache 2.0

https://github.com/apache/commons-lang/blob/master/LICENSE.txt

nl.basjes.parse.useragent:yauaa

5.23

https://github.com/nielsbasjes/yauaa

Apache 2.0

https://github.com/nielsbasjes/yauaa/blob/master/LICENSE

org.eclipse.persistence:org.eclipse.persistence.moxy

2.7.9

https://github.com/eclipse-ee4j/eclipselink/tree/master/moxy

EPL 2.0

https://github.com/eclipse-ee4j/eclipselink/blob/master/LICENSE.md

com.google.guava:guava

33.0.0-jre.jar

https://github.com/google/guava

Apache 2.0


https://github.com/google/guava/blob/master/COPYING


org.apache.logging.log4j:log4j-api

2.20.0

https://github.com/apache/logging-log4j2

Apache 2.0


https://github.com/apache/logging-log4j2/blob/release-2.x/LICENSE.txt


com.javax0.license3j:license3j

3.2.0

https://github.com/verhas/License3j

Apache 2.0

https://github.com/verhas/License3j/blob/master/LICENSE.txt

javax.servlet:javax.servlet-api

4.0.1

https://github.com/javaee/servlet-spec

CDDL-1.0

https://github.com/javaee/servlet-spec/blob/master/LICENSE

org.apache.poi:poi-ooxml 

5.2.3

https://github.com/apache/poi

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0

com.univocity:univocity-parsers

2.9.1

https://github.com/uniVocity/univocity-parsers

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0

com.opencsv:opencsv

5.9

https://github.com/cygri/opencsv      

Apache 2.0

https://github.com/cygri/opencsv/blob/master/LICENSE

com.ibm.icu:icu4j

70.1

https://github.com/unicode-org/icu

ICU license

https://github.com/unicode-org/icu/blob/main/icu4c/LICENSE

com.fasterxml.jackson.core:jackson-databind

2.18.1

https://github.com/FasterXML/Jackson-databind

Apache 2.0

https://github.com/FasterXML/jackson-databind/blob/2.13/LICENSE

com.datastax.oss:java-driver-core

4.17.0

https://github.com/datastax/java-driver

Apache 2.0

https://github.com/datastax/java-driver/blob/4.x/LICENSE

com.datastax.oss:java-driver-query-builder

4.17.0

https://github.com/datastax/java-driver

Apache 2.0

https://github.com/datastax/java-driver/blob/4.x/LICENSE

com.datastax.oss:java-driver-mapper-runtime

4.17.0

https://github.com/datastax/java-driver

Apache 2.0

https://github.com/datastax/java-driver/blob/4.x/LICENSE

org.json:json

20211205


https://github.com/vogella/org.json/tree/master/src


org.JSON


https://github.com/vogella/org.json/tree/master/src


org.apache.httpcomponents:httpclient

4.5.14

https://github.com/apache/httpcomponents-client

Apache 2.0

https://github.com/apache/httpcomponents-client/blob/master/LICENSE.txt

org.apache.cxf:cxf-rt-frontend-jaxws

4.0.8

https://github.com/apache/cxf

Apache 2.0

https://github.com/apache/cxf/blob/master/LICENSE

org.apache.cxf:cxf-rt-rs-security-cors

4.0.8

https://github.com/apache/cxf

Apache 2.0

https://github.com/apache/cxf/blob/master/LICENSE

org.apache.cxf:cxf-rt-ws-rm

4.0.8

https://github.com/apache/cxf

Apache 2.0

https://github.com/apache/cxf/blob/master/LICENSE

org.springframework: spring-context

6.2.7

https://github.com/spring-projects/spring-framework/tree/main/spring-context

Apache 2.0


https://github.com/spring-projects/spring-framework/blob/main/src/docs/dist/license.txt


org.springframework:spring-web

6.2.7

https://github.com/spring-projects/spring-framework/tree/main/spring-web

Apache 2.0


https://github.com/spring-projects/spring-framework/blob/main/src/docs/dist/license.txt


org.codehaus.woodstox:stax2-api

3.1.4

https://github.com/FasterXML/woodstox

Apache 2.0

https://github.com/FasterXML/woodstox/blob/master/LICENSE

org.springframework.boot:spring-boot-starter-web 

3.3.12

https://github.com/spring-projects/spring-boot

Apache 2.0

https://github.com/spring-projects/spring-boot/blob/main/LICENSE.txt

org.springframework.boot:spring-boot-starter-security

3.3.12

https://github.com/spring-projects/spring-boot

Apache 2.0

https://github.com/spring-projects/spring-boot/blob/main/LICENSE.txt

org.springframework.security:spring-security-jwt

1.0.10
RELEASE

https://github.com/spring-projects/spring-security-oauth            

Apache 2.0

https://github.com/spring-projects/spring-security-oauth/blob/main/license.txt

o.jsonwebtoken:jjwt

0.9.1

https://github.com/jwtk/jjwt

Apache 2.0

https://github.com/jwtk/jjwt/blob/master/LICENSE

javax.resource:javax.resource-api 

1.7.1

https://github.com/javaee/javax.resource

CDDL-1.0

https://github.com/javaee/javax.resource/blob/master/LICENSE

commons-io:commons-io

2.5

https://github.com/apache/commons-io

Apache 2.0

https://github.com/apache/commons-io/blob/master/LICENSE.txt

commons-fileupload:commons-fileupload 

1.2.1

https://github.com/apache/commons-fileupload

Apache 2.0

https://github.com/apache/commons-fileupload/blob/master/LICENSE.txt

commons-beanutils:commons-beanutils

1.9.4

https://github.com/apache/commons-beanutils

Apache 2.0

https://github.com/apache/commons-beanutils/blob/master/LICENSE.txt

org.springframework.boot:spring-boot-gradle-plugin

3.3.12

https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project

Apache 2.0

https://github.com/spring-projects/spring-boot/blob/main/LICENSE.txt

org.springframework.batch:spring-batch-core 

4.3.10

https://github.com/spring-projects/spring-batch

Apache 2.0

https://github.com/spring-projects/spring-batch/blob/main/LICENSE.txt

org.springframework.batch:spring-batch-infrastructure

4.3.7

https://github.com/spring-projects/spring-batch

Apache 2.0

https://github.com/spring-projects/spring-batch/blob/main/LICENSE.txt

org.springframework.boot:spring-boot-starter-actuator

3.3.12

https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project

Apache 2.0

https://github.com/spring-projects/spring-boot/blob/main/LICENSE.txt

org.springframework.hateoas:spring-hateoas

2.5.0

https://github.com/spring-projects/spring-hateoas

Apache 2.0

https://github.com/spring-projects/spring-hateoas/blob/main/LICENSE

org.jolokia:jolokia-core

1.7.2

https://github.com/rhuss/jolokia        

Apache 2.0

https://github.com/rhuss/jolokia/blob/master/LICENSE

org.dizitart:nitrite

3.2.0

https://github.com/nitrite/nitrite-java

Apache 2.0

https://github.com/nitrite/nitrite-java/blob/develop/LICENSE.md

org.springframework.boot:spring-boot-starter-oauth2-resource-server  

6.2.7

https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project

Apache 2.0

https://github.com/spring-projects/spring-boot/blob/main/LICENSE.txt

org.springframework.security:spring-security-oauth2-jose

5.8.2

https://github.com/spring-projects/spring-security

Apache 2.0

https://github.com/spring-projects/spring-security           https://github.com/spring-projects/spring-security/blob/main/LICENSE.txt

org.springframework.security.oauth:spring-security-oauth2

2.5.2.RELEASE

https://github.com/spring-projects/spring-security

Apache 2.0

https://github.com/spring-projects/spring-security    -https://github.com/spring-projects/spring-security/blob/main/LICENSE.txt

org.springframework.security:spring-security-oauth2-client

6.4.6

https://github.com/spring-projects/spring-security

Apache 2.0

https://github.com/spring-projects/spring-security    -https://github.com/spring-projects/spring-security/blob/main/LICENSE.txt

org.springframework.security.oauth.boot:spring-security-oauth2-autoconfigure

2.6.8

https://github.com/spring-projects/spring-security

Apache 2.0

https://github.com/spring-projects/spring-security    -https://github.com/spring-projects/spring-security/blob/main/LICENSE.txt

Tomcat

10.1.52

https://github.com/apache/tomcat

Apache 2.0

https://github.com/apache/tomcat/blob/main/LICENSE

Java

21

https://github.com/adoptium/jdk

-

https://www.eclipse.org/legal/epl-2.0/

MongoDB

7.0.7

https://fastdl.mongodb.org/windows/mongodb-windows-x86_64



MIP SDK

1.18.103

https://learn.microsoft.com/en-us/information-protection/develop/version-release-history

The MIP SDK is publicly available for integration, but is not open source. It is provided by Microsoft under proprietary licensing terms. 

https://docs.microsoft.com/en-us/information-protection/develop/

MIP SDK

MSAL

4.73.1

https://github.com/AzureAD/microsoft-authentication-library-for-dotnet

https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/blob/master/LICENSE

MSAL

Spdlog

1.17.0

 

https://github.com/gabime/spdlog

Spdlog

Third-party libraries