Skip to main content

Forward Proxy

The Forward Proxy provides a seamless way to automatically send collected data from your local environment to a centralized server. It is built to deliver data reliably and efficiently, ensuring that information reaches its destination without the need for constant manual handling.

With flexible configuration options, the system can be tailored to fit different workflows and requirements. By reducing manual intervention, it helps streamline operations, improve data consistency, and support timely decision-making across your organization.

Forward Proxy Configuration

Step 1: Open the CoreAPI Configuration Directory

  1. Go to the OpeniT CoreAPI Configuration directory.

    By default, this is in C:\Program Files\OpeniT\Core\service\openit_coreapi.

Step 2: Create or Open the Override File

  1. Create a copy of Forwarding.json.

  2. Rename the duplicate file to Forwarding.Override.json.

  3. If a Forwarding.Override.json file already exists, open the existing file instead.

Step 3: Provide the Server URL

  1. In the override file, update the value of the NewServerUrl where the data will be sent.

    Forwarding.json
    {
    "Forwarding": {
    "NewServerUrl": "http://server:port",
    "ValidateSslCertificate": true,
    "IncomingSaveDir": "incoming_save",
    "ScheduleCron": "*/5 * * * *",
    "MaxParallelism": 6,
    "MaxBatchSize": 1024,
    Example
    {
    "Forwarding": {
    "NewServerUrl": "https://WIN-HOST01:1234",
    "ValidateSslCertificate": true,
    "IncomingSaveDir": "incoming_save",
    "ScheduleCron": "*/5 * * * *",
    "MaxParallelism": 6,
    "MaxBatchSize": 1024,
  2. (Optional) You may also update the other data forwarding configurations as needed.

    Configuration KeyDescription
    ValidateSslCertificateUse this to determine whether the SSL/TLS certificate presented by the destination server is validated during connection.
    IncomingSaveDirUse this to specify the directory where incoming files are temporarily stored before processing.
    ScheduleCronUse this to specify the cron expression that defines how often the forwarding job runs. The default value is */5 * * * *, which means the job will run every 5 minutes.
    MaxParallelismUse this to specify the maximum number of concurrent forwarding operations. The default value is 6.
    MaxBatchSizeUse this to specify the maximum number of files included in a single batch for forwarding. The default value is 1024.
    Data Forwarding Configuration Settings

Step 4: (Optional) Modify Connection and Timeout Settings

  1. Update the connection and timeout-related settings in the configuration file as needed.

    Forwarding.json
    "HttpClient": {
    "RequestTimeoutMinutes": 5,
    "MaxConnectionsPerServer": 32,
    "PooledConnectionLifetimeMinutes": 10,
    "PooledConnectionIdleTimeoutMinutes": 2,
    "HandlerLifetimeMinutes": 15
    },
    Configuration KeyDescription
    RequestTimeoutMinutesUse this to specify the maximum time the system waits for a request to complete before it is canceled. The default value is 5 minutes.
    MaxConnectionsPerServerUse this to specify the maximum number of simultaneous connections allowed to a single server. The default value is 32.
    PooledConnectionLifetimeMinutesUse this to specify how long a connection can be reused before it is replaced with a new one. The default value is 10 minutes.
    PooledConnectionIdleTimeoutMinutesUse this to specify how long an unused connection stays in the pool before it is closed. The default value is 2 minutes.
    HandlerLifetimeMinutesUse this to specify the duration a connection handler is kept before it is recycled to refresh underlying connections and settings. The default value is 15 minutes.
    Connection and Timeout Settings

Step 5: (Optional) Enable Selective Forwarding

  1. Update the Selective configuration as needed to control which data is sent to the new server.

    Forwarding.json
       "Selective": {
    "Enabled": false,
    "ForwardBlocks": ["workstation"]
    }

    This is not enabled by default, and the default forward block is workstation. You can check the included TaskBlocks in the next section.

Step 6: (Optional) Modify TaskBlocks Settings

  1. Update the TaskBlocks configuration as needed to further refine which data is sent to the new server.

    Forwarding.json
       "TaskBlocks": {
    "workstation": [
    "upload_appusage_win_data",
    "upload_appusage_win_sum",
    "upload_appusage_win2_data",
    "upload_recorder",
    "upload_freezemonitor"
    ],
    "licenseserver": [
    "upload_licpoll",
    "upload_flexlogcollector"
    ]
    }

Step 6: Apply the Changes

  1. Save the changes in the configuration file.

  2. Open the Task Manager.

  3. Click Services.

  4. Restart the OpeniTCoreAPI service to apply the changes.