HaloCAD for Autodesk Vault
HaloCAD for Autodesk Vault
Breadcrumbs

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)

Prerequisites: Ensure that HaloCAD for Autodesk Vault is installed before proceeding.

Follow these steps to configure the settings through the GUI:

Step 1. 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. To run, either double-click the HaloCAD-for-Autodesk-Vault-config-<version>.jar file or open Command Prompt with administrative privileges and execute the following syntax.

    Syntax: <pathtojar>java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar
    For example: C:\Program Files\Secude\HalocadVault\config>java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar

Result: The HaloCAD for Autodesk Vault Config Tool window is displayed.

Step 2. Enter the following details 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 considered and applied to all dependent files.

    2. Multi Label Optimization: Each file type group label defined in the Classification Engine is considered and applied to the corresponding group during ASM optimization.

  3. Optimized Download Protection: When this option is enabled (disabled by default), during the download of assembly files (for example, a parent ASM with dependent files), the smallest single file is protected and delivered to the user’s download location. The remaining files are then automatically protected at the user’s download location by the HaloCAD for PLM Client.

  4. AutodeskDM Target URL: Enter the AutodeskDM Target URL on which your Autodesk Vault is hosted. For example, http://10.98.89.190:80/AutodeskDM.

  5. AutodeskTC Target URL: Enter the AutodeskTC Target URL on which your Autodesk Vault Thin Client is installed. For example,http://10.98.89.190:80/AutodeskTC.

  6. Click Apply. A red tooltip message appears if any required values are missing. Enter the missing information and click Apply to continue.

Result:

  • A confirmation message dialog box appears.

  • Click OK to close the dialog box.

Step 3. Go to the Primary HaloENGINE Configuration tab, and then enter the following information.

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 from which HaloENGINE can be accessed. For example, 8746

  5. HaloENGINE Service File Mode: Select the file transmission method.

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

    2. Stream: File as a sequence of bytes.

  6. Customer ID: Enter the Customer ID that has been assigned 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. A red tooltip message appears if any required values are missing. Enter the missing information and click Apply to continue.

Result:

  • A confirmation message dialog box appears.

  • Click OK to close the dialog box.

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

  • 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 in Step 4 below.

Step 4. Go to the Secondary HaloENGINE Configuration tab, and then enter the following information.

If you have not selected the Secondary HaloENGINE option on the Primary HaloENGINE Configuration tab, skip this step. This step is required only if you plan 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. A red tooltip message appears if any required values are missing. Enter the missing information and click Apply to continue.

Result:

  • A confirmation message dialog box appears.

  • Click OK to close the dialog box.

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, type java -jar HaloCAD-for-Autodesk-Vault-config-<version>.jar -shell, and press Enter.

    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

Optimized Download Protection: (Default:Disable)
1. Enable
2. Disable
Please choose an option: 1

Enter the AutodeskDM Target URL :http://10.98.89.190:80/AutodeskDM

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

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
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\Administrator\Desktop\Certs\Vault01_ClientKey.jks

Enter the Primary certificate Password:

Enter the Primary HaloENGINE Host:10.98.89.198

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

Enter the Customer ID:halo_customer

Enter the System ID:VAULTCLNT01

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.198
HaloENGINE Endpoint Port    :8746
HaloENGINE Service Mode     :Local
HaloENGINE Service File Mode:File Path
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.