CData Python Connector for SugarCRM

Build 25.0.9454

Metrics

Stores configuration details for metric definitions that drive pipeline and performance visualization. This table supports reporting dashboards and role-based KPIs.

Columns

Name Type ReadOnly Description
Acl_Team_Names String True

The list of team names that are associated with the record for access control purposes. This field supports permission inheritance and record visibility.

Acl_Team_Set_Id String False

The Identifier (Id) of the team set that defines collective access permissions. This Id enables shared ownership and collaboration across multiple teams.

Assigned_User_Id String False

The Id of the user who is assigned to this metric configuration. This assignment determines ownership and workflow responsibility.

Assigned_User_Name String True

The display name of the user who is assigned to this metric configuration.

Created_By String True

The Id of the user who created the record. This information is used for auditing and historical tracking.

Created_By_Name String True

The display name of the user who created the record.

Date_Entered Datetime True

The date and time when the record was created. This timestamp reflects when the metric configuration first entered the system.

Date_Modified Datetime True

The date and time when the record was last modified. This timestamp is updated whenever a user or system process changes the record.

Deleted Bool False

A Boolean field that returns a value of 'true' when the metric record is flagged as deleted. It returns a value of 'false' when the record remains active. This field enables soft-delete behavior instead of permanent removal.

Description String False

A detailed description that explains the purpose or usage of the metric. Users often apply this field to provide context for dashboards, reporting, or shared definitions.

Filter_Def String False

The serialized filter definition that is used to refine or limit the dataset displayed in the metric. This value is typically generated by module filtering tools in the UI.

Following Bool False

A Boolean field that returns a value of 'true' when the current user is following the record. It returns a value of 'false' when the user is not following it. Following enables notifications and activity stream tracking.

Freeze_First_Column Bool False

A Boolean field that returns a value of 'true' when the first column in the metric result set should remain fixed during horizontal scrolling. It returns a value of 'false' when the first column should scroll normally.

Id [KEY] String True

The unique Id of the metric record.

Labels String False

A JSON-formatted set of labels that are associated with the metric layout. These labels define display text for metric components in dashboards and saved views.

Metric_Context String False

The context in which the metric is evaluated (for example, list view, dashboard visualization, or reporting workspace). This field influences how metric data is formatted and presented.

Metric_Module String False

The name of the SugarCRM module against which the metric definition is built. This value determines the source of underlying data.

Modified_By_Name String True

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

Modified_User_Id String True

The Id of the user who last modified the record.

My_Favorite Bool False

A Boolean field that returns a value of 'true' when the record is marked as a favorite by the current user. It returns a value of 'false' when it is not marked as a favorite. Favoriting helps users quickly access frequently used metrics.

Name String False

The user-defined name of the metric configuration. This name appears in dashboards, saved metrics lists, and shared workspace views.

Order_By_Primary String False

The field that is used as the primary sorting key when displaying metric results. This ordering determines the main hierarchy of data presentation.

Order_By_Primary_Direction String False

The direction of the primary sorting order (for example, 'ascending' or 'descending'). This direction affects how metric data is visually structured.

Order_By_Secondary String False

The field that is used as the secondary sorting key to break ties in primary ordering. This field provides fine-grained data sorting within grouped records.

Order_By_Secondary_Direction String False

The direction of the secondary sorting order (for example, 'ascending' or 'descending'). This direction determines how secondary sorting is applied.

Status String False

The status of the metric configuration. This status indicates whether the metric is active, inactive, draft, or system-generated.

Sync_Key String True

An internal synchronization key that is used to match the record across integrations or distributed environments.

Tag String False

Tags that are assigned to the record for search and categorization. Tags support filtering, grouping, and discovery across dashboard and analytics interfaces.

Team_Count String False

The count of teams that are associated with the record. This value assists in displaying ownership distribution.

Team_Id String False

The Id of the primary team that is associated with the record. The primary team determines base-level record visibility.

Team_Name String False

The name of the primary team that is associated with the record. This value is used for display in UI lists and filters.

Team_Set_Id String False

The Id of the team set that represents all teams that have access to the record. This Id is used for access control inheritance.

Viewdefs String False

The serialized view definition structure that is used to render the metric in the SugarCRM interface. This field controls layout components, displayed columns, and arrangement logic.

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