The HaloENGINE Tomcat Service communicates directly with the Microsoft Purview Information Protection service to fetch the MPIP labels. These labels are then available under the Protect option on the Action Rule page.
Any changes to labels in the Microsoft Purview portal require restarting the HaloENGINE Tomcat service.
If a MPIP label is added, removed, or modified in the Microsoft Purview portal, or if you change the service registry settings, the administrator must restart the HaloENGINE Tomcat service to ensure that the changes take effect. By doing this, labels are updated in and synchronized with the Microsoft Purview portal.
Configuration Tool
During installation, Azure details are provided to initialize the HaloENGINE Tomcat Service. After successful authentication, the labels are fetched automatically. To update MPIP-related details (such as the Application ID), use heslibconfig.exe.
Default locations of log files
|
Name |
Default Path |
|---|---|
|
HaloENGINE log |
|
|
Configuration tool |
|
|
MIP logs |
|
Default locations
To update your Azure details, follow the procedure below.
-
Open the Command Prompt with elevated rights (Run as Administrator).
-
Navigate to the directory where
heslibconfig.exeis located. -
To view the list of available options in silent mode, enter the following command:
Typeheslibconfig.exe -help
PressEnter
Output
Usage:
heslibconfig.exe -testmip
heslibconfig.exe -update -applicationid <application_id> -tenantid <tenant_id> -thumbprint <thumb_print> -cloudtype <(Commercial|Custom|Germany|US_DoD|US_GCC|US_GCC_HIGH|US_Sec|US_Nat|China_01) (if cloudtype is Custom) <protectioncloudurl> <policycloudurl> -
The following command illustrates how to update json file.
heslibconfig.exe -update -applicationid 9f0de2dd-8d49-4a3f-9676-bf4b6ff17d44 -tenantid 8c425ee7-352a-4657-ac77-7dc198712cb3 -thumbprint 961602617275c2ab538cf28bb3648c0c6d97edab -cloudtype Custom https://api.aadrm.com https://dataservice.protection.outlook.com -
A confirmation message appears stating that the configuration JSON file location has been successfully updated,
...\config\HaloENGINESVC.json
Configuration change in JSON File
After installation, navigate to the configuration folder...\HaloENGINEService\config, and you will find a JSON file that contains the HaloENGINE Tomcat Service configuration properties. Note: From the list of default parameters, only the parameters listed below should be modified, and only when necessary. All other parameters must remain at their default values to ensure proper system functionality and stability.
|
Name |
Description |
|---|---|
|
block_pii |
Enable or disable the visibility of Personally Identifiable Information (PII) in the MIP SDK logs.
|
|
cachetype |
MPIP cache storage type used by the service.
|
|
cacheuserlicense |
|
|
databoundary |
Audit and telemetry events are sent to the nearest collector, where these events are stored and processed. Other options:
For example, if your AIP administrator sets North_America, the HaloENGINE Tomcat Service forces all telemetry and audit data to go directly to North America. |
|
enabledke |
Double Key Encryption
Please be aware that DKE labels are only visible when DKE functionality is enabled. |
|
enablefiletracking |
To register a protected file to track and revoke.
|
|
enableminimaltelemetry
|
To transmit diagnostic information to Microsoft.
|
|
log_level |
The available log levels are ERROR, WARNING, INFO, and DEBUG. |
|
log_purge
|
It indicates removing files older than a defined time frame. By default, the log files older than 7 days will be deleted. |
|
streambuffersize |
It is a buffer size used for memory-based encryption with the MIP SDK. When the allotted buffer size is exceeded, an additional memory of stream buffer size is allocated, and this process is repeated until the encryption/decryption operation is completed. The default setting is 10MB. |
|
templatefile_purge |
Defines the purge time of template files that are generated for every CAD assembly file (compound file) download. The default value set is one hour. For example, when a file is downloaded at 15:25 hours, the HaloENGINE Tomcat Service creates a template file in the tmp\GUID folder (which can be located in the HaloENGINE Tomcat Service user's profile folder). In the background, it examines and deletes files that have reached the configured time, i.e., after 16:25 hours. Note: This is only applicable in the event of CAD assembly file labeling. |
HaloENGINE Tomcat service configuration
WinHTTP Proxy Settings
To allow MIP SDK to use the proxy settings set up in your environment, follow the steps below:
|
Determine whether the proxy server has been properly set up by running the following command.
If the response to the command is as shown above, it indicates that the proxy server has not been configured in the registry for WinHTTP. To configure the proxy server for WinHTTP, use the following command: Syntax: Example: In this case, the proxy server has been set up with |
|---|