Skill for Creating and Updating Yida Form Pages

Overview

This skill describes how to call Yida APIs via HTTP requests to create or update form pages. Two modes are supported:

create mode: Create a new form page, define field lists, field types, options, etc. First create a blank form to get formUuid, then save the form Schema.
update mode: Update an existing form page, supporting operations like adding, deleting, modifying fields and adjusting attributes. First get the existing Schema, apply modifications and then save.

When to Use

Use this skill in the following scenarios:

Users need to create data collection forms (such as registration forms, survey forms) in applications
Users need to create form pages with fields to store data
Users need to update fields of existing forms (add, delete, modify)
After creating an application with yida-create-app, need to create forms to collect data

Usage Examples

Example 1: Create a New Form

Scenario: Create a simple user information form in an application Command:

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js create "APP_XXX" "用户信息表" '[{"type":"TextField","label":"姓名","required":true},{"type":"SelectField","label":"部门","options":["技术部","产品部"]}]'

Output:

json

{"success":true,"formUuid":"FORM-XXX","formTitle":"用户信息表","appType":"APP_XXX","fieldCount":2}

Example 2: Update an Existing Form

Scenario: Add a new field to an existing form Command:

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js update "APP_XXX" "FORM-XXX" '[{"action":"add","field":{"type":"TextField","label":"备注"}}]'

Usage Methods

create mode (Create New Form)

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js create <appType> <formTitle> <fieldsJsonOrFile>

Parameter Description:

Parameter	Required	Description
`appType`	Yes	Application ID, e.g., `APP_XXX`
`formTitle`	Yes	Form name
`fieldsJsonOrFile`	Yes	Field definition, supporting two formats: JSON string (starting with `[` ) or JSON file path

Example:

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js create "APP_xxx" "图片生成表" .claude/skills/yida-create-form-page/scripts/fields.json

Output: Logs are output to stderr, JSON results are output to stdout:

json

{"success":true,"formUuid":"FORM-XXX","formTitle":"图片生成表","appType":"APP_xxx","fieldCount":4,"url":"{base_url}/APP_xxx/workbench/FORM-XXX"}

update mode (Update Existing Form)

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js update <appType> <formUuid> <changesJsonOrFile>

Parameter Description:

Parameter	Required	Description
`appType`	Yes	Application ID, e.g., `APP_XXX`
`formUuid`	Yes	Unique identifier of the form page, e.g., `FORM-XXX`
`changesJsonOrFile`	Yes	Modification definition, supporting two formats: JSON string (automatically recognized if starting with `[` ) or JSON file path

Example (JSON string, recommended):

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js update "APP_xxx" "FORM-yyy" '[{"action":"add","field":{"type":"TextField","label":"备注"}}]'

Example (JSON file):

bash

node .claude/skills/yida-create-form-page/scripts/create-form-page.js update "APP_xxx" "FORM-yyy" changes.json

Output: Logs are output to stderr, JSON results are output to stdout:

json

{"success":true,"formUuid":"FORM-YYY","appType":"APP_XXX","changesApplied":3,"changes":[...],"url":"https://www.aliwork.com/APP_XXX/workbench/FORM-YYY"}

Field Definition JSON Format

Field definition is a JSON array, where each element describes a field. Two formats are supported:

Format 1 (Recommended)

Define

type

and

label

directly in the object:

json

[
  { "type": "TextField", "label": "姓名", "required": true },
  { "type": "SelectField", "label": "部门", "options": ["技术部", "产品部", "设计部"] },
  { "type": "DateField", "label": "入职日期" }
]

Format 2 (Compatible)

Place field properties in the

field

sub-object:

json

[
  { "field": { "type": "TextField", "label": "姓名" }, "required": true },
  { "field": { "type": "SelectField", "label": "部门", "options": ["技术部"] } }
]

Both formats have the same effect, Format 1 is recommended for its simplicity.

Field Properties:

Property	Type	Required	Description
`type`	String	Yes	Field type (see supported field types below)
`label`	String	Yes	Field label
`required`	Boolean	No	Whether it is required, default `false` (not required)
`placeholder`	String	No	Placeholder prompt text
`behavior`	String	No	Field behavior, `NORMAL` (normal, default) / `READONLY` (read-only) / `HIDDEN` (hidden)
`visibility`	String[]	No	Display terminals, `["PC", "MOBILE"]` (default) / `["PC"]` (PC only) / `["MOBILE"]` (mobile only)
`labelAlign`	String	No	Label alignment, `top` (default) / `left` / `right`
`options`	String[]	Conditionally required	Option list, required for option-type fields
`multiple`	Boolean	No	Whether multiple selection is allowed, available for `EmployeeField` / `DepartmentSelectField` / `CountrySelectField` / `AssociationFormField`
`children`	Object[]	Conditionally required	Sub-field list, required for `TableField`
`associationForm`	Object	Conditionally required	Associated form configuration object, required for `AssociationFormField` , see below for details

Default Properties of Each Field Type

The following lists the unique default properties automatically set when creating each field type (common properties like

fieldId

label

behavior

visibility

are shared by all fields and will not be repeated).

TextField / TextareaField

Property	Default Value	Description
`validationType`	`"text"`	Validation type
`maxLength`	`200`	Maximum number of characters
`hasClear`	`true`	Show clear button
`isCustomStore`	`true`	Custom storage
`scanCode.enabled`	`false`	Scan code input

NumberField

Property	Default Value	Description
`precision`	`0`	Number of decimal places
`step`	`1`	Step value
`thousandsSeparators`	`false`	Thousands separator
`isCustomStore`	`true`	Custom storage
`innerAfter`	""	Unit

RateField

Property	Default Value	Description
`count`	`5`	Total number of stars
`allowHalf`	`false`	Allow half stars
`showGrade`	`false`	Show grade text

RadioField / CheckboxField

Property	Default Value	Description
`dataSourceType`	`"custom"`	Data source type
`valueType`	`"custom"`	Value type

SelectField / MultiSelectField

Property	Default Value	Description
`showSearch`	`true`	Support search
`autoWidth`	`true`	Auto width
`filterLocal`	`true`	Local filtering
`mode`	`"single"` / `"multiple"`	Selection mode

DateField

Property	Default Value	Description
`format`	`"YYYY-MM-DD"`	Date format
`hasClear`	`true`	Show clear button
`resetTime`	`false`	Reset time
`disabledDate.type`	`"none"`	Disabled date rule
format options:

```
"YYYY"
```
: Year
```
"YYYY-MM"
```
: Year-Month
```
"YYYY-MM-DD"
```
: Year-Month-Day
```
"YYYY-MM-DD HH:mm"
```
: Year-Month-Day Hour:Minute
```
"YYYY-MM-DD HH:mm:ss"
```
: Year-Month-Day Hour:Minute:Second

CascadeDateField

Property	Default Value	Description
`format`	`"YYYY-MM-DD"`	Date format
`hasClear`	`true`	Show clear button
`resetTime`	`false`	Reset time
format options:

```
"YYYY"
```
: Year
```
"YYYY-MM"
```
: Year-Month
```
"YYYY-MM-DD"
```
: Year-Month-Day
```
"YYYY-MM-DD HH:mm"
```
: Year-Month-Day Hour:Minute
```
"YYYY-MM-DD HH:mm:ss"
```
: Year-Month-Day Hour:Minute:Second

EmployeeField

Property	Default Value	Description
`userRangeType`	`"ALL"`	User range
`showEmpIdType`	`"NAME"`	Display method
`startWithDepartmentId`	`"SELF"`	Starting department
`renderLinkForView`	`true`	Render link when viewing
`closeOnSelect`	`false`	Close after selection

DepartmentSelectField

Property	Default Value	Description
`deptRangeType`	`"ALL"`	Department range
`mode`	`"single"`	Selection mode
`isShowDeptFullName`	`false`	Show full department path
`hasSelectAll`	`false`	Select all button

CountrySelectField

Property	Default Value	Description
`mode`	`"single"`	Selection mode
`showSearch`	`true`	Support search
`hasSelectAll`	`false`	Select all button

AddressField

Property	Default Value	Description
`countryMode`	`"default"`	Country mode
`addressType`	`"ADDRESS"`	Address type
`enableLocation`	`true`	Enable location
`showCountry`	`false`	Show country

AttachmentField

Property	Default Value	Description
`listType`	`"text"`	List display type
`multiple`	`true`	Allow multiple files
`limit`	`9`	Maximum number of files
`maxFileSize`	`100`	Maximum file size (MB)
`autoUpload`	`true`	Auto upload
`onlineEdit`	`false`	Online editing

ImageField

Property	Default Value	Description
`listType`	`"image"`	List display type
`multiple`	`true`	Allow multiple images
`limit`	`9`	Maximum number of images
`maxFileSize`	`50`	Maximum file size (MB)
`accept`	`"image/*"`	Accepted file types
`enableCameraDate`	`true`	Camera watermark date
`enableCameraLocation`	`true`	Camera watermark location
`onlyCameraUpload`	`false`	Camera upload only

TableField

Property	Default Value	Description
`showIndex`	`true`	Show row numbers
`pageSize`	`20`	Number of rows per page
`maxItems`	`500`	Maximum number of rows
`minItems`	`1`	Minimum number of rows
`layout`	`"TABLE"`	PC-side layout
`mobileLayout`	`"TILED"`	Mobile layout
`theme`	`"split"`	Table theme
`showActions`	`true`	Show action column
`showDelAction`	`true`	Show delete button
`showCopyAction`	`false`	Show copy button
`enableExport`	`true`	Allow export
`enableImport`	`true`	Allow import
`enableBatchDelete`	`false`	Batch delete
`enableSummary`	`false`	Enable summary
`isFreezeOperateColumn`	`true`	Freeze action column

AssociationFormField

For detailed usage, refer to
reference/AssociationFormField.md

SerialNumberField

Property	Default Value	Description
`serialNumberRule`	Default rule (prefix + auto-increment)	Serial number generation rule array
`serialNumPreview`	`"serial00001"`	Serial number preview
`serialNumReset`	`1`	Reset starting value
`syncSerialConfig`	`false`	Whether to sync serial number configuration
`formula`	Auto-generated	Serial number formula (automatically generated by the system, including corpId, appType, formUuid, fieldId and rule configuration)

Default Serial Number Rule:

Rule 1: Fixed prefix "serial" (4 characters)
Rule 2: Auto-incrementing numbers (5 digits, starting from 1, no reset)

formula Format (object format, not string):

json

{
  "formula": {
    "expression": "SERIALNUMBER(\"<corpId>\", \"<appType>\", \"<formUuid>\", \"<fieldId>\", \"<escapedRuleJson>\")"
  }
}

Where

<escapedRuleJson>

is the JSON string of

{ "type": "custom", "value": <serialNumberRule array> }

, with double quotes escaped (

→

\"

Modification Definition JSON Format (update mode)

Modification definition is a JSON array, where each element describes a modification operation. It can be directly passed as a JSON string in the command line parameter, or written to a file and then passed as the file path.

json

[
  { "action": "add", "field": { "type": "TextField", "label": "姓名", "required": true } },
  { "action": "add", "field": { "type": "SelectField", "label": "部门", "options": ["技术部", "产品部"] }, "after": "姓名" },
  { "action": "delete", "label": "备注" },
  { "action": "update", "label": "年龄", "changes": { "required": true, "placeholder": "请输入年龄" } },
  { "action": "update", "label": "状态", "changes": { "label": "审批状态", "options": ["待审批", "已通过", "已拒绝"] } }
]

Operation Types

Operation	Required Properties	Optional Properties	Description
`add`	`field.type` , `field.label`	`after` , `before` , `field.required` , `field.options` , `field.placeholder` , `field.multiple` , `field.children` , `field.behavior` , `field.visibility` , `field.labelAlign`	Add a new field, `after` / `before` specifies the insertion position (matched by field label)
`delete`	`label`	—	Delete the field with the specified label
`update`	`label` , `changes`	`tableLabel`	Modify properties of the field with the specified label; if the field is in a sub-table, specify the parent-child table label via `tableLabel`

Properties Supported by update's changes

Property	Type	Description
`label`	String	Modify field label
`required`	Boolean	Modify whether it is required
`placeholder`	String	Modify placeholder prompt
`options`	String[]	Modify option list (for option-type fields: RadioField/SelectField/CheckboxField/MultiSelectField)
`multiple`	Boolean	Modify whether multiple selection is allowed (EmployeeField/DepartmentSelectField/CountrySelectField)
`behavior`	String	Modify field behavior: `NORMAL` / `READONLY` / `HIDDEN`
`visibility`	String[]	Modify display terminals: `["PC", "MOBILE"]` / `["PC"]` / `["MOBILE"]`
`innerAfter`	String	Modify number field unit (only available for `NumberField` ), e.g., `"H"` , `"元"`

Field Definition for add's field

Identical to the field definition format in create mode, refer to the "Field Definition JSON Format" section above.

Prerequisites

Node.js
```
.cache/cookies.json
```
exists in the project root directory (scan code login will be triggered automatically on first run)

Calling Process

create mode

Prepare the field definition JSON file
Read
```
.cache/cookies.json
```
in the project root directory to obtain the login state (including corpId); if it does not exist, automatically call
```
login.py
```
to trigger scan code login
Call the
```
saveFormSchemaInfo
```
API to create a blank form and get formUuid; automatically handle exceptions according to the
```
errorCode
```
in the response body (see the "Error Handling Mechanism" section of the yida-login skill document)
Generate the form Schema JSON based on the field definition (the formula of SerialNumberField will automatically use corpId, appType, formUuid and fieldId to construct)
Call the
```
saveFormSchema
```
API to save the Schema; also automatically handle exceptions according to the
```
errorCode
```
in the response body
Call the
```
updateFormConfig
```
API to update the form configuration (MINI_RESOURCE = 0); also automatically handle exceptions according to the
```
errorCode
```
in the response body

update mode

Read
```
.cache/cookies.json
```
in the project root directory to obtain the login state (including corpId); if it does not exist, automatically call
```
login.py
```
to trigger scan code login
Call the
```
getFormSchema
```
API to obtain the complete Schema of the current form; automatically handle exceptions according to the
```
errorCode
```
in the response body:
- ```
errorCode: "TIANSHU_000030"
```
  (csrf verification failed) → automatically refresh csrf_token and retry
- ```
errorCode: "307"
```
  (login expired) → automatically re-login and retry
Parse the modification definition (JSON string or JSON file)
Execute each modification operation in order:
- add: Construct a new field component and insert it at the specified position (or at the end)
- delete: Find and remove the field by label
- update: Find the field by label and update its properties
Set the formula for all SerialNumberField (using corpId, appType, formUuid and fieldId)
Call the
```
saveFormSchema
```
API to save the modified Schema; also automatically handle exceptions according to the
```
errorCode
```
in the response body (same as above)
Call the
```
updateFormConfig
```
API to update the form configuration (MINI_RESOURCE = 0); also automatically handle exceptions according to the
```
errorCode
```
in the response body (same as above)

File Structure

yida-create-form-page/
├── SKILL.md                    # This document
└── scripts/
    ├── create-form-page.js     # Form page creation & update script

API Description

saveFormSchemaInfo (Create Blank Form, create mode)

URL:

POST /dingtalk/web/{appType}/query/formdesign/saveFormSchemaInfo.json

Content-Type:
```
application/x-www-form-urlencoded
```
Parameters:

Parameter	Type	Required	Description
`_csrf_token`	String	Yes	CSRF Token (obtained from yida-login)
`formType`	String	Yes	Form type, fixed as `receipt`
`title`	String (JSON)	Yes	Form name, in i18n format: `{"zh_CN":"名称","en_US":"名称","type":"i18n"}`

Return Value:

json

{
  "content": { "formUuid": "FORM-XXX" },
  "success": true
}

getFormSchema (Obtain Form Schema, update mode)

URL:

GET /alibaba/web/{appType}/_view/query/formdesign/getFormSchema.json

Parameters:

Parameter	Type	Required	Description
`formUuid`	String	Yes	Form UUID
`schemaVersion`	String	No	Schema version, default `V5`

Return Value: Complete form Schema JSON, including
```
pages
```
array, with the same structure as the format saved by
```
saveFormSchema
```

saveFormSchema (Save Form Schema, shared by both modes)

URL:

POST /dingtalk/web/{appType}/_view/query/formdesign/saveFormSchema.json

Content-Type:
```
application/x-www-form-urlencoded
```
Parameters:

Parameter	Type	Required	Description
`_csrf_token`	String	Yes	CSRF Token (obtained from yida-login)
`formUuid`	String	Yes	Form UUID
`content`	String (JSON)	Yes	Form Schema content ( `schemaType: "superform"` )
`schemaVersion`	String	Yes	Fixed as `V5`
`importSchema`	String	Yes	Fixed as `"true"`

Return Value:

json

{ "success": true }

updateFormConfig (Update Form Configuration)

URL:

POST /dingtalk/web/{appType}/query/formdesign/updateFormConfig.json

Content-Type:
```
application/x-www-form-urlencoded
```
Parameters:

Parameter	Type	Required	Description
`_csrf_token`	String	Yes	CSRF Token (obtained from yida-login)
`formUuid`	String	Yes	Form UUID
`version`	Number	Yes	Version number (starts from 1 for newly created forms)
`configType`	String	Yes	Fixed as `MINI_RESOURCE`
`value`	Number	Yes	Fixed as `0` (form page configuration value)

Return Value:

json

{
  "success": true,
  "traceId": null,
  "throwable": null,
  "errorCode": null,
  "content": null,
  "errorMsg": null
}

Supported Field Types

Field Type	componentName	Description	Special Properties
`TextField`	TextField	Single-line text, used for names, titles, numbers, etc.	—
`TextareaField`	TextareaField	Multi-line text, used for descriptions, remarks, etc.	—
`RadioField`	RadioField	Single selection, used for gender, status and other mutually exclusive options	`options`
`SelectField`	SelectField	Drop-down single selection, suitable for scenarios with many options (>5)	`options`
`CheckboxField`	CheckboxField	Multiple selection, used for hobbies, skill tags, etc.	`options`
`MultiSelectField`	MultiSelectField	Drop-down multiple selection, suitable for scenarios with many options (>5)	`options`
`NumberField`	NumberField	Number, used for amounts, quantities, ages, etc.	—
`RateField`	RateField	Rating, used for satisfaction evaluation and other star rating scenarios	—
`DateField`	DateField	Date, used for birthdays, deadlines, etc.	—
`CascadeDateField`	CascadeDateField	Cascading date, used for date range selection	—
`EmployeeField`	EmployeeField	Member, select members within the organization	`multiple`
`DepartmentSelectField`	DepartmentSelectField	Department, select departments within the organization	`multiple`
`CountrySelectField`	CountrySelectField	Country, select countries/regions	`multiple`
`AddressField`	AddressField	Address, used for shipping addresses, etc.	—
`AttachmentField`	AttachmentField	Attachment upload	—
`ImageField`	ImageField	Image upload	—
`TableField`	TableField	Table (sub-table), used for structured data	`children`
`AssociationFormField`	AssociationFormField	Associated form	`associationForm`
`SerialNumberField`	SerialNumberField	Serial number, automatically generate unique numbers	`serialNumberRule`

Cooperation with Other Skills

Create Application → Use
```
yida-create-app
```
skill to get
```
appType
```
Create Form Page → This skill (create mode), get
```
formUuid
```
and field IDs
Update Form Page → This skill (update mode), perform field add/delete/modify on existing forms
Obtain Form Schema → Use
```
get-schema
```
skill to view the current form structure in advance
Record Configuration → Write
```
formUuid
```
and field IDs to
```
prd/<project-name>.md
```
Create Custom Page → Use
```
yida-create-page
```
skill
Deploy Page Code → Use
```
yida-publish
```
skill

Tip: If you need to create a custom display page (no fields, used for deploying JSX code), please use the
yida-create-page
skill.

Form Data Operation APIs

The following APIs are used to perform add/delete/modify/search operations on form data in custom pages or scripts, called via
this.utils.yida.<method-name>(params)
, all APIs return Promise.

saveFormData — Create New Form Instance

Parameter	Type	Required	Description
`formUuid`	String	Yes	Form UUID
`appType`	String	Yes	Application ID
`formDataJson`	String	Yes	Form data (JSON string)

javascript

this.utils.yida.saveFormData({
  formUuid: 'FORM-XXX',
  appType: window.pageConfig.appType,
  formDataJson: JSON.stringify({
    textField_xxx: 'Single-line text',
    numberField_xxx: 100,
  }),
}).then(function(res) {
  console.log('Created successfully, instance ID:', res.result);
}).catch(function(err) {
  console.error('Creation failed:', err.message);
});

updateFormData — Update Form Instance

Parameter	Type	Required	Description
`formInstId`	String	Yes	Form instance ID
`updateFormDataJson`	String	Yes	Fields to be updated (JSON string)

javascript

this.utils.yida.updateFormData({
  formInstId: 'FINST-XXX',
  updateFormDataJson: JSON.stringify({ textField_xxx: 'New value' }),
});

deleteFormData — Delete Form Instance

Parameter	Type	Required	Description
`formUuid`	String	Yes	Form UUID
`formInstId`	String	Yes	Form instance ID

getFormDataById — Query Single Instance Details

Parameter	Type	Required	Description
`formInstId`	String	Yes	Form instance ID

searchFormDatas — Query Instance List by Condition

Parameter	Type	Required	Description
`formUuid`	String	Yes	Form UUID
`searchFieldJson`	String	No	Filter by field value (JSON string)
`currentPage`	Number	No	Current page, default 1
`pageSize`	Number	No	Number of records per page, default 10, maximum 100

javascript

this.utils.yida.searchFormDatas({
  formUuid: 'FORM-XXX',
  searchFieldJson: JSON.stringify({ textField_xxx: 'Query value' }),
  currentPage: 1,
  pageSize: 10,
}).then(function(res) {
  // res.data: Instance list, res.totalCount: Total number
  console.log('Query results:', res.data);
});

searchFormDataIds — Query Instance ID List by Condition

Same parameters as

searchFormDatas

, returns an array of instance IDs (suitable for batch operation scenarios).

getFormComponentDefinationList — Obtain Form Field Definitions

Parameter	Type	Required	Description
`formUuid`	String	Yes	Form UUID

Notes

Temporary files are written to the .cache folder in the current project root directory; create the folder if it does not exist, do not write to other system folders
In update mode, the operations in the modification definition JSON are executed in sequence, pay attention to the dependencies between operations (e.g., delete first then add)
Field matching is based on Chinese labels (
```
label.zh_CN
```
), ensure the label name is accurate
```
componentsMap
```
is automatically updated when adding fields, no manual handling required
It is recommended to view the current Schema structure via the
```
get-schema
```
skill before making important modifications
The script is compatible with the old create mode calling method (without the
```
create
```
prefix), but it is recommended to use the new explicit mode parameter

Set Default Value of EmployeeField to Current Logged-in User

The update mode of

create-form-page.js

does not support directly setting the "current logged-in user" default value for EmployeeField, which needs to be achieved by directly modifying the Schema after update.

Correct Schema Configuration Format

To set the default value of Yida EmployeeField to the current logged-in user, the following three properties need to be modified simultaneously (obtain the Schema via

getFormSchema

, directly modify the props of the corresponding field, then call

saveFormSchema

to save):

json

{
  "valueType": "variable",
  "complexValue": {
    "complexType": "formula",
    "formula": "USER()",
    "value": []
  },
  "variable": {
    "type": "user"
  }
}

⚠️ Note:
formula
must be
"USER()"
, not
"CURRENT_USER()"
(the latter will be rejected by Yida, reporting "Expression parsing failed" error).

Modification Steps

Call
```
getFormSchema
```
to obtain the current Schema (return structure is
```
{ success, content: { pages, ... } }
```
)
Recursively find the field node of the target
```
fieldId
```
in the
```
content
```
object
Write the above three properties to the field node
Call
```
saveFormSchema
```
and pass in the modified
```
content
```
(note: pass the
```
content
```
object, not the entire response body)
Call
```
updateFormConfig
```
to update the form configuration

Detailed Explanation of SerialNumberField Serial Number Rules

Default Scenario (No Custom Requirements)

Only one

autoCount

rule, 4-digit auto-increment, starting from 1, no reset:

json

{
  "serialNumberRule": [
    {
      "resetPeriod": "noClean",
      "dateFormat": "yyyyMMdd",
      "ruleType": "autoCount",
      "timeZone": "+8",
      "__sid": "item_auto_count",
      "__hide_delete__": true,
      "__sid__": "serial_auto_count",
      "digitCount": "4",
      "isFixed": true,
      "initialValue": 1,
      "content": "",
      "formField": ""
    }
  ],
  "serialNumPreview": "0001"
}

⚠️ Note: For the default
autoCount
rule,
__hide_delete__
must be
true
(cannot be deleted), and
digitCount
is the string
"4"
.

Custom Scenario (Combination of Multiple Rules)

The following 4 rule types are supported, which can be combined and arranged arbitrarily:

`ruleType`	Description	Key Fields
`autoCount`	Auto count (auto-incrementing numbers)	`digitCount` (number of digits, string), `initialValue` (starting value), `resetPeriod` (reset period)
`character`	Fixed character	`content` (fixed string content)
`date`	Submission date	`dateFormat` (date format, e.g., `"yy"` , `"yyyyMMdd"` )
`form`	Get form field value	`formField` (field fieldId)

Custom Rule General Structure:

json

{
  "resetPeriod": "noClean",
  "dateFormat": "yyyyMMdd",
  "ruleType": "<type>",
  "timeZone": "+8",
  "__sid": "item_<unique-id>",
  "__hide_delete__": false,
  "__sid__": "serial_<unique-id>",
  "digitCount": 4,
  "isFixed": true,
  "initialValue": 1,
  "content": "<fixed-character, only fill for character type>",
  "formField": "<field-fieldId, only fill for form type>",
  "isFixedTips": "",
  "resetPeriodTips": ""
}

⚠️ Note: In custom rules,
digitCount
is of number type (not string), and
__hide_delete__
is
false
; while in the default
autoCount
rule,
digitCount
is the string
"4"
and
__hide_delete__
is
true
.

resetPeriod
Reset Period Options:

Value	Description
`"noClean"`	No reset (permanent auto-increment)
`"day"`	Reset daily
`"month"`	Reset monthly
`"year"`	Reset annually

dateFormat
Date Format Options (for

date

type rules):

Value	Example
`"yy"`	`26` (last two digits of year)
`"yyyy"`	`2026`
`"yyyyMM"`	`202603`
`"yyyyMMdd"`	`20260311`

Example: Rule Configuration for
YY-Submission Date-4-digit Auto Count
:

json

{
  "serialNumberRule": [
    {
      "ruleType": "character",
      "content": "YY",
      "dateFormat": "yyyyMMdd", "timeZone": "+8",
      "resetPeriod": "noClean", "digitCount": 4,
      "isFixed": true, "initialValue": 1,
      "isFixedTips": "", "resetPeriodTips": "",
      "formField": "",
      "__sid": "item_char_yy", "__sid__": "serial_char_yy", "__hide_delete__": false
    },
    {
      "ruleType": "date",
      "content": "",
      "dateFormat": "yy", "timeZone": "+8",
      "resetPeriod": "noClean", "digitCount": 4,
      "isFixed": true, "initialValue": 1,
      "isFixedTips": "", "resetPeriodTips": "",
      "formField": "",
      "__sid": "item_date_yy", "__sid__": "serial_date_yy", "__hide_delete__": false
    },
    {
      "ruleType": "autoCount",
      "content": "",
      "dateFormat": "yyyyMMdd", "timeZone": "+8",
      "resetPeriod": "noClean", "digitCount": 4,
      "isFixed": true, "initialValue": 1,
      "isFixedTips": "", "resetPeriodTips": "",
      "formField": "",
      "__sid": "item_auto", "__sid__": "serial_auto", "__hide_delete__": true
    }
  ],
  "serialNumPreview": "YY260001"
}

formula Construction Rules

formula

must be in object format (not string), the last parameter of

expression

is the JSON string of

{ "type": "custom", "value": <serialNumberRule array> }

, with double quotes escaped:

javascript

var ruleJson = JSON.stringify({ type: 'custom', value: serialNumberRule });
var escapedRuleJson = ruleJson.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
var expression = 'SERIALNUMBER("' + corpId + '", "' + appType + '", "' + formUuid + '", "' + fieldId + '", "' + escapedRuleJson + '")';
obj.formula = { expression: expression };

yida-create-form-page

NPX Install

Tags

SKILL.md Content (Chinese)

Skill for Creating and Updating Yida Form Pages

Overview

When to Use

Usage Examples

Example 1: Create a New Form

Example 2: Update an Existing Form

Usage Methods

create mode (Create New Form)

update mode (Update Existing Form)

Field Definition JSON Format

Format 1 (Recommended)

Format 2 (Compatible)

Default Properties of Each Field Type

TextField / TextareaField

NumberField

RateField

RadioField / CheckboxField

SelectField / MultiSelectField

DateField

CascadeDateField

EmployeeField

DepartmentSelectField

CountrySelectField

AddressField

AttachmentField

ImageField

TableField

AssociationFormField

SerialNumberField

Modification Definition JSON Format (update mode)

Operation Types

Properties Supported by update's changes

Field Definition for add's field

Prerequisites

Calling Process

create mode

update mode

File Structure

API Description

saveFormSchemaInfo (Create Blank Form, create mode)

getFormSchema (Obtain Form Schema, update mode)

saveFormSchema (Save Form Schema, shared by both modes)

updateFormConfig (Update Form Configuration)

Supported Field Types

Cooperation with Other Skills

Form Data Operation APIs

saveFormData — Create New Form Instance

updateFormData — Update Form Instance

deleteFormData — Delete Form Instance

getFormDataById — Query Single Instance Details

searchFormDatas — Query Instance List by Condition

searchFormDataIds — Query Instance ID List by Condition

getFormComponentDefinationList — Obtain Form Field Definitions

Notes

Set Default Value of EmployeeField to Current Logged-in User

Correct Schema Configuration Format

Modification Steps

Detailed Explanation of SerialNumberField Serial Number Rules

Default Scenario (No Custom Requirements)

Custom Scenario (Combination of Multiple Rules)

formula Construction Rules