New Release Available in October – Stay tuned!
HaloCAD for Viewers
1.7 1.6 1.5 1.4 1.3
1.7 1.6 1.5 1.4 1.3

Installation and Usage Guide

Introduction

Organizations frequently share CAD files, such as drawings, blueprints, and prototypes, with suppliers, partners, and vendors. Sharing these files outside the organization increases the risk of unauthorized access or data leakage. HaloCAD for Viewers helps protect sensitive CAD files by enforcing persistent access controls, allowing authorized users to securely view protected content.

About this Manual

This manual walks you through the process of installing, configuring, and operating HaloCAD for Viewers.

Reference

All technical manuals are included with the product package.

Before using this manual, administrators should review the Technical Reference Manual to understand the HaloCAD for Viewers architecture and prerequisites. They should also review the Release Notes to verify the supported CAD viewer applications before following the procedures in this manual.

General FAQs

This section provides answers to frequently asked questions (FAQs). If you need additional assistance, contact your Secude sales representative or Technical Support.

  1. What is HaloCAD for Viewers?

    HaloCAD for Viewers is a lightweight application that allows users with view-only permissions to securely open and view HaloCAD-protected files in supported CAD viewer applications.

  2. Can HaloCAD for Viewers open all protected CAD file types?

    No. HaloCAD for Viewers supports only the HaloCAD-protected CAD file types listed in the Release Notes.

  3. What languages does HaloCAD for Viewers support?

    HaloCAD for Viewers currently supports English only.

  4. What happens if an unauthorized user tries to open a HaloCAD-protected CAD file?

    User authentication is performed before the file is opened. If authentication fails or the user does not have the required permissions, an error message is displayed, and access to the file is denied.

Installing HaloCAD for Viewers

Step 1: Fulfill the Prerequisites

  1. Refer to the Release Notes for the list of supported operating systems, CAD viewer applications, and file types.

  2. Ensure that all prerequisites described in the Technical Reference Manual are completed before installing HaloCAD for Viewers.

Please refer to the section “Prerequisites”.

Step 2: Create an Encrypted JSON File

To simplify installation and protect Microsoft Entra ID application details, create an encrypted JSON configuration file by using the administrator tool. Place the hc.conf.enc file in the same directory as the HaloCAD installer. During installation, HaloCAD automatically reads the Microsoft Entra ID application details, so you do not need to enter them manually. A license key is not required for HaloCAD for Viewers.

Please refer to the section “Secure Installation (Recommended Method)”.

Step 3: Install the Add-on

HaloCAD for Viewers can be installed using one of the following methods:

  1. Graphical Mode
    Provides an interactive, wizard-based installation through the graphical user interface (GUI).

  2. Silent Mode
    Installs HaloCAD for Viewers without displaying a user interface and requires no user interaction. It is intended for automated deployments.

  3. Via System Center Configuration Manager
    Enables administrators to deploy HaloCAD for Viewers silently to multiple computers across the enterprise.

Graphical Mode

Before you begin
Ensure that the following prerequisites are met:

  1. The user performing the installation has administrator privileges.

  2. Have your Microsoft Entra ID application details available when prompted during installation. Alternatively, use the hc.conf.enc file for a secure, automated installation.

Installation Procedure

Install HaloCAD for Viewers by using the GUI-based setup program included in the installation package.

  1. Double-click HaloCAD_Viewers_Shield_Setup.exe to start the installation.

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

    Startup dialog

    Welcome dialog.jpg

    Welcome dialog

  4. Click Next to continue the installation. 

  5. The License Agreement dialog appears.

    End-User License Agreement dialog.png

    End-User License Agreement dialog

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

  7. The Destination dialog appears.

    Destination Folder dialog.png

    Destination folder selection dialog

  8. By default, the application is installed in C:\Program Files\Secude\. To install it in a different location, click Browse, select the destination folder, and then click Next.

  9. The Feature dialog appears.

    Feature Selection dialog.png

    Feature selection dialog

    1. Viewers Shield is selected by default.

    2. To review or modify the installation settings, click Back. When you are ready to continue, click Next to begin the installation.

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

    Installing dialog.png

    Installation progress dialog

  11. When the installation is complete, a confirmation message appears.

    Installation completed successfully dialog.png

    Installation completed dialog

  12. Click Next to continue.

  13. The Initializing Service dialog appears. To prevent connectivity issues, ensure that the correct Microsoft Entra ID application details are entered on the screen.

    If the hc.conf.enc file is not present. Enter the following Microsoft Entra ID application details:

    Initialization dialog.jpg

    Initializing Service dialog with application details

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

    2. Redirect URI: Enter the redirect URI specified when registering the application. For example, https://localhost.

    3. Tenant ID: If the application is registered as a Single tenant application, enter the tenant ID (GUID). Otherwise, leave this field blank. For example, 9c1cfc28-1ec6-44ea-bec6-e3492ef0cd16.

    4. Cloud Type: Commercial is selected by default. Depending on your Microsoft Entra ID cloud environment, select one of the following options: Commercial, Custom, Germany, US_DoD, US_GCC, US_GCC_High, US_Sec, US_Nat, or China_01. If you select Custom, specify the following:

      • Protection Cloud URL: For example, https://api.aadrm.com

      • Policy Cloud URL: For example, https://dataservice.protection.outlook.com

    5. Enable Federal Information Processing Standards (FIPS) Mode: Select this option to use FIPS-compliant encryption algorithms. When enabled, Microsoft Purview Information Protection (MPIP) uses only FIPS-compliant encryption algorithms. When disabled, MPIP uses standard encryption algorithms. If this option is not enabled during installation, you can enable it later by modifying the registry. For more information, refer to section “Registry Settings”.

  14. If the hc.conf.enc file is present.

    Initialization dialog without application details.jpg

    Initializing Service dialog without application details

    The installer automatically reads the Microsoft Entra ID application details from the hc.conf.enc file. As a result, the Microsoft Entra ID application fields are disabled and appear empty. Only FIPS Mode can be enabled or disabled.

  15. Click Next.

  16. Once the initialization is complete, the following success message appears.  

    Completing the HaloCAD for Viewers setup dialog.png

    Initialization completed dialog

  17. Click Close to close the installation wizard.

  18. After installation, a shortcut icon Viewer Icon.png is created on the desktop. It is also loaded on the startup menu.

  19. To launch the application, double-click the HaloCAD_Viewers icon or navigate to All apps > HaloCAD_Viewers from the Start menu. The startup dialog appears, as shown below.

    Viewers Startup dialog.png

    Viewers Startup dialog

    Note: The Viewers application starts automatically after a system restart or new login session; if it is already running, double-clicking the HaloCAD_Viewers icon displays the message “HaloCAD for Viewer already running.”

  20. After you log in to the HaloCAD session and complete authentication through the Microsoft Sign-In Assistant, you can access the following log files:

    1. HaloCAD logs at %AppData%\Roaming\Secude\HaloCAD\viewers\halocad.log

    2. MIP SDK logs at %AppData%\Roaming\Secude\HaloCAD\viewers\mip\logs\mip_sdk.miplog

Silent Mode

In addition to Graphical Mode, HaloCAD for Viewers supports Silent Mode installation. Silent Mode installs the application without displaying a user interface or requiring user interaction, making it suitable for automated installations.

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

  2. Navigate to the directory that contains the installer.

  3. To display the available Silent Mode options, run the following command:
    Type HaloCAD_Viewers_Shield_Setup.exe -help
    Press Enter
    Output
    ...
    HaloCAD_Viewers_Shield_Setup.exe [-install [-viewersshield] [-dir <destination_directory>]
    [<ApplicationID> <Redirect URI> <TenantID/Name> <Cloud Type ("Commercial"|"Custom"|"Germany"|"US_DoD"|"US_GCC"|"US_GCC_High"|"US_Sec"|"US_Nat"|"China_01"|"")> [(if Custom) <Protection Cloud Url> <Policy Cloud Url>] [-enablefipsmode <true|false>]
    For Silent Mode Installation if ENC file already exists in the same location
    HaloCAD_Viewers_Shield_Setup.exe [-install [-viewersshield] [-dir <destination_directory>] [-enablefipsmode <true|false>]]
    HaloCAD_Viewers_Shield_Setup.exe [-uninstall -silent <true|false>]

  4. The following example installs the add-on by using the Microsoft Entra ID application details.
    HaloCAD_Viewers_Shield_Setup.exe -install -viewersshield -dir "C:\Program Files\Secude" v6ca776-c74e-437d-98ef-662ecb5751tt https://localhost 9c1cfc28-1ec6-44ea-bec6-e3492ef0cd16 Commercial -enablefipsmode true

  5. The following example installs the add-on by using the hc.conf.enc file located in the same directory as the installer.
    HaloCAD_Viewers_Shield_Setup.exe -install -viewersshield -dir "C:\Program Files\Secude" -enablefipsmode true

  6. Press Enter.

  7. Installation is complete.

Via System Center Configuration Manager

Microsoft System Center Configuration Manager (SCCM) enables organizations to deploy operating systems and applications across enterprise-managed Windows devices.

Using SCCM, administrators can deploy the HaloCAD Add-on silently to multiple target computers across the enterprise.

Before You Begin

  1. Review the prerequisites described in the Graphical Mode section.

  2. Follow your organization's best practices when creating an SCCM deployment.

  3. For information about configuring SCCM, refer to the Microsoft documentation.

Deployment Using SCCM

This procedure assumes that your SCCM environment is already configured. Use the Silent Mode command-line options described in the previous section to create and deploy the installation package through SCCM.

Registry Settings

HaloCAD stores configuration settings in the Windows registry. This section describes the registry entries that can be configured. Do not modify any other settings.

Prerequisite: Back up the registry before making any changes, in case you need to restore it later.

Modify the Registry

To modify a registry value:

  1. Open Registry Editor.

  2. Navigate to the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Secude\HaloCAD for Viewers

  3. Locate the registry key that you want to update.

  4. Modify the value as required.

Name

Default Value

Type

Description

log_enable

on

REG_SZ

Defines the status of the log.

  • On — A log file is generated in the default location.

  • Off — A log file is not generated.

  • Clean — Log files are deleted. This parameter deletes only the logs and does not change the log_enable value from "On" or "Off" to "Clean".

log_level

3

REG_SZ

Log level information is logged in the halocad.log file.

  • Error—0. Logs error events that prevent program execution.

  • Record—1. Records all details about the application's behavior.

  • Warning—2. Logs unexpected exceptions that indicate potential problems.

  • Information—3. A standard log level that highlights the progress of the application.

  • Verbose—4. Debug events are logged.

  • Verbose 1—5. Debug 1 events are logged.

  • Verbose 2—6. Debug 2 events are logged.

  • Verbose 3—7. Debug 3 events are logged.

  • Verbose 4—8. Debug 4 events are logged.

log_purge

7

REG_SZ

It indicates the removal of files older than a defined time frame. By default, log files older than 7 days are deleted.

log_rollover

100

REG_SZ

Defines the log rollover interval, that is, a new log file is generated after the specified number of minutes. By default, a new log file is generated every 100 minutes.

mipallowpii

false

REG_SZ

Enable or disable the visibility of Personally Identifiable Information (PII) such as email addresses and IP addresses in the MIP SDK logs.

  • true — PII is visible in clear text in the MIP SDK logs.

  • false (default) — PII is masked with asterisks in the MIP SDK logs, helping to protect PII confidentiality.

enable_fips

false

REG_SZ

Enable or Disable FIPS Mode

  1. true: MPIP uses only FIPS-compliant encryption algorithms.

  2. false: MPIP uses standard encryption algorithms.

Registry value

Next Steps

HaloCAD for Viewers has been successfully installed and initialized in your environment. You may now proceed to open protected files using the supported CAD Viewer applications. For additional information, please refer to the “Operating Instructions.”

Operating Instructions

This section outlines key operational procedures for working with HaloCAD for Viewers.

How does it work?

At a high level, HaloCAD for Viewers operates as follows:

Viewer-01.png

HaloCAD for Viewers

  1. The user launches the CAD viewer application, after which HaloCAD loads and displays the message “Protected files can be loaded.” The user then selects two files protected by HaloCAD.

  2. The first time you sign in, HaloCAD prompts you to sign in using Microsoft Sign-In Assistant.

  3. The user is permitted to open File 1 with view-only access.

  4. File 2 does not open because the user does not have the required permissions.

How to Open a Protected File in HaloCAD for Viewers?

Prerequisite: Ensure that HaloCAD for Viewers is installed.

  1. Open a supported CAD viewer application, such as Teamcenter Visualization Base.

  2. HaloCAD for Viewers loads automatically whenever a viewer application is launched, and the following message appears.

    Protected files can be loaded.png

    Protected files can be loaded

  3. Click OK.

  4. Open a HaloCAD-protected file using File > Open. When you log in to a HaloCAD session for the first time, you must connect to Microsoft Purview Information Protection. As a result, the HaloCAD Microsoft sign-in window prompts you to enter your credentials to start a new session.

    Microsoft Sign-In Assistant invoking message.png

    Microsoft Sign-In Assistant invoking message

  5. Click OK. Enter your credentials.

    Microsoft Sign in1.png

    Authentication sign-in dialog

  6. After successful authentication, HaloCAD connects to the Microsoft Entra tenant configured during initialization.
    Result: The file opens in view-only mode.

User Reset

After logging in to a HaloCAD session, the credentials are cached for easier access to Microsoft Purview Information Protection. To clear the cached credentials, select Show hidden icons on the taskbar, right-click the Secude icon, and select User Reset.

User Reset.png

User Reset button

Restrictions When Using Viewers

When you launch a viewer application, HaloCAD for Viewers starts automatically and enforces the permissions assigned to the protected file. The following sections describe the restrictions and warning messages displayed when you attempt to perform restricted actions.

Copy Data

If you try to copy data by pressing Ctrl+C, HaloCAD blocks the operation and displays a warning message.

copy error message.png

Warning message for the copy action

Capture a Screenshot

If you try to capture a screenshot by pressing Print Screen (PrtScn) or using the Snipping Tool, the displayed data is blanked out.

With view-only rights, you can view the content but cannot print it. If you try to print the file by selecting Print > Microsoft Print to PDF, a warning message appears.

Print action error message.png

Warning message for the print action

Export, Save, or Edit a File

With view-only rights, you can view the content but cannot export, save, or edit the file. If you try to export the file using options such as Export Image, save it using Save or Save As, or edit the file, a warning message appears.

Write error message.png

Warning message for the export action

Send a File by Email

With view-only rights, you can view the content but cannot send the protected file by email. If you try to send the file by selecting File > Send > Representation by E-mail, entering the details in the New Annotation Set dialog box, and clicking OK, or by selecting File > Send > Active View by E-mail, a warning message appears.

Representation by E-mail error.png

Warning message for the email action

Warning message in an unprotected file

After a HaloCAD-protected file is opened, HaloCAD for Viewers blocks exporting, editing, and emailing files for the duration of the active HaloCAD session, even for unprotected files. Therefore, complete any required editing before opening a HaloCAD-protected file.

Technical Support

Before Contacting Technical Support

Before contacting Technical Support, ensure that you have the following information available. Providing this information helps the support team investigate and resolve your issue more efficiently.

  • Full contact details

  • Product build version

  • Date, time, and description of the error (include screenshots, if possible)

  • Details of any third-party software used with the product

  • Any additional information required to reproduce the issue

Contact Technical Support

Secude provides technical support through email support@secude.com. When contacting Technical Support by email, include your company details, a detailed description of the issue, and the relevant log files (if available). A support representative will respond to your inquiry.

Additional Resources

Visit the Secude website https://secude.com to learn about upcoming events, press releases, and to download white papers.

Documentation Feedback

Secude values your feedback and continuously strives to improve product documentation. To provide feedback, send an email to: documentation@secude.com
Include the following details in your feedback:

  • Product name and version

  • Documentation topic

  • Description of the suggestion or error

The technical documentation team reviews all feedback and incorporates relevant updates in future documentation releases.

Appendix

This section provides supplemental information.

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 HaloCAD for Viewers are shown in the table below.

Third-party libraries

Uninstalling the HaloCAD for Viewers

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

Installer Version Requirement

When uninstalling the HaloCAD add-on, use the installer for the currently installed version, whether you run it by double-clicking the installer or from the command line. Using a different installer version may result in errors.

Method #1

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

  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 add-on.

  3. The HaloCAD installer checks the current user session for any supported CAD viewer applications running in the background and, if any are detected, displays the following message.

    Close all applications Viewers.png

    Uninstall Message #1

  4. Click OK and close all HaloCAD-supported CAD viewer applications.

  5. Redo step 1, and the following confirmation message appears.

    Uninstall message #1.png

    Uninstall Message #2

  6. Click Yes to confirm the uninstallation of HaloCAD from your computer.

    Uninstall message #2.png

    Uninstall Message #3

  7. The HaloCAD component has been successfully uninstalled. Click OK to close the dialog box.

Method #2 

The following is an example of uninstalling HaloCAD for Viewers using the command line.

  1. Open a command prompt.

  2. Navigate to the directory of the add-on installer.
    Example: HaloCAD_Viewers_Shield_Setup.exe -uninstall -silent true

  3. The uninstallation process is complete.


Last updated: