Stonebranch Documentation

website·Indexed 35 days ago

https://documentation.stonebranch.com

Technical documentation for Stonebranch products, including Universal Enterprise Controller (UEC) version 6.3.0, Universal Agent for SOA, and Universal Service Provider (USP) version 3.2. Covers installation guides for Windows, Linux (Debian and RHEL), and database setup for UDMG using MySQL, as well as detailed USBMJOB configuration parameters.

Tokens
2.9M
Snippets
8K
Records
24K
Agent score
47%

What's inside Stonebranch

  1. Overview of UDMG as Server Pipelines

    When UDMG acts as a Server, it exposes server Endpoints that allow external partners to initiate file transfers using their own clients or a web browser. Unlike Client Pipelines, which are triggered via API, Server Pipelines are triggered by external partner actions. All files received through these server Endpoints are stored on the Local Filesystem.
  2. Overview of Universal Extensions in UAC

    The Universal Extension subsystem allows developers to implement custom solutions (such as tasks, triggers, or monitors) that integrate deeply with the Universal Automation Center (UAC). Unlike Universal Tasks, Universal Extensions support:

    • Bidirectional Communication: Extension instances on an Agent can dynamically update the Controller (e.g., updating Job ID, Run Status, or Percentage Complete).
    • Dynamic Command Definitions: Extensions can provide commands to populate task definition form fields or perform instance-specific actions (e.g., 'Abort SAP job').
    • Dynamic Event Generation: Extensions can raise 'Universal Events' to trigger actions within the Controller.

    Universal Extensions are developed in Python by extending the UniversalExtension base class provided by Stonebranch.

  3. Overview of USP authentication methods

    Universal Process Store (USP) supports three authentication methods tailored for two different entity types: Users (Administrators accessing the USP Admin UI and REST API) and Accounts (Business partners transferring files).

    Available authentication methods include:

    • Standard Authentication: Uses usernames and passwords stored and managed directly within USP; no external identity provider is required.
    • LDAP Authentication: Authenticates against an external LDAP directory for centralized management. For Users, this supports Just-In-Time (JIT) provisioning and role mapping.
    • Single Sign-On (SSO): Authenticates via an external Identity Provider (IdP) using SAML or OIDC / OAuth 2.0. This method supports multiple providers, JIT provisioning, and role mapping, but is available for Users only.
  4. Overview of Universal Controller for Agent Management (UCAM)

    UCAM is a specialized version of the Universal Controller used to implement central license management for Universal Agents (version 6.9.0.0 or higher) used with 3rd-party scheduling solutions.

    Key capabilities include:

    • Implementing a single license key per environment (Production or Non-Production).
    • Centralized license management for Universal Command, Universal Data Mover, and Universal Connectors (SOA, SAP, and Peoplesoft).
    • Distribution of license keys to Universal Agents upon registration via an OMS server.
    • Tracking and displaying registered Agent status in a customizable dashboard.
  5. Overview of UDMG Server Command Line Interface (CLI)

    The udmg-server CLI is a set of administrative tools built into the server binary for local operations on the host where UDMG Server is installed. Unlike the Admin UI or REST API, the CLI operates directly against the server's configuration and database. Most commands require access to the UDMG Server Configuration File. It is intended for local administration and recovery, not as a remote client.
  6. Overview of UDMG SSO for User Authentication

    UDMG supports Single Sign-On (SSO) for User authentication in the Admin UI, acting as the Service Provider (SP). Each UDMG Domain supports a single SSO provider. Upon successful authentication, UDMG validates the token/assertion, verifies authorization, issues its own session tokens, and performs Just-in-Time (JIT) provisioning of Users.
  7. Overview of the CSV Tool Universal Extension

    The CSV Tool is a Universal Extension used to read, filter, and process input data in Comma-Separated Value (CSV), Delimited Separated Value (DSV), or Tab Separated Value (TSV) formats. It can save filtered data into new files of the same format or transform the data into JSON for use as extension output.
  8. Overview of the Universal Virtual Terminal Script (UNVVT) interpreter

    The Universal Virtual Terminal Script (UNVVT) interpreter is a general-purpose CL script interpreter designed for batch execution environments. It allows developers to script CL commands with support for variables, helper functions, and logical flow control. While it does not interact with a virtual terminal directly, it provides enhanced integration capabilities via the UNVVTSND command, making it suitable for scripting virtual terminal sessions.
  9. Overview of the File Compression Universal Extension

    The File Compression Universal Extension (ue-util-compress) allows users to compress and decompress files or directories to reduce file size. It supports AES-256 password encryption and integrates with 7-Zip (Windows/Linux), p7zip (Linux), and the Embedded (Linux) archiver.
  10. Overview of Universal Monitor Tasks

    The Universal Monitor task is used to monitor published Universal Events. To define a monitor, you must specify either a Global Universal Event Template or a Local Universal Template Event Template.

    Permissions Requirements:

    • The Execution User must have read permission for the published Universal Event.
    • When monitoring Pre-Defined Global Universal Events, the Execution User must also have read permission for the underlying record associated with the Universal Event.

    Monitoring Modes:

    • Continuous Monitoring: Assign the Universal Monitor to a Universal Monitor Trigger. The trigger fires every time the Universal Event match criteria are met.
    • Non-Continuous Monitoring: Add the Universal Monitor to a workflow or launch it as a stand-alone task. The task completes only when the Universal Event match criteria are met.