Pricing Try it now
Community Edition
Getting Started Documentation Guides
Architecture API FAQ
On this page

SENTIENT v3.3.x upgrade instructions for Windows

Upgrading SENTIENT to 3.3.4.1

Doc info icon

NOTE:

These upgrade steps are applicable for SENTIENT version 3.3.4. In order to upgrade to 3.3.4.1 you need to upgrade to 3.3.4 first.

SENTIENT package download

Download SENTIENT installation file for Windows: sentient-windows-3.3.4.1.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.

  • Compare and merge your old SENTIENT configuration files (from the backup you made in the first step) with new ones.

Start the service

1
net start sentient

Upgrading SENTIENT to 3.3.4

Doc info icon

NOTE:

These upgrade steps are applicable for SENTIENT version 3.3.3. In order to upgrade to 3.3.4 you need to upgrade to 3.3.3 first.

SENTIENT package download

Download SENTIENT installation file for Windows: sentient-windows-3.3.4.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.

  • Compare and merge your old SENTIENT configuration files (from the backup you made in the first step) with new ones.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\sentient>upgrade.bat --fromVersion=3.3.3

Start the service

1
net start sentient

Upgrading SENTIENT to 3.3.3

NOTE: These upgrade steps are applicable for SENTIENT version 3.3.2. In order to upgrade to 3.3.3 you need to upgrade to 3.3.2 first.

Doc info icon

Important note before upgrading to SENTIENT 3.3.3

SENTIENT UI was migrated to Angular 12. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 12.

SENTIENT package download

Download SENTIENT installation archive for Windows: sentient-windows-3.3.3.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.
  • Compare and merge your old SENTIENT configuration files (from the backup you made in the first step) with new ones.

  • Finally, run upgrade.bat script to upgrade SENTIENT to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\sentient>upgrade.bat --fromVersion=3.3.2

Start the service

1
net start sentient

Upgrading SENTIENT to 3.3.2

NOTE: These upgrade steps are applicable for SENTIENT version 3.3.1. In order to upgrade to 3.3.2 you need to upgrade to 3.3.1 first.

SENTIENT package download

Download SENTIENT installation archive for Windows: sentient-windows-3.3.2.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.
  • Compare your old SENTIENT configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <SENTIENT install dir>\conf\sentient.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade SENTIENT to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\sentient>upgrade.bat --fromVersion=3.3.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the SENTIENT.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for SENTIENT. If other applications use Redis, you need to locate the SENTIENT database and flush only that. The default database index is 0, configurable with REDIS_DB SENTIENT environment value.

redis-cli

select 0

flushdb

1
net start sentient

Upgrading SENTIENT to 3.3.1

NOTE: These upgrade steps are applicable for SENTIENT version 3.3.0. In order to upgrade to 3.3.1 you need to upgrade to 3.3.0 first.

SENTIENT package download

Download SENTIENT installation archive for Windows: sentient-windows-3.3.1.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.
  • Compare your old SENTIENT configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <SENTIENT install dir>\conf\sentient.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade SENTIENT to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\sentient>upgrade.bat --fromVersion=3.3.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the SENTIENT.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for SENTIENT. If other applications use Redis, you need to locate the SENTIENT database and flush only that. The default database index is 0, configurable with REDIS_DB SENTIENT environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the SENTIENT.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for SENTIENT. If other applications use Redis, you need to locate the SENTIENT database and flush only that. The default database index is 0, configurable with REDIS_DB SENTIENT environment value.

redis-cli

select 0

flushdb

1
net start sentient

Upgrading SENTIENT to 3.3

NOTE: These upgrade steps are applicable for SENTIENT version 3.2.2. In order to upgrade to 3.3 you need to upgrade to 3.2.2 first.

SENTIENT package download

Download SENTIENT installation archive for Windows: sentient-windows-3.3.zip.

SENTIENT service upgrade

  • Stop SENTIENT service if it is running.
1
net stop sentient
  • Make a backup of previous SENTIENT configuration located in <SENTIENT install dir>\conf (for ex. C:\sentient\conf).

  • Remove SENTIENT install dir.
  • Unzip installation archive to SENTIENT install dir.
  • Compare your old SENTIENT configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <SENTIENT install dir>\conf\sentient.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • If you were using MQTT over SSL instead of default MQTT, please make sure you have a proper configuration (sentient.yml) of ports/addresses:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
transport:

. . .

  # Local MQTT transport parameters
  mqtt:
    # Enable/disable mqtt transport protocol.
    enabled: "${MQTT_ENABLED:true}"
    bind_address: "${MQTT_BIND_ADDRESS:0.0.0.0}"
    bind_port: "${MQTT_BIND_PORT:1883}"

. . .

    ssl:
      # Enable/disable SSL support
      enabled: "${MQTT_SSL_ENABLED:true}"
      # MQTT SSL bind address
      bind_address: "${MQTT_SSL_BIND_ADDRESS:0.0.0.0}"
      # MQTT SSL bind port
      bind_port: "${MQTT_SSL_BIND_PORT:8883}"
  • Finally, run upgrade.bat script to upgrade SENTIENT to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\sentient>upgrade.bat --fromVersion=3.2.2

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the SENTIENT.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for SENTIENT. If other applications use Redis, you need to locate the SENTIENT database and flush only that. The default database index is 0, configurable with REDIS_DB SENTIENT environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the SENTIENT.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for SENTIENT. If other applications use Redis, you need to locate the SENTIENT database and flush only that. The default database index is 0, configurable with REDIS_DB SENTIENT environment value.

redis-cli

select 0

flushdb

1
net start sentient