This guide will cover how to configure and manage the ODX server.
- Install and Configure the ODX Server Service
- Connect to the ODX Server
- Add Data Storage
Structure of an ODX
The ODX server sits in the middle of it all and copies data from data sources to a data
storage, which can both be on-premise or in the cloud, and, when requested by Discovery
Hub, on to modern data warehouses.
For storing metadata about sources and storages as well as the tasks it needs to run, the
server uses a local backlog that is continuously synced with the cloud repository. In the
cloud repository, the ODX server connects to a project. Each ODX server has one project
open at a time and two ODX servers should never use the same project.
ODX is a client/server solution. The server runs as a service with no GUI. Once initial setup
has been completed, management and administration of the server happens through the client, the ODX manager. It is part of the TimeXtender software package and resides on the
To get data from the ODX, you add the ODX server in TimeXtender. You
can then search for data from all the sources in the ODX and drag-and-drop the tables to
your data warehouses. The ODX server will then copy the data from the data storage to the
data warehouse on execution.
Set-up ODX Server
Download & Install ODX Server
To install and configure the ODX Server, you will need the following:
- Download TimeXtender ODX Server
- When the file has been downloaded, unzip the installation package and run Setup.exe.
- The last page of the installation wizard, ensure Configure ODX Server is selected, and click Finish.
Configure the ODX Server Service
If you completed the Installation, without running the ODX Server Configuration, you can lauch the configuration wizard from "C:\Program Files\TimeXtender\<ODX Version>\ODXServerConfiguration.exe".
- At the start of the wizard, will be presented with the Welcome page, Click Next.
- If your server is behind a Proxy Server, configure your proxy settings, otherwise, leave as default and click Next.
- Find your Client Secret in the TimeXtender Portal. If you don't already have an ODX Instance, click Add, to create one. Then copy the secret.
- Enter your Client Secret into the wizard and click Next.
- Create a new project, or select an existing and click Next. Only one ODX server service should be connected to the same ODX project at once.
- The port number and maximum concurrent execution tasks can be left as default unless you have a reason to customize them. Click Next.
- Enter the ODX Admin and User Passwords and click Next.
- When connecting to the ODX from the TimeXtender Desktop application, one of the above passwords will be required. Using the same password for both with provide Admin access.
- The User Password: Only allows you to select and transfer data from the ODX to a TimeXtender Data Warehouse, but not configure a data storage or data sources
- The Admin Password: Provides user access as well as configure a data storage and data sources.
- Define the encryption method used to encrypt your ODX metadata such as data source connection strings etc. The defuault encryption method is recommended. If you decide to generate your own encryption key (16-32 characters), make sure to store the secret in a safe place since we cannot help you retrieve a lost secret. Click Next.
- Specify the windows or Active Directory account you want to run the ODX Server Service. This account's credentials will be used to connect to any SQL Servers using "windows authentication". The user account needs to have the appropriate access on these servers. Specify the account or use the Local System Account and click Next.
- Save your settings and start the ODX Server Service. Click Save.
Connect to the ODX Server
If you have not Set-up the TimeXtender desktop application you may do so now.
If you have already set-up TimeXtender, please continue below:
Before connecting to the ODX Server in TimeXtender, ensure the ODX Server Service is currently running.
- In the Tools menu, click Options, then click the ODX Server tab in the window that appears. Please note, if you just started the ODX Server service it can take up to 20 minutes for the server to initialize. You will be unable to set up the ODX Server in TimeXtender until it has initialized.
- In the Name box, type a name for the ODX server.
- In the Server box, enter the ODX server's address. If it is installed locally, use localhost
- In the Port box, enter the port number if it is different from the default.
- In the Password box, enter either the Admin Password or the User Password configured above. Click OK.
- You should now see the ODX server listed in the Solution Explorer in TimeXtender.
**The ODX server you add by following the steps above is your primary ODX server. If you open a project that uses data from another ODX server, that server will be displayed in the Solution Explorer in TimeXtender as a secondary ODX server.
Add Data Storage
The ODX Server only supports one storage option at a time, either a SQL Server database or an Azure Data Lake.
Adding SQL Server Storage
- In the Manage ODX Servers window, right-click an ODX Server and click Add SQL Server Data Storage.
- Name: Type the name you want to use for the storage
- Server: enter the address of the SQL server you will be using.
- Database: enter the name of the database. If you want to create a new database, make sure the authentication options below are correct and then type a name for the database and click Create.
- Select authentication (Windows or SQL Server). Please note, SQL Server Authentication is required when using an Azure SQL Database.
- Click OK to have the storage option added
Adding Azure Data Lake (Gen2) Storage
For additional information on adding and synchronizing data sources, please view this section in the User Guide.