VJSP Configuration File Documentation

vjspai-link.yml is the core project configuration file in the VJSP Framework, used to define essential parameters required for integrating your project with the VJSP plugin. Upon startup, the plugin automatically loads this file to initialize critical runtime environments such as data sources, static resource paths, and internationalization (i18n) settings.

✅ 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, certain VJSP plugin features may not function properly.

---

🔧 Feature Modules Dependent on This Configuration

The following VJSP features rely on configurations defined in vjspai-link.yml:

• Database Table Selection
• Workflow Selection
• Database Schema Editor
• Workflow Designer
• Form Logic & Page Builder

If the configuration is missing or incorrect, these features will be unavailable—resulting in failures to load data sources, locate workflow definitions, or render form fields.

---

📋 Key Configuration Items

Configuration Key	Description
datasource	Data source configuration
driverClassName	Database driver class. Currently supports MySQL 、 PostgreSQL、Dameng (DM). PostgreSQL: org.postgresql.Driver MySQL: com.mysql.cj.jdbc.Driver Dameng (DM) ：dm.jdbc.driver.DmDriver
url	Database connection URL
username	Database username
password	Database password
staticPath	Path to static resources (use default value; no modification needed)
mappingPath	Path to logic mapping files (use default value; no modification needed)
templatePath	Path to HTML template for code generation (use default value; no modification needed)
i18n	Internationalization locales: zh_CN (Chinese), ja_JP (Japanese), en_US (English)
appUrl	Application access URL. Update here if IP address or port changes

---

Configuration File Example

# VJSPAI Plugin Configuration File

vjspai:
  # Data Source Configuration
  datasource:
    # Database driver: currently supports PostgreSQL 、 MySQL 、 Dameng (DM).
    driverClassName: org.postgresql.Driver
    # Database connection URL format: jdbc:postgresql://host:port/database_name
    # Example: jdbc:postgresql://127.0.0.1:5436/vjsp_form
    url: jdbc:postgresql://${DB_HOST}:${DB_PORT}/${database-name}
    # Database username
    username: ${DB_USERNAME}
    # Database password
    password: ${DB_PASSWORD}
  # VJSP Resource Paths
  resources: 
    # Static resource path
    staticPath: src/main/resources/static/
    # Logic mapping files
    mappingPath: src/main/resources/vjsp-mapping/
    # HTML template path for generation
    templatePath: src/main/resources/template/html-template.html
  # Internationalization (i18n)
  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 credentials from version control via .gitignore, or inject them using environment variables.

Need support for other databases? Please contact us

---

Database Driver and Connection Examples

Database	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
Dameng (DM)	dm.jdbc.driver.DmDriver	jdbc:dm://localhost:5236/vjsp_form?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=true&useOldAliasMetadataBehavior=true&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true