@nocobase/plugin-ai 2.3.0-alpha.1 → 3.0.0-alpha.2

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/created-by.md

@@ -1,13 +1,111 @@
+---
+title: "Created by"
+description: "The Created by field automatically records the user who created a record."
+keywords: "Created by,createdBy,field,Field interface,NocoBase"
+---
+
 # Created by
 
 ## Introduction
 
-To be added
+In NocoBase, **Created by** automatically records the user who created a record.
+
+It is usually generated by preset fields and is suitable for permissions, responsibility tracking, filters, and auditing. For a business owner, handler, or approver, create a separate user relation field instead.
+
+## Use cases
+
+Created by fields are suitable for these business scenarios:
+
+- Creation responsibility tracking
+- Audit records
+- Creator-based filters
+- Permission and workflow conditions
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Created by** to create this field.
+
+![Configure a Created by field](https://static-docs.nocobase.com/index-2025-11-01-00-50-59.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Created by uses `createdBy`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Created by`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Created by uses `belongsTo` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Is maintained automatically and normally does not require manual validation. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Created by field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `createdBy`. |
+| Default Field type | `belongsTo`. |
+| Available Field types | `belongsTo`. |
+| Page component | Displays a related user maintained by the system. |
+| Filtering | Supports filtering by creator. |
+| Sorting | Supports sorting where supported by the relation mapping. |
+| Validation | Is maintained automatically and normally does not require manual validation. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Created by field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Created by field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Created by fields are suitable for auditing, responsibility tracing, and creator-based filtering.
+
+![Use a Created by field in a page](https://static-docs.nocobase.com/20260710153223.png)
 
-## Field Configuration
 
-![index-2025-11-01-00-50-59](https://static-docs.nocobase.com/index-2025-11-01-00-50-59.png)
+| Scenario | Use |
+| --- | --- |
+| Table block | Display and filter the creator. |
+| Details block | Display the record creator. |
+| Filter block | Filter records by creator. |
+| Workflows and permissions | Use the creator in conditions. |
 
-## Example
+## Related links
 
-To be added
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/space.md

@@ -1,17 +1,111 @@
 ---
-pkg: "@nocobase/plugin-multi-space"
+title: "Space"
+description: "The Space field records the space to which data belongs and supports data isolation by space."
+keywords: "Space,space,field,Field interface,NocoBase"
 ---
 
 # Space
 
 ## Introduction
 
-To be added
+In NocoBase, **Space** records the space to which data belongs.
 
-## Field Configuration
+It appears after the Multi-space plugin is enabled and isolates data by space. Do not use it as an ordinary business field. For a business department, region, or project dimension, create a normal relation or choice field instead.
 
-![index-2025-11-01-00-50-45](https://static-docs.nocobase.com/index-2025-11-01-00-50-45.png)
+## Use cases
 
-## Example
+Space fields are suitable for these business scenarios:
 
-To be added
+- Data isolation by space
+- Multi-space access control
+- Space-scoped records
+- Multi-tenant data separation
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Space** to create this field.
+
+![Configure a Space field](https://static-docs.nocobase.com/index-2025-11-01-00-50-45.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Space uses `space`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Space`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Space uses `belongsTo` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Is normally maintained by the system or space context. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Space field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `space`. |
+| Default Field type | `belongsTo`. |
+| Available Field types | `belongsTo`. |
+| Page component | Is maintained by system and space context. |
+| Filtering | Supports filtering by the current space where configured. |
+| Sorting | It is usually not used for sorting. |
+| Validation | Is normally maintained by the system or space context. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Space field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Space field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Space fields are suitable only for Multi-space data isolation.
+
+
+
+
+| Scenario | Use |
+| --- | --- |
+| Table block | Display the space where appropriate. |
+| Details block | Display the record space. |
+| Filters and permissions | Limit records by current space. |
+| Workflows | Use space context in business logic. |
+
+## Related links
+
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/table-oid.md

@@ -1,13 +1,111 @@
+---
+title: "Table OID"
+description: "The Table OID field identifies the collection to which a record belongs."
+keywords: "Table OID,tableoid,field,Field interface,NocoBase"
+---
+
 # Table OID
 
 ## Introduction
 
-## Field configuration
+In NocoBase, **Table OID** identifies the collection to which a record belongs.
+
+It is commonly used by inheritance collections or scenarios that need to distinguish the source collection of a record. It is mainly a system and metadata capability; ordinary business collections usually do not need it.
+
+## Use cases
+
+Table OID fields are suitable for these business scenarios:
+
+- Inheritance collections
+- Distinguishing a record source collection
+- System metadata
+- Collection-level record identification
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Table OID** to create this field.
+
+![Configure a Table OID field](https://static-docs.nocobase.com/20240512174746.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Table OID uses `tableoid`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Table OID` or `Source collection`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Table OID uses `virtual` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Is normally maintained by the system. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Table OID field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `tableoid`. |
+| Default Field type | `virtual`. |
+| Available Field types | `virtual`. |
+| Page component | Is maintained as a virtual system field. |
+| Filtering | Supports filtering where supported by system metadata. |
+| Sorting | It is usually not used for sorting. |
+| Validation | Is normally maintained by the system. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Table OID field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Table OID field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Table OID fields are suitable for system metadata and inheritance scenarios.
+
 
 
-![20240512174746](https://static-docs.nocobase.com/20240512174746.png)
 
+| Scenario | Use |
+| --- | --- |
+| Details block | Display source-collection metadata where needed. |
+| System configuration | Distinguish a record source collection. |
+| Workflows | Use collection metadata in advanced logic. |
+| APIs | Return collection-source metadata where needed. |
 
-## Example
+## Related links
 
-to be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/updated-at.md

@@ -1,13 +1,112 @@
-# Updated At
+---
+title: "Updated at"
+description: "The Updated at field automatically records when a record was last updated."
+keywords: "Updated at,updatedAt,field,Field interface,NocoBase"
+---
+
+# Updated at
 
 ## Introduction
 
-## Field Configuration
+In NocoBase, **Updated at** automatically records the last update time of a record.
+
+It is usually generated by preset fields and is suitable for auditing, synchronization decisions, sorting, filtering, and workflow conditions. For a manually entered completion or approval time, use DateTime.
+
+## Use cases
+
+Updated at fields are suitable for these business scenarios:
+
+- Audit and update-time tracking
+- Synchronization decisions
+- Sorting and filtering by update time
+- Workflow conditions
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Updated at** to create this field.
+
+![Configure a Updated at field](https://static-docs.nocobase.com/20240512174826.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Updated at uses `updatedAt`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Updated at` or `Last updated`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Updated at uses `date` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Is maintained automatically and normally does not require manual validation. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Updated at field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `updatedAt`. |
+| Default Field type | `date`. |
+| Available Field types | `date`. |
+| Page component | Is maintained automatically by the system. |
+| Filtering | Supports date-time filtering. |
+| Sorting | Supports chronological sorting in Table blocks. |
+| Validation | Is maintained automatically and normally does not require manual validation. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Updated at field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Updated at field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Updated at fields are suitable for audit, synchronization, filters, and workflow conditions.
 
+![Use a Updated at field in a page](https://static-docs.nocobase.com/20260710153223.png)
 
-![20240512174826](https://static-docs.nocobase.com/20240512174826.png)
 
+| Scenario | Use |
+| --- | --- |
+| Table block | Display, sort, and filter records by update time. |
+| Details block | Display the record update time. |
+| Filter block | Filter records by update date. |
+| Workflows and permissions | Use the update time in conditions. |
 
-## Example
+## Related links
 
-To be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.
+- [DateTime](../datetime/datetime.md) - Store a manually entered business date and time.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/updated-by.md

@@ -1,13 +1,111 @@
-# Last updated by
+---
+title: "Updated by"
+description: "The Updated by field automatically records the user who last updated a record."
+keywords: "Updated by,updatedBy,field,Field interface,NocoBase"
+---
+
+# Updated by
 
 ## Introduction
 
-To be added
+In NocoBase, **Updated by** automatically records the user who last updated a record.
+
+It is usually generated by preset fields and is suitable for auditing, responsibility tracking, filters, and workflow conditions. For a business owner, handler, or approver, create a separate user relation field instead.
+
+## Use cases
+
+Updated by fields are suitable for these business scenarios:
+
+- Last editor tracking
+- Audit records
+- Editor-based filters
+- Workflow and responsibility conditions
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Updated by** to create this field.
+
+![Configure a Updated by field](https://static-docs.nocobase.com/index-2025-11-01-00-51-12.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Updated by uses `updatedBy`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Updated by` or `Last updated by`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Updated by uses `belongsTo` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Is maintained automatically and normally does not require manual validation. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Updated by field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `updatedBy`. |
+| Default Field type | `belongsTo`. |
+| Available Field types | `belongsTo`. |
+| Page component | Displays a related user maintained by the system. |
+| Filtering | Supports filtering by last editor. |
+| Sorting | Supports sorting where supported by the relation mapping. |
+| Validation | Is maintained automatically and normally does not require manual validation. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Updated by field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Updated by field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Updated by fields are suitable for audit, responsibility tracing, and editor-based filtering.
+
+![Use a Updated by field in a page](https://static-docs.nocobase.com/20260710153223.png)
 
-## Field Configuration
 
-![index-2025-11-01-00-51-12](https://static-docs.nocobase.com/index-2025-11-01-00-51-12.png)
+| Scenario | Use |
+| --- | --- |
+| Table block | Display and filter the last editor. |
+| Details block | Display the last editor. |
+| Filter block | Filter records by last editor. |
+| Workflows and permissions | Use the last editor in conditions. |
 
-## Example
+## Related links
 
-To be added
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.