Using the dt command line tool

Contents[Hide]

1. Overview

The dt.exe tool lets you perform various admin/configuration tasks from the command-line:

  • reset the admin password
  • run a health check on the application
  • change configuration settings
  • encrypt/decrypt the connection information

2. View the help page for dt

On the server where Dundas BI is installed, open a Command Prompt window and navigate to the tools folder. By default, this folder location is:

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\{InstanceName}\tools

In the command prompt window, type dt help to get the help page for this tool.

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>dt help
Dundas BI Tools version 5.0.1.0-20180601133452
Copyright (c) 2017 Dundas Data Visualization Inc. All rights reserved.

Type dt help <command name> for command description.

Commands:
dt help                    Type dt help  for command description.

dt createAppDb             Creates a new application database or initializes a previously-created empty application database.

dt createWarehouseDb       Creates a new data warehouse database or initializes an empty one created before.

dt scriptAppDb             Generates the application database creation script.

dt upgradeDatabases        Upgrades the application and warehouse databases.

dt resetAdminPassword      Resets the password for the built-in administrator account.

dt setConfigValue          Sets the global value of a configuration setting.

dt healthCheck             Performs an application health check.

dt reviveAppDb             Revives an application database containing only data.

dt reviveWarehouseDb       Revives a warehouse database containing only data.

dt connectionConfig        Encrypts or decrypts the connection information for the App DB stored in dundasBIConnection.config.

dt installLicense          Installs a license.

dt getExportConfigFile     Gets export configuration as a file.

dt export                  Exports application data into a DBIE file.

dt import                  Imports application data from a DBIE file.

dt deleteOldEntityData     Deletes old entity revisions.

dt generateViewThumbnails   Generates thumbnails for views which don't already have them.

Each command has further help, which you can view by typing: dt help <command>

For example, enter dt help setConfigValue to see the syntax for setting a configuration value.

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>dt help setConfigValue
Dundas BI Tools version 5.0.0.1000
Copyright (c) 2017 Dundas Data Visualization Inc. All rights reserved.

Sets the global value of a configuration setting.

Syntax:
dt setConfigValue [/appcs:<application database connection string>] [/appStorage:<application database server type>] /settingId:<setting identifier> /value:<new value>

<application database connection string> – The application database connection string. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. 
<application database server type> – The application database server type. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. Valid values: "SqlServer", "Postgres".
<setting identifier> – A string identifying the configuration setting. This may be the setting ID (in the case of core or extension settings), or for other settings, in the format "moduleId:settingName". The argument is mandatory. 
<new value> – The new value of the setting. The argument is mandatory. 

Example (To change the warehouse db connection string):
dt setConfigValue /appcs:"Data Source=localhost; Initial Catalog=DundasApp; Integrated Security=True" /appStorage:SqlServer /settingId:c6e739e5-a58a-49af-be1b-92b1f0fa62a2 /value:"abc"

3. Commands

3.1. resetAdminPassword

This command lets you reset the administrator password for Dundas BI.

For more details, see the article, How to reset the admin password.

3.2. setConfigValue

Use this command to set a configuration value.

For more details, see the article, Set a configuration value from the command line.

3.3. healthCheck

Perform a health check on the Dundas BI application and its databases with option to fix errors.

For more details, see the article Perform a health check using the command line.

3.4. connectionConfig

Encrypts or decrypts the connection information for the App DB stored in dundasBIConnection.config.

Examples:

  • To encrypt the application database connection string:
    dt connectionConfig encrypt
  • To decrypt the application database connection string:
    dt connectionConfig decrypt

3.5. export

Exports the application data into a DBIE file. 

Syntax:

dt export [/appcs:<application database connection string>] [/appStorage:<application database server type>] /ecf:<export configuration file> /dbie:<DBIE export file> [/report:<export report file>]
  • <application database connectionstring> – The connection string of the application database. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file.
  • <application database storage type> – The application database server type. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. Valid values: "SqlServer", "Postgres".
  • <export configuration file> – The export configuration input file. If not provided, the value will be read from standard input.
  • <DBIE export file> – The output DBIE export file (mandatory).
  • <export report file> – The output export file (optional).

Example:

dt export /ecf:"C:\temp\Export Configuration 1.json" /dbie:"C:\temp\Export 1.dbie" /report:"C:\temp\Export 1 report.txt"

3.6. getExportConfigFile

Generates the export configuration file.

Syntax:

dt getExportConfigFile [/appcs:<application database connection string>] [/appStorage:<application database server type>] /name:<export configuration name> /file:<export configuration output file>
  • <application database connectionstring> – The connection string of the application database. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file.
  • <application database storage type> – The application database server type. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. Valid values: "SqlServer", "Postgres".
  • <export configuration name> – The name of the existing export configuration (mandatory). To create an export configuration see Save Configuration.
  • <the export configuration output file> – The export configuration output file (mandatory). Will be created if does not exist or overwritten if exists.

Example:

dt getExportConfigFile /name:"Export Configuration 1" /file:"C:\temp\Export Configuration 1.json"

3.7. import

Imports application data from a DBIE file.

Syntax:

dt import [/appcs:<application database connection string>] [/appStorage:<application database server type>] [/dbie:]<DBIE export file> [/report:<import report file>]
  • <application database connectionstring> – The connection string of the application database. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file.
  • <application database storage type> – The application database server type. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. Valid values: "SqlServer", "Postgres".
  • <DBIE export file> – The input DBIE export file. If not provided, the value will be read from standard input.
  • <import report file> – The output import report file (optional).

Example:

dt import /report:"C:\temp\Import 1 report.txt"

3.8. deleteOldEntityData

Deletes old entity revisions.

Syntax:

dt deleteOldEntityData [/appcs:<application database connection string>] [/appStorage:<application database server type>] [/beforeDate:<before date>] [/entityIds:<entity IDs>] [/tenantIds:<tenant IDs>]
  • <application database connection string> – The application database connection string (optional). If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file.
  • <application database storage type> – The application database server type. If not specified, the value will be taken from the dbi.config file located in the App_Data folder specified in the dt.exe.config file. The argument is optional. Valid values: "SqlServer", "Postgres".
  • <before date> – Only revisions created before this date will be processed (optional). If not specified, all revisions will be processed. Parsed as local time.
  • <entity IDs> – A comma-separated list containing the IDs of entities to process (optional). If not specified, all entities will be processed.
  • <tenant IDs> – A comma-separated list containing the IDs of tenants to which the operation will be limited (optional). If not specified, all tenants will be included.

Example:

dt deleteOldEntityData /beforeDate:"2017-01-02 00:12:00" /entityIds:1b7c71af-4704-430c-b647-6046aa40728a,65f5f5ad-dfdb-4302-94ea-1593f1737456 /tenantIds:306fcf43-a2ad-4c99-b2db-27f89b7da895,c24e7c1b-0d53-4057-8f12-9318cf8e4935

4. See also

 

 

Dundas Data Visualization, Inc.
500-250 Ferrand Drive
Toronto, ON, Canada
M3C 3G8

North America: 1.800.463.1492
International: 1.416.467.5100

Dundas Support Hours: 7am-6pm, ET, Mon-Fri