Skip to main content
Skip table of contents

Configuring the HaloCAD Proxy

This section describes two methods (command line and GUI) for configuring the parameters of HaloCAD and HaloENGINE.

Configuration Using Tool (GUI)

Prerequisite: Ensure that HaloCAD for Autodesk Vault has been installed.

Follow the steps below to configure settings using the GUI.

Step 1. Stop the Tomcat Service.

Step 2. Run the HaloCAD Configuration Tool.

  1. Navigate to the destination folder you specified during installation. The default folder is C:\Program Files\Secude\HalocadVault\config.

  2. Double-click the jar file or type HaloCAD-for-Autodesk-Vault-config-<version>.jar and press Enter in the Command Prompt with administrative privileges.
    Example: C:\Program Files\Secude\HalocadVault\config>java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar

  3. The HaloCAD for Autodesk Vault Config Tool window will appear.

Step 2a. Enter the following information under the Autodesk Vault Configuration tab.

1_Tool_Vault Confguration.png

Autodesk Vault configuration tab

  1. 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 is blocked, whenever any error occurs.

    2. Tolerant (default): The file upload or download will be allowed, even when an error occurs.

  2. 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.

  3. AutodeskDM Target URL: Enter the AutodeskDM Target URL on which your Autodesk Vault is hosted. Example, http://10.98.89.190:80/AutodeskDM.

  4. 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 confirmation message dialog box will appear.

    2. Click OK on the confirmation dialog box.

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

2_Tool_Vault Primary HaloENGINE Configuration.png

Primary HaloENGINE configuration tab

  1. Certificate Name: Click Choose File to browse and select the client Keystore in JKS format, which is generated by the HaloENGINE Admin Portal (through which communication is established between the HaloENGINE and Autodesk Vault). Example, Vault01_ClientKey.jks

  2. Password: Enter the password of the selected client Keystore. Example, Key$T#123

  3. HaloENGINE Host: Enter the IP address/FQDN of HaloENGINE. Example, 10.98.89.190

  4. HaloENGINE Endpoint Port: Enter the Endpoint Port where the service is accessed by this client application. Example, 8746

  5. HaloENGINE Service Mode: Select the location where the HaloENGINE Service is installed.

    1. Local (default): Select if HaloENGINE Service and HaloCAD for Autodesk Vault are installed on the same machine on which Autodesk Vault is installed. If you choose Local, you must select the file transmission method in the HaloENGINE Service File Mode (FilePath/Stream) and enter the port number in the HaloENGINE Service Port text box.

      • FilePath (default): File stored in a local temporary location for encryption and decryption process. Here, file path information is used for transferring.

      • Stream: File as a sequence of bytes.

      • HaloENGINE Service Port: Enter the port assigned to the HaloENGINE Service during the installation. By default, HaloENGINE Service uses port 20000.

    2. Remote: Select if HaloENGINE Service and HaloCAD for Autodesk Vault are installed on different machines.

  6. 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.

  7. System ID: Enter the Autodesk Vault Server’s hostname and the same must be entered in the System Unique ID (HaloENGINE admin portal). For example, VAULTCLNT01.

  8. 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”.

  9. 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 confirmation message dialog box will appear.

    2. Click OK on the confirmation dialog box.

    3. After successful configuration, the configuration tool will create a config.properties file in C:\Program Files\Secude\HalocadVault\config.

    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. Enter the following information under the Secondary HaloENGINE Configuration tab.

If you haven't selected the Secondary HaloENGINE option in the Autodesk Vault 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_Vault_Secondary HaloENGINE Configuration.png

Secondary HaloENGINE configuration tab

  1. 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 Autodesk Vault]. For example, Vault02_ClientKey.jks

  2. Password: Enter the password of the selected client Keystore. For example, Key$T#1234

  3. HaloENGINE Host: Enter the IP address/FQDN of HaloENGINE. For example, 10.41.0.122.

  4. HaloENGINE Endpoint Port: Enter the endpoint port from which HaloENGINE can be accessed. For example, 8746

  5. 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 confirmation message dialog box will appear.

    2. Click OK on the confirmation dialog box.

Step 3. Start the Tomcat Service.

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 Autodesk Vault has been installed.

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

  1. Open a command prompt and navigate to the destination folder and type java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar -shell, and press Enter.

    CODE 
    C:\Program Files\SECUDE\HalocadVault\config>java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar -shell
--------------------------------------------------------------------------------
HaloCAD for Autodesk Vault
Config Path: C:\Program Files\SECUDE\HalocadVault\config
1. Autodesk Vault Configuration
2. Primary HaloENGINE Configuration
0. Exit
Note: If an invalid value is entered, the default value will be applied.
Please choose an option:1
--------------------------------------------------------------------------------
Autodesk Vault Configuration
--------------------------------------------------------------------------------
Fail Safe Mode: (Default:Tolerant) :
1. Tolerant
2. Strict
Please choose an option: 1

File Optimization: (Default:Single Label Optimization)
1. Multi Label Optimization
2. Single Label Optimization
Please choose an option: 1

Enter the AutodeskDM Target URL :http://10.98.89.190:80/AutodeskDM
Saved Successfully.
--------------------------------------------------------------------------------
Autodesk Vault Configuration
Fail Safe Mode         :Tolerant
File Optimization      :Multi Label Optimization
AutodeskDM Target URL  :http://10.98.89.190:80/AutodeskDM

1. Modify all configuration
2. Modify the particular configuration
3. Back to main menu
0. Exit
Please choose an option: 3
--------------------------------------------------------------------------------
1. Autodesk Vault Configuration
2. Primary HaloENGINE Configuration
0. Exit
Note: If an invalid value is entered, the default value will be applied.
Please choose an option:2
--------------------------------------------------------------------------------
Primary HaloENGINE Configuration
Certificate Name            :
HaloENGINE Host IP          :
HaloENGINE Endpoint Port    :
HaloENGINE Service Mode     :Local
HaloENGINE Service File Mode:File Path
HaloENGINE Service Port     :20000
Customer ID                 :halo_customer
System ID                   :
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: 1
--------------------------------------------------------------------------------
Primary HaloENGINE Configuration
Enter the Primary Certificate Path: C:\Users\superdocs\Desktop\SM\Vault01_ClientKey.jks

Enter the Primary certificate Password:

Enter the Primary HaloENGINE Host:10.98.89.190

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

Enter the Customer ID:halo_customer

Enter the System ID:VAULTCLNT01

HaloENGINE Service Mode (Default:Local) :
1. Remote
2. Local
Please choose an option: 1

Secondary HaloENGINE: (Default:Disable Secondary HaloENGINE)
1. Disable Secondary HaloENGINE
2. Enable Secondary HaloENGINE
Please choose an option: 1
Saved Successfully.
--------------------------------------------------------------------------------
Primary HaloENGINE Configuration
Certificate Name            :Vault01_ClientKey.jks
HaloENGINE Host IP          :10.98.89.190
HaloENGINE Endpoint Port    :8746
HaloENGINE Service Mode     :Remote
Customer ID                 :halo_customer
System ID                   :VAULTCLNT01
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:

  2. Click Close to close the command prompt.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close