◫UBC Data BridgeDocumentation2.1.1
Product website Consultation

UBC DATA BRIDGE

Documentation

Practical guides to your first workflow, ETL, APIs, Agent, connectors, execution, access and examples.

Getting started

What's new in UBC Data Bridge 2.1.1

UBC Data Bridge 2.1.1: data exchange, APIs, private-network resources and controlled workflows.

↗
UBC Data Bridge capabilities

From a data source to a validated result in one visual flow.

↗
Your first flow

Step by step: upload a table, select rows and produce a file.

↗
Core concepts

Source, connection, block, flow, draft and run are distinct system objects.

↗

Architecture

System architecture

System components and responsibilities, independent of implementation languages.

↗
Engine and performance

How the system executes a graph, controls resources and prepares writes.

↗
Deployment options

A standalone product or integration with UBC Analytics; online and offline distributions.

↗
Metadata and file storage

What is stored in the database, what is stored as files and how isolation works.

↗

Workflows and execution

Libraries and organizing work

Find flows, connections and sources, and work with folders and editing locks.

↗
Flow designer

Canvas, blocks, ports, properties and intermediate-result analysis.

↗
Drafts and Production

Editing, autosave, simulation and publication of a working version.

↗
Running, validation and results

How to read statuses and avoid duplicates after a failure.

↗
A launch button on another website

Run a flow from a corporate portal: purpose, URL-based embedding, statuses and the interactive wizard.

↗
Schedules and automated jobs

Start by time, interval or a source change.

↗

Sources and connectors

File sources and ranges

How to turn a file into a stable table for a flow.

↗
File Manager

Managed files, versions, folders and retention settings.

↗
Remote file storage

Configure Google Drive, OneDrive, S3, FTP/FTPS and a network drive.

↗
Working with connections

A shared procedure for creating, testing and using service access.

↗
Reading and writing databases

Tables, queries, keys and insert/update modes.

↗
REST API and OData

Resources, formats, response pages and row delivery.

↗
Microsoft Dynamics 365

Connection settings, required fields and usage rules.

↗
1C:Enterprise 8 (local server)

Connection settings, required fields and usage rules.

↗
Microsoft SQL Server

Connection settings, required fields and usage rules.

↗
Azure SQL Database

Connection settings, required fields and usage rules.

↗
Oracle Database

Connection settings, required fields and usage rules.

↗
IBM Db2

Connection settings, required fields and usage rules.

↗
PostgreSQL

Connection settings, required fields and usage rules.

↗
MySQL / MariaDB

Connection settings, required fields and usage rules.

↗
ClickHouse

Connection settings, required fields and usage rules.

↗
Redis

Connection settings, required fields and usage rules.

↗
ODBC data source

Connection settings, required fields and usage rules.

↗
REST API (any HTTP service)

Connection settings, required fields and usage rules.

↗
Email (SMTP)

Connection settings, required fields and usage rules.

↗
Telegram bot

Connection settings, required fields and usage rules.

↗

API configuration

API: three directions of exchange

Choose an API direction, prepare access, publish a flow and verify the complete exchange cycle.

↗
Receiving data and files through the API

Configure an inbound endpoint, field validation, a Production flow, idempotency and delivery tracking.

↗
Reading from and sending to external APIs

Configure a REST connection: authentication, response parsing, pagination, batch writes and retry controls.

↗
Publishing flow data through the API

Publish a dataset with filters, pagination, freshness checks or execution on demand.

↗
API clients, keys and request signing

Give an external system controlled flow access and verify its key, HMAC signature and permissions.

↗
API technical reference and verification

Generate the current endpoint reference from its settings, give integrators access and verify the contract.

↗

Agent configuration

UBC Data Bridge Agent: getting started

Connect UBC Data Bridge to private network resources, register an Agent and manage its access throughout its lifecycle.

↗
Agent on Windows: installation and configuration

Install the Windows service, register it securely, grant folder access, verify connectivity and maintain the Agent.

↗
Agent on macOS: installation and configuration

Install the Agent on a Mac, register it, configure service permissions and network volumes, and manage updates.

↗
Agent on Linux: installation and setup

Prepare Linux, connect Agent to Data Bridge, grant folder access and check that the service works.

↗
Agent: resources, permissions and networking

Configure allowed folders, databases and APIs, proxy authentication, trusted certificates and the route to Data Bridge.

↗
Agent: diagnostics and troubleshooting

Find the cause of Agent failures, check networking and permissions, retry file operations safely and prepare a useful support report.

↗

Blocks and transformations

Designer block reference

Blocks for processing, interaction, flow calls, APIs and result delivery.

↗
File

Reads a registered file source or writes to its range.

↗
Connection

A single block for business systems, databases, file storage and external APIs.

↗
Field ordering and visibility

Keeps the required fields and changes their order and names.

↗
Unpivot columns

Converts a wide table of periods into “period — value” rows.

↗
Column mapping

Builds a new table from selected columns and constant values.

↗
Filter

Keeps rows that meet the specified conditions.

↗
Grouping

Groups rows by keys and calculates aggregates.

↗
Run parameters

A user form and constant values that control execution.

↗
Union

Combines the rows of several tables into one dataset.

↗
Join

Adds fields from other tables using shared keys.

↗
Deduplication

Keeps the required occurrence of each key, or only keys that occur once.

↗
Routing

Distributes rows between conditional branches, including by reference data.

↗
Splitter

Passes the entire table to several branches at the same time.

↗
Calculated fields

Adds calculations for numbers, text, dates and conditions.

↗
Choose a file during execution

Compatibility with saved flows that upload a file at this step.

↗
Data preview

A review table during execution and a way to end a branch without writing.

↗
Data export

Creates an Excel, CSV, TXT, JSON, XML or SQLite file.

↗
Text transformation

Sequential cleansing and standardisation of text fields.

↗
Unique identifier

Adds a GUID, Snowflake ID or sequential number.

↗
Number and date formats

Recognition, normalisation and formatting of numbers and calendar values.

↗
Data cleansing and quality control

Rules for replacement, row rejection and stopping on quality errors.

↗
Enrich with a single-row table

Adds the measures from a single auxiliary row to every row of the main table.

↗
Transpose rows and columns

Swaps the rows and columns of a table.

↗
Message

Displays a notification or dialog during user-driven execution.

↗
Choose an option

A manual user decision that activates one branch.

↗
Merge branches

Continues one of the alternative branches that executed.

↗
Set field values

Conditionally changes existing fields and adds new ones.

↗
Email

Sends emails through a configured email connection.

↗
Telegram message

Sends messages and attachments through a bot.

↗
Role and user

Adds current UBC Analytics role and user values.

↗
Formula function reference

All functions in the documented version: signatures, purpose and examples.

↗
File transfer

Copy and move files and folders between File Manager and connected storage.

↗
Route by launch method

Separate branches for a manual start, inbound API and Workspace button.

↗
Call flows

Start the Production versions of one or more other flows with parameters and data.

↗
Receive data from flow

An input for a subflow or process receiving a table from another flow.

↗
Call flow (subflow)

Reuse a flow as a function: an input table and a transformed output table.

↗
Return data to flow

A declared output returned to the calling subflow block.

↗
API input data

A source block for external request data and files: formats, fields, keys, validation and simulation.

↗
API data publication

A branch-ending block that publishes a flow result with parameters, filters and an execution mode.

↗

IBM Planning Analytics

IBM Planning Analytics: integration capabilities

How UBC Data Bridge works with TM1, which objects are available and how to choose an integration scenario.

↗
Creating and testing a TM1 connection

REST address, network access, certificates and five authentication methods.

↗
CAM, SSO and the user's own session

How UBC Data Bridge login, Cognos and TM1 access with personal permissions work together.

↗
Corporate login and background runs

A saved account for automated flows, the Cognos gateway and login constraints.

↗
Reading cubes and public views

IBM source settings, output columns, consolidations and volume limits.

↗
Dimensions, hierarchies and attributes

How to export IBM reference data with structure, weights and repeated element occurrences.

↗
Subsets and IBM element parameters

Selecting a dimension element in the run form and using its value in destinations.

↗
Mapping rows to TM1 cells

Dimensions, constants, mapping tables, aliases and duplicate-coordinate handling.

↗
Writing to a cube: validation, batches and results

What is checked before writing and how to handle confirmed or uncertain results.

↗
Cube clearing and transactional addition

Addition, replacement, controlled clearing and cube updates driven by form-save events.

↗
TurboIntegrator processes and automation

Selecting a TI process, parameters, simulation, IBM status and the distinction from Chores.

↗
A launch button in IBM Planning Analytics Workspace

Connect a book through a URL: Data Bridge and PAW setup, styling examples, statuses and the report-update wizard.

↗

Administration

Users, roles and permissions

A unified access model for local login, OIDC, IBM CAM and UBC Analytics.

↗
UBC Analytics integration

Environments, workspaces, forms, cubes and launch buttons.

↗
Import, export and migration

How to move flows, sources and connections between environments.

↗
Diagnostics and common errors

From an error message to checking a specific block.

↗
Licensing and installation health

Activation, validity period and checking system operation.

↗
About this documentation

Using UBC Data Bridge 2.1.1 documentation, examples and illustrations.

↗

Workflow examples

20 configured flows

A practical progression from a simple CSV import to writing into IBM Planning Analytics.

↗
01. Convert CSV to JSON

Read a semicolon-delimited sales file, preserve column names and produce JSON for the next integration.

↗
02. Excel: months from columns to rows

Prepare a wide Excel budget template for loading into a model with a period dimension.

↗
03. JSON: extract an array of nested records

Take the data.items array from JSON and create a flat CSV with a consistent column order.

↗
04. XML: product catalog to Excel

Select repeating XML elements, use the id attribute as the code and write the catalog to Excel.

↗
05. Normalize codes and remove duplicates

Normalize product codes to one spelling and retain the last record for each code.

↗
06. Sequential quality rules

Correct missing values and negative quantities, replace Excel errors and reject rows containing unacceptable text.

↗
07. Revenue and regional totals

Calculate revenue for each sale and prepare a summary table by region.

↗
08. Join: sales with a price reference

Join prices to sales by a numeric key while retaining rows with no price.

↗
09. Union: combine branch data

Combine two sales datasets into one table by column names, even when their order differs.

↗
10. Route large orders

Split orders into priority and regular orders by amount, with a separate file for each branch.

↗
11. Route using a limits reference

Compare a request amount with its department's individual limit rather than a single constant for everyone.

↗
12. Filter with a run parameter

Let the user choose a region and minimum amount without editing the flow itself.

↗
13. SQL: select open orders

Read a limited set of SQL records with one SELECT query and create a verification CSV.

↗
14. SQL: upsert product reference data

Update an existing product by its sku key and add a missing product to a training SQL table.

↗
15. REST API: orders from a JSON response

Read an API resource, extract the data.items array, retain open orders and produce Excel.

↗
16. IBM Planning Analytics: export a public view

Read a public IBM Planning Analytics cube view and pass it to a tabular report.

↗
17. IBM Planning Analytics: Excel budget to cube

Unpivot months in a budget workbook and write four values to a training cube with explicit mapping of every dimension.

↗
18. IBM Planning Analytics: run TurboIntegrator

Start one training TI process with a fixed year and a scenario chosen in the execution wizard.

↗
19. Manual scenario selection and branch merging

Let the operator approve or reject a set of requests and return to a shared export after the selected action.

↗
20. Exception notifications by email and Telegram

Find orders with a negative amount and send a concise report to a control group through two channels.

↗
Enlarged illustration