Skip to content

Data User Guide

Template

Download the upload template, which includes field names and data type requirements. Prepare your data according to the specified format before uploading.

Note: Keep all content in the template. Data rows must start from the third row.

Upload

Batch import data into the system.

Note: Only CSV format is supported.

Please use UTF-8 encoded CSV files.

To avoid data misalignment issues, open the CSV file in Notepad, move any unquoted fields to the last column, save the file, and then upload.

img_2.png

img_2.png

Four import modes are available:

1. Overwrite

Full replacement: deletes all existing data before importing new data.

2. Append

Keeps existing data and adds new records from the uploaded file.

3. Modify

Batch update: the uploaded file must include the primary key id.

4. Delete

Batch delete: the uploaded file must include the primary key id.

Download

Downloads all data in full.

+NEW

Create a single record via the NEW button using one of two methods: manual entry or file upload with auto-recognition.

+new.png

Manual Creation

Manually enter a single record. Suitable for structured data entry scenarios.

Steps

  1. Click the NEW button to open the creation page.
  2. Fill in the required data fields.
  3. Submit the form to create the record.

Auto-generated Fields (Read-only)

The following fields are generated automatically and cannot be edited:

  • id
  • createby
  • createtime
  • lastupdateby
  • lastupdatetime

img_2.png

Upload File

Upload a file to automatically recognize and generate structured data. Suitable for automated entry of documents such as invoices.

Description

  1. Permission check: Only users with the current group's permission can upload files.
  2. Supported file types: Images, PDF.
  3. Recognition logic: The system automatically performs OCR or content recognition on the uploaded file.
  4. View results: After recognition, click Edit to review results. The interface includes:
    • Left side: file preview
    • Right side: recognized data

Upload Example

new_upload.png

Recognition Result Example

new_preview.png

Edit

Modify a single record and submit the changes.

The following fields cannot be edited: id, createby, createtime, lastupdateby, lastupdatetime.

img_3.png

Delete

Delete a single record.

Bulk Edit and Delete

When records are selected, the Edit and Delete buttons become visible, allowing bulk operations. Bulk modification requires that no field other than id has a uniqueness constraint.

img.png

Enter text in the search box to trigger a fuzzy search on indexed fields. The search executes when the input box loses focus.

img.png

Sub-form

When creating a form, assign a parent_id to the sub-form — the parent_id should be the form_id of the parent form. A single form can have multiple sub-forms.

img.png

In the Data view, if a sub-form exists, click Edit to access it:

img_1.png

img_2.png

Sub-forms support create, read, update, and delete operations.

img_3.png

Refresh

One-click refresh of all materialized views and Cube caches associated with the current table. A notification will display the names of the refreshed views and cubes.

img.png

Share

Two sharing modes are available:

a. Share for creation (no data selected): Allows the target user to create new records. The user can only view records they created.

b. Share for editing (with data selected): Shares specific records with a user. The createby field of the shared records is updated to the target user's account.

img_1.png

  • Share form: All shared users can create new data records.
  • Share data (single or multiple records): Can only be shared with one user at a time. The user can then create, read, update, and delete that record.

Events

Remote Dropdown Data

Fetch URL:
https://g8hk7lagpe.execute-api.us-west-2.amazonaws.com/olap_prod_v2_internal/interface/formdatalist

Parameters:

  • form_id — the target form
  • field — field name to use as the dropdown list

img_2.pngimg_3.png

Component Interaction via JavaScript

Example: Set gender based on age

When age > 30, set gender to "Male"; otherwise set to "Female".

javascript
const fApi = $inject.api
const formData = fApi.form;
if (formData.age > 30) {
  formData.gender = 'Male'
} else {
  formData.gender = 'Female'
}

img_4.png

Example: Hide submit button when phone number is too short

javascript
const fApi = $inject.api
const options = fApi.config;
const formData = fApi.form;

if (formData.phone.length > 10) {
  fApi.updateOptions({ submitBtn: true })
} else {
  fApi.updateOptions({ submitBtn: false })
}

img_5.png

Remote Query

img_6.png

File Upload

1. Overview

Configure an Upload component in the Designer page to enable file uploads. Uploaded files can then be accessed from the Data page.

2. Configuration Steps

2.1 Configure the Upload Component in the Designer
  1. Select the Upload component type in the Designer page.
  2. Set the upload file type (e.g., text).
  3. Save the configuration.
2.2 Test File Upload in the Data Page
  1. Go to the Data page and open the New/Edit dialog.
  2. Click Upload to upload a file.
  3. After a successful upload, the filename will be displayed.
  4. Click the filename to access the stored file via its URL.

3. Notes

  • If you change the data type of the Upload component in the Designer, you must first delete old data in the Data page before using the upload feature again.
  • If you change an existing field type (e.g., from input to upload), verify that the corresponding MySQL field length is sufficient.

4. Reference Screenshots

upload2.png

upload5.png

Parent-Child Data Sharing Configuration

This feature is designed for multi-level nested form scenarios. Sub-form query conditions can automatically reference saved field values from the parent form, enabling data linkage and context-aware filtering.


Step 1: Configuration

  1. Open the Designer page and select the target sub-form component.

  2. In the right-side properties panel, expand Props and click the Edit icon.

  3. In the JSON configuration window, enter the following:

    json
    "custom_condition": {
      "condition": [
        {
          "expression": "eq",
          "attribute_name": "",  // Field name for filtering
          "attribute_value": ""
        }
      ]
    }

    props_5.png

  4. Click Save to confirm the sub-form configuration.

  5. Return to the Designer page and click the top Save button to save the overall form.

  6. Switch to the Data page and ensure the parent form fields have been saved.

  7. Open the sub-form for editing — the system will automatically populate query conditions based on parent form values.

  8. Sub-form Designer example:

    props_custom.png


Step 2: Remote API Configuration (fetch)

Applicable when any form field needs to retrieve enumeration data from a remote API.

This endpoint is no longer maintained:

https://g8hk7lagpe.execute-api.us-west-2.amazonaws.com/olap_prod_v2_internal/interface/formdatalist
It can be used for global enumeration queries but does not support filtering. For parent-child form sharing, use the endpoint below instead.

Endpoint:
https://g8hk7lagpe.execute-api.us-west-2.amazonaws.com/olap_prod_v2_internal/interface/formdatalistCondition

Parameters:

ParameterTypeDescription
form_idstringThe database table to query
fieldstringThe parent form field for filtering

Step 3: Examples

props_3.pngprops_4.png


Notes

  • This feature only applies to sub-form editing scenarios.
  • Parent form fields must be saved and consistent with the database.
  • The API request method is POST and cannot be changed to GET.

Result

props_1.pngprops_2.png