COURSE OVERVIEW

Photo of Triangle Shape Digital Wallpaper

Training Module:

Portal

Web-based configuration and administration of your Instances, Data Source connections, and User Access

Geometrical Illustration

Table of ContentS

  • Prerequisites & Concepts
    • Prerequisites
    • Sign-In or Sign-up Free
    • Anatomy of a TimeXtender Data Estate
    • What’s an Instance?
    • Client-Server Setup
  • Create & Manage Instances
    • Add ODX Instance
    • Add MDW Instance
    • Add SSL Instance
    • (optional) Edit Instance
    • (optional) Delete Instance
  • Add Users
    • (optional) Add Users (Instance User Access)
  • Add Data Sources
    • Add Data Source: SQL Server
    • What is AdventureWorks?
    • (optional) Add Data Source: CSV
    • (optional) Add Data Source: Excel
    • (optional) Add Data Source: REST API
    • Map Data Sources
  • Install & Configure: TimeXtender Desktop and ODX Server
    • Install ODX Server
    • Install TimeXtender Desktop
    • Create ODX & MDW Storage
    • (optional) Firewall
  • Multiple Environments
    • What are Multiple Environments?
    • (optional) Add, edit, or delete an Environment
    • (optional) Transfer Instance move metadata


Geometrical Illustration

Prerequisites & Concepts

Prerequisites & ConceptS

To complete this module you will need to have a data storage resource such as On-Prem SQL Server, Azure SQL Database or Data Lake Storage Account.

Sandbox

For a quick and easy way to set up SQL Server Developer edition for TimeXtender for non-production use, create a sandbox.

OR

Reference Architecture

If you already have a SQL environment ready, or ​would prefer a more production-ready ​environment please review and configure one of ​our preferred reference architectures: On-Prem ​SQL Server, Azure SQL Database or Azure ​Synapse Dedicated SQL Pool.

Sign-in or Sign-up Free

To access the TimeXtender Portal, simply go to app.TimeXtender.com and sign-in.

But what if I don't already have an account?

Partners

  • As a Partner, you get free access to the Premium tier. Check your inbox for an invitation.
  • If you don't already have access, reach out to your solution specialist or company admin to get partner-level access.
  • If you don't know your solution specialist or company admin, email support@timextender.com

Customers

  • If you don't already have access, reach out to your partner or company admin to get user access to your customer account.

Sign-up Free

Anatomy of a TimeXtender data estate

1. The ODX Server

Windows-based server software installed on a centrally located physical or virtual machine. This software orchestrates the ingestion of data from various sources. This separates data movement from the desktop software, while ensuring data never leaves a user's environment.

2. The ODX Storage

A SQL database or Azure Data Lake where raw data is stored after ingestion from sources. By storing data in its raw form, it can be used for later analysis, or retrieval.

3. The MDW Storage

A SQL Database or Synapse Dedicated SQL Pool where data from multiple sources is cleansed, transformed, and consolidated into a single version of truth.

4. SSL Endpoints

A subset of related data combined into a single model or "mart". This model can be exported to multiple endpoints such as Power BI, Qlik, Tableau, Analysis Services, or CSV.

5. TimeXtender Portal

A web portal handling the administration of your TimeXtender Data Estate. Instances hold the storage connection details as well as maintain the configuration information implemented in TimeXtender Desktop.

6. TimeXtender Desktop

Windows-based Desktop-client software where each instance can be configured & implemented through a single, integrated user-interface.

What's an Instance?

Instances are the metadata components of your TimeXtender Data Estate.


  • They store the connection info to the associated target storage.
  • They contain the metadata for how this area of TimeXtender is configured. (e.g. What tables are selects in an ODX Data Source, What relations & transformations exist in your MDW, etc.)
  • They maintain versioning, so each individual instance can be rolled back a previous version.
  • Any instance can be copied to another instance of the same type. Allowing you to migrate your instance configuration to another storage type or environment.
  • All credentials entered into the portal are protected with 256-bit AES encryption.
Brushstroke Arrow Smooth Curve Down Small

Client-Server Setup

When working in a sandbox environment, the Desktop and Server software can be installed, run, and controlled all from the same machine.


However, in production-ready setups, multiple concurrent users are necessary. Ideally, each client runs their own local instance of TimeXtender Desktop and connect remotely to the ODX Server.


Please note: With a client-server setup, the ODX Server IP Address or Hostname must be "reachable" by each client machine.

Server software should be installed on a centrally located server, so it can be controlled by multiple clients.

Each TimeXtender user should install and use TimeXtender Desktop on their own "client" machine

Geometrical Illustration

Create Instances

Add odx instance

This is the Username and Password created when you set up SQL Server in your Sandbox.

(the default System Administrator account Username is SA)

Circle Pin Icon
White Circle Vector
Cute Organic Light Bulb
  1. Click Data Estate > Instances
  2. Click Add Instance > Add ODX
  3. Enter Instance Name and Description
  4. Storage Info
    1. Select Storage Type > SQL database storage
    2. Enter Server Name: localhost
    3. Enter Database Name: ODX Dev
    4. Enter Username: SA
    5. Enter Password
  5. ODX Server Connection info
    1. Enter IP or Hostname: localhost
  6. Click: Save
Circle Pin Icon
White Circle Vector
Cute Organic Light Bulb

It is not necessary for the database to exist at this point. We will have TimeXtender create them later.

This is the IP Address or Hostname of the machine where the ODX Server software is running. See Client-Server Setup above...

Circle Pin Icon
White Circle Vector
Cute Organic Light Bulb

Add MDW instance

  1. Click Data Estate > Instances
  2. Click Add Instance > Add Data Warehouse
  3. Enter Instance Name and Description
  4. Storage Info
    1. Select Storage Type > SQL database storage
    2. Enter Server Name: localhost
    3. Enter Database Name: MDW Dev
    4. Authentication > SQL Server Authentication
    5. Enter Username and Password
  5. Click: Save

This is the Username and Password created when you set up SQL Server in your Sandbox.

(the default System Administrator account Username is SA)

Circle Pin Icon
White Circle Vector
Cute Organic Light Bulb
Circle Pin Icon
White Circle Vector
Cute Organic Light Bulb

It is not necessary for the database to exist at this point. We will have TimeXtender create them later.

Add SSL instance

  1. Click Data Estate > Instances
  2. Click Add Instance > Add Semantic Model
  3. Enter Instance Name and Description
  4. Add an Endpoint
    1. Endpoint Type > CSV Endpoint
    2. Click: Add
    3. Enter Name: CSV Endpoint
    4. Enter Directory: C:\SSL
    5. Enter File Extension: CSV
  5. Click: Save
Geometrical Illustration

Add Users

Users can be added here in the portal and mapped to a specific instance. When these users log into TimeXtender Desktop, they will only be able to access the instances which they have been mapped to.

Add User

  1. Click: Admin > Users
  2. Click: Add
    1. Enter First/Last Name & Email
    2. Click: Add

map User

  1. Data Estate > Instances
  2. Select an Instance
  3. Scroll to the bottom and click: Grant Access
  4. User > Select Desired User
  5. Click: Grant

ADD USERs (Instance User Access)

OPtional

Geometrical Illustration

Add Data Sources

Add Data Source: SQL Server

Required (Training Exercises use this data source)

Data Source Connections are added and stored here in the portal. They can then be easily copied and/or mapped to an ODX Instance for later configuration in TimeXtender Desktop.

All credentials entered into the portal are protected with 256-bit AES encryption.

  1. Click Data Estate > Data Sources
  2. Click: Add Data Source
  3. Choose Data Source > TimeXtender SQL Data Source
  4. Enter Name and Description
  5. Enter Server: txtraining.database.windows.net
  6. Enter Database: AdventureWorks
  7. Authentication > SQL Server Authentication
  8. Enter Username: txlogin
  9. Enter Password: TimeXtenderRocks!
  10. Check the box for Trust server certificate
  11. Click: Add

What's adventureWorks?

This training uses the AdventureWorks sample database. For training purposes, we host a fully managed version of this database which you can access with the below connection details:

  • Server: txtraining.database.windows.net
  • Database: AdventureWorks
  • SQL Server Authentication
  • Username: txlogin
  • Password: TimeXtenderRocks!


You may also download and explore your own copy of the database from Microsoft here:

AdventureWorks sample databases.

Cursor Click Icon

AdventureWorks is a commonly used sample dataset that closely represents common online transactional processing (OLTP) systems. It is based on a fictitious manufacturer and distributor of bicycles, outdoor equipment, and apparel. In this training we will perform common extract, transform, and load (ETL) techniques on this data. To become more familiar with the dataset, click to expand and explore the AdventureWorks entity relationship diagram.

Add Data Source: CSV

OPtional

To learn more about data source connections, please check out Connect to CSV Data Sources.

  1. Click Data Estate > Data Sources
  2. Click: Add Data Source
  3. Choose Data Source > CSV
  4. Enter Name and Description
  5. In Schema Section change Row Scan Depth: 0
  6. In the Connection section enter URI: File Path
  7. Click: Add

Add Data Source: Excel

OPtional

To learn more about data source connections, please check out Connect to Excel Data Sources.

  1. Click Data Estate > Data Sources
  2. Click: Add Data Source
  3. Choose Data Source > Excel
  4. Enter Name and Description
  5. In the Connection section enter URI: <your file path>
  6. Change Row Scan Depth: 0
  7. Add values to the fields, as needed, Authentication, Azure Authentication, and Data
  8. Click: Add

Add Data Source: Rest API (JSON)

OPtional

JSON, XML, CSV, and SOAP are supported connection types, with the RESTful API data source connections. To learn more about data source connections, please check out Connect to REST API Data Sources.

  1. Click Data Estate > Data Sources
  2. Click: Add Data Source
  3. Choose Data Source > REST
  4. Enter Name and Description
  5. Enter URI: https://gorest.co.in/public-api/users
  6. Enter Custom URL Params: access-token=U7-PD71mEXzfmdDm3uvpUTWzfDgZWsZTxRW1
  7. Change Row Scan Depth: 0
  8. Click: Add

MAP Data Source

By Mapping a Data Source to an ODX instance you are specifying which ODX should be allowed to connect and transfer this source data. This will be useful later when you have multiple ODX instances.

  1. Click Data Estate > Instances
  2. Click: ODX Dev
  3. Scroll to Mapped Data Sources section and click: Add
  4. Data Source > Adventure Works
  5. Click: Add
Geometrical Illustration

Install & Configure:

TimeXtender Desktop and ODX Server

Install ODX Server


  2. Open the file and launch setup
  3. Follow prompts with default settings
  4. Choose: Typical Setup
  5. Check: Launch Configure ODX Server
  6. Click: Finish
  7. Sign in to the portal
  8. Instances > ODX Dev
  9. Continue with default settings
  10. Click: Save
Download Icon

Download ODX Server

Install TimeXtender desktop


  2. Open the file and launch setup
  3. Follow prompts with default settings
  4. Click: Finish
Download Icon

Download TimeXtender

Create ODX & MDW Storage

  1. Launch TimeXtender
  2. Login

create storage

  1. Double-Click: ODX Dev Instance
  2. Right Click: ODX Dev Instance> Edit Instance
  3. Click: Create Storage
  4. Continue with Default Settings
  5. Click: OK
  6. Double-Click: Instance MDW Dev
  7. Right Click: Instance MDW Dev > Edit Instance
  8. Click: Create Storage
  9. Continue with Default Settings
  10. Click: OK

In this step you will have TimeXtender create the database (or data lake container) you specified when you created the instance in the portal.

Configure Firewall

OPtional

firewall

For more information and troubleshooting tips, please check out Configure Your Firewall.

TimeXtender Desktop

ODX Server

Additional Servers

Instance databases:

  • sql-instances-prod.database.windows.net
  • Server is outside Azure (On-Prem):
    • Port 1433 standard for SQL Server
  • Server is Inside Azure (cloud):
    • Port range 11000-11999

Updating CData components:

  • api.timextender.com
  • Port 443
  • auth0.com
    • Port 443


  • eu.auth0.com
    • Port 443


  • cdn.auth0.com
    • Port 443


  • app.timextender.com
    • Port 443


  • app-encryption-prod-001.azurewebsites.net
    • Port 443


Client secret authentication, data sources provider download and updates:

  • traws.timextender.com
  • Port 443

If using Azure Data Lake Storage

  • <storage account name>.dfs.core.windows.net
  • Port 443


Sign-in to Desktop, ODX configuration

  • timextender-saas.eu.auth0.com
  • Port 443

If using Azure Data Factory Data Sources

  • management.azure.com
  • Port 443


Ensure that inbound rules are added for the ports used for the ODX instances

Geometrical Illustration

Multiple Environments

multiple enviRoNmentS

What are Multiple ENvironments?

TimeXtender supports multiple environment deployments that allow developers to create separate environments for development, testing, and production. These environments can be comprised of separate instances that can then be related to one another.

For example, a common configuration is to use three (3) environments, representing Development, Testing/User Acceptance, and Production, (a.k.a “Dev, Test, Prod”). By using three environments, we experience several benefits.


  1. Development (“dev”) is where developers build the solution, and may have many requests or work items to work on, at any given time. When the features or improvements to the data estate are “completed”, the work is “promoted” to the Test Environment.
  2. Testing (“test”) is where the prod-ready version of the data estate is tested by the developers, consultants, or QA Engineer. This ensure that a deployment to Production will be smooth for the users, and that all features are STILL working as expected. Documentation is a good idea at this stage, if not already done.
  3. Production (“prod”) is undisturbed by building and testing, by planning new deployments at low usage times during the “business week”. This is to allow Data Users to have an uninterrupted access to reports and analytics.

create New enviRoNment in Portal

  1. Open www.app.timextender.com in your web browser.
  2. After successfully logging in select Environments from the drop down menu on the top right.
  3. Click on Add Environment
  4. In the pop-up fill in the Name, Description, and select the instances to be added in the environment.
  5. Once the instances are added you can view them in the environment page.
  6. Click Add


Transfer instances

  1. To promote the changes, select the arrow next to the instance containing the changes that are to be promoted.
  2. In the To dropdown select the instance where the changes needs to transferred to.
  3. Click Transfer

WARNING: Only tasks relating to one ODX instance can be added to a job. In other words, tasks from different ODX instances cannot be added to the same job.


For more information on tasks, see Multiple Environments.

Section Quiz...

Planning to take the Solution Architect exam? Then you want to be sure these questions are easy to answer.

What are the 6 components of a TimeXtender Solution?

What is a TimeXtender Instance?

How are my connection details kept private?

Brushstroke Arrow Smooth Curve Down Small

When you're ready, see Answers Below

Section Quiz Answers

Planning to take the Solution Architect exam? Then you want to be sure these questions are easy to answer.

What are the 6 components of a TimeXtender Solution?


  1. ODX Server
  2. ODX Storage
  3. MDW Storage
  4. SSL Endpoints
  5. TimeXtender Portal
  6. TimeXtender Desktop

What is a TimeXtender Instance?



The metadata components of a TimeXtender Data Estate.

How are my connection details kept private?



All credentials entered into the portal are protected with 256-bit AES encryption.

Congratulations! You've completed the training module

Portal

give FEEDBACK

Thumbs Up Illustration
Thumbs Up Illustration