VJSPAI-LINK Configuration
vjspai-link.yml is the core project configuration file for VJSP visualization features. It defines all parameters required for integrating the current project with VJSP plugins. The plugin automatically loads this file at startup and initializes critical runtime environments such as data sources, static resource paths, and internationalization (i18n) settings.
✅ File Location:
Project/.vjsp/vjspai-link.yml
⚠️ Prerequisites: Ensure this file exists and is correctly formatted; otherwise, certain VJSP plugin features will not function properly.
Note: If the
vjspai-link.ymlfile does not exist, click the "Database Designer" or "Workflow Designer" in the plugin. The file will be automatically created in the.vjspdirectory, and no manual creation is required.
Environment Requirements
The plugin functionality depends on Java service. Please ensure the Java environment is installed locally and environment variables are configured correctly.
- Recommended version: Java 8 ~ Java 17
- Check method: Execute
java -versionin command line/terminal- Verification success: Command returns normally and displays Java version information
🔧 Functional Modules Dependent on This Configuration
The following VJSP features all rely on configurations defined in vjspai-link.yml:
Database Schema Editor
Workflow Designer
Form Logic & Page Builder
If not configured correctly, these features will be unavailable, and the following issues may occur:
- Data sources cannot be loaded
- Workflow definitions cannot be found
- Form fields cannot be rendered
📋 Main Configuration Items Explanation
| Configuration Item | Description |
|---|---|
datasource | Data source configuration |
driverClassName | Database driver: Currently supports MySQL, PostgreSQL, Dameng Database drivers. - PostgreSQL: org.postgresql.Driver- MySQL: com.mysql.cj.jdbc.Driver- Dameng: dm.jdbc.driver.DmDriver |
url | Database connection URL |
username | Database username |
password | Database password |
staticPath | Static resource path, use default value, no modification needed |
mappingPath | Logic file path, use default value, no modification needed |
templatePath | HTML template generation path, use default value, no modification needed |
i18n | Internationalization: zh_CN Chinese, ja_JP Japanese, en_US English |
appUrl | Application access URL. If you change IP or port, please update it here |
Configuration File Example
# VJSPAI Plugin Configuration File
vjspai:
# Data source configuration
datasource:
# Database driver
driverClassName: org.postgresql.Driver
#driverClassName: com.mysql.cj.jdbc.Driver
#driverClassName: dm.jdbc.driver.DmDriver
# Database connection URL
url: jdbc:postgresql://127.0.0.1:5432/xxx
#url: jdbc:mysql://127.0.0.1:3306/xxx?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
#url: jdbc:dm://127.0.0.1:5236/xxx?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=true&&useOldAliasMetadataBehavior=true&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true
# Database username
username: xxx
# Database password
# Encrypted password:
# Key generation method: Use the `generateHexKey()` method in `SM4Utils.java` from the accompanying application project to generate a key, then configure it under `sm4-key` below.
# Sensitive information encryption method: Use the `encrypt("string_to_encrypt", "key")` method in `SM4Utils.java`.
# password: ENC(142d7d928b591d6c030c6350a21ecfc19db6718b2879eaeea3fac0bd0fb70d241)
# Plaintext password
password: "123456"
# VJSP file paths
resources:
# Static resource path
staticPath: src/main/resources/static/
# Logic file path
mappingPath: src/main/resources/vjsp-mapping/
# HTML template generation path
templatePath: src/main/resources/template/html-template.html
# Internationalization
i18n:
list: zh_CN,en_US
default: zh_CN
# Application access URL
appUrl: http://localhost:8070/
# ENC encryption configuration
jasypt:
encryptor:
# SM4 key (32-character hexadecimal string)
sm4-key: 2fe4b2696b85208e81d30a71c44fb482
# Encryption class
bean: jasyptStringEncryptor🔐 Security Tip: It is recommended to exclude sensitive information via
.gitignoreor inject credentials using environment variables.
Database Drivers and Connection Examples
| Database | Driver (driverClassName) | Connection URL (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.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 |
Configuration Activation Instructions
After adding or modifying configuration files, to ensure the new configurations take full effect, you need to follow these steps:
Close the current designer window.
Reopen the designer.
At this point, the designer will load and apply the latest configuration file content.
After correct configuration and saving the file, a prompt "VJSP AI TOOLS started successfully" will appear in the bottom right corner of the IDE. If no prompt appears, please check if the file is configured correctly and the local Java version.
