Installing the HaloCAD Add-on for Solid Edge

This chapter walks through the process of installing and configuring the HaloCAD Add-on for Solid Edge. This manual just briefly explains steps 1-3, which cover the prerequisites, obtaining the licensing key, and creating an encrypted JSON file; for more information, please refer to the Technical Reference Manual.

Step 1: Fulfill the Prerequisites

1. Refer to the Release Notes to learn about supported operating systems, file types, and CAD applications.

2. Before installing the add-on, make sure all prerequisites are fulfilled.

Please refer to the section “Prerequisites”.

Step 2: Obtain the License Key

Obtain the license key and choose whether to activate it automatically or manually.

Please refer to the section License Administration.

Step 3: Create an Encrypted JSON File

To ensure a secure installation, create an encrypted JSON file using this admin tool and share it without exposing the original tenant details. When the encrypted JSON file is ready, place it with the HaloCAD installer. By reading data from the hc.conf.enc file, the installer activates the license and bypasses the "Initialization" screen, which would otherwise ask for Microsoft Entra ID application details.

Please refer to the section Secure Installation (Recommended).

Step 4: Install the Add-on

You can install the add-on in the following modes:

1. Graphical Mode
   Graphical mode installation is an interactive, graphical user interface-based method that is driven by a wizard.

2. Silent Mode
   Silent-mode installation is a non-interactive method of installing the add-on using command lines.

3. Via System Center Configuration Manager
   With System Center Configuration Manager (SCCM), the add-on is deployed on the targeted computers across your enterprise.

Graphical Mode

Before you begin

The following prerequisites must be met:

1. A user who installs the HaloCAD Add-on must have administrator rights. 

2. Ensure that all active and open CAD applications are closed. If not, HaloCAD prompts a warning message as “Please close all the CAD applications to proceed with the installation of HaloCAD Add-on for Solid Edge.”

3. Ensure that the HaloCAD Reader Add-on for Solid Edge is not installed on the same workstation. If it is already installed, HaloCAD prompts a warning message as “No supported CAD applications are available in the system. (OR) Remove the Reader version of this product.”

4. Ensure that your Microsoft Entra tenant details are ready when the installation UI requests them. As an alternative, you can use hc.conf.enc for a secure and automated installation.

Installation Procedure

Install the add-on using the GUI-based setup program provided in the installation package. 

1. Double-click the installer HaloCAD_SolidEdge_Setup.exe file. 

2. Depending on your Windows security settings, a prompt may appear stating, "Do you want to allow the following program to make changes to this computer?" If this warning appears, click Yes to continue with the installation.

3. When the installer starts, the Startup dialog appears, followed by the Welcome dialog.

   

   Startup dialog

   

   Welcome dialog

4. Click Next to continue the installation. The installer UI includes a link to the product’s online documentation. When you click Online Help, the installation help page opens in your browser.

5. The End-User License Agreement (EULA) dialog appears.

   

   End-User License Agreement dialog

6. Read the End-User License Agreement. If you agree to the terms, select I accept the terms in the License Agreement and click Next to continue.

7. The CAD application version selection dialog appears.

   

   CAD application version selection dialog

8. Select the installed Solid Edge application version in your system.

   1. By default, application files are stored in the program files directory (C:\Program Files\Secude\Solid Edge). If you would like to choose an alternate location, click the Browse button and select your location preference.

   2. When you are finished, click Next. To review or modify any installation settings, click Back to return to the previous screens. If you are ready to proceed, click Next to begin installing the application.

9. The installation begins, and the progress is displayed in the dialog.

   

   Installation progress dialog

10. When the installation is complete, a message appears confirming that the add-on has been successfully installed.

    

    Installation completed dialog

11. Click Next to proceed.

12. The initialization dialog appears. To prevent connectivity issues, ensure that the correct Microsoft Entra ID application details are entered on the screen. Note: If the hc.conf.enc file is included with the installer, this initialization screen is skipped and only the completion dialog is shown. The initialization screen appears only when the hc.conf.enc file is not present in the installer folder.

    

    Initialization dialog

    1. Application ID: Enter the unique identifier of your registered application. For example, v6ca776-c74e-437d-98ef-662ecb5751tt

    2. Redirect URI: Enter the URI, that was provided when registering the native application in the Azure portal. For example, https://localhost.

    3. Tenant ID: If the registered application is Single tenant, you need to enter the globally unique identifier of your tenant if not, you can leave it empty. For example, 9c1cfc28-1ec6-44ea-bec6-e3492ef0cd16 

    4. Cloud Type: Commercial is selected by default. Based on your Azure subscription and configuration, select the required cloud type from the list: Commercial, Custom, Germany, US_DoD, US_GCC, US_GCC_High, US_Sec, US_Nat, or China_01. If you select Custom, enter the appropriate URLs in the Protection Cloud URL (for example, https://api.aadrm.com) and Policy Cloud URL (for example, https://dataservice.protection.outlook.com) fields.

    5. Enable Federal Information Processing Standards (FIPS): Enable this option to use encryption algorithms that comply with FIPS standards. When enabled, MPIP uses only FIPS-compliant encryption algorithms, and when disabled, it uses standard encryption algorithms. If this option was not enabled during installation, it can later be enabled through a registry entry. For more details, please refer to the section “Step 5: Modify Registry Settings”.

    6. Click Next.

13. Once the initialization is complete, a success message appears as shown below. 

    

    Initialization completed dialog

14. Click Close to close the installation wizard.

Post-installation checks:

1. To view the add-on, open the Solid Edge Application > HaloCAD tab.

2. Masking Personally Identifiable Information (PII): By default, the HaloCAD Add-on masks Personally Identifiable Information (PII) in logs, such as email names, file paths, and IP addresses in the MIP SDK logs. In HaloCAD logs, information such as the label name, label ID, engine ID, policy ID, and watermark text is masked with asterisks. To view PII in clear text, create the following registry entry in Path: Computer\HKEY_CURRENT_USER\SOFTWARE\Secude\HaloCAD Add-on for Solid Edge

   Name: mipallowpii, Type: REG_SZ, Value: true

   The log files are located at the following paths:

   • MIP SDK log: %AppData%\Roaming\Secude\HaloCAD\Solid Edge\mip\logs\mip_sdk.miplog

   • HaloCAD log: %AppData%\Roaming\Secude\HaloCAD\Solid Edge\halocad.log

3. If your network infrastructure includes a proxy server that provides access to external websites. Then, to connect to the Secude License Manager URL, you need to manually add the Proxy settings in the add-on. To do so, create a registry entry in the root directory, Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Secude\HaloCAD Add-on for Solid Edge
   Name: proxyuri, Type: REG_SZ, Value: The format is, <URL>:<PORT>. For example, http://10.41.0.130:808

Silent Mode

Besides graphical mode, the add-on can be installed in silent mode, which does not require user involvement or display a user interface. It is a convenient way to streamline installation using the command at once. 

1. Open the Command Prompt with elevated rights (Run as Administrator).

2. Navigate to the add-on installer directory.

3. To know the list of options available in silent mode, follow the steps given below:
   Type HaloCAD_SolidEdge_Setup.exe -help
   Press Enter
   Output
   ...
   HaloCAD_SolidEdge_Setup.exe -install -application <Solid Edge 2022|Solid Edge 2024|Solid Edge 2025> -customdirlocation <default|custom> -applicationid <azure_application_id> -redirecturi <azure_redirect_url> -tenantid <azure_tenant_id for Single-tenant app|null for Multi-tenant app> [-cloudtype <Commercial|Custom|Germany|US_DoD|US_GCC|US_GCC_High|US_Sec|US_Nat|China> -protectioncloudurl <protection cloud url> -policycloudurl <policy cloud url>] -enablefipsmode <true|false>
[Default Parameters: cloudtype - Commercial and enablefipsmode - false]
HaloCAD_SolidEdge_Setup.exe -uninstall
To delete HaloCAD cache through Silent Mode Uninstallation
HaloCAD_SolidEdge_Setup.exe -uninstall -clearcache <yes>
For Silent Mode Installation if ENC file already exists in the same location
HaloCAD_SolidEdge_Setup.exe -install -application <Solid Edge 2022|Solid Edge 2024|Solid Edge 2025> -customdirlocation <default|custom> -enablefipsmode <true|false>

4. The following command illustrates how to install the add-on using the Azure application details.
   HaloCAD_SolidEdge_Setup.exe -install -application "Solid Edge 2024" -customdirlocation C:\Program Files\Secude -applicationid v6ca776-c74e-437d-98ef-662ecb5751tt -redirecturi https://localhost -tenantid 9c1cfc28-1ec6-44ea-bec6-e3492ef0cd16 -cloudtype Custom -protectioncloudurl https://api.aadrm.com -policycloudurl https://dataservice.protection.outlook.com -enablefipsmode true

5. The example below shows how to install the add-on using the hc.conf.enc file located in the same installation location as mentioned.
   HaloCAD_SolidEdge_Setup.exe -install -application "Solid Edge 2024" -customdirlocation C:\Program Files\Secude -enablefipsmode true

6. Press Enter.

7. The installation is complete.

Via System Center Configuration Manager

Microsoft System Center Configuration Manager (SCCM) is an administrative tool that allows organizations to deploy operating systems and applications to Windows users efficiently and cost-effectively across their environment.

Using SCCM, the HaloCAD add-on can be deployed silently and automatically to specific target computers throughout the enterprise.

Before You Begin

1. Ensure that you have reviewed the prerequisites described in the Graphical Mode section.

2. We recommend adhering to best practices when creating a deployment procedure.

3. For guidance on preparing your environment, refer to the official Microsoft online documentation.

Deployment Using SCCM

This guide assumes that an SCCM environment is already configured. After setup, you can use the silent mode commands described in the Silent Mode section to deploy the add-on.

Step 5: Modify Registry Settings

Prerequisite: To modify the add-on registry entries, first launch the CAD application and sign in to Microsoft Purview Information Protection to ensure that an active HaloCAD session is established.

Note: Only the registry entries listed in the table below should be modified.

The HaloCAD registry entries are grouped into two sections: HKEY_CURRENT_USER and HKEY_LOCAL_MACHINE. Depending on your requirements, you can modify the following settings:

1. HKEY_CURRENT_USER\SOFTWARE\Secude\HaloCAD Add-on for Solid Edge. Once you have logged into the HaloCAD Session, open Registry Editor, navigate to this path, and modify the desired registry key. For example, to change the log level, double-click loglevel, change the "Value data" using the values listed in the table below, and then click OK.

   1. loginterval

   2. loglevel

   3. logsize

2. HKEY_LOCAL_MACHINE\SOFTWARE\Secude\HaloCAD Add-on for Solid Edge: enable_fips (This entry does not require an active HaloCAD session.)

Configuration in the HaloCAD Registry

What to do next

1. If the encrypted configuration file was placed with the installer:

   1. You can launch the CAD application and start using the HaloCAD features immediately.

   2. The license is activated silently in the background.

   3. For details on protecting CAD files, refer to the Operations Manual.

2. If the encrypted configuration file was not placed with the installer:

   1. You must activate the license manually.

   2. Follow the instructions in the “UI-based Manual License Activation” section of the Technical Reference Manual.