Skip to main content

Report Module

Page/Section: Module-Report-Overview

The Report module allows users to create, edit, and manage BID‑driven reporting structures inside the platform. Reports are generated based on BID (Business Integration Descriptor) definitions. When a report is created, its structure is mapped using BID variables, and the final output is stored in the platform's report table.

Report List & Actions

Page/Section: Module-Report-List

The main Report Management page displays:

  • Report GID
  • Report Name
  • Category
  • Description
  • Resource GID
  • Workflow Name

Each column contains:

  • Sort controls
  • A search field for quick filtering

Below the table, pagination controls help navigate large report datasets.

Action Bar (Top‑Left)​

  • Create (+) — opens Report Creation wizard
  • Edit (pencil) — opens selected report in edit mode
  • Delete (trash) — removes selected report
  • Download — exports the report list
  • Refresh — reloads table

Creating a Report

Page/Section: Module-Report-Create

The report creation workflow begins when the user clicks Create.
A new page opens with:

## BID Selection​

A dropdown named Integration Option lists available BID values.
Once the user selects a BID:

  • The system loads the BID mapping structure
  • All related fields, variables, types, and qualifiers become available for mapping

Report Mapping Interface

Page/Section: Module-Report-Mapping

The mapping screen has two major panels:

## Left Panel: Source Fields (Table)​

Provides raw BID data attributes such as:

  • createdAt
  • description
  • domainName
  • projectGid
  • transactionIdentifierGid
  • transactionIdentifierKey
  • transactionXid
  • transmissionXid
  • value

Each attribute can be dragged or selected for mapping to the output.

## Center Panel: Aggregations​

Users may choose:

Count
Sum
Group By
Qualifier

BID variable options include:

  • bidVariableName
  • transactionIdentifierXid
  • type
  • updatedAt

Mapping Output Preview

Page/Section: Module-Report-Preview

Once mapping selections are made, the right panel shows the preview grid:

Columns include:

  • bidVariableName
  • transactionIdentifierXid
  • type
  • updatedAt
  • qualifier
  • BID-wise output columns (BID1, BID2, …)

A Totals row summarizes aggregated counts.

Example:

gt_bid_bid1 | 53 | AlphaNumeric | updatedAt | 1
gt_bid_bid1 | 55 | AlphaNumeric | updatedAt | 1
gt_bid_bid2 | 54 | Number       | updatedAt | 1
gt_bid_bid2 | 56 | Number       | updatedAt | 1
Totals: BID1 = 2, BID2 = 2

Saving the Report

Page/Section: Module-Report-Save

Once mapping is complete:

  • Clicking Save stores the report configuration
  • The report becomes available in the Report List
  • Its metadata is persisted in the report table

Editing an Existing Report

Page/Section: Module-Report-Edit

When the user selects a report and clicks Edit:

  • The mapping interface reopens
  • All saved mappings are pre‑loaded
  • User can modify:
    • BID selections
    • Mapped fields
    • Aggregator logic
    • Qualifiers

After modifications, clicking Save updates the existing record.

Key Highlights

Page/Section: Module-Report-Highlights

  • Reports are tightly linked with BID schemas
  • User‑friendly UI allows drag/drop‑style mapping
  • Supports aggregations, qualifiers, and groupings
  • Provides real‑time preview during mapping
  • Saved reports can be edited anytime

Code Example: Sample BID Structure Reference

{
  "bidVariableName": "gt_bid_bid1",
  "transactionIdentifierXid": "53",
  "type": "AlphaNumeric",
  "qualifier": "BID1",
  "updatedAt": "2025-12-01T10:15:00Z"
}

Summary

Page/Section: Module-Report-Summary

The Report module enables seamless creation of customizable and BID‑aligned reporting models. With a structured, consistent layout similar to the Connection module, it ensures traceability of data and easy maintainability across the integration ecosystem.