Documents
Stores document metadata and content references. This table supports file storage, sharing, and record attachment workflows.
Columns
| Name | Type | ReadOnly | Description |
| Acl_Team_Names | String | True |
The list of team names that are associated with the document record through team-based access control. |
| Acl_Team_Set_Id | String | False |
The unique identifier (Id) of the team set that provides shared access and collaborative permissions for the document record. |
| Active_Date | Date | False |
The date when the document becomes active or available for use or reference within the system. |
| Assigned_User_Id | String | False |
The Id of the user who is assigned to manage or maintain the document record. |
| Assigned_User_Name | String | True |
The display name of the user who is assigned to manage or maintain the document record. |
| Category_Id | String | False |
The Id of the category used to group or classify the document for navigation, filtering, and organization. |
| Commentlog | String | True |
A system-generated comment log that records collaborative discussion, review notes, and user interactions with the document record. |
| Contract_Name | String | False |
The name of the contract that is associated with the document when the document is linked to a contract record. |
| Contract_Status | String | False |
The contract status that is associated with the document, providing context for business approval, renewal, or compliance workflows. |
| Created_By | String | True |
The Id of the user who created the document record. |
| Created_By_Name | String | True |
The display name of the user who created the document record. |
| Date_Entered | Datetime | True |
The date and time when the document record was created. |
| Date_Modified | Datetime | True |
The date and time when the document record was most recently modified. |
| Deleted | Bool | False |
A Boolean field that returns a value of 'true' when the document record is marked for deletion. It returns a value of 'false' when the record remains active, supporting standard soft-delete behavior. |
| Description | String | False |
A full-text description that provides additional detail or context about the document's purpose or content. |
| Doc_Id | String | False |
The Id of the document as stored in an integrated external document storage provider such as Google Drive or Microsoft OneDrive. |
| Doc_Type | String | True |
The external storage provider type where the document is stored, (for example, 'Google Drive', 'Box', or 'IBM SmartCloud'). |
| Doc_Url | String | False |
The URL that is used to retrieve the externally stored document from the linked document provider. |
| Document_Name | String | False |
The display name of the document record within Sugar's Documents module. |
| Document_Revision_Id | String | False |
The Id of the most recent document revision that is associated with this document. |
| Exp_Date | Date | False |
The expiration date of the document, which is often used for compliance, contract renewals, or document lifecycle workflows. |
| Filename | String | False |
The filename of the document file that is attached to this record. |
| Following | Bool | False |
A Boolean field that returns a value of 'true' when the current user is following the document record to receive activity notifications. It returns a value of 'false' when the user is not following the record. |
| Id [KEY] | String | True |
The Id for the document record. |
| Is_Shared | Bool | False |
A Boolean field that returns a value of 'true' when the document has been shared with external users or systems. It returns a value of 'false' when the document is available only within the internal system. |
| Is_Template | Bool | False |
A Boolean field that returns a value of 'true' when the document serves as a reusable template. It returns a value of 'false' when the document is a standalone or uploaded file. |
| Last_Rev_Create_Date | String | True |
The date when the most recent revision of the document was created. |
| Last_Rev_Created_Name | String | False |
The display name of the user who created the most recent document revision. |
| Last_Rev_Mime_Type | String | False |
The content type of the most recent document revision, used to determine how the file can be viewed or downloaded. |
| Latest_Revision | String | False |
The revision label or marker that identifies the most recent version of the document. |
| Latest_Revision_File_Ext | String | True |
The file extension of the most recent document revision (for example, 'PDF', 'DOCX', or 'XLSX'). |
| Latest_Revision_File_Mime_Type | String | True |
The content type of the most recent document revision file. |
| Latest_Revision_File_Size | String | True |
The file size of the most recent document revision, represented in bytes. |
| Latest_Revision_Id | String | False |
The Id of the most recent revision that is associated with this document record. |
| Latest_Revision_Name | String | False |
The display name of the most recent document revision. |
| Linked_Id | String | False |
The Id of a related record when the document is linked as an attachment or supporting reference. |
| Locked_Fields | String | True |
A list of fields that are restricted from modification due to administrative configuration or workflow enforcement. |
| Modified_By_Name | String | True |
The display name of the user who last modified the document record. |
| Modified_User_Id | String | True |
The Id of the user who last modified the document record, used for audit and accountability tracking. |
| My_Favorite | Bool | False |
A Boolean field that returns a value of 'true' when the record is marked as a favorite by the user for quick access. It returns a value of 'false' when the record is not marked as a favorite. |
| Name | String | False |
The name that is assigned to the document for display in record lists, selection dialogs, and dashboards. |
| Related_Doc_Id | String | False |
The Id of another document that this record is associated with in metadata-based workflows. |
| Related_Doc_Name | String | True |
The display name of the related document that is used in metadata-based document relationships. |
| Related_Doc_Rev_Id | String | False |
The Id of the related document revision that is used for reference, comparison, or lookup. |
| Related_Doc_Rev_Number | String | True |
The revision number of the related document that is used for version comparison and selection. |
| Revision | String | False |
The revision label that is assigned to this document record, reflecting its version history or update sequence. |
| Selected_Revision_Filename | String | False |
The filename of the selected revision when multiple revisions are available. |
| Selected_Revision_Id | String | False |
The Id of the selected revision for download, preview, or workflow processing. |
| Selected_Revision_Name | String | False |
The display name of the selected revision. |
| Status | String | False |
The current status of the document, often used for workflow gating, publishing, or archival stages. |
| Status_Id | String | False |
The Id that corresponds to the document status value in the metadata framework. |
| Subcategory_Id | String | False |
The Id of the subcategory that is used to further classify the document within a nested or hierarchical category structure. |
| Sync_Key | String | True |
A synchronization key that is used to match and track the document record across connected systems or integration endpoints. |
| Tag | String | False |
A collection of user-defined tags that are used for searching, grouping, and filtering document records. |
| Team_Count | String | False |
The number of teams that are associated with the document record for access control. |
| Team_Id | String | False |
The Id of the primary team that is associated with the document record. |
| Team_Name | String | False |
The display name of the primary team that is associated with the document record. |
| Team_Set_Id | String | False |
The Id of the full team set that is associated with the document record for collaborative access. |
| Template_Type | String | False |
The template classification that is used when the document functions as a reusable merge or correspondence template. |