VJSPAI-LINK Configuration
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 VJSP plugins. The plugin automatically loads this file at startup and initializes critical runtime environments such as data sources, static resource paths, internationalization (i18n) settings, etc.
✅ File Location:
Project/.vjsp/vjspai-link.yml
⚠️ Prerequisites: Please ensure this file exists and is correctly formatted; otherwise, certain features of the VJSP plugin will not function properly.
Note: If you do not have a
vjspai-link.ymlfile, please 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.
🔧 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—data sources cannot be loaded, workflow definitions cannot be found, or form fields cannot be rendered.
📋 Main Configuration Items Explanation
| Description | |
|---|---|
datasource | Data source configuration |
driverClassName | Database driver: currently supports MySQL, PostgreSQL, and Dameng Database drivers. For PostgreSQL: org.postgresql.Driver For MySQL: com.mysql.cj.jdbc.Driver For Dameng: dm.jdbc.driver.DmDriver |
url | Database connection URL |
username | Database username |
password | Database password |
staticPath | Static resource path (default value; no modification needed) |
mappingPath | Logical mapping files (default value; no modification needed) |
templatePath | HTML template generation path (default value; no modification needed) |
i18n | Internationalization: zh_CN for Chinese, ja_JP for Japanese, en_US for English |
appUrl | Application access URL. If you change the 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/
# Logical Mapping Files
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 Bean
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.
