Visual Paradigm QueryBase User's Guide

QueryBase Model Queries introduce advanced data mining to visual software architecture through Chained Model Traversal. By linking sequential queries into a progressive pipeline, you can trace complex relationships across connected diagram elements, perform deep impact analysis, and extract high-value graph subsets into structured JSON data. What is Chained Model Traversal? In visual modeling, critical domain logic is rarely contained within a single standalone shape. Value exists in how elements connect—how an Actor connects to a Use Case via an Association, or how a Database Entity links to a Service Class through a Dependency. Standard search engines can only find isolated elements based on direct attribute filters. Chained Model Traversal acts as a progressive graph query builder. It uses the output of one search step as the seed input for the next, traversing along relationship lines to extract precise networks of connected model data. How Progressive Query Pipeline Works Chained queries operate like a multi-stage data funnel. Each link in the chain narrows down or expands the dataset based on relationship paths: Stage 1: Base Element Filtering (Seed Selection) Define initial criteria to locate seed elements (e.g., locate all Actors containing the name string “Customer”). Stage 2: Relationship Traversal (Path Following) Follow connected connector paths originating from or pointing to the Stage 1 seed elements (e.g., fetch all Association relationships connected to those Customer Actors). Stage 3: Target Model Retrieval (Destination Extraction) Extract the target model elements attached to the far end of those Stage 2 relationships (e.g., retrieve all Use Cases linked to those Associations). Practical Traversal Scenario Consider an enterprise Use Case Diagram containing dozens of system actors and hundreds of use cases. You need an exact export of all functionality available specifically to the Customer role. [Query 1: Actor “Customer”] → (Traverse Association Links) → [Query 2: Connected Associations] → (Traverse to Connected Shapes) → [Query 3: Target Use Cases] Without Chained Model Traversal, you would have to manually open diagrams, trace every line visually, and write down the connected shapes. With QueryBase, this multi-stage graph traversal runs automatically across your entire cloud repository in milliseconds, returning a clean, exportable JSON dataset. Comparison: Hierarchical Queries vs. Chained Model Queries Capability Hierarchical Queries Chained Model Queries Primary Purpose Extract static tree models based on structural hierarchy Mine dynamic graph relationships across connected paths Data Pattern Project > Diagram > Element > Property Seed Element → Relationship → Target Element → … Query Style Single-level scope filtering Multi-stage sequential pipeline chaining Best For Documentation exports, class specs, property dumps Dependency analysis, requirement tracing, impact assessment Why Architectural Mining Matters Automated Impact Analysis: Instantly discover which software components or business processes will be impacted if an actor or core service is modified. Elimination of Orphan Elements: Trace unlinked or disconnected shapes across massive enterprise repositories to clean up system models. Complex Graph Extraction: Export multi-hop relationship chains directly into automated code generators or graph analytics engines.

Chained model queries in QueryBase allow you to mine interconnected project models by linking sequential filters together into a continuous pipeline. This guide walks you through constructing a complete 3-step chained query using a real-world Use Case diagram scenario: isolating an Actor, traversing its Association relationships, and extracting all connected Use Cases. Example Scenario Goal In your Visual Paradigm Cloud workspace, you have a large enterprise project containing numerous diagrams. Your goal is to generate a clean JSON list of every Use Case connected specifically to the “Member” Actor, without manually reviewing every diagram or extracting unrelated elements. Pipeline Strategy: Filter Actor (“Member”) → Traverse Connected Associations → Retrieve Connected Use Cases Step-by-Step Query Construction Step 1: Base Element Filtering (Seed Selection) The first query in the chain establishes the starting point (seed data) by filtering for the target element. Open QueryBase from your workspace and navigate to Query by Model in the top menu. Set the Element Type filter to Actor in the first query. Add a condition: Name Contains “Customer”. Outcome of Step 1: QueryBase isolates all Actor shapes in your project named “Member” (or containing “Member”) and holds them as the seed input for Step 2 Step 2: Relationship Traversal (Path Following) The second step follows the relationship lines attached to the seed elements identified in Step 1. Click + Chain Query to append Query 2 to your pipeline. Select Relationship to be the type of link. Select Association to be the type of diagram element to query. Outcome of Step 2: QueryBase traverses outward from the “Member” Actor elements and gathers every Association line connected to them. Step 3: Target Model Retrieval (Destination Extraction) The third step extracts the target shapes attached to the far end of the relationships gathered in Step 2. Click + Chain Query to append Query 3. Select Model to be the type of link. Select Use Case to be the type of diagram element to query. Outcome of Step 3: QueryBase resolves the opposite side of each Association relationship, yielding the final, filtered list of target Use Cases linked directly to the “Member” Actor. Executing the Chain & Inspecting Results Once all three query steps are linked in the editor, you can export JSON for your result. Key Takeaways & Next Steps Chains Flow Sequentially: The output of Step N becomes the direct evaluation context for Step N+1. Filter at Each Stage: Narrow down types or properties at each step to prevent broad or noisy graph results. Export Anywhere: Save your chain configuration for repeated executions or export the JSON output for downstream processing.

QueryBase Hierarchical Queries enable teams to extract rich architectural models from Visual Paradigm Cloud and convert them into structured, developer-friendly data formats. By organizing model data into a clean tree structure, QueryBase makes it effortless to analyze, transform, and integrate your modeling assets into external systems. What is Hierarchical Model Extraction? Visual models are inherently hierarchical. A system model contains multiple diagrams; diagrams contain shapes, entities, and connectors; and each shape possesses distinct properties such as names, stereotypes, custom tags, and documentation notes. Hierarchical Model Extraction is QueryBase’s built-in engine for parsing these nested relationships and flattening them into structured JSON payloads. Instead of requiring manual data entry or complex custom API integrations, users can extract well-defined tree structures directly from their web browser. The Standard Extraction Structure Hierarchical queries strictly enforce a logical multi-tier data model: Project > Diagram > Diagram Element > Properties This uniform mapping guarantees that every extracted model payload follows a predictable, easy-to-parse schema regardless of diagram type: Project Level: The top-level wrapper defining repository metadata, project name, version, and unique IDs. Diagram Level: Contains the subset of targeted diagrams (e.g., Use Case Diagrams, BPMN workflows, ERDs) filtered by your query criteria. Diagram Element Level: Lists all shapes, actors, classes, tasks, or connectors present within each diagram. Properties Level: Contains explicit metadata attributes chosen for inclusion, such as names, descriptions, stereotypes, and custom tagged values. Example Structured JSON Output Below is a simplified example of how QueryBase structures an extracted Use Case Diagram model into clean JSON: { “workspace”: “dshv9sdg”, “projects”: [ { “id”: “PRJ-90210”, “name”: “E-Commerce System”, “diagrams”: [ { “id”: “DIAG-101”, “name”: “Checkout Process”, “type”: “UseCaseDiagram”, “imageUrl”: “https://….”, “diagramElements”: [ { “id”: “ELEM-001”, “name”: “Customer”, “stereotypes”: [“PrimaryActor”], “description”: “Registered user performing online purchases.” }, { “id”: “ELEM-002”, “name”: “Process Payment”, “type”: “UseCase”, “status”: “Approved” } ] } ] } ] } Common Business & Engineering Use Cases Structured hierarchical extraction turns static design artifacts into actionable data for downstream workflows: 📄 Automated Documentation Generation Feed structured JSON into static site generators or publishing tools (e.g., Hugo, Sphinx, Confluence) to maintain automated, living software documentation. ⚙️ CI/CD & Code Generation Pipelines Extract data models and class specifications directly into build scripts to automatically generate API interfaces, DTOs, database migrations, or configuration files. 📊 Compliance & Governance Reporting Extract properties, custom tags, and security levels into data analytics tools or Excel to run enterprise risk and regulatory compliance checks. Extraction Tier Overview Tier Level Description Typical Extracted JSON Attributes Project Root container in Cloud Workspace id, name, author, lastModified Diagram Visual view or canvas container id, name, type (e.g., BPMN, UML, ERD) Diagram Element Individual shape, model, or line id, name, elementType (e.g., Class, Actor, Task) Properties Detailed attributes and tags stereotype, documentation, customTags

QueryBase Hierarchical Queries provide complete control over what model data is extracted from your Visual Paradigm Cloud workspace. By defining targeted scope conditions and selecting exact property fields, you can generate lightweight, tailor-made JSON payloads for downstream processing. The 3-Step Extraction Workflow Extracting hierarchical JSON from QueryBase follows an intuitive, step-by-step process designed to minimize data noise and maximize output efficiency: Define Scope Conditions: Filter targeted Projects, Diagrams, and Elements. Customize Included Properties: Pick exact attributes (e.g., Name, ID, Stereotype, Custom Tags) to feature in the payload. Export Query and Download JSON: Preview live JSON and download or copy the payload. 1. Configuring Scope Conditions Defining a precise query scope ensures that your JSON payload contains only the relevant model assets. QueryBase allows multi-tier scope filtering across three levels: Project Scope Select specific projects or repositories from your cloud workspace. You can target a single active project or query across multiple related enterprise projects simultaneously. Diagram Scope Narrow the scope to specific diagram types (e.g., only Use Case Diagrams, BPMN Business Processes, or Entity Relationship Diagrams) or select individual diagrams by name. Element Scope & Filters Filter diagram shapes using logical conditions: Element Type: Restrict extraction to specific shapes like Actor, Class, Task, or Database Table. Stereotype: Filter elements carrying designated stereotypes (e.g., «Primary» or «RESTful»). Name Conditions: Apply string matchers like Contains, Starts With, or exact keyword matches. 3. Generating & Exporting JSONOnce your scope and property selections are set, QueryBase builds the JSON structure dynamically: Run Query Preview: Click Execute Query to view the structured JSON hierarchy directly in the built-in web editor with full code highlighting. Verify Payload: Inspect the live output tree to ensure all required fields and element nodes are accurately represented. Export Payload: Download JSON File: Save the payload as a .json file for immediate use in external toolchains. Copy to Clipboard: Instantly copy raw JSON formatted for quick pasting into code editors or REST client tools. Best Practices for Optimized JSON Extractions Exclude Unused Properties: Stripping out spatial properties (like position coordinates) when only data definitions are needed can reduce file sizes by up to 70%. Save Query Configurations: Reuse your scope and property filter rules across future cloud project runs to maintain consistent JSON schema structures. Click on Export Query at the top of the page to output the query.

The QueryBase Project Explorer transforms your cloud-stored Visual Paradigm models into an interactive, web-accessible database. It empowers reviewers, developers, and stakeholders to inspect system architecture, diagrams, shapes, and relationships directly from any modern web browser—with zero desktop software installation required. What is the QueryBase Project Explorer? Traditionally, viewing detailed model properties, custom tags, or interconnected shape relationships required opening a native modeling application like Visual Paradigm Desktop. Static exports (like PNGs or PDFs) lost the rich semantic metadata underlying the visual design. The QueryBase Project Explorer bridges this gap by rendering fully interactive, metadata-rich representations of your cloud projects on the web. It provides a lightweight, read-optimized interface for deep architectural inspection and conditional model searching. Key Web-Browsing Features Designed for rapid discovery and effortless navigation, the Project Explorer includes several core features: 🔍 Zero-Install Access Open and inspect any project saved in your Visual Paradigm Cloud Workspace instantly using Chrome, Safari, Firefox, or Edge on any device. 📍 Seamless Breadcrumb Navigation Maintain spatial and logical context as you drill down into complex architectures. Jump effortlessly between the project root, specific diagrams, model elements, and associated properties. ⚡ Conditional Model Search Engine Locate specific shapes or elements across multi-diagram projects using targeted text, stereotype, or type filters. Click any search result to jump directly to that element within its diagram context. 🔗 Dynamic Relationship & Property Inspection Click any shape or line to view its underlying attributes, custom properties, tagged values, and incoming/outgoing connections in a dedicated inspector sidebar. Who Benefits from Web-Based Browsing? User Role Primary Web-Browsing Use Case Developers & Engineers Inspect class models, API endpoint shapes, or DB schemas to inform implementation details without launching a heavy IDE/desktop suite. Product Managers & BAs Review business process flows (BPMN) and Use Cases alongside clients to verify business rules in real time. QA & Security Testers Verify model requirements, trace user actors, and audit system boundaries against functional specs. External Stakeholders Explore approved system design deliverables securely through read-only web access. Quick Start: How to Open a Project in Explorer Open your browser and log in to your Visual Paradigm Online account at: https://online.visual-paradigm.com/login.jsp You’ll be redirected to the Visual Paradigm Unified Platform. Click your logo at the top right corner and select Admin Pane. Click on the Projects menu on the left. Hover over the project where you want to enable QueryBase. Click Edit. In the Project tab, you can open the URL of QueryBase for this project. Visit the URL to start using QueryBase.

The QueryBase Project Explorer provides a fluid, web-native experience for navigating complex software models and enterprise architectures. By combining interactive breadcrumbs, web views, and detailed property inspectors, users can effortlessly drill down from high-level project repositories to granular element attributes. Understanding the Navigation Hierarchy In Visual Paradigm QueryBase, project data is organized in a clean, logical tree structure. Navigation follows a four-tier path: Cloud Workspace > Project > Diagram > Element / Shape > Properties & Relationships This hierarchical organization ensures that whether you are viewing a high-level BPMN workflow or a detailed UML class specification, you always maintain clear context of where an element fits within the broader project. 1. Contextual Breadcrumb Navigation At the top of the Project Explorer window sits the interactive Breadcrumb Bar. Breadcrumbs offer two major advantages when navigating extensive models: Instant Level Switching: Click any prior node in the breadcrumb trail (e.g., clicking the Project Name while inspecting an individual diagram) to return immediately to that parent context. Context Awareness: Always know exactly which diagram, package, or subsystem you are currently examining without getting lost in deep nested models. 2. Browsing Diagrams & Viewing Shape Details Selecting a diagram from the project list opens the interactive diagram canvas. From here, you can inspect visual models and extract key properties: Interactive Canvas Inspection Click any diagram element—such as an Actor, Use Case, Class, Activity, or Database Table—to reveal its specification at the bottom. The specification panel displays crucial metadata, including: Basic Attributes: Name, ID, Stereotype, Type, and Description. Custom Properties: Tagged values, documentation notes, and user-defined fields. Model Relationships: Incoming and outgoing connections (e.g., associations, dependencies, generalizations). Navigation Summary Matrix Navigation Task Action in QueryBase Primary Outcome Return to Project Root Click the Project name in the top Breadcrumb bar Displays the complete diagram index and top-level packages. Inspect Shape Metadata Click any shape on the diagram canvas Opens the Property Inspector with attributes, descriptions, and tags. Traverse Connected Elements Click connected model links in the Property Inspector Jumps directly to related elements or target diagrams.

Locating a single element, stereotype, or relationship within an enterprise-scale architecture can be challenging. The QueryBase Conditional Model Search engine lets you execute targeted search queries across your entire project repository and instantly navigate to matching elements within their visual diagram context. Why Use Conditional Search in QueryBase? In complex software models containing hundreds of diagrams and thousands of shapes, browsing package hierarchies manually is slow and inefficient. QueryBase solves this with a multi-attribute search mechanism that indexes every element, property, and relationship in real time. Instead of relying on simple keyword matching, Conditional Model Search lets you combine structural parameters—such as element type, assigned stereotypes, and custom property keys—to isolate precise subsets of your project data. Universal Element Querying (Advanced Search) Universal Querying is the most powerful feature, enabling you to search for any element by its properties across all projects simultaneously, not just the one you are viewing. To begin a search, click the Magnifier Icon (🔎) located in the top right corner of the application to open the dedicated Query Interface. From here, you can set your search condition. For example, configure the search to look at the Element Property: Name, select contains, and type your search term. Once your condition is set, click the Search button. The results will list all matching elements from every project in the workspace. To focus your results, use the Element Type Filter in the results panel; simply uncheck all types except the desired one to instantly narrow down the list. Practical Search Scenarios User Goal Search Configuration / Criteria Result / Outcome Audit Security Actors Type: Actor | Name contains: “Admin” Lists all administrator actor shapes across all system Use Case diagrams. Find Deprecated Services Stereotype: «Deprecated» Locates all legacy components marked for refactoring or retirement. Locate Database Tables Type: Entity | Property: PrimaryKey=True Extracts primary key entity attributes from ERDs across the project. Search Efficiency Tips Combine Type + Keyword: Narrow large result sets quickly by specifying the model type alongside a text keyword. Use Stereotypes for Governance: Apply standardized stereotypes in Visual Paradigm Desktop to make governance and security audits effortless in QueryBase. Inspect Context Links: Use the direct jump feature to inspect how an element interacts with surrounding shapes before making architectural decisions.

Visual Paradigm QueryBase unlocks the structured intelligence stored inside your architectural, business process, and software engineering models. By shifting model data from isolated desktop files to an accessible, web-queryable cloud repository, QueryBase gives every team member direct access to precise system insights. Core Capabilities of QueryBase QueryBase turns passive modeling repositories into dynamic, searchable databases. Its core capabilities center on three distinct functional paradigms designed for accessibility, flexibility, and automation: 1. Web-Based Model Exploration & Conditional Search Browse any project stored in your Visual Paradigm Cloud Workspace directly inside your web browser. Interactive Breadcrumb Navigation: Move effortlessly across hierarchical layers—from whole projects down to individual diagrams, shapes, and relationship parameters. Conditional Model Filtering: Search for model elements based on specific attributes, names, stereotypes, or types, and jump directly to the target element’s web context. Zero Client Footprint: Access full model details and relationship metadata without downloading or launching desktop modeling tools. 2. Hierarchical Model Extraction (Structured JSON Output) Extract clean, structured representations of your visual models formatted explicitly for data processing and analysis. Structured Tree Formatting: Generates well-formed JSON outputs structured as Project > Diagram > Diagram Element > Properties. Scope & Property Customization: Define precisely which projects, diagrams, or shapes to query, and select exact property keys to include in the payload to keep output data lightweight. Instant Data Portability: Export JSON files ready for consumption by custom scripts, automated reporting engines, or external databases. 3. Chained Model Queries (Graph Traversal & Data Mining) Perform multi-step graph traversal across connected model elements to discover hidden dependencies and structural impacts. Progressive Query Pipelines: Connect sequential query criteria together. Filter initial seed elements, traverse intermediate relationships (e.g., associations or dependencies), and capture connected target models. Deep Relationship Mining: Trace complex paths—such as linking a specific “Customer” Actor through its association relationships to extract every associated Use Case across your enterprise models. Exportable Graph Subsets: Export multi-level query results directly into structured JSON payloads for downstream architectural analysis. Key Benefits for Teams & Organizations Implementing QueryBase into your modeling workflow delivers measurable operational advantages across technical and business roles: 🚀 Accelerated Decision-Making & Transparency Democratize system architecture data. Product managers, quality assurance engineers, and business stakeholders can inspect project details independently without requesting manual exports or screenshots from enterprise architects. ⚡ Seamless Automation & CI/CD Integration QueryBase turns visual models into structured data sources. Developers can feed exported JSON payloads directly into custom documentation pipelines, code generation tools, compliance audit checkers, or third-party analytics dashboards. 🔍 Enhanced Impact & Dependency Analysis Before modifying a core business process or software module, use chained model queries to perform precise impact analysis. Instantly identify every system component, requirement, or user actor tied to a specific model element. 💰 Reduced Licensing & Infrastructure Friction Non-authoring stakeholders no longer require dedicated desktop modeling software licenses simply to review project specifications, significantly reducing software overhead and IT maintenance effort. Capability & Benefit Summary Matrix Capability Primary Problem Solved Key Output / Deliverable Project Explorer Difficulty accessing model details without desktop software Interactive web view with instant breadcrumb navigation & direct element search Hierarchical Queries Manual and error-prone copy-pasting of model attributes Structured JSON hierarchy (Project > Diagram > Element > Property) Model Queries (Chained) Inability to trace multi-step relationship dependencies easily Exportable graph traversal dataset for deep impact analysis

Visual Paradigm QueryBase operates as a native cloud-querying service built directly on top of the Visual Paradigm Cloud Workspace. Understanding how QueryBase bridges your desktop modeling environment with cloud data repositories ensures seamless collaboration and accurate data extraction across your team. Architecture & Data Flow The connection between Visual Paradigm Desktop, Cloud Workspace, and QueryBase forms a unified modeling and data-mining lifecycle: Authoring (Visual Paradigm Desktop): Architects and designers create, modify, and manage models (UML, BPMN, ERD, ArchiMate, Use Cases) using Visual Paradigm Desktop. Synchronization (Cloud Workspace): When project updates are committed to the Visual Paradigm Cloud Workspace repository, the structured model definitions—including diagram layouts, element stereotypes, custom attributes, and inter-element relationships—are securely stored in the cloud. Indexing & Mining (QueryBase Engine): QueryBase directly accesses this centralized cloud repository. It parses project structures dynamically, allowing users to browse, search, construct hierarchical queries, and execute chained model queries in real time through any web browser. Key Advantages of Cloud Integration Connecting QueryBase directly to the Visual Paradigm Cloud Workspace offers several technical and operational advantages: Always Up-to-Date Model Data: QueryBase queries reflect the latest project state committed to your cloud workspace, eliminating stale documentation and outdated static report exports. Zero-Client Footprint for Stakeholders: Project reviewers, software engineers, QA teams, and business analysts can query and extract complete model metadata without requiring a local Visual Paradigm Desktop installation or local project file downloads. Centralized Access Control: Because QueryBase relies on your Visual Paradigm Cloud Workspace environment, project visibility, user roles, and data security are governed centrally using your existing cloud permissions. Optimized API & Web Execution: Heavy graph traversal and hierarchical property extraction are processed in the cloud, delivering high performance even for large-scale enterprise models. Activating QueryBase Step-by-Step Accessing your cloud projects within QueryBase requires activating the QueryBase service on Visual Paradigm Online. To activate QueryBase, make sure: Your project is hosted in Visual Paradigm Online (not a local or offline project) You have sufficient permissions (e.g., project manager) Your team has a valid license for QueryBase You’ve already created your Visual Paradigm Online account and joined your workspace If these conditions are met, you’re ready to enable web access to your model data. Open your browser and log in to your Visual Paradigm Online account at: https://online.visual-paradigm.com/login.jsp You’ll be redirected to the Visual Paradigm Unified Platform. Click your logo at the top right corner and select Admin Panel. Click on the Projects menu on the left. Hover over the project where you want to enable QueryBase. Click Edit. Select Enable QueryBase. Click Save at the top right. You can copy the URL next to [/] Enable QueryBase, and visit the URL to open the Project Explorer. Accessing the different tools To navigate among the various tools of QueryBase (Project Explorer, Model Queries, Hierarchical Queries), click on the Tools menu at the top right of any tool, and then select the tool to open. Data Synchronization Summary Layer Primary Role Data Handling Visual Paradigm Desktop Model Creation & Editing Generates visual models, relationships, and property configurations. Cloud Workspace Centralized Repository Stores and versions project metadata, diagrams, and permissions securely. QueryBase Data Mining & Output Pipeline Queries, filters, traverses, and exports model metadata directly to JSON.

Visual Paradigm QueryBase seamlessly inherits user permissions and governance policies from the Visual Paradigm Cloud Workspace. This ensures secure model data access across your organization while providing an intuitive web UI to navigate projects, manage query execution, and inspect system architecture. Navigating the QueryBase Workspace The QueryBase user interface is designed for immediate accessibility, enabling team members to locate projects, build queries, and extract structured data without complex training. 1. Workspace Dashboard & Project Selector Upon logging into QueryBase via your browser, the main workspace dashboard presents a centralized list of all synchronized projects you have permission to view. Use the workspace selector in the top navigation bar to switch between different team repositories or enterprise departments. 2. Contextual Breadcrumb Bar Situated at the top of every project view, the breadcrumb trail keeps you grounded within complex system hierarchies. Click any segment in the breadcrumb path—such as Workspace > Project > Diagram > Shape—to instantly jump across architectural levels. 3. Tool Switcher Sidebar A dedicated sidebar gives instant access to QueryBase’s three core querying modalities: Query by Template (Project Explorer): Interactive visual browsing and conditional search. Query by Model: Multi-step chained graph traversal pipelines. Query by Hierarchy: Structured tree formatting and property configuration.