CData Python Connector for SugarCRM

Build 25.0.9454

DocumentMerges

Stores configuration rules that are used for document generation and template merging. This table supports automated production of customer-facing documents.

Columns

Name Type ReadOnly Description
Acl_Team_Names String True

The list of team names that are associated with the document merge 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 merge record.

Assigned_User_Id String False

The Id of the user who is assigned to manage or review the document merge record.

Assigned_User_Name String True

The display name of the user who is assigned to manage or review the document merge record.

Commentlog String True

A system-maintained log of comment entries that capture discussion history and collaboration context.

Created_By String True

The Id of the user who created the document merge record.

Created_By_Name String True

The display name of the user who created the document merge record.

Date_Entered Datetime True

The date and time when the document merge record was created.

Date_Modified Datetime True

The date and time when the document merge record was most recently modified.

Deleted Bool False

A Boolean field that returns a value of 'true' when the document merge record is marked for deletion. It returns a value of 'false' when the record remains active in the system under soft-delete behavior.

Description String False

A free-form text description that provides additional context or processing notes related to the document merge.

Dismissed Bool False

A Boolean field that returns a value of 'true' when the merge notification or task has been dismissed by the user. It returns a value of 'false' when the merge remains pending or visible.

File_Type String True

The file type associated with the generated document (for example, 'PDF' or 'DOCX').

Flow_Data String False

A serialized data structure that stores workflow, merge settings, and runtime parameters associated with the document generation process.

Following Bool False

A Boolean field that returns a value of 'true' when the current user is following the record to receive notifications. It returns a value of 'false' when the user is not following the record.

Generated_Document_Id String True

The Id of the generated document file that results from the merge operation.

Id [KEY] String True

The Id for the document merge record.

Locked_Fields String True

A list of fields that are restricted from modification due to workflow or administrative configuration.

Merge_Type String True

The type of merge that was performed, such as single-record merge or multi-record merge.

Message String True

A message string that provides status detail, user feedback, or system logging information related to the merge process.

Modified_By_Name String True

The display name of the user who last modified the document merge record.

Modified_User_Id String True

The Id of the user who last modified the document merge record, used for audit tracking.

My_Favorite Bool False

A Boolean field that returns a value of 'true' when the user marks the document merge record as a favorite. 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 merge record for identification in lists and dashboards.

Parent_Id String True

The Id of the parent record that the merge is associated with (for example, 'Account', 'Contact', or 'Case').

Parent_Name String True

The display name of the parent record that is associated with the merge.

Parent_Type String True

The module or record type of the parent record associated with the document merge.

Record_Ids String True

The list of record Ids that are included in a multi-record merge operation.

Seen Bool False

A Boolean field that returns a value of 'true' when the merge is viewed by the assigned user. It returns a value of 'false' when it remains unseen.

Status String True

The current processing state of the document merge, such as pending, in progress, or completed.

Sync_Key String True

A synchronization key that is used to match the document merge record across integrations or replication environments.

Tag String False

A set of user-defined tags that support filtering, organization, and grouping.

Team_Count String False

The number of teams that are associated with the document merge record for visibility and access control.

Team_Id String False

The Id of the primary team that is associated with the document merge record.

Team_Name String False

The display name of the primary team that is associated with the document merge record.

Team_Set_Id String False

The Id of the complete team set that provides combined access permissions for the record.

Template String True

The display name of the document template that is used during the merge process.

Template_Id String True

The Id of the document template that defines the layout and merge fields used to generate the document.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454