Add ODX Instances

  • 29 December 2022
  • 0 replies
Add ODX Instances
Userlevel 3
Badge +3

Relates to TimeXtender 6024.1 and later versions

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. 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.

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 Estate > Instances, click Add Instance, and then click Add ODX instance.

Note: All connection credentials are protected with 256 bit AES encryption


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 ODX instance.
  2. In the Description box, type a description of the ODX instance. 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 DatabaseAzure SQL Managed InstanceSQL Database: The different types of SQL storage that can be selected all require the same set of connection information.

      Note: SQL Server Authentication is required for Azure SQL Database, Azure SQL Managed Instance or SQL Database


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

Azure Data Lake Gen2 storage:

SQL Server storage:

  1. In the Server name box, enter the name of the server that TimeXtender will use for the creation and storage of the ODX Instance database. For named SQL instances, enter the server name and instance name separated by a backslash: <ServerName>\<InstanceName>.
  2. From the Server type list, select the type of SQL server. Note that this setting currently only needs to be changed if you will be using an Azure Dedicated SQL pool, previously known as an Azure SQL Data Warehouse.
  3. In the Database box, type the name that you want the ODX Server to use when creating the ODX Instance database during the initialization phase of your data estate deployment. (The initialization steps are performed in the TimeXtender Desktop and are described in detail later in this setup guide.)
  4. In the Username (SQL Server authentication) box, enter the username that TimeXtender will use to connect to the database. Note that TimeXtender does not support Windows Authentication, so SQL authentication is required for connections to the SQL Server database. 
  5. In the Password box, enter the password that is associated with your SQL authentication username.
  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.

Note that the ODX Server does not need to be installed yet to complete this section, and these settings can be updated later, if necessary. 

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 or will be 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 is available on your network and can be reached by other machines. If you are installing TimeXtender using the Sandbox reference architecture, where all of the software and services are on the same system, then you may be able to enter "localhost" for the ODX Server name.
  2. Enter the port in the Port box. “20000” is the default port used by the ODX Server. Make sure to allow traffic to the specified port number in the host machine's firewall as well as any network firewalls that may be regulating traffic to the ODX Server.

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

Go to TimeXtender Portal  

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

Go to TimeXtender Portal  

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

Initializing the ODX Instance in the TimeXtender Desktop

Create ODX Storage

Before you can execute transfer tasks in an ODX instance, you must create the data storage.

In TimeXtender Desktop, open the ODX instance and then right-click on the instance and select Edit Instance.

Next, select Create Storage... in order to create the storage for the ODX instance.

Testing the Storage Connection

After you have created the storage, you can click Test Storage Connection to confirm it is available and ready for use. 


Create Storage Error

Error: Service request failed: Response status code does not indicate success: 403 (This request is not authorized to perform this operation using this permission)

This error may appear if a storage container has been manually created outside TimeXtender (i.e. within the Azure portal under the storage account resource). This error can be resolved by manually deleting the container within Azure, or by changing the storage container name within the TimeXtender portal. Then try to select Edit Instance and Create Storage...

0 replies

Be the first to reply!