This guide will cover how to configure and manage an ODX server.
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 Discovery Hub software package and resides on the
Discovery Hub server.
To get data from the ODX, you add the ODX server on the Data tab in Discovery Hub. 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.
Complete the following steps to configure and manage the ODX Server:
- Install and Configure the ODX Server Service
- Connect to the ODX Server
- Add Data Storage
1. Install and Configure the ODX Server Service
Installing the ODX Server Service
To install and configure the ODX Server, you will need the following:
- The ODX Server installation package. The installation package can be downloaded from the support site at support.timextender.com. If you deployed Discovery Hub using the Azure Marketplace templates then it is already installed on your virtual machine and can be found at C:\Program Files\Discovery Hub\ODX Server.
- The client secret that is used to connect the ODX server to the cloud repository. Can be
found in the TimeXtender User Portal at portal.timextender.com/odx
- A user account for running the ODX server service if you need to connect to
SQL Servers using Active Directory authentication. The user account needs to have the
appropriate access to these servers.
Configure the ODX Server Service
1. Open the ODX Server Configuration exe file. You can find it at “C:\Program Files\Discovery Hub\ODX Server”. This will open a wizard to help you configure the server and set up and start the Windows service.
2. In Step 1 of the Wizard you will be asked for your Client Secret. You can find this by going to portal.timextender.com and clicking on the ODX tab. Once you have entered in your client secret, click Next.
3. In Step 2 of the wizard, add a new project name and click next.
4. In Step 3 of the wizard you are asked to specify a port number and maximum concurrent execution tasks. We recommend that you leave these at their default unless you have a reason to customize them. Click next.
5. In Step 4 of the wizard you are asked to create the ODX management password and the Discovery Hub connection password. Enter in this information and click
6. In Step 5 of the wizard you can enter an encryption secret that is used when the encryption key is generated. Make sure to store the secret in a safe place since we cannot help you retrieve a lost secret. Enter in your encryption secret (16-32 characters) or use the system default encryption and click next.
7. In Step 6 of the wizard you can specify what account you want to run the service as if you need to connect to SQL Servers using ActiveDirectory 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.
8. In Step 7 of the wizard you can save your settings and start the ODX Server Service. Click Save.
2. Connect to the ODX Server
Connecting to the ODX server in Discovery Hub allows you to manage the ODX. This is where you can add data storages, add data sources, and schedule executions and synchronize data sources. To copy data from a data source to the data storage, you start by connecting to the ODX Server. You then add a data storage and the data source. When this is done, you add a task to transfer data from source to storage. You can schedule executions of the task to have data copied automatically.
Before connecting to the ODX Server in Discovery Hub, ensure the ODX Server Service is currently running.
1. In the Tools menu, click Manage ODX Servers
2. In the Manage ODX Servers window, right-click ODX Servers and click Add ODX
2. In the Name box, type a name for the ODX server.
3. In the Server box, enter the ODX server's address.
4. In the Port box, enter the port number if it is different from the default.
5. In the Password box, enter the password for managing the ODX.
6. Click OK.
*When you close and later reopen Discovery Hub and the ODX manager, you will have to enter the password again.
3. 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
1. Adding SQL Server Storage1. In the Manage ODX Servers window, right-click an ODX Server and click Add SQL Server Data Storage.
2. In the Name box, type the name you want to use for the storage
3. In the Server box, enter the address of the Azure SQL Database you created earlier.
4. Select SQL Server Authentication and enter your SQL Server credentials.
5. Under Database type in ODX and then click This will create your ODX database where all of your raw data will be stored.
6. Click OK to have the storage option added
Adding Azure Data Lake Storage
Before connecting to the Azure Data Lake Storage for ODX in Discovery Hub, you need to register an application to access data lake services. Go to step 3 in this article, Create an Azure Data Lake Storage in ODX, to find out how to register an application in Azure Active Directory.
1. In the Manage ODX Servers window, right-click an ODX Server and click Add SQL Server Data Storage.
Account Name: Use the name of your Data Lake Store. The input only needs the name of the resource instead of the entire URL.2.
Name: type the name you want to use for the storage
Folder name: Type the name of the folder you want to create. This folder doesn’t have to be created in Data Lake Store in advance. The root folder is always Operational data eXchange and this folder name will be under that.
Analytics account name: Use the name of your Data Lake Analytics. This input only needs the name of the resource instead of the entire URL.
Tenant ID: This is the [Directory ID] found under properties of Azure Active Directory.
Application ID: Use the application you registered previously. The ID can be found under the registered app.
Application Key: Use the key you created under the application.
Analytics Unit: You pay for Analytics Units (AU) time used on your Azure subscription. Adding more AUs can increase performance on Incremental Load.
Where is this information in Azure?
|Analytics Account Name|
For additional information and to see how to add and synchronize data sources, please view the User Guide