System Configuration

The initial configuration settings on the System Configuration page can be updated at any time. This page also handles certificate and password management. You can set a password policy if necessary for your business environment, but it is not mandatory. 

System Configuration page

HaloENGINE Configuration  

Basic Configuration

Follow the steps below to update the basic HaloENGINE configuration:

1. Login admin portal.

2. On the left navigation bar, click System Configuration, and then on the HaloENGINE Configuration tab, click Configure. 

3. Update the following:

   1. Log level

   2. Path for HaloENGINE configuration files

   3. Path for HaloENGINE system log

   4. Retention period of HaloENGINE log 

   5. Retention period of Tomcat log

   6. Enable/disable remote access

4. To make basic configuration changes take effect, click Apply and then click Reload Configuration in the left navigation bar.

   

   HaloENGINE Configuration

   Results:

   1. The page will be directed to the login page once the reload is done.

   2. If any changes are made to Remote Settings, please restart the HaloENGINE Tomcat service.

Password Policy

HaloENGINE's password policy requires a minimum of 12 characters and a maximum of 30 characters to increase security. However, the length of a company's password policy is determined by security requirements, regulatory obligations, and industry best practices. Therefore, you can configure or update your length seamlessly on this page.

1. Select the Password Policy tab and enter the following details as shown in the figure below:

   

   Password policy configuration

2. Password minimum length − Enter the minimum number of characters required for your password. The default setting allows more than 12 characters.

3. Password maximum length − Enter the maximum number of characters required for your password. The default setting allows up to 30 characters.

4. No. of special character − Enter the number of special characters that should be included in your password. The default setting requires at least one special character. Note: If you set a Password Policy that includes more than one special character, you must input the password continuously. For example, if you set the No. of special character to 2, input them one after the other (for example, Pass234567!$). Entering special characters apart (for example, Pass!234567$) in the new password field will not be accepted.

5. Click Apply.

   Results:

   1. You will receive a confirmation message after successfully updating the password policy, followed by a warning message, “Please change your Password.”

   2. On the warning message screen, click Change Password. The Change Admin Password screen appears. Enter your current password, create a new password, and confirm it in the text boxes provided. For more details, please refer to the section “ Change Password ”.

   3. The admin portal will restart automatically, and you must enter a new password to access it. The current password cannot be reused."

Import/Export Configuration

Exporting the configuration is important because the exported configuration file can be imported during a new installation, allowing retention of existing settings, reducing the time and effort needed for reconfiguration, ensuring consistency across environments, and minimizing the risk of misconfigurations or errors.

Follow the steps below to update the import/export configuration:

1. On the left navigation bar, click System Configuration, and then on the Import/Export Configuration tab, click Configure. 

2. To import:

   1. Select either Upload with Certificate to import the configuration file along with the existing certificate, or Upload without Certificate to import the configuration file without the certificate.

   2. Click on the button and select the HaloENGINE-admin-config.zip file from the Open dialog box.

   3. Results: You can see the name of the zip file displayed on the page.

      

      Import Configuration

3. What to do next: Restart the HaloENGINE Tomcat service for the configuration update to take effect.

4. To export:

   1. Click Export Configuration and then click Export Config button.

   2. Please wait while the file HaloENGINE-admin-config.zip is downloaded.

CAD File Types Configuration 

Use this page to add a new CAD file extension that will enable encryption and decryption for CAD-compatible file formats.

To add a new file extension, follow the steps below:

1. On the left navigation bar, click System Configuration, and then on the CAD File Types Configuration tab, click Configure.

2. The CAD Filetypes page appears as shown in the figure below:

   

   CAD File Types Configuration

3. Option 1:

   1. To change the Creo Iteration of a file type from the existing list.

   2. Turn ON the Enable Creo Iteration slider for the file type. In this example, .iam is enabled with Creo Iteration.

4. Click Save. 

   Results: You can see a confirmation message after saving the file type. In the example below, the .iam row gets appended to the end of the list with Creo Iteration Enabled = true.

   

   Creo Iteration Enabled

5. Option 2: To add a new file extension.

   1. Click the plus icon and enter the file extension along with Creo Iteration Enabled = true/false status.

   2. Click Save. 

      Results: After saving the file type, a confirmation message appears, and the new entry is added to the list. Click Reload Configuration to apply the changes.

6. To find a file extension:

   1. Click Search File Extension. The Search File Extension page appears. 

   2. Enter the file extension in Search File Extension and click Search.

      Results: The results of the search will be automatically listed. You can manage the file extension using the Edit or Delete icon.

      

      Search File Extension

Download Logs

The HaloENGINE logs and Tomcat logs can be downloaded via the admin portal using the following procedure:

1. On the left navigation bar, click System Configuration, and then on the Download HaloENGINE/Tomcat Logs tab, click Configure.

2. The Download HaloENGINE/Tomcat Logs page appears as shown in the figure below:

   

   HaloENGINE and Tomcat logs

3. To download the HaloENGINE logs:

   1. Enter the number of days and then click Download HaloENGINE Logs. 

   2. Results: A zip file (HaloENGINE-Log) will be downloaded to the default download location.

4. To download the Tomcat logs:

   1. Enter the number of days and then click Download Tomcat Logs.

   2. Results: A zip file (tomcat-Log) will be downloaded to the default download location.

5. Please note that you can only enter the value within the range that is defined on the HaloENGINE Configuration page for HaloENGINE log retention and Tomcat log retention.

HaloENGINE Admin Activities Log 

Halochain scrutinizes the log file HaloENGINE_Admin_Activities.log for any modifications and shows the results.

1. On the left navigation bar, click System Configuration, and then on the HaloENGINE Admin Activities Log tab, click Validate.

2. The HaloENGINE Admin Activities Log page appears as shown in the figure below:

   

   Admin Activities log

3. Click Validate Logs.

   Results:

   1. You will receive the message “The log file has been validated and no manipulated entries found.”, if no manipulation is identified.

   2. If manipulation is detected, you will obtain the following output:

      

      Halochain output

Monitor Log Validation

Halochain is a powerful feature that scrutinizes audit log files such as HaloENGINE_Monitor.log and HaloENGINE_Admin_Activities.log for any manipulation.

Prerequisites:

1. Make sure that you have enabled Halochain in Monitor Properties. Please refer to the section “ Monitor Properties ”.

2. It is recommended to enable the Halochain feature during the initial configuration of the HaloENGINE. This is because Halochain is designed to work with a fresh HaloENGINE_Monitor.log file. In case you enable it at a later stage, you need to back up the HaloENGINE_Monitor.log file and then delete or empty the log file to start the validation.

Follow the procedure below to validate the audit log file: 

1. On the left navigation bar, click Customer Configuration, and then select the customer ID (halo_customer) from the list.

2. On the Monitor Log Validation tab, click Configure.

3. The Monitor Local Log Validation page appears as shown below:

   

   Monitor log validation

4. Click Validate Logs.

   Results:

   1. If no manipulation is detected, you will see the message: The log file has been validated and no manipulated entries found.

   2. The following output appears if manipulation is detected.

      

      Halochain output

Log Out

Logging out means terminating the current user's access to the portal. When the Log Out button is pressed, the portal is notified that the current user intends to terminate the login session.

A logged-in user's login session expires after 20 minutes. The user will no longer be able to use the portal after this period has passed. The user will be automatically logged out and redirected back to the login screen.

Change Password

You can change your password for security concerns by following the steps below:

1. Click Change Password in the top right corner.

   

   Change login password #1

2. The Change Admin Password dialog appears as shown in the figure below:

   

   Change login password #2

3. Enter the current password.

4. Enter your new password and re-enter again.

5. Click Save.

Reset Administrator Password 

Use the following procedure to reset, update, or change your administrator password.

1. Copy haloengine-password-config-<version>.zip file to the desktop and extract it. 

2. Open Command Prompt with administrator rights and change directory to haloengine-password-config-<version>\bin.

3. Type haloengine-password-config.bat -h to display the help information.
   For example:
   haloengine-password-config.bat -confPath <Full path of HaloENGINE config directory> -newPwd <new password for the login>
haloengine-password-config.bat -confPath "C:\Program Files\Secude\HaloENGINE\config" -newPwd TestHalo!2345