Using the dt command line tool

Contents[Hide]

1. Overview

The dt 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 (Terminal on Linux) and navigate to the tools folder. The default location of this folder on Windows is:

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

On Linux:

/usr/share/dundas/bi/Files/{InstanceName}/tools

On Windows, type dt followed by a command, and on Linux, type ./dt.sh followed by a command.

For example, type dt help or ./dt.sh help to get the help page for this tool.

DT tool
DT tool

Each command has further help, which you can view by adding typing the command name after help.

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

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\Instance1\tools>dt help setConfigValue

DT tool
DT tool

3. Commands

3.1. resetAdminPassword

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

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

3.2. setConfigValue

Use this command to set a configuration value.

For more details, see 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 application database stored in dbi.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

3.9. manageExtensions

Use this command to manage extensions.

Example:

  • To view the list of extensions (custom extensions display Resource in the IsResource column):
dt manageExtensions List

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:
Phone: 9am-6pm, ET, Mon-Fri
Email: 7am-6pm, ET, Mon-Fri