Reference Guide

Back-End framework

• Module API
  • Module
  • Module Lifecycle
  • Module Startup
• ORM API
  • Model
  • Field
  • Enums and Data Dictionaries
  • Model Inheritance
  • Common ORM Methods
  • Persistence Layer Operations
  • Exception Handling
• Functions API
  • Function Definition
  • Extpoint Extension Points
  • Hook Interceptors
  • Trigger
  • Built-in Functions
  • Expressions
  • Transaction Control
• Actions API
  • Server Action
  • View Action
  • Url Action
  • Client Action
• UX API
  • Application-related
  • Menu-related Annotations
  • View-related Annotations
  • Button-related Annotations
  • Action-related Annotations
• Security in Oinone
  • Concept Introduction
  • Module Filtering
  • Action/Function Filtering
  • Custom Permission Tree and Authorization via Pages
  • Custom Data Filtering
• Advance API
  • Protocol API
    • Detailed Explanation of GraphQL Protocol
    • Detailed Explanation of RSQL Protocol
    • Advantage Comparison Between GraphQL and RESTful
    • Variables
    • PlaceHolder
  • Request Context API
    • PamirsSession
    • RequestContext
    • Session Construction Process (HTTP Request Handling)
    • Example Code
  • Meta Directive API
    • Data Directives
    • Request Context Directives
    • Meta Directive Usage Modes
  • Hint API
    • Data Source Specification DsHint
    • BatchSizeHint
  • Message Hub API
    • Member Variables
    • Constructor
    • Core Methods
    • Message Levels (InformationLevelEnum)
    • Example Code
    • Notes
    • Class Diagram (Simplified）
  • FileClient API
    • Overview
    • Method Descriptions
    • Complete Example
    • Data Structure CdnFile
    • Notes
    • Supported Storage Services
  • MQ API
    • Dependencies and YAML Configuration
    • Core Interfaces
    • Usage Examples
    • Advanced Features
    • Differences Handling Among Different Middleware
    • Common Questions
  • Redis API
    • Basic Usage
    • Best Practices
    • Source Code Analysis of Core Configuration
  • ES API
    • EnhanceModel Usage Guide
    • Basic Configuration
    • Common Issues
  • Tools API
    • IdGenerator Interface (ID Generator)
    • UidGenerator Interface (Unique ID Generator)
    • SequenceGenerator Interface Documentation
    • RSQLHelper Class (RSQL Parsing Utility Class)
    • RsqlParseHelper Class (RSQL to SQL Utility Class)
    • ObjectUtils Class (Object Utility Class)
    • PamirsJsonUtils Class (For Frontend Interaction)

Front-End framework

• Framework Overview
  • Technical Stack Description
  • Code Structure
  • Web Client Architecture
  • Environment
  • Context
  • Building Blocks
  • Expression
  • Domains
• Environment
  • Compile-time Environment Configuration
  • Runtime Environment Configuration
  • Custom Runtime Configuration
  • VueOioProvider Entry Configuration
  • Reference List
• Context
  • Runtime Context
  • Reference List
• Widget
  • Component Lifecycle
    • Vue Component Lifecycle
    • Widget Lifecycle
    • Reference List
  • Basic
    • Core Component Map
    • SPI Token Component Map
    • Metadata Component Map
    • Reference List
  • Mask
    • Built-in Masks (Mask)
    • Mask Components
    • Registration of Mask Components
    • Registering Masks
    • Reference List
  • Layout
    • Built-in Layouts
    • Layout Components
    • Slots
    • Registering Layouts
  • DSL
    • Vue Slots
    • DSL Slots
    • DSL Merging
    • Component Slots
    • Differences Between Default View and Design View
  • View
  • Element
    • Element Component Map
    • Registration of Element Components
    • Reference List
  • Pack
    • Pack Component Map
    • Registration of Pack Components
    • Usage of Common Layout and Container Components
    • Reference List
  • Action
    • Registration of Action Components
    • Reference List
  • Field
    • Table Field
    • Search Field
    • Form Field
    • Detail Field
    • Gallery Field
  • Router
    • Registration of Router Components
    • Reference List
• Oio Components
  • Vue UI Antd
    • General
    • Layout
    • Navigation
    • Data Entry
    • Data Display
    • Feedback
  • Vue UI El
    • Data Display
  • Vue UI
    • Table
• Services
  • Metadata Service
    • Metadata Diagram
    • How to Obtain Runtime Metadata
    • Reference List
  • SPI Service
    • Overview
    • SPI API
    • Using SPI Service to Abstract Business Logic
    • Using SPI Storage for Dimension Storage
    • Using SPIOperator for Dimension Storage
  • Router Service
    • Built-in Routes
    • Custom Routes
    • Common Usages
    • Reference List
  • GraphQL Service
    • GraphQL Protocol
    • Initiating Requests with Visual Tools
    • Using GraphQL in Oinone
    • Usage of GQL Utility Classes
  • RSQL Service
    • RSQL Protocol
    • Usage of RSQL Tool Classes
  • HttpClient Service
  • Message Hub Service
  • Event Bus Service
  • Stream Service
    • Overview
    • Using RxJS in Widget Components
  • Expression Service
    • Overview
    • Using Expressions in Widget Components
    • Expression Syntax
  • Translate Service
    • Using the Translation Function in Widget Components
    • Using the Translation Function in Vue Template
    • Variable Handling
    • Obtaining the Translation File Address Format

User interface

• View architectures
  • Table
    • View Characteristics
    • DSL Structure
    • Default Field Components
    • Optional Field Components
    • DSL Attribute Configuration
  • Form
    • View Characteristics
    • DSL Structure
    • Default Field Components
    • Optional Field Components
    • DSL Property Configuration
  • Detail
    • View Characteristics
    • DSL Structure
    • Default Field Components
    • Optional Field Components
    • DSL Property Configuration
  • Gallery
    • View Characteristics
    • DSL Structure
    • Default Field Components
    • Optional Field Components
    • DSL Property Configuration
  • Tree
    • View Features
    • DSL Structure
    • Node Configuration Examples
• UI icons

Standard Modules

• User & Business API
  • Overview
  • Common Examples
  • More Commonly Used APIs
• Message API
  • Overview
  • Preparation Work
  • Message Configuration
  • API Usage Instructions
• Workflow
  • Overview
  • Dependency Setup
  • Workflow API Introduction
• Import And Export
  • Overview
  • Preparation
  • Yaml Configuration
  • Creating Templates
  • Custom Import/Export Logic
  • Reference List
• Resources API
  • Overview
  • Dependencies and Configuration
  • Reference List
• EIP API
  • Overview
  • Preparation Work
  • @Open Annotation
  • @Integrate Annotation
  • Core Processing Functions
  • Complete Call Flow
  • Register Open and Integrated Interfaces
  • Examples

Common Extension Points And SPI List

• SPI Mechanism
  • Pamirs SPI Framework
  • Configuration Methods
• System Extension Points
  • Framework Layer
  • Metadata Scanning
  • Metadata Calculation
  • API Layer
  • FaaS Layer
  • ORM Layer
  • Persistence Layer

Error Code

• Built-in Platform Error Codes
• Business Error Codes