Import, export and list all UI configurations
Available Sub Commands
delete
Delete an existing UIConfig if it is not in use by any Connections
Delete Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-n [ --name ] arg | The name of an existing UIConfig |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
export
Export an existing UIConfig to a file
Export Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-n [ --name ] arg | The name of an existing UIConfig |
-f [ --file-name ] arg | The name of a file that the UIConfig will be written into |
--force | Overwrite the destination file if it already exists |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
import-file
Import a UIConfig from a file
Import Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-f [ --file-name ] arg | The name of an existing file that contains the UIConfig |
--force | Overwrite the destination UIConfig if it already exists |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
list-all
List all UI Configurations
List All Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
show
Show the contents of an existing UI Config
Show Arguments
Argument | Description |
|---|---|
-h [ --help ] | Display this message |
-n [ --name ] arg | The name of an existing UI Config |
Metadata Repository Login Arguments
Argument | Description |
|---|---|
--meta-dsn arg | ODBC DSN of the metadata repository |
--meta-dsn-arch arg (=32) | The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified. |
--meta-user-name arg | Username for the ODBC DSN |
--meta-password arg | Password for the ODBC DSN |
--meta-database arg | Database used by the ODBC DSN |
--td-wallet | The supplied password will be treated as a TDWallet string |
--dimension-space arg | A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2). |
--index-space arg | A named area of the RDBMS to store the metadata (DB2 only). |
--meta-space arg | A named area of the RDBMS to store the metadata. |
--meta-index-space arg | A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL). |
--meta-con-string arg | ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$. |
--red-profile arg | Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use. |
UI Config Arguments
Argument | Description |
|---|---|
| -h [ --help] | Displays This message |
Common Arguments
| Argument | Description |
|---|---|
-c [ --config-file ] <arg> | A configuration file that contains program options (format is INI file) |
| -o [ --output-mode ] <arg> | Either human, json or xml. |
| -l [ --log-level ] <arg> | Log level, 0-5 inclusive. 0=only fatal errors, 5=all logging messages. |