Skip to main content
Skip table of contents

Installing the HaloCAD for Teamcenter

This chapter explains the requirements, prerequisites, and how to install HaloCAD for Teamcenter.

System Requirements

The following system requirements table specifies the minimum and recommended technical specifications, such as software and network resources, necessary to run the product.

Components

Details

Supported Operating System

Windows Server 2016 and above

Supported Teamcenter versions

  1. Teamcenter 13.x, 14.x

  2. Teamcenter 2312

Supported file types

  1. NX file types

  2. Creo file types

  3. PDF

  4. MS Office native file types

Other components

HaloENGINE and HaloENGINE Service

Requirements

Prerequisites

The following preparatory steps or conditions must be met before installing the product.

  1. Make sure you have administrative access before performing the most of system and dataset tasks.

  2. Make sure the client computer running the HaloCAD Add-on for NX or the HaloCAD Add-on for Creo can connect to the Teamcenter Server.

  3. Make sure your HaloENGINE complies with the requirements listed below:

    1. License file (enabled with TEAMCENTER system type).

    2. Proper action rules

    3. Client certificate (.JKS

  4. Make sure that the following system variables are set:

    1. Default_Transient_Server − The default transient file server location.

      • Default_Transient_Server=http://<host>:<port>/tc/fms

      • For example, Default_Transient_Server=http://tclu0310.secude.local:8080/tc/fms

    2. Fms_BootStrap_Urls – The FMS server that manages file downloads.

      • Fms_BootStrap_Urls=http://<host>:<port>/tc/fms

      • For example, Fms_BootStrap_Urls=http://tclu0310.secude.local:8080/tc/fms

  5. Make sure to have an entry in Credential Manager which will be used during the HaloCAD component configuration. To do so, go to Control Panel > User Accounts > Credential Manager > Manage Windows Credentials > Add a Generic Credential, enter all the required details, and save the entry.

  6. The credentials are stored in Windows Vault. The following figure shows a sample entry for the Credential Manager.

    Target Name.png

    Entry in Credential Manager

  7. Make sure to log in to Teamcenter using the service user in client SOA (which is added in Credential Manager), and we recommend that the user is assigned with “read” permission.

  8. If you want to implement a failover mechanism in HaloENGINE, please refer to the section “Failover Mechanism for HaloENGINE in HaloCAD for PLM”.

Installation Modes

You can install the HaloCAD component 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 HaloCAD component using command lines.

Graphical Mode

Install the HaloCAD component using the GUI-based setup program provided in the installation package.

  1. To begin the interactive installation, double-click the installer HaloCAD_Teamcenter_Setup.exe file. 

  2. Depending on your Windows security settings, you may get a warning such 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 continue the installation.

  3. When the installer starts, you will see the startup dialog followed by the welcome dialog:

    Startup Dialog.png

    Startup Dialog

    Welcome Dialog.png

    Welcome Dialog

  4. Click Next to continue the installation.

  5. The end-user license agreement dialog will appear: 

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

  7. The Tomcat memory pool size configuration dialog will appear:

    3_Tomcat pool size configuration dialog.png

    Tomcat pool size configuration dialog

  8. Enter the amount of memory you want to allocate to change the preset values for the Initial Memory Pool and Total Memory Pool. Note: Ensure that the Total Memory Pool does not exceed the System's available 3/4th RAM.

  9. Click Next. The destination folder selection dialog will appear:

    4_Destination Folder dialog.png

    Destination folder selection dialog

  10. By default, application files are stored in the program files directory (C:\Program Files\Secude\). If you would like to choose an alternate location, click the Browse button and select your location preference. Note: If HaloENGINE Service and/or HaloENGINE are already installed, you cannot change the destination folder. The browse button becomes disabled. Click Next to allow the Setup program to install the HaloCAD component.

  11. To return to any point in the installation process, click the Back button (optional).

  12. The Tomcat user credential dialog will appear:

    5_Tomcat User Credentials dialog.png

    Tomcat user credential dialog

  13. To configure the Tomcat service, enter the following details:

    1. If the computer is connected to a domain you need to enter a domain name first followed by the user name and password in the Tomcat User text box. For example, [Domain Name]\[User], SECUDE.TC\Admin.

    2. On a non-domain joined computer, you need to enter the machine name first followed by the user name and password in the Tomcat User text box. For example, [Machine Name]\[User], SECUDEdesk\Admin.

    3. Tomcat Port: The default port is 8383. You can, however, change the port number; it must be greater than 999 and less than or equal to 65535.

  14. The installation begins and progress is shown in the dialog.

    6_Installing Dialog.png

    Installation progress dialog

  15. When the installation is completed, you will see a message confirming that the HaloCAD component has been successfully installed.

    7_Installation completed successfully dialog.png

    Installation completed dialog

  16. Click Close to close the installation wizard.  

Post-Installation files:

The following files and directories can be found in both the default and user-specified installation locations:

  1. Configuration Tool—C:\Program Files\Secude\HaloCADTeamcenter\config\halocad-teamcenter-config-<version>.jar. This tool is explained in the next section “Configuring the HaloCAD Proxy”.

  2. Java-related files—C:\Program Files\Secude\secude-jre

  3. Tomcat Related files—C:\Program Files\Secude\Tomcat

  4. Log file—C:\Program Files\Secude\Tomcat\logs\haloproxy.log

Silent Mode

Besides graphical mode, the HaloCAD component can be installed in silent mode, which does not require user involvement or display a user interface. It is a convenient way to streamline the installation process using commands at once.  

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

  2. Navigate to the directory of the HaloCAD component installer.

  3. To know the list of options available in silent mode, follow the steps given below:
    Type HaloCAD_Teamcenter_Setup.exe -help
    Press Enter
    Output
    ...
    HaloCAD_Teamcenter_Setup.exe -help
    HaloCAD_Teamcenter_Setup.exe -install -initmempool <Initial memory pool size in MB(s).
    Minimum size is 128 MB> -totalmempool <Total memory pool size in MB(s).
    Maximum size is 3/4 of total RAM size.> -dir <destination_directory> -port <range_1_to_65535> -username <keep-empty-quotes> -password <user-domain-password>
    HaloCAD_Teamcenter_Setup.exe -uninstall

  4. The following command illustrates how to install the HaloCAD component.
    HaloCAD_Teamcenter_Setup.exe -install -initmempool 1024 -totalmempool 2048 -dir "C:\Program Files\Secude" -port 8383 -username "" -password "Sample@123"

  5. Press Enter.

  6. The installation is complete.

JavaScript errors detected

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

If this problem persists, please contact our support.