UBC DATA BRIDGE
Documentation
Practical guides to your first workflow, ETL, APIs, Agent, connectors, execution, access and examples.
Your first workflow
Connect → transform → validate → run.
02Configure APIs
Inbound requests, outbound calls, publishing and access.
03Configure Agent
Windows, macOS, Linux, resources and diagnostics.
04Flow editor capabilities
Parameters and rules for every documented block.
05Launch from another application
A button, wizard, parameters and execution states.
Getting started
UBC Data Bridge 2.1.1: data exchange, APIs, private-network resources and controlled workflows.
↗UBC Data Bridge capabilitiesFrom a data source to a validated result in one visual flow.
↗Your first flowStep by step: upload a table, select rows and produce a file.
↗Core conceptsSource, connection, block, flow, draft and run are distinct system objects.
↗Architecture
System components and responsibilities, independent of implementation languages.
↗Engine and performanceHow the system executes a graph, controls resources and prepares writes.
↗Deployment optionsA standalone product or integration with UBC Analytics; online and offline distributions.
↗Metadata and file storageWhat is stored in the database, what is stored as files and how isolation works.
↗Workflows and execution
Find flows, connections and sources, and work with folders and editing locks.
↗Flow designerCanvas, blocks, ports, properties and intermediate-result analysis.
↗Drafts and ProductionEditing, autosave, simulation and publication of a working version.
↗Running, validation and resultsHow to read statuses and avoid duplicates after a failure.
↗A launch button on another websiteRun a flow from a corporate portal: purpose, URL-based embedding, statuses and the interactive wizard.
↗Schedules and automated jobsStart by time, interval or a source change.
↗Sources and connectors
How to turn a file into a stable table for a flow.
↗File ManagerManaged files, versions, folders and retention settings.
↗Remote file storageConfigure Google Drive, OneDrive, S3, FTP/FTPS and a network drive.
↗Working with connectionsA shared procedure for creating, testing and using service access.
↗Reading and writing databasesTables, queries, keys and insert/update modes.
↗REST API and ODataResources, formats, response pages and row delivery.
↗Microsoft Dynamics 365Connection settings, required fields and usage rules.
↗1C:Enterprise 8 (local server)Connection settings, required fields and usage rules.
↗Microsoft SQL ServerConnection settings, required fields and usage rules.
↗Azure SQL DatabaseConnection settings, required fields and usage rules.
↗Oracle DatabaseConnection settings, required fields and usage rules.
↗IBM Db2Connection settings, required fields and usage rules.
↗PostgreSQLConnection settings, required fields and usage rules.
↗MySQL / MariaDBConnection settings, required fields and usage rules.
↗ClickHouseConnection settings, required fields and usage rules.
↗RedisConnection settings, required fields and usage rules.
↗ODBC data sourceConnection 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 botConnection settings, required fields and usage rules.
↗API configuration
Choose an API direction, prepare access, publish a flow and verify the complete exchange cycle.
↗Receiving data and files through the APIConfigure an inbound endpoint, field validation, a Production flow, idempotency and delivery tracking.
↗Reading from and sending to external APIsConfigure a REST connection: authentication, response parsing, pagination, batch writes and retry controls.
↗Publishing flow data through the APIPublish a dataset with filters, pagination, freshness checks or execution on demand.
↗API clients, keys and request signingGive an external system controlled flow access and verify its key, HMAC signature and permissions.
↗API technical reference and verificationGenerate the current endpoint reference from its settings, give integrators access and verify the contract.
↗Agent configuration
Connect UBC Data Bridge to private network resources, register an Agent and manage its access throughout its lifecycle.
↗Agent on Windows: installation and configurationInstall the Windows service, register it securely, grant folder access, verify connectivity and maintain the Agent.
↗Agent on macOS: installation and configurationInstall the Agent on a Mac, register it, configure service permissions and network volumes, and manage updates.
↗Agent on Linux: installation and setupPrepare Linux, connect Agent to Data Bridge, grant folder access and check that the service works.
↗Agent: resources, permissions and networkingConfigure allowed folders, databases and APIs, proxy authentication, trusted certificates and the route to Data Bridge.
↗Agent: diagnostics and troubleshootingFind the cause of Agent failures, check networking and permissions, retry file operations safely and prepare a useful support report.
↗Blocks and transformations
Blocks for processing, interaction, flow calls, APIs and result delivery.
↗FileReads a registered file source or writes to its range.
↗ConnectionA single block for business systems, databases, file storage and external APIs.
↗Field ordering and visibilityKeeps the required fields and changes their order and names.
↗Unpivot columnsConverts a wide table of periods into “period — value” rows.
↗Column mappingBuilds a new table from selected columns and constant values.
↗FilterKeeps rows that meet the specified conditions.
↗GroupingGroups rows by keys and calculates aggregates.
↗Run parametersA user form and constant values that control execution.
↗UnionCombines the rows of several tables into one dataset.
↗JoinAdds fields from other tables using shared keys.
↗DeduplicationKeeps the required occurrence of each key, or only keys that occur once.
↗RoutingDistributes rows between conditional branches, including by reference data.
↗SplitterPasses the entire table to several branches at the same time.
↗Calculated fieldsAdds calculations for numbers, text, dates and conditions.
↗Choose a file during executionCompatibility with saved flows that upload a file at this step.
↗Data previewA review table during execution and a way to end a branch without writing.
↗Data exportCreates an Excel, CSV, TXT, JSON, XML or SQLite file.
↗Text transformationSequential cleansing and standardisation of text fields.
↗Unique identifierAdds a GUID, Snowflake ID or sequential number.
↗Number and date formatsRecognition, normalisation and formatting of numbers and calendar values.
↗Data cleansing and quality controlRules for replacement, row rejection and stopping on quality errors.
↗Enrich with a single-row tableAdds the measures from a single auxiliary row to every row of the main table.
↗Transpose rows and columnsSwaps the rows and columns of a table.
↗MessageDisplays a notification or dialog during user-driven execution.
↗Choose an optionA manual user decision that activates one branch.
↗Merge branchesContinues one of the alternative branches that executed.
↗Set field valuesConditionally changes existing fields and adds new ones.
↗EmailSends emails through a configured email connection.
↗Telegram messageSends messages and attachments through a bot.
↗Role and userAdds current UBC Analytics role and user values.
↗Formula function referenceAll functions in the documented version: signatures, purpose and examples.
↗File transferCopy and move files and folders between File Manager and connected storage.
↗Route by launch methodSeparate branches for a manual start, inbound API and Workspace button.
↗Call flowsStart the Production versions of one or more other flows with parameters and data.
↗Receive data from flowAn 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 flowA declared output returned to the calling subflow block.
↗API input dataA source block for external request data and files: formats, fields, keys, validation and simulation.
↗API data publicationA branch-ending block that publishes a flow result with parameters, filters and an execution mode.
↗IBM Planning Analytics
How UBC Data Bridge works with TM1, which objects are available and how to choose an integration scenario.
↗Creating and testing a TM1 connectionREST address, network access, certificates and five authentication methods.
↗CAM, SSO and the user's own sessionHow UBC Data Bridge login, Cognos and TM1 access with personal permissions work together.
↗Corporate login and background runsA saved account for automated flows, the Cognos gateway and login constraints.
↗Reading cubes and public viewsIBM source settings, output columns, consolidations and volume limits.
↗Dimensions, hierarchies and attributesHow to export IBM reference data with structure, weights and repeated element occurrences.
↗Subsets and IBM element parametersSelecting a dimension element in the run form and using its value in destinations.
↗Mapping rows to TM1 cellsDimensions, constants, mapping tables, aliases and duplicate-coordinate handling.
↗Writing to a cube: validation, batches and resultsWhat is checked before writing and how to handle confirmed or uncertain results.
↗Cube clearing and transactional additionAddition, replacement, controlled clearing and cube updates driven by form-save events.
↗TurboIntegrator processes and automationSelecting a TI process, parameters, simulation, IBM status and the distinction from Chores.
↗A launch button in IBM Planning Analytics WorkspaceConnect a book through a URL: Data Bridge and PAW setup, styling examples, statuses and the report-update wizard.
↗Administration
A unified access model for local login, OIDC, IBM CAM and UBC Analytics.
↗UBC Analytics integrationEnvironments, workspaces, forms, cubes and launch buttons.
↗Import, export and migrationHow to move flows, sources and connections between environments.
↗Diagnostics and common errorsFrom an error message to checking a specific block.
↗Licensing and installation healthActivation, validity period and checking system operation.
↗About this documentationUsing UBC Data Bridge 2.1.1 documentation, examples and illustrations.
↗Workflow examples
A practical progression from a simple CSV import to writing into IBM Planning Analytics.
↗01. Convert CSV to JSONRead a semicolon-delimited sales file, preserve column names and produce JSON for the next integration.
↗02. Excel: months from columns to rowsPrepare a wide Excel budget template for loading into a model with a period dimension.
↗03. JSON: extract an array of nested recordsTake the data.items array from JSON and create a flat CSV with a consistent column order.
↗04. XML: product catalog to ExcelSelect repeating XML elements, use the id attribute as the code and write the catalog to Excel.
↗05. Normalize codes and remove duplicatesNormalize product codes to one spelling and retain the last record for each code.
↗06. Sequential quality rulesCorrect missing values and negative quantities, replace Excel errors and reject rows containing unacceptable text.
↗07. Revenue and regional totalsCalculate revenue for each sale and prepare a summary table by region.
↗08. Join: sales with a price referenceJoin prices to sales by a numeric key while retaining rows with no price.
↗09. Union: combine branch dataCombine two sales datasets into one table by column names, even when their order differs.
↗10. Route large ordersSplit orders into priority and regular orders by amount, with a separate file for each branch.
↗11. Route using a limits referenceCompare a request amount with its department's individual limit rather than a single constant for everyone.
↗12. Filter with a run parameterLet the user choose a region and minimum amount without editing the flow itself.
↗13. SQL: select open ordersRead a limited set of SQL records with one SELECT query and create a verification CSV.
↗14. SQL: upsert product reference dataUpdate an existing product by its sku key and add a missing product to a training SQL table.
↗15. REST API: orders from a JSON responseRead an API resource, extract the data.items array, retain open orders and produce Excel.
↗16. IBM Planning Analytics: export a public viewRead a public IBM Planning Analytics cube view and pass it to a tabular report.
↗17. IBM Planning Analytics: Excel budget to cubeUnpivot months in a budget workbook and write four values to a training cube with explicit mapping of every dimension.
↗18. IBM Planning Analytics: run TurboIntegratorStart one training TI process with a fixed year and a scenario chosen in the execution wizard.
↗19. Manual scenario selection and branch mergingLet 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 TelegramFind orders with a negative amount and send a concise report to a control group through two channels.
↗