Disclaimer

Your use of this download is governed by Stonebranch's Terms of Use.

Version Information

Refer to Changelog for version history information.

Overview

Beta DocX and Beta LogX together provide a comprehensive, enterprise-wide solution for the management, storage, and processing of documents and system logs. They enable centralized access, secure storage, audit-proof archiving, and intelligent handling of both high-volume documents and cross-platform log data. Beta DocX focuses on document management and output, including integration with SAP and mainframe systems, mass printing, and workflow-based document processing. Beta LogX provides centralized log management, full-text search for forensics, and compliance monitoring across diverse systems such as mainframe, Windows, Linux/Unix, and SAP applications.

The Beta UX Universal Task is a Beta UX integration that sends Task Instance logs into Beta LogX, enabling automated collection, processing, and enterprise-wide availability of job logs. Currently, this Universal Task only supports Beta LogX, but in the future it will also support Beta DocX, allowing seamless processing and archiving of both log data and documents through the same integration framework.

Key Features:

The Beta UX Universal Task sends the Task Instance details including any generated log files to Beta LogX.

• Execute a Beta UX Integration Process in Real-time

• Monitor a Beta UX Integration Process in Real-time

• Backlog Processing

How it works:

The log information for all Task Instances that meet specific selection criteria should be made available to Beta LogX in real time, once the Task Instance reaches a final state (either Finished or Success).

To achieve this, a Webhook must be configured in the Universal Controller. This Webhook triggers the Beta UX Universal Task for each Task Instance that meets the defined selection criteria.

In the example screenshot below, the task “BetaUX Import Task Instances to LogX” is triggered for every Task Instance that:

• Has a status of Finished or Success

• Is of type Windows Task

• Contains the value “logx” in Custom Field 1

These criteria are provided as examples; any other selection criteria can be configured according to your requirements.

The Screenshot below shows the configured Webhook example:

Open

Webhook Example

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task and a script that contains the Beta UX integration script to be executed.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

Supported Actions

Action: Execute Beta UX Logx Integration Process

This action allows the execution of an Integration Process in Beta UX. An Integration Process is a workflow that automates the movement and transformation of data between different systems using a series of connected steps.

The Integration Process runs the import command with the task instance information in order to send it to Beta UX system. 

Input Fields

Exit Codes

STDOUT and STDERR

STDOUT of this integration is empty, and STDERR provides detailed information about the Integration Process and its individual steps.

Task Example

Execute Beta UX LogX Integration Process

Universal Task for Beta UX

The following Task executes an Integration Process in Beta UX.

Open

Beta UX Universal Task

Credentials:

Open

Universal Controller RestAPI Credentials

Report for Backlog Processing

Open

Backlog Processing Example

How To

Import Universal Template

To use the Universal Template, you first must perform the following steps.

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

2. To import the Universal Template into your Controller, follow these instructions.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

Integration Modifications

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

• Python code modifications should not be done.

• Template Modifications

  • General Section

    • "Name", "Extension", "Variable Prefix", and "Icon" should not be changed.

  • Universal Template Details Section

    • "Template Type", "Agent Type", "Send Extension Variables", and "Always Cancel on Force Finish" should not be changed.

  • Result Processing Defaults Section

    • Success and Failure Exit codes should not be changed.

    • Success and Failure Output processing should not be changed.

  • Fields Restriction Section
    The setup of the template does not impose any restrictions. However, concerning the "Exit Code Processing Fields" section.

    1. Success/Failure exit codes need to be respected.

    2. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Reading Stonebranch Job Logs by Beta UX

Overview

After the completion of a Universal Automation Center Task which meets the criteria of the configured Webhook, the Beta UX Universal Task is triggered in Universal Controller. The triggered Beta UX Universal Task retrieves the Task Instance details including any generated log files and sends them in JSON format to the reader blximport.jar.

Data Flow

The reader is provided by Beta LogX and must be installed on the server where Universal Automation Center runs. It sends UAC job logs to the BLX server, which processes and stores them in the Beta LogX database.

Prerequisites

Installing the Reader

Universal Automation Center provides a remote REST API that exposes:

• Relevant metadata

• STDOUT and STDERR content of a Task Instance

Steps:

1. Configure the API to select which metadata should be generated and sent to Beta LogX.

2. Generated data is passed to blximport.jar for import into the Beta LogX database.

3. The Universal Automation Center manages the process.

More information: Stonebranch Task Instance Web Services

Running the Reader

Syntax

Parameters

Enabling Security Check for BLX Server

Use the LST parameter RDR_REMOTE_LOGON to enable a security check.

Requirements if security check is active:

1. The user calling the BLX server must be defined as a Remote Logon User.

2. The Remote Logon User must be mapped to a Beta LogX user with permission to execute the IMP (import) function.

To enable security check:

Beta LogX - Log File Search in Beta Admin

After the Task Instance Log information has been read by the Reader, it is available in Log File Search in Beta Admin.

Open

Beta LogX - Log File Search in Beta Admin

BetaUX Integration Script Documentation

Overview

This Python script serves as an integration bridge between Universal Automation Center (UAC) and BetaUX systems. It retrieves task instance data from UAC and processes it through external integration scripts for either LogX or DocX systems.

Version: 1.1.0

Purpose

The script enables automated processing of UAC task instances by:

• Fetching task instance data via UAC REST API

• Passing the data to external integration scripts (LogX or DocX)

• Supporting both single-instance and backlog batch processing modes

Configuration Variables

The script uses template variables that are substituted at runtime:

Operating Modes

1. Single Instance Mode

• Processes one specific task instance identified by ops_var_instance_id

• Default mode when ops_var_process_backlog is "false"

2. Backlog Mode

• Processes multiple task instances from a UAC report

• Enabled when ops_var_process_backlog is "true"

• Retrieves instance IDs from the specified report

• Iterates through all instances sequentially

Main Workflow

Execution Flow

1. Initialization

   • Configure logging based on specified log level

   • Disable SSL warnings if using unverified certificates

   • Set up HTTP headers for API authentication

2. Mode Selection

   • Single instance: Process gl_instance_id directly

   • Backlog mode: Fetch instance list from report, process each

3. Instance Processing (for each instance)

   • Retrieve task instance details from UAC API

   • Create temporary file with instance JSON data

   • Execute appropriate integration script (LogX or DocX)

   • Log results and cleanup temporary files

4. Completion

   • Log total runtime

   • Exit with appropriate status code

API Integration

UAC REST API Endpoints

TaskInstance.get_TaskInstance()

• Endpoint: /resources/taskinstance/listadv

• Method: POST

• Purpose: Retrieve detailed task instance information

• Payload: {"sysId": instance_id, "responseFields": "*"}

Report.get_RunReport()

• Endpoint: /resources/report/run?reporttitle={name}

• Method: GET

• Purpose: Execute report and retrieve instance IDs for backlog processing

• Returns: List of instance IDs from report results

Authentication

Supports two authentication modes:

• Basic Auth: Username/password credentials (default)

• Token Auth: Bearer token authorization

Integration Script Execution

LogX Processing

1. Read the LogX integration script from configured path

2. Retrieve task instance JSON from UAC

3. Write JSON data to temporary file

4. Execute LogX script with temp file path as argument

5. Capture stdout/stderr and return code

6. Log success (code 0) or failure (non-zero code)

7. Clean up temporary file

Command Format:

DocX Processing

Currently a placeholder implementation with basic structure for future development.

Key Classes and Functions

JobFuncs

• run_logx(): Execute LogX integration with task instance data