Agent Console displays account, premises, and service details only when the required fields on Product, Account, Billing Account, Location, Service Point, and Energy Service Agreement records are set. Review which fields Agent Console reads and the values it expects.
How Agent Console Uses Energy Service Agreements
Agent Console finds an account's premises through its energy service agreements, and it updates those agreements when an agent starts, stops, or transfers a service.
- To find premises, Agent Console captures all active energy service agreement items for the current date that belong to active energy service agreements. Then it captures the premises from each item's service point:
EnergyServiceAgreementItems.ServicePoint.Premises. - When an agent starts a service with a bundle product, Agent Console creates an energy service agreement for the primary product and an energy service agreement item for each child product in the bundle.
- When an agent starts a service without a bundle product, Agent Console creates an energy service agreement and an energy service agreement item for the product.
- When an agent stops a service, Agent Console sets the energy service agreement's end date to the selected move-out date and its status to Terminated.
- When an agent transfers a service, Agent Console updates the end dates of all associated energy service agreements and creates energy service agreements for all service points at the new location for every billing account.
Product Fields Required for Agent Console
Set these Product fields so that products appear in Agent Console. Only active products appear.
| 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 Fields for Bundles
To define a bundle product, set these Product Relationship Type fields.
| 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 Fields for Bundles
Set these fields on each Product Related Component record that links a child product to a bundle.
| 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 Displayed in Agent Console
Agent Console displays these Account fields.
| Field | Notes |
|---|---|
| BillingCity, BillingCountry, BillingPostalCode, BillingState, BillingStreet, Industry, Phone | Details from these fields are displayed in the Details tab of the account. |
| SourceSystemIdentifier | Displayed as Customer ID. |
Billing Account Fields Required for Agent Console
Agent Console shows only active billing accounts. Set these Billing Account fields.
| 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 Fields Required for Agent Console
Agent Console shows only active locations, which represent premises. Set these Location fields.
| Field | Notes |
|---|---|
| Status | Set Status to Active. Only active locations are visible in Agent Console. |
| Name, VisitorAddressId, ExternalReference | Details of the premises. |
Service Point Fields Required for Agent Console
Set these Service Point fields for each service point at a premises.
| Field | Notes |
|---|---|
| ServiceType | Choose a service point type such as Electricity, Gas, etc. |
| Status | Set the status to Connected. |
Energy Service Agreement Settings for Agent Console
Agent Console shows an account's energy service agreements in a dynamic related list. To configure it, open an account in Agent Console, click Edit Page, select the Energy Service Agreements dynamic related list, and set these properties:
- 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: Selected
- Related List Fields: Name, Type, Billing Schedule, Product, External Contract Identifier
- Sort Field: Created Date
- Sort Order: Descending
Set these fields on each Energy Service Agreement record.
| Field | Notes |
|---|---|
| AccountId | Set to the account associated with the Energy Service Agreement. |
| Status | Set the status to Active. |