Configuration Parameters
Overview
To address issues related to different deployment environments and software dependency calls, the platform extracts configurable content as system configurations. By modifying these configurations, administrators can quickly adjust configuration data and rapidly switch system dependencies.
Storage
Configuration of system file storage paths and rules
Parameter Description
| id | Name | Description |
|---|---|---|
| textindex.homePath | Full-text Search Storage Root Path | Directory where the system's search engine module stores dictionary files |
| app.backup.homePath | APP Backup Path | When an application is deleted, the system automatically backs up application configuration information to this path |
| fileservice.homePath | Local File Storage Root Path | Root path for local file storage |
| system.companyDbIndex | Team Data Storage Database Index | Business database index. Changes only affect teams created afterward; previously created teams continue to store data according to their original index |
Additional Notes
- To improve access speed, files accessed by users (account avatars, application materials, website resources, data table attachments, etc.) are temporarily stored on the server, with the
Local File Storage Root Pathas the root directory.
SystemHook Configuration
Used for single sign-on functionality. For more detailed usage scenarios, please refer to the documentation Single Sign-On
Parameter Description
| id | Name | Description |
|---|---|---|
| system.systemHookApplicationId | System Hook Application ID | Configure the application ID where system hook scripts are stored |
| system.systemHookDbIndex | Database Index for the Team to Which the System Hook Application Belongs | The Team Data Storage Database Index of the team to which the application belongs |
| system.systemHookApplicationScript | System Hook Script Path | Path to the script, using a relative path. For example, if stored in systemhook.js at the root directory, configure as systemhook.js |
| system.systemHookLoginFunc | Trigger Function When Logging in on Informat Page | Triggered after users enter their account and password on the Informat login page and click login |
| system.systemHookLogoutFunc | Trigger Function When Logging out on Informat Page | Triggered when users log out on the Informat login page |
| system.systemHookSsoFunc | Trigger Function When SSO Login is Initiated from Third-party Pages | Triggered after third-party pages request the Informat SSO service address |
| system.systemHookBeforeInvokeFunc | Trigger Function Before Calling biz System Services | Triggered before calling biz system services |
| system.systemHookAfterInvokeFunc | Trigger Function After Calling biz System Services | Triggered after calling biz system services |
Login and Resources
Parameter Description
| Name | Description |
|---|---|
| Homepage Address | Web service address. Prefix for links sent in system email notifications Prefix for links that can be opened when the system sends WeChat notifications |
| Login Address | Authorization address to jump to when user login information expires |
| Resource Address | Static resource loading address |
| API Address | Service address for system page API requests |
| System Dynamic Routing Mode | Routing mode used by the system web site, options:hash: Uses URL hash values for routing, supports all browsers including those that do not support HTML5 History API.history: Depends on HTML5 History API and server configuration |
| Token Expiration Seconds | Any system operation will update the token validity period. If there is no operation for the configured number of seconds, the token will expire; default is 3 days |
| System Login Page Title | Displayed in the browser tab. If not set, the system default title is used |
| System Login Page Background Image | If not set, the system default background image is used |
| System Login Page Company LOGO | If not set, no logo is displayed |
| System Login Page Description Text | Displayed at the bottom of the login box, supports rich text |
Additional Notes on Login Address
If not filled, the system default jump logic is used
Example:
js
https://next.informat.cn/sso/redirect?ticket=xxx&redirectUrl=https%3A%2F%2Fnext.informat.cn%2Fsso%2Flogin%3FrdUrl%3D{rdUrl}%26logintType%3D{tokenType}After configuration is enabled, it will automatically jump to this address when authentication information expires in the following situations:
- User login expires within the platform
- User logs out within the platform
- User accesses the system login page
URL Address Description
- The filled value must be a correct URL address.
- The system can carry dynamic parameters
- Redirect address: {rdUrl}. After authentication failure, the frontend will replace this parameter with the link to the page where the user is currently located
- Login type: {tokenType}. After authentication failure, the frontend will replace this parameter with the current user's login type. Login type range: (index, mobile)
Additional Notes on Resource Address
- If not filled, the current address bar domain name and port are used by default
- For standalone deployment of static resources, an independent static resource server
- Use cloud services or private CDN services, such as Tencent Cloud Content Delivery Network ,Alibaba Cloud CDN Content Delivery Network
Additional Notes on API Address
- If not filled, the current address bar domain name and port are used by default
- After configuration is enabled, the specified address will be used directly.
- After configuration is enabled, it is important to enable CORS settings to allow cross-origin requests.
Password Rules
After configuring password rules, users must comply with these rules when setting passwords to save successfully.
Parameter Description
| Name | Description |
|---|---|
| Password Rule Regular Expression | ^(?=.[a-z])(?=.[A-Z])(?=.*\d)[A-Za-z\d]{8,20}$ |
| Password Rule Description | Example: Password must contain at least 1 uppercase letter, 1 lowercase letter, and 1 number, with a length of 8-20 characters, allowing only uppercase and lowercase letters and numbers |
| Password Force Update Time (Days) | Number of days after which passwords must be forcibly updated, e.g., 365 days |
File Preview Service
Used for OFFICE file preview, editing, and other functions
Parameter Description
| Name | Description |
|---|---|
| Office File Preview Method | Set the type of office file preview service. Option value: onlyoffice |
| Office File Preview Address | Set the office file preview service address, e.g., http://{external IP}:9002/ |
| Office File Preview Host Whitelist | Set the host IP or domain name that can call the file preview service, separated by English commas |
File Shared Storage
Used for file sharing storage operations such as uploading and editing avatars, application LOGOs, and attachment fields
Parameter Description
| Name | Description |
|---|---|
| Amazon S3 Access Key | Amazon S3 access key |
| Amazon S3 Bucket Name | Bucket name must be at least 3 characters and no more than 63 characters |
| Amazon S3 EndPoint | Network address used to access the S3 service. The default Minio EndPoint address for default installations is: http://127.0.0.1:19000 |
| Amazon S3 Region Information | Physical location where bucket data is stored |
| Amazon S3 SecretKey | Part of the authentication credentials used to access and manage S3 resources. Together with the "Access Key ID", it forms the security credentials for accessing AWS resources |
| Amazon S3 Client Maximum Http Connections | Set the maximum number of HTTP concurrent connections to optimize upload and download performance |
| File Type Whitelist | Multiple types separated by commas, e.g., .jpeg,.png (If a whitelist is set, files not in the whitelist cannot be uploaded) |
| File Type Blacklist | Multiple types separated by commas, e.g., .exe,.bat (If a blacklist is set, files in the blacklist cannot be uploaded) |
| Maximum Upload File Size | Unit: MB |
File Storage Configuration Based on Amazon S3
When the platform is deployed, it comes with a Minio file storage service installed, which is an Amazon S3-compatible file storage. Minio Chinese Site ,Minio English Site
Other object storage services based on the S3 protocol are also supported, such as Tencent Cloud Object Storage COS, Alibaba Cloud Object Storage OSS, and Huawei Cloud Object Storage OBS.
Tencent Cloud Object Storage COS Configuration Example:
- Open Tencent Cloud COS Management Console
- Create a bucket and obtain the bucket name and region
- Create API key "Access Management >> Access Key >> API Key Management" to get SecretId and SecretKey
- In the Informat backend "System Information >> Parameter Settings"
Information obtained from the first 3 steps:
| id | Description |
|---|---|
| Bucket Name | informat2-uat-1251341307 |
| Region | Guangzhou (China) (ap-guangzhou) |
| SecretId | AKIDpuv88tTt52kDR3BjUDhqoY3MJ1UCy0tX |
| SecretKey | jHeni3r55rJjnVzSokV3QdePveBUch9X |
Alibaba Cloud Object Storage OSS Configuration Example:
- Open Alibaba Cloud OSS Management Console
- Create a bucket and obtain the bucket name and region
- Create API key "AccessKey Management >> AccessKey" to get AccessKey Id and AccessKey Secret
- In the Informat backend "System Information >> Parameter Settings"
Information obtained from the first 3 steps:
| id | Description |
|---|---|
| Bucket Name | informat2-uat |
| AccessKey Id | LTAI5tN65CnzhRxCoJx2Crpj |
| AccessKey Secret | XH0J2MPcyf1NQht1tQKOro9mpamdWn |
TIP
Endpoint needs to distinguish between internal and external networks. Be sure to use the internal network address, such as https://oss-cn-hangzhou-internal.aliyuncs.com (needs to include https://)
Huawei Cloud Object Storage OBS Configuration Example:
- Open Huawei Cloud OBS Management Console
- Create a bucket and obtain the bucket name and Endpoint
- Create API key "My Credentials >> Access Keys", download credentials.csv to get Access Key Id and Secret Access Key
- In the Informat backend "System Information >> Parameter Settings"
Information obtained from the first 3 steps:
| id | Description |
|---|---|
| Bucket Name | informat2-uat |
| Access Key Id | BU2QQXQ8X1EVBGPPTUPX |
| Secret Access Key | UTN32FWwMwqi1KMKaq4dhlfgx41ouEheeIzt2iVX |
Data Table
Used for data table-related configurations
Parameter Description
| Name | Description |
|---|---|
| Text Watermark Font Name | Default font is SimSun |
Map Service
Used for data table geographic location coordinates fields to open maps for coordinate selection and map view display records. Currently only supports Amap
Parameter Description
| Name | Description |
|---|---|
| Amap APPKEY | Amap JSAPI application KEY |
| Amap Security Key | Keys applied after December 2, 2021 need to be used with your security key |
| Amap Proxy Server Domain or Address | Setting a proxy server domain or address can effectively prevent leakage of Amap APPKEY and Amap Security Key |
Additional Notes
- The platform internally loads the Amap JSAPI synchronously. If Amap Proxy Server Domain or Address is configured, it prioritizes using the proxy for loading; otherwise, it uses the Amap Security Key for loading
- Amap-related configurations can be obtained through the Application Management Center application
- The service platform for application application must be Web (JSAPI)
- Application Key, Secret, and JSAPI proxy can be referenced
AI
Used for AI-related functions in the system such as data table field configuration AI queries and form-based AI queries
Parameter Description
| Name | Description |
|---|---|
| Enable AI | After enabling, the platform supports AI-related functions |
| AI Service Address | For OpenAI, enter https://api.openai.com. For proxy servers, configure the proxy server Chat interface URL |
| OpenAI chatGPT Interface API Key | OpenAI cahtGPT interface API key |
| AI ChatCompletions Interface Address | Default value: https://api.openai.com/v1/chat/completions |
| AI Model Name | Default value: gpt-4o |
TIP
The chatGPT interface URL https://api.openai.com can be a proxy server address without /v1/chat/completions
Git
Used for Git-related functions
Parameter Description
| Name | Description |
|---|---|
| Git Command Path | Path where Git is installed on the server, e.g., /usr/bin/git |
Node
Used for Node-related functions
Parameter Description
| Name | Description |
|---|---|
| Node Command Line | Path where Node is installed on the server, e.g., /usr/local/bin/node |
| Node Module Path | Used for compiling component designer components, e.g., /informat-next |
| Npm Command Line | Path where NPM is installed on the server, e.g., /usr/local/bin/npm |
| NPM Proxy URL | After configuration, all requests made through NPM will be routed through this proxy server |
| Enable NPM | Whether to enable NPM. If enabled, scripts can use npm package management |
Monitoring
Used for Informat service monitoring and other related functions
Parameter Description
| Name | Description |
|---|---|
| Server Monitoring Address | Deployed server monitoring address |
Application Market
Parameter Description
| Name | Description |
|---|---|
| Application Market Type | Disable; External source address; Default |
| Application Market Public Access | Can be enabled to allow third parties to download applications from the application market |
| Application Market External Source | Can configure the Informat official website application market source address: https://next.informat.cn/account/market/apps |