VJSP Configuration File Guide

vjspai-link.yml is the core project configuration file in the VJSP framework, used to define various parameters required for integrating the current project with the VJSP plugin. The plugin automatically loads this file upon startup and initializes key runtime environments such as data sources, static resource paths, and internationalization (i18n) configurations accordingly.

✅ File Location: Project root directory (at the same level as package.json or pom.xml)

⚠️ Prerequisite: Ensure this file exists and is correctly formatted, otherwise some VJSP plugin functions will not work properly.

🔧 Functional Modules Dependent on This Configuration

The following VJSP functions all rely on configuration information in vjspai-link.yml:

• Select Database Table

• Select Workflow

• Database Schema Editor

• Workflow Designer

• Form Logic & Page Builder

If not configured correctly, the above functions will be unavailable, resulting in failures to load data sources, find process definitions, or render form fields.

📋 Main Configuration Items Explanation

Configuration Item	Description
datasource	Data source configuration
driverClassName	Database driver: Currently supports MySQL and PostgreSQL database drivers. PostgreSQL uses: org.postgresql.Driver MySQL uses: com.mysql.cj.jdbc.Driver
url	Database connection URL
username	Database username
password	Database password
staticPath	Static resource path, use default value, no modification needed
mappingPath	Logic files, use default value, no modification needed
templatePath	Generated HTML template path, use default value, no modification needed
i18n	Internationalization: zh_CN Chinese, ja_JP Japanese, en_US English
appUrl	Application access URL, modify here if IP or port changes

Configuration File Example

# VJSPAI Plugin Configuration File

vjspai:
  # Data source configuration
  datasource:
    # Database driver: Currently supports PostgreSQL and MySQL database drivers.
    driverClassName: org.postgresql.Driver
    # Database connection format: jdbc:postgresql://host:port/database-name
    # Example: jdbc:postgresql://127.0.0.1:5432/vjsp_form
    url: jdbc:postgresql://${DB_HOST}:${DB_PORT}/${database-name}
    # Database username
    username: ${DB_USERNAME}
    # Database password
    password: ${DB_PASSWORD}
  # VJSP file paths
  resources: 
    # Static resource path
    staticPath: src/main/resources/static/
    # Logic files
    mappingPath: src/main/resources/vjsp-mapping/
    # Generated HTML template path
    templatePath: src/main/resources/template/html-template.html
  # Internationalization
  i18n:
    list: zh_CN,ja_JP,en_US
    default: zh_CN
  # Application access URL, modify here if IP or port changes.
  appUrl: http://localhost:8080/

🔐 Security Tip: It is recommended to exclude sensitive information via .gitignore, or use environment variables to inject credentials.

Need to use other databases? Contact Us

Database Drivers & Connection Examples

Database	Driver driverClassName	Connection url
postgresql	org.postgresql.Driver	jdbc:postgresql://127.0.0.1:5432/vjsp_form
mysql	com.mysql.cj.jdbc.Driver	jdbc:mysql://127.0.0.1:3306/vjsp_form?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false