Configuring the HaloCAD Proxy

This section explains how to configure HaloCAD and HaloENGINE parameters using both command line and GUI methods, as well as Dataset and TCCS configurations.

Configuration Using Tool (GUI)

Step 1. Stop the Tomcat Service.

Use services.msc to stop the service.

Step 2. Run the HaloCAD Config tool.

Go to the default installation directory C:\Program Files\Secude\HaloCADTeamcenter\config.
Double-click on the halocad-teamcenter-config-<version>.jar file or run the jar file in a Command Prompt using administrator privileges. In the latter case, you must type the following command and press Enter.
Syntax: java -jar <pathtojar>\halocad-teamcenter-config-<version>.jar
For example: java -jar C:\Program Files\Secude\HaloCADTeamcenter\config\halocad-teamcenter-config-<version>.jar
The HaloCAD for Teamcenter Config Tool window will appear.

Step 2a. Enter the following information under the Teamcenter Configuration tab.

Teamcenter Configuration tab

Proxy URL: Enter the URL where the proxy (HaloCAD component) is installed. For example, http://tclu0310.secude.local:8080
Tomcat Path: Click Choose Path to browse and select the path of the Tomcat home directory. For example, C:\Program Files\Secude\Tomcat
Fail-Safe Mode: The Fail-Safe Mode controls the system's behavior in case of inconsistencies that prevent the specified protection from being applied (conflicting configuration, server component unreachable, or returning an error message. etc.). You can define any one of the following:
1. Strict: The file upload or download will be blocked, whenever any error occurs.
2. Tolerant (default): The file upload or download will be allowed, even when an error occurs.
File Optimization: Choose one of the following options for file optimization. By default, Single Label Optimization is set.
1. Single Label Optimization: The top-level file label is taken into account and applied to all dependent files.
2. Multi-Label Optimization: Each file type group label defined in the classification engine is taken into account and assigned to the appropriate group with ASM optimization.
AWC Micro Service: To communicate with Teamcenter via Microservices, enable this option.
AWC 5.x with Microservice:
1. If you use Microservices for AWC, enable the option AWC Micro Service and provide the port number in AWC Proxy Port. Please use a different port number for the Proxy URL and AWC Proxy Port.
2. For Example: If your Proxy URL = 8080 you may use a different port for AWC Proxy Port as 8081.
3. To access AWC, use http://hostname:awcproxyport. For example, http://svlu0309:8081
AWC 4.x without Microservice:
1. Here, to use AWC without Microservice, disable the option AWC Micro Service.
2. To access AWC, use http://hostname:proxyport/awc. For example, http://svlu0309:8080/awc
Log Level: Select a log level as per your choice.
1. INFO: A standard log level that highlights the progress of the application.
2. ERROR: Logs error events that prevent program execution.
3. DEBUG: Logs detailed tracing messages. It should be used for information that may be required for diagnosing issues and troubleshooting. The log level is set to "DEBUG" by default. The log rollover period is configured to 24 hours, which means that every 24 hours, a new log file with the file format haloproxy.<yyyy-MM-dd>.log is generated.
FMS Target URL: Enter the URL of the Teamcenter Server where the file download needs to be protected. For more details, please refer to the section "Appendix". For example, http://tclu0310.secude.local:4544
Other Target URL: In case of multiple FSC configurations, enter other URLs as given in the following format http://<fmstarget url_1>;http://<proxy url_1>,http://<fmstarget url_2>; http://<proxy url_1>. For more details, please refer to the section "Appendix".
Example, http://tclu0317.secude.local:4544/;http://tclu0310.secude.local:8080, http://tclu0312.secude.local:4544;http://tclu0313.secude.local:8080
AWC Target URL: Enter AWC’s URL.
1. Without Microservice: http://tclu0310.secude.local:80/awc
2. With Microservice: http://tclu0310.secude.local:3000
Group: Enter the name of the group. For example, dba.
ServerHost: Enter your Teamcenter URL. For example, http://tclu0310.secude.local:80/tc or http://tclu0310.secude.local:7001/tc.
TargetName: Enter the network address that is added in the Credential Manager as TargetName. For example, secude.com.
Click Apply. Any missing values will be indicated with a red tool tip message. This indicates that you need to enter and click Apply.
Results:
1. A progress bar indicates that "Restarting Tomcat Service" is being performed.
2. A confirmation message dialog box will appear.
3. Click OK on the confirmation dialog box.

Step 2b. Enter the following information under the Primary HaloENGINE configuration tab.

2_Tool_Primary HaloENGINE Configuration.png

Primary HaloENGINE configuration tab

Certificate Name: Click Choose File to browse and select the client Keystore in JKS format, generated by the HaloENGINE Admin Portal (through which communication is established between primary HaloENGINE and Teamcenter). For example, Teamcenter01_ClientKey.jks
Password: Enter the password of the selected client Keystore. For example, ckpass
Host: Enter the IP address/FQDN of HaloENGINE. For example, 10.41.14.169
Endpoint Port: Enter the Endpoint Port where the service is accessed by this client application. For example, 8746
HaloENGINE Service Mode: Select the location where the HaloENGINE Service is installed.
1. Local (default): Select if HaloENGINE Service and HaloCAD for Teamcenter are installed on the same machine on which Teamcenter PLM is installed. If you choose Local, you must select the file transmission method in the HaloENGINE Service File Mode (Filepath / Stream) and then enter the port number in the HaloENGINE Service Port text box.
2. FilePath (default): File stored in a local temporary location for encryption and decryption process. Here, file path information is used for transferring.
3. Stream: File as a sequence of bytes.
4. HaloENGINE Service Port: Enter the port assigned to the HaloENGINE Service during the installation. By default, HaloENGINE Service uses port 20000.
5. Remote: Select if HaloENGINE Service and HaloCAD for Teamcenter are installed on different machines.
Customer ID: Enter the Customer ID that is assigned for Single Customer mode or Multi-Customer mode in the admin portal. For example, halo_customer.
System ID: System Unique ID must be the Teamcenter Server’s hostname that is added as the FMS target in the proxy configuration. For example, TEAMCENTER01
Secondary HaloENGINE: If you want to set up a failover mechanism in your environment, select this check box. HaloCAD supports connection failover between two HaloENGINEs. For more information, please refer to the section “Failover Mechanism for HaloENGINE in HaloCAD for PLM”.
Click Apply. Any missing values will be indicated with a red tool tip message. This indicates that you need to enter and click Apply.
Results:
1. A progress bar indicates that "Restarting Tomcat Service" is being performed.
2. A confirmation message dialog box will appear.
3. Click OK on the confirmation dialog box.
4. If you have selected the Secondary HaloENGINE option, you can notice that the Secondary HaloENGINE Configuration tab has been added to the configuration tool as shown below in Step 2c.

Step 2c. Check the connection status on the Secondary HaloENGINE configuration tab.

If you haven't selected the Secondary HaloENGINE option in the Teamcenter Configuration tab, skip this step. This step is only necessary if you want to use the failover mechanism.

Prerequisite: Ensure that the secondary HaloENGINE uses the same configuration profiles and rules as the primary HaloENGINE. Thus, when the primary HaloENGINE fails, the secondary HaloENGINE immediately takes over, assuring continuous operation.

3_Tool_Secondary HaloENGINE Configuration.png

Secondary HaloENGINE configuration tab

Certificate Name: Click Choose File to browse and select the client Keystore in JKS format, generated by the HaloENGINE Admin Portal [through which communication is established between HaloENGINE (secondary) and Teamcenter ]. For example, Teamcenter02_ClientKey.jks
Certificate Password: Enter the password of the selected client Keystore. For example, Key$T#1234
HaloENGINE Host: Enter the IP address/FQDN of HaloENGINE. For example, 10.91.0.190
HaloENGINE Endpoint Port: Enter the endpoint port from which HaloENGINE can be accessed. For example, 8746
Click Apply. Any missing values will be indicated with a red tool tip message. This indicates that you need to enter and click Apply.
Results:
1. A progress bar indicates that "Restarting Tomcat Service" is being performed.
2. A confirmation message dialog box will appear.
3. Click OK on the confirmation dialog box.

Step 2d. Check the connection status on the SOA Validation tab.

SOA Validation tab

Press the SOA Login Check button to confirm the SOA credential configuration.
Click Apply. Any missing values will be indicated with a red tool tip message. This indicates that you need to enter and click Apply.
Results:
1. A progress bar indicates that "Checking SOA logging connection status” is being performed.
2. A confirmation message dialog is displayed if the connection is successful. Click OK on the confirmation dialog box.
3. Click Close to close the HaloCAD for Teamcenter Config Tool window.
Related task: If there is an error in the connection, you will receive the appropriate warning. Please follow the message and try again.

Dataset Configuration - DatasetFromIman

The following steps are to be carried out by a user with DBA privileges on the Teamcenter server. For illustration, the user account Infodba is used.

Click the Query Builder icon in the navigation pane.
Click on Saved Queries. A new query page will appear, and you need to enter the following details.
1. Enter DatasetFromIman in the Name text box.
2. In Search Type, select Dataset from the list.
3. In Modifiable Query Types, select Local Query from the list.
4. Under the Properties Selection section, double-click on the property ref_list. The Business Type Selection Dialog will appear.
5. You need to search for ImanFile and double-click on it. It will be added to the property.
6. The property name will now appear as ref_list [File].
7. Under ref_list [File], double-click on file_name. You can see the attributes being displayed in the Search Criteria section.
  Adding a new query - DatasetFromIman
Click Create.
Result: The query is saved and added to the Query Builder list.

TCCS Configuration

The following procedure explains how to change the File Management System (FMS) master file and FMS client cache (FCC) file in the Teamcenter client communication system (TCCS). We recommend you make a backup of the current two XML files.

Step 1. Modify the FMS master file.
1. Go to Siemens installed location <Installed_Path>\Siemens\Teamcenter12\fsc\fmsmaster_FSC_<ComputerName>_Teamcenter.xml>.
  For example, C:\Program Files\Siemens\Teamceter12\fsc\fmsmaster_FSC_tclu0310_Teamcenter.xml
2. Open the XML file with administrator privilege and add the following line after <fscgroup id="mygroup"> tag along with the port number as shown in the example below:
  Line format:<loadbalancer id="ReverseProxy" address="<host>:<port>/tc/fms/" />
  For Example, <loadbalancer id="ReverseProxy" address="http://tclu0310.Secude.local:8080/tc/fms/" />
3. Save the file.
Step 2. Modify the FCC file.
1. Go to Siemens installed location <Installed_Path>\Siemens\Teamcenter12\tccs\fcc.xml>.
  For example, C:\Program Files\Siemens\Teamceter12\tccs\fcc.xml
2. Open the XML file with administrator privilege and add the following line along with the port number as shown in the below example:
  Line format: <parentfsc address="http://<host>:<port>/tc/fms" priority="0" transport="lan"/> <assignment address="parentfsc address">
  For Example: <parentfsc address="http://tclu0310.Secude.local:8080/tc/fms" priority="0" transport="lan"/> <assignment mode = "parentfsc">
3. Save the file.
Step 3. Restart the Siemens service.
1. Restart the Teamcenter FSC Service (FSC_<serverhostname>_Teamcenter) via the Windows Services Manager.
2. Please note that whenever XML files are modified, the FSC service should be restarted.

Configuration Using the Command Line

This is an alternative method of configuring the HaloCAD and HaloENGINE parameters using the command line.

Prerequisite: Ensure that HaloCAD for Teamcenter has been installed.

Follow the command-line instructions. A sample is provided below:

Open a command prompt and navigate to the destination folder and type java -jar halocad-teamcenter-config-<version>.jar -shell, and press Enter.

CODE

C:\Program Files\Secude\HaloCADTeamcenter\config>java -jar halocad-teamcenter-config-<version>.jar -shell
--------------------------------------------------------------------------------
HaloCAD for Teamcenter
Config Path: C:\Program Files\Secude\HaloCADTeamcenter\config
1. Teamcenter Configuration
2. Primary HaloENGINE Configuration
3. SOA Validation
0. Exit
Note: If an invalid value is entered, the default value will be applied.
Please choose an option:1
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Teamcenter Configuration:
--------------------------------------------------------------------------------
Enter the Proxy URL:
http://tclu0310.secude.local:8080

Enter the Tomcat path:
C:\Program Files\Secude\Tomcat

Fail Safe Mode: (Default:Tolerant)
1. Tolerant
2. Strict

Please choose an option:
1

Fail Optimization: (Default:Single Label Optimization)
1. Multi Label Optimization
2. Single Label Optimization

Please choose an option:1

Awc Microservice: (Default:AWC Disable)
1. AWC Enable
2. AWC Disable

Please choose an option:
2

Log Level: (Default:INFO)
1. INFO
2. DEBUG
3. ERROR

Please choose an option:
2
Enter the FMS Target URI:
http://tclu0310.secude.local:4544
Enter the AWC Target URI:
http://tclu0310.secude.local:80/awc
Enter the Group Name:
dba
Enter the Serverhost:
http://tclu0310.secude.local:80/tc
Enter the Target name:
secude.com
Restarting Tomcat Service. Please wait.
Tomcat restarted successfully
--------------------------------------------------------------------------------
Teamcenter Configuration:

Proxy URL                       :http://tclu0310.secude.local:8080
Tomcat Path                     :C:\Program Files\Secude\Tomcat
Fail Safe Mode                  :Tolerant
Fail Optimization               :Multi Label Optimization
Awc Microservice                :AWC Disable
Log Level                       :DEBUG
FMS Target URL                  :http://tclu0310.secude.local:4544
AWC Target URL                  :http://tclu0310.secude.local:80/awc
Group Name                      :dba
Server host                     :http://tclu0310.secude.local:80/tc
Target Name                     :secude.com

1. Modify all configuration
2. Modify the particular configuration
3. Back to main menu
0. Exit

Please choose an option:
3
--------------------------------------------------------------------------------
1. Teamcenter Configuration
2. Primary HaloENGINE Configuration
3. SOA Validation
0. Exit
Note: If an invalid value is entered, the default value will be applied.
Please choose an option:2
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
Certificate Configuration:
--------------------------------------------------------------------------------
Enter the Primary Certificate Path:
C:\Users\superdocs\Desktop\SM\Teamcenter01_ClientKey.jks
File name:Teamcenter01_ClientKey.jks.

Enter the Primary certificate Password:


Enter the Primary HaloENGINE Host:
10.41.14.169

Enter the Primary HaloENGINE Endpoint Port: (Default:8746)
8746

Enter the Customer ID:
halo_customer

Enter the System ID:
TEAMCENTER01

HaloENGINE Service: (Default:Local)
1. Local
2. Remote

Please choose an option:
1

HaloENGINE Service File Mode: (Default:File Path)
1. File Path
2. Stream

Please choose an option:
1

Enter the HaloENGINE Service Port: (Default:20000)
20000

Secondary HaloENGINE: (Default:Disable Secondary HaloENGINE)
1. Disable Secondary HaloENGINE
2. Enable Secondary HaloENGINE

Please choose an option:
1
Restarting Tomcat Service. Please wait.
Tomcat restarted successfully
Saved Successfully.
--------------------------------------------------------------------------------
Primary HaloENGINE Configuration:

Primary Certificate Name         :Teamcenter01_ClientKey.jks
Primary HaloENGINE Host          :10.41.14.169
Primary HaloENGINE Endpoint Port :8746
HaloENGINE Service               :Local
HaloENGINE Service File Mode     :File Path
HaloENGINE Service Port          :20000
Customer ID                      :halo_customer
System ID                        :TEAMCENTER01
Secondary HaloENGINE             :Disable Secondary HaloENGINE

1. Modify all configuration
2. Modify the particular configuration
3. Back to main menu
0. Exit

Please choose an option:
3

--------------------------------------------------------------------------------
1. Teamcenter Configuration
2. Primary HaloENGINE Configuration
3. SOA Validation
0. Exit
Note: If an invalid value is entered, the default value will be applied.
Please choose an option:3
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
SOA Login connection status:
--------------------------------------------------------------------------------
1. Check SOA connection status
0. Exit

Please choose a valid option:1
Checking Teamcenter Login status, Please wait.
Oct 25, 2024 3:11:58 AM com.secude.halocad.teamcentercmd.AppXSessionCMD loginShell
INFO: TC--> Login successful
SOA login is successful

1. Check Status again
2. Back to main menu
0. Exit

Click Close to close the command prompt.