Developer Guide Index
Experience a revolutionary approach to application development. Build powerful enterprise-grade applications using cutting-edge AI technology.
This developer guide offers a comprehensive learning path—from organizational management and application fundamentals to business logic implementation—complete with best practices for mastering complex application architecture through real-world scenarios.
How to use this guide: Beginners should follow the sequential learning path. Experienced developers can jump directly to scenario-based advanced guides.
First, you need to complete the basic Download and Installation!
Basic concepts
Master JitAi's core concepts and architecture principles. Build a solid theoretical foundation by understanding platform applications, element systems, development frameworks, and visual development tools.
Platform Architecture and Core Concepts
Learn JitAi's platform architecture, application concepts, JAAP protocol, element systems, and development frameworks—the foundational principles that power the platform.
Platform installation and node activation
Set up your development environment by installing the platform and activating nodes. Master installation procedures, node activation workflows, and developer team management.
Download and Installation
Download and install JitAi platform for your deployment scenario—desktop or server versions available.
Node Activation and Developer Team
Activate nodes and manage developer teams—configure organization binding, add team members, and perform essential management operations.
Platform Node Updates and Upgrades
Keep your platform nodes up-to-date with the latest features and stability improvements.
Development tools and publishing services
Accelerate development with a powerful, integrated toolchain. Master visual development environments, DevOps management tools, and cloud publishing services for seamless development-to-deployment workflows.
JitAi Visual Development Tools
Navigate the visual development environment with confidence—explore IDE functional areas and seamlessly switch between visual and source code modes.
DevOps Management Tool
Manage your entire application lifecycle with a comprehensive dual-console DevOps solution—from development through deployment and beyond.
JCS Cloud Application Publishing Service
Leverage the official cloud publishing service for centralized application repositories, version management, and seamless deployment across JitNodes.
Creating and publishing applications
Master the complete workflow from application creation to distributed deployment. Learn application scaffolding, source code management, version publishing, runtime environment configuration, and infinitely scalable distributed architectures.
Creating and Deploying Applications
Create, configure, and deploy applications—from inheritance patterns to data configuration, master the fundamental development workflow.
Application Directory and Element Source Code
Navigate JitAi's JAAP-based directory structure—understand element code organization and source code export/import workflows.
Publishing and Upgrading Applications
Control your application lifecycle with version management, publishing workflows, and upgrade strategies—including semantic versioning and deployment best practices.
Runtime Environment Management
Configure and manage runtime environments—create deployment targets, organize node clusters, and control application deployment strategies.
Distributed Cluster Architecture for Unlimited Horizontal Scaling
Build infinitely scalable distributed architectures—design enterprise cluster topologies for high availability and performance at scale.
Frontend portals and pages
Craft beautiful, intuitive user interfaces. Build portal navigation, construct dynamic pages, design component layouts, and manage data flows—everything you need for exceptional user experiences.
Creating Portals
Design role-based portal interfaces—configure navigation menus, set permission controls, and deliver personalized user experiences.
Componentized Pages
Understand componentized pages—the foundation of JitAi's page system, built with functional components for data display and user interaction.
Creating Generic Pages
Build page interfaces visually—drag and drop components, configure events, and create rich interactive experiences without writing code.
AI Data Management Page
Leverage AI-powered data management—intelligently browse, filter, edit, and perform batch operations with built-in assistance.
AI Data Analysis Page
Generate data visualizations using natural language—AI creates charts from your descriptions and lets you adjust styles and dimensions on the fly.
Data Entry Pages
Rapidly build data entry forms for streamlined data collection and submission workflows.
Markdown Page
Create document-rich pages with full Markdown support—perfect for documentation, guides, and formatted content.
Full Code Page Development
Take full control with code-based page development—implement complex business logic and create fully customized interfaces.
Using AI in portals and pages
Elevate user experiences with AI-powered intelligence. Integrate AI assistants, agents, and smart components into portals and pages for personalized assistance and automated workflows.
Using AI Assistant in Portals
Embed AI assistants into portal interfaces—provide users with intelligent, contextual help throughout their workflow.
Using AI Assistant in Component Pages
Enhance component pages with embedded AI assistants—deliver contextual help and intelligent interactions for task-specific workflows.
Using AI Elements in Pages
Invoke AI elements directly from pages—leverage AI agents, LLM services, and knowledge bases for dynamic, intelligent content generation.
Calling business elements in pages
Power your pages with business logic and data operations. Invoke service functions and data model functions to build dynamic, data-driven interfaces with real-time processing capabilities.
Calling Service Functions in Pages
Execute business logic directly from pages—invoke service functions to process data, integrate external systems, and generate dynamic content.
Calling Data Model Functions in Pages
Perform CRUD operations and complex queries—invoke data model functions from pages for real-time database interactions and data display.
Full-code UI components in pages
Build advanced custom UI components with complete programming control. Create sophisticated interactive elements, handle complex events, and deliver rich experiences beyond standard components.
UI Component Interface Specifications
Master full-code component development—understand interface specifications, props management, state handling, and lifecycle methods.
Calling Page and Component Functions in Full-Code Components
Integrate full-code components seamlessly—invoke page functions and communicate with other components for cohesive interactions.
Emitting Events
Enable component communication with custom events—emit and handle events between full-code components, pages, and parent containers.
Calling Full-Code Component Functions in Page Code
Control full-code components from page code—invoke exposed functions to manage component behavior and orchestrate data flow.
Using functional components in pages
Leverage a powerful component library for rapid development. Drag and drop tables, forms, charts, and more—build complex interfaces with simple, intuitive visual tools.
Form Components
Build sophisticated forms with validation, permission controls, and complex business rules—collect and manage data effortlessly.
Basic Table
Display data with rich table features—bind data sources, customize fields, enable pagination, sorting, and inline editing.
Grouped Table
Organize data hierarchically—group table rows by specified fields for structured data management and analysis.
Cascaded Table
Display parent-child data hierarchies—manage tree structures with expandable rows and nested relationships.
View More Components
Crosstab
Perform multi-dimensional data analysis—create pivot tables with row-column cross-analysis for statistical reports.
Row to Column
Special table mode that converts row data to column display, suitable for dynamic field display scenarios.
Rich data visualization chart components supporting bar charts, line charts, pie charts and other chart types.
📝 Documentation is being improved, please stay tuned...
Tree Components
Display hierarchical data structures with node expand/collapse and selection operations, providing clear data navigation experience.
List Components
Flexible data list display component supporting title, summary, button configuration, suitable for various list display scenarios.
Components for displaying card-style content and media files, including dashboard and gallery functions.
📝 Documentation is being improved, please stay tuned...
Model Filter
Advanced filtering component based on data models, supporting simple, complex and free filtering modes.
Universal Filter
Flexible universal filtering component supporting custom field configuration and multiple trigger modes.
Calendar
Schedule management and time arrangement component supporting event creation, editing, and view switching.
Timeline
Timeline display component suitable for showing historical records and process progress.
Gantt Chart
Project management and progress tracking component supporting task dependencies and progress visualization.
Button Components
Various types of button components supporting different styles and interactive effects.
Layout Components (Editing in Progress)
Page layout and container components including popups, tabs and other interface structural elements.
📝 Documentation is being improved, please stay tuned...
Approval Components
UI components related to approval processes, supporting application initiation and approval processing.
Payment Components
Components integrating payment functionality, supporting multiple payment methods and payment flows.
Data Parsing and Import
Powerful data import and parsing tools supporting Excel file batch import, data cleaning, conditional filtering, and master-detail table association import.
Full Code Components
Fully customized code components supporting highly personalized function implementation.
Click "View More Components" above to collapse
AI large language models
Integrate leading LLMs like GPT-4, Claude, and Tongyi Qianwen. Enable intelligent dialogue, text generation, and code assistance—with multi-vendor failover and private deployment options.
Create AI Large Language Model Element
Integrate major LLM providers—configure API keys, set up retry mechanisms, and invoke AI functions in your applications.
LLM Input and Output
Configure LLM inputs and outputs—optimize prompts, model parameters, and response handling for peak performance.
Implement multimodal AIGC using LLM functions
Discover how to leverage LLM functions to create multimodal AI-generated content with text, images, and other media types.
📝 Coming soon...
AI knowledge base
Transform enterprise documents into intelligent, searchable knowledge bases. Enable automatic document processing, intelligent chunking, and semantic retrieval—empowering AI to answer questions accurately from your organizational knowledge.
Creating Knowledge Base Elements
Build AI knowledge bases—understand core components, system architecture, and the principles behind semantic search.
Knowledge Base Document Management
Manage documents, fine-tune parameters, and optimize performance—test queries and configure vectorization settings.
Full-Text and Semantic Search Using Knowledge Base Elements
Learn how to call knowledge bases in backend visual programming and understand how configuration settings participate in the query flow.
Integrating Knowledge Base into Agent
Integrate knowledge base into Agent to implement RAG.
Deploying Vector Databases as Standalone Services
Intelligent storage engine for enterprise knowledge. Convert text into vector data to achieve semantic-level precise search.
AI Knowledge Base API Exposure
Expose AI Knowledge Base capabilities through API interfaces for external system integration.
📝 Coming soon...
AI agent
Build intelligent agents with reasoning and action capabilities. Configure prompts and tools to enable AI-powered autonomous problem analysis, solution design, and task execution for complex business scenarios.
Creating AI Agents
Create ReActAgents with system prompts, model selection, capability descriptions, and runtime state storage configuration.
Tools in Agent
Learn how to add and manage various tools in Agent, including model functions, service functions, MCP services, external APIs, and page functions.
Agent Input and Output
Master Agent's input variable configuration, output result settings, streaming output, and various calling methods.
Using Knowledge Base for Retrieval-Augmented Generation (RAG)
Learn how to integrate knowledge bases with Agent to implement RAG functionality for enhanced response accuracy.
Implement Single-Task Intelligent Agent with Agent
Learn how to use Agent to implement specialized single-task intelligent agents for optimized business scenario handling.
📝 Coming soon...
Agent API Exposure
Expose Agent capabilities through API interfaces for external system integration.
📝 Coming soon...
AI assistant
Design intelligent workflows visually. Orchestrate business processes with drag-and-drop nodes, blend AI decision-making with human interaction, and automate customer service, approvals, and data processing.
Creating AI Assistant Elements
Build production-grade AI applications with multi-agent collaboration, UI interaction, and visual orchestration—no coding required.
Process Orchestration and Node Configuration
Master visual workflow design with 8+ node types including AIAgent, routing, conditional logic, and human-AI collaboration nodes.
AI Assistant Input and Output
Configure custom input parameters, control runtime log verbosity, and send structured data to conversations with custom widgets.
AI Assistant Runtime State
Leverage runtime state as the AI's 'memory bank' for context preservation, multi-turn conversations, and error recovery.
AI Assistant Events
Subscribe to node execution, tool call, and human interaction events in both frontend pages and backend services.
AI Assistant API Integration
Expose AI assistant capabilities through API interfaces for integration within applications and external systems.
Welcome Message and Conversation History
Configure welcome messages, opening statements, and manage conversation history for better user engagement and context continuity.
Conversational Multi-Task AI Assistant
Complete tutorial: Build an AI assistant with intelligent routing, multiple agents, and automated document generation.
Human-AI Collaborative Enterprise Assistant
Build a sophisticated AI grading system demonstrating deep UI integration, event-driven collaboration, and human oversight.
Data modeling
Build a robust data foundation visually—no SQL expertise required. Create tables, design field types, establish relationships, and manage data with intuitive visual tools.
Creating Data Tables
Build your data foundation—create tables, configure fields, design data types, and set constraints for optimal data integrity.
Creating Tables from Existing Database Schema
Quickly create data table elements from existing database tables, supporting rapid model generation.
Built-in Data Management Tools
Utilize built-in data management tools for efficient data operations and administration.
Creating Data Model Functions
Design and implement custom data model functions to extend data processing capabilities.
Aggregated Table Model
Multi-table data integration and statistical analysis, supporting complex data aggregation and calculation functions.
Extension Table Model
Data extension based on existing tables, implementing business field extension and multi-table data integration through association with other data tables.
Using Data Models in Pages and Functions
Learn how to effectively use data models in frontend pages and backend function logic for data operations.
Creating Data Object Models
Specialized data structures engineered for full-code development environments, similar to DTOs, used for structured data expression and transmission in business logic.
Calling Data Models with AI Agents
Add data model functions as Agent tools, enabling AI to intelligently perform CRUD operations and automated data processing.
Managing Database Connections
Configure and manage multiple database connections, supporting multi-data source application development.
Supported Database Vendors
Learn about various database types and connection configurations supported by JitAi.
Transaction management
Ensure data integrity in complex operations—master transaction control, implement atomic operations, and handle concurrency safely.
Transaction Management
Control database transactions and maintain consistency—ensure reliable, atomic data operations across your application.
User and permission management
Build secure user systems with flexible authentication and authorization. Support multiple login methods, organizational hierarchies, and fine-grained permissions—ensure data security while enabling role-based access.
Organization
Manage enterprise organizational structures—configure departments, positions, roles, and personnel hierarchies.
Login Authentication
Configure secure authentication—support multiple login methods including password, phone, OAuth, and third-party providers.
Role and Portal Menu Permissions
Define application roles and allocate permissions—implement fine-grained access control for portals, menus, and components.
Roles and Business Element Permissions
Apply advanced role-based access control to business elements, data models, and functional components.
Agent Tool Permission Control
Secure AI Agent operations—configure permission controls for tool execution and ensure safe, authorized agent actions.
Business logic development
Implement powerful business logic with visual programming. Handle complex rules, respond to user actions, and execute background tasks—all as intuitive as assembling building blocks.
Creating Service Elements
Encapsulate reusable backend logic—create service functions that provide API interfaces and data processing capabilities.
Calling Elements in Service Functions
Orchestrate comprehensive business logic—invoke data models, services, external APIs, and AI elements from service functions.
Service Elements Usage Scenarios
Discover practical patterns and best practices—apply service elements effectively across diverse business contexts and architectures.
Background Tasks
Automate workflows with scheduled and asynchronous tasks—execute complex background processes reliably.
Event Handling
Implement reactive business logic—monitor and respond to system events, model changes, and custom triggers.
Approval process
Streamline enterprise approvals with visual workflow design. Drag and drop to create flowcharts, configure approvers and conditions, and automate routing—transform paper-based processes into efficient digital workflows.
Approval Process Basic Configuration
Creation and basic settings of approval processes, including process node configuration and path design.
Start Node Configuration
Configuration of approval process start node, defining conditions and rules for application initiation.
Approval Node Configuration
Detailed configuration of approval links, including approver settings and approval rules.
Special Node Configuration
Configuration methods for special process nodes such as condition nodes and parallel nodes.
Approval Page Customization
Customize approval interface and user experience to improve approval efficiency.
Approval Process Usage
Practical application and operation guide of approval process, including initiating and processing approvals.
Calling Business Logic Elements in Approval Process
Learn how to call business logic elements within approval processes to implement complex business rules and automated decisions.
Integrating AI in Approval Process
Integrate artificial intelligence capabilities into approval processes to achieve intelligent routing, automated review, and smart decision making.
📝 Coming soon...
File processing
Handle files effortlessly—upload and download multiple formats, dynamically generate Word and Excel documents, and streamline all file operations.
File Storage
Configure file upload and storage—support local disk, cloud providers (OSS, S3, MinIO), and comprehensive file management.
Creating File Templates
Document template generation and processing, supporting dynamic content filling and format conversion.
Generating and Printing Files Using File Templates
Learn how to use file templates to generate and print documents programmatically, including dynamic content population and output formatting.
External API integration
Connect to the broader ecosystem—integrate third-party APIs, payment gateways (WeChat Pay, Alipay), and SMS services to extend your application's capabilities.
Creating Universal External API Elements
Integrate third-party HTTP APIs seamlessly—manage RESTful calls with standard methods, preprocessing, and response handling.
Built-in Payment Services
Integrate mainstream payment platforms to implement online payment and transaction functions.
Built-in SMS Service
SMS sending and notification service integration, supporting verification codes and message push.
Cache management
Boost performance with intelligent caching. Configure caching strategies to optimize data access speed and ensure smooth operation under high concurrency.
Cache Configuration and Usage
Application cache strategy configuration to improve system performance and response speed.
Internal API exposure
Expose application capabilities as APIs—generate standard interfaces, manage permissions, and monitor usage to enable external system integrations.
API Authorization
Permission control and access authorization management for API interfaces.
API Exposure Examples for Various Elements
Comprehensive examples demonstrating how to expose different types of elements as APIs, including data models, services, and custom functions.
Using SDK to Call Authorized Element APIs
Learn how to use official SDKs to call authorized element APIs, including authentication, request handling, and error management.
Using Cross-App Service Elements to Call Authorized APIs
Implement cross-application API calls using service elements, enabling seamless integration between different JitAi applications.
Internationalization
Reach global audiences—support multiple languages, regional settings, and dynamic language switching for truly international applications.
Creating Language Packages
Learn how to create custom language packages for your application, including structure definition and content organization.
Extending System Built-in Language Packages
Extend and customize existing system language packages to meet specific business requirements and regional needs.
How to Translate Page Terms
Master the techniques for translating page content, including dynamic text replacement and context-aware translations.
Translation Ignore Rules
Configure rules to exclude specific content from translation, ensuring proper handling of brand names, technical terms, and other non-translatable content.
Default Language
Configure the default language for your application to ensure optimal user experience for first-time visitors and users without explicit language preferences.
Frontend UI customization
Craft unique brand experiences—customize themes, develop exclusive UI components, and align interfaces with your corporate identity while enhancing user experience.
Global Styles
Application overall style and theme configuration, unifying interface style and user experience.
Custom Controls
Develop personalized UI components to meet special business needs and interaction requirements.
Component Customization
Platform provides two main approaches for component customization to meet different development needs and scenarios.
Page Customization
Specific development technologies and usage patterns for full-code pages, including style processing, component usage, resource management, and data operations.
Portal Customization
Full-code custom portals provide flexible solutions for navigation layout adjustment, interface style customization, and interaction method optimization.
Advanced guide
Master complex architectures and best practices through real-world scenarios—in-depth guides for advanced application development.
Development and Operations Process
Optimize your workflow—master development processes, debugging techniques, and production deployment for stable applications and efficient team collaboration.
AI Development and Applications
Build intelligent applications with AI agents, assistants, and prompt engineering—deliver enhanced experiences and automated workflows.
Data Modeling and Analysis
Build advanced data analysis systems with JitORM—implement multi-dimensional aggregations and automated business rules.
Business Services and API
Implement custom authentication and business service architectures with JitService—secure and organize your API layer.