CRUD for Metering Entities - m3ter Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

The m3ter Connector for Salesforce managed package offers automatic CRUD syncing from Salesforce for key metering entities - Products, Meters, Aggregations, and Compound Aggregations. In addition, the m3ter Admin Setup tab has been improved for enhanced usability and a new Balance Consumption Widget is available, which allows you to quickly check and track Balance draw-down progress. This topic explains how to work with these new features:

• CRUD Sync for Metering Entities
• Admin Setup
• Balance Consumption Widget

Important!

• Check Version. CRUD for metering entities and the other features described in this topic are only available in v0.15 and above. See m3ter Connector for Salesforce - Changelog for details on how to check your current installed version.

CRUD Sync for Metering Entities

The CRUD sync for metering entities feature delivers some common behavior across all entities it applies to, with the range of fields synced and certain constraints applied to specific entities:

• Common CRUD Behavior
• Products
• Meters
• Aggregations
• Compound Aggregations

Common CRUD Behavior

The common CRUD behavior for all affected entities is as follows:

• Automatic Sync. Creating, updating, or deleting records in Salesforce automatically syncs the change to the corresponding m3ter entities.
• Sync Status. The syncStatus_c field tracks sync status:
  • Not Synced
  • Success
  • Failed
  • Pending Deletion
  • Delete Failed
• Troubleshooting. A last synced timestamp and result message is stored on each record.
• Retries. Failed syncs can be retried manually.
• Custom Field Syncing. All four entity types support custom field syncing using customFields_c to store key/value pairs which are synced to m3ter.
• Deleting Records. Deleting a record moves it to the Recycle Bin and queues a deletion call to m3ter:
  • If deletion succeeds, the record is permanently removed.
  • If deletion fails, then record is restored from the Recycle Bin with a status of Delete Failed.
• Restoring Records. Restoring a record from the Recycle Bin resets sync status to Not Synced but does not undo the m3ter deletion. The m3ter entity must be re-synced or recreated in m3ter.

Products

• Fields synced: Name, Product Code, Custom Fields.
• Deletion restrictions: no deletion restrictions.

Meters

• Fields synced: Name, Code, Product (optional and if left blank = global Meter), Custom Fields, Data Fields, Derived Fields.
• Constraints: Product association cannot be changed once set.
• Deletion restrictions: A Meter that has Aggregations that target it cannot be deleted - you must delete any dependent Aggregations first.

Custom components of the record page:

• Data Fields
  • Inline editor for defining the Data Fields the Meter uses to collect raw data.
  • Each Data Field has Name, Code, Category, and Description.
  • Add or remove Data Fields directly from the record page; saved with a Save/Cancel flow.
• Derived Fields
  • Same inline editor as for Data Fields with additional Calculation Formula column.
  • Used to define fields that are computed from raw data at time of ingest.
• Custom Fields
  • Key/Value editor for the customFields_c field.
  • Keys must start with a letter or underscore and contain only alphanumeric characters and underscores.
  • Validates in real time - any invalid keys are flagged before saving.

Aggregations

• Fields synced: Name, Code, Meter (required), Target Field, Aggregation Type (SUM/MIN/MAX/COUNT/LATEST/MEAN/UNIQUE), Unit, Quantity Per Unit, Rounding, Default Value, Segmented Fields, Segments, Custom Fields.

• Constraints: On creation, Product is automatically inherited from targeted or parent Meter and cannot be changed.

• Deletion restrictions: no deletion restrictions.

• However, please note that if an Aggregation has been used to price a Plan in m3ter, then the deletion will be blocked on the Salesforce side.

Custom components of the record page:

• Target Field Picker
  • A drop-down shows all Data and Derived Fields on the linked Meter.
  • Options are labeled [Data] or [Derived] with field name and code.
  • Save/Cancel only activates when the selection has changed.
• Segmented Fields
  • Checkbox list of string type fields on the linked Meter - numeric fields cannot be segmented and are excluded.
  • Up to 5 fields can be selected, and further selections are blocked once this limit is reached.
  • A running count of selected fields is shown.
• Segment Values
  • Table editor for defining specific segment value combinations.
  • Table columns are derivative on the Segments Fields selections, which should be made first.
  • Each row defines a segment. You can leave a cell blank to wildcard that field for the segment - matches any value.
  • Duplicate rows are flagged and up to 1,000 segments are supported.

Compound Aggregations

• Fields synced: Name, Code, Calculation Expression, Product (Optional), Unit, Quantity Per Unit, Rounding, Evaluate Null Aggregations, Custom Fields.
• Constraints: Calculation Expression references Aggregation codes not Salesforce field names.
• Evaluate Null Aggregations ( Default is OFF):
  • When OFF, any simple Aggregations that have null values and are referenced by the Calculation Expression will not be passed in for evaluation. (Note: that simple Aggregations targeting Meter Data Fields with no usage data will have null values.)
  • When ON, referenced simple Aggregations with null values will be passed in and evaluated. (Tip: set the default values on any referenced simple Aggregations to 0 for predictable results.)
• Product scope:
  • Optional and global Compound Aggregations can be used to price Plans belonging to any Product.
  • Product cannot be changed once set.
• Deletion restrictions: no deletion restrictions.
  • However, please note that if a Compound Aggregation has been used to price a Plan in m3ter, then the deletion will be blocked on the Salesforce side.

Admin Setup

The m3ter Admin Setup now opens with an Overview tab where the connection status is visible at a glance: The CONNECTED STATUS banner shows:

• Connected/Disconnected state.
• The m3ter connection URL.
• Quick links provided for editing the connection and for opening docs.
• When connected, the TIMEZONE of the m3ter Organization synced to.
• Pattern cards enabling quick navigation to:
  • Auto-Sync settings.
  • m3sh Triggers if enabled.
  • Docs for Sync to m3ter.

Balance Consumption Widget

A new Lightning component has been added to the Balance record page, which shows Wallets Balance cards that carry a visual Balance consumption progress bar:

• Balance Details:
  • Name
  • Consumed amount
  • Available amount
  • Total Balance
  • Currency
• Balance Consumption:
  • Progress bar color coded for tracking consumption level:
    • Green = < 75%
    • Orange = 75% to 89%
    • Red = ≥ 90%
• Refresh:
  • Auto-refresh every 2 minutes.
  • Manual refresh button.