You are here:
Agent Console Objects and Fields
To display account details correctly in the Agent Console, ensure that the fields in these objects are populated correctly.
Capturing Premises for an Account
-
In Agent Console, all active energy service agreement items for the current date that have active energy service agreements are captured.
-
The premises are then captured from the service point field in the energy service agreement items: EnergyServiceAgreementItems.ServicePoint.Premises
Starting a Service
- If you start a service with a bundle product, an energy service agreement object is created for the primary product, while energy service agreement items are created for all child products in the bundle.
- If you start a service without a bundle product, an energy service agreement object and energy service agreement item object is created for the product.
Stopping a Service
- When you stop a service, the end date and status in the energy service agreement are updated to the selected move out date, and Terminated respectively.
Transfer a Service
- When you transfer a service, the end dates of all associated the energy service agreements are updated, and new energy service agreements are created for all service points at the new location against every billing account.
Product
| Field | Notes |
| Active | Enable the Active field in the Product object, as only active products are seen in the program. |
| Family | Add a product family such as Electricity, Gas etc. |
| Type | Specify whether a product is a Bundle or not. |
Product Relationship Type
| Field | Notes |
| AssociatedProductRoleCat | The position category that the associated product plays in the relationship. Supported value BundleComponent. |
| MainProductRoleCat | The position category that the main product plays in the relationship, supported value Bundle |
Product Related Component
| Field | Notes |
| ParentProductId | The main product around which the bundle or set is built.. |
| ChildProductId | In a bundle relationship, this item is the child product. |
| QuantityScaleMethod | The scaling method used to calculate the associated product's quantity based on changes made to the main product's quantity in a transaction.Supported value Proportional. |
| DoesBundlePriceIncludeChild | Indicates whether the bundle price includes the associated component product's price. |
Account
| Fields | Notes |
| BillingCity, BillingCountry, BillingPostralCode, BillingState, BillingStreet, Industry, Phone | Details from these fields are displayed in the Details tab of the account. |
| SourceSystemIdentifier | Displayed as Customer ID. |
Billing Account
| Field | Notes |
| PrimaryBillAddrCity, PrimaryBillAddrCountry, PrimaryBillAddrPostalCode, PrimaryBillAddrState, PrimaryBillAddrStreet | Details from these fields are displayed as the billing address of the billing account. |
| Status | Set the Status to Active. Only active billing accounts are visible in Agent Console. |
Location
| Field | Notes |
| Status | Set Status to Active. Only active locations are visible in Agent Console. |
| Name, VisitorAddressId, ExternalReference | Details of the premises. |
Service Point
| Field | Notes |
| ServiceType | Choose a service point type such as Electricity, Gas, etc. |
| Status | Set the status to Connected. |
Energy Service Agreement
The Energy Service Agreement for an account is displayed as a related list in the account. In Agent Console, open an account, then click Edit Page, and select the Energy Service Agreements dynamic related list. Ensure that the following are set correctly:
- Parent Record : Use This Account
- Related List : Energy Service Agreements
- Related List Type : List
- Number of Records to Display : 5
- Show list view action bar : true
- Related List Fields : Name, Type, Billing Schedule, Product, External Contract Identifier
- Sort Field : Created Date
- Sort Order : Descending
Also ensure that these fields in the Energy Service Agreement object are set correctly.
| Field | Notes |
| AccountId | Set to the account associated with the Energy Service Agreement. |
| Status | Set the status to Active. |

