Add an ODX Instance

Add an ODX Instance

ODX instances are added in the web interface just like data warehouse or semantic model instances.

Unlike data warehouses and semantic models, there are a few additional steps that need to be taken before an ODX instance can be opened in TimeXtender Desktop. The ODX service needs to be installed on a machine (the ODX server) and configured to use the ODX instance that has been created in the portal. For more information see Setup and Configure an ODX Instance. The hostname and port TimeXtender Desktop needs for connection are also part of the information you need to enter when you add an ODX instance.

To add an ODX instance go to the Add ODX instance page. If you're already signed in, then go to Data EstateInstances, click Add Instance, and then click Add ODX instance.


The 'add' form is structured into three sections - we'll take them one by one in the following.

Basic info

The first section is basic information that is - mostly - the same for all instance types.

  1. In the Name box, type the name you want to use for the data warehouse.
  2. In the Description box, type a description of the data warehouse. The description is displayed on the desktop and on the instance details page.
  3. (Optional) In the Log Retention Days box, adjust the number of days logs should be kept.
  4. In the Storage type list, select the type of storage you want to use. 
    • Azure Data Lake Gen2 (default)
    • Azure SQL Database, Azure SQL Managed Instance, SQL Database: The different SQL flavors come with the same set of required connection information. Note: SQL Server Authentication is required


Depending on the type of storage you selected, different fields will appear.

Azure Data Lake Gen2 storage

  1. In the Storage account box, enter the name of your Azure Storage Account.
  2. In the  Container name box, enter a name for the Azure Storage Container.
  3. In the Tenant ID box, enter the tenant ID, also known as the "Directory ID", that can be found under properties of Azure Active Directory.
  4. In the Application ID box, enter the ID of the App Registration created to provide access to the storage. This can be found here: Azure portal > Azure Active Directory > App Registrations.
  5. In the Application key box, enter the secret created for your App Registration.
  6. In the Connection Timeout and Command timeout boxes, you can adjust the timeouts for communicating with the Azure Storage account. The defaults are ideal for most situations but may need to be extended for slow connections or exceptionally long data transfers.
  7. Select Limit memory use when copying data to a data warehouse if you have issues with high memory consumption when you copy data to the data warehouse.
  8. Click Save.

SQL Server storage

  1. In the Server name box, type the name of the server that you want to store the database on. If it is a named instance, type the server name and the instance name.
  2. In the Server type list, select the type of the server. Currently, you'll only have to change this setting if you're using a dedicated SQL pool (previously known as SQL Data Warehouse).
  3. In the Database box, type the name of the database you want to use.
    Note: The first time you open the data warehouse on the desktop, you need to right-click the data warehouse instance, click Edit Instance... and click Create Storage...
  4. In the Username (SQL Server authentication) box, enter the username you will use for connection to the database. As the label implies, only SQL Server authentication is supported.
  5. In the Password box, enter the password used for authentication.
  6. (Optional) In the Connection timeout box, enter the number of seconds to wait before terminating the attempt to connect to the server. Set it to 0 to wait indefinitely.
  7. (Optional) In the Command timeout box, enter the number of seconds to wait before terminating a command. Set it to 0 to wait indefinitely.
  8. In the Batch size box, enter the number of rows to copy when using transfer. '0' equals unlimited.
  9. (Optional) In the Encrypt connection list, you can enable encryption of the connection, which is recommended when you are not in a private network (e.g. when your server is on Azure). You have the following options:
    • No: The communication is not encrypted (default).
    • Yes: The communication is encrypted. The server's certificate is verified by a certificate authority.
    • Yes, trust server certificate: The communication is encrypted. but the server's certificate is not verified. This setting is not recommended for use on public networks.
  10. (Optional) If you need a connection string with properties not found in the UI, you can enter it in the Additional connection properties box. It will override the data in the other boxes with connection information.
  11. Click Save.

Note: TimeXtender Desktop must be refreshed to retrieve the newly created ODX Instance


ODX server connection info

To use the ODX instance, an ODX server needs to be configured to run it. The information in this section is used for connecting to the ODX server from TimeXtender Desktop.

One ODX server can only host one ODX instance, so each ODX instance should have unique settings in this section.

  1. In the IP or hostname box, enter the name or IP of the machine where the ODX service is installed. In Azure, this is the Public IP address or DNS name defined for the VM. This will be used by TimeXtender Desktop to connect to the ODX, so make sure to use an IP or hostname that can be reached by other machines.  However, "localhost" can be appropriate for testing or development work.
  2. In the Port box, enter the port TimeXtender Desktop should use when connecting. Make sure to allow traffic to this port number in the host machine's firewall.

Firewall Rules

If the ODX Service is installed and running on a VM in Azure, create an inbound security rule in the VM network settings for the port which has been defined for the ODX instance in the portal. In the example below, we have an ODX instance with the following ODX server connection info properties:



 An inbound security rule is therefore created under Networking Settings for the VM in the Azure portal. 



Edit an ODX Instance

Home -> Data Estate -> Instances

1. Click on your instance, it will open a page with instance details
2. Click on Edit button, edit properties and Save

Note: TimeXtender Desktop must be refreshed to retrieve the latest changes for the ODX Instance.

Delete an ODX Instance

Home -> Data Estate -> Instances

1. Click on Delete button next to your instance.  The Delete dialog will be shown.
2. Enter the instance name to confirm, add a comment (reason) and click on Delete

Create ODX Storage

Before you can execute transfer tasks in an ODX instance, you must create the data storage. Right-click on the instance and select Edit Instance.

Next, select Create Storage... in order to create the storage for the ODX instance.
Was this article helpful?
0 out of 0 found this helpful


Please sign in to leave a comment.