Versions Compared

Old Version 1

changes.mady.by.user Kim Blake

Saved on

compared with

New Version Current

changes.mady.by.user Graham Paul

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The diagram in Figure 1 shows the Sigma Tenant Billing Item Schema and the relationships that exist between:

  • Core Sigma Items (shown in yellow);
  • Tenant Billing items (shown in purple);

Relationships shown in black are visible in the Data Selector pane of the Sigma Browser screens.
Relationships shown in red are not visible in the Data Selector pane of the Sigma Browser screens.

...

Configuring and maintaining Tenant Billing Items involves the following activities:

...

A Tenant Provider

...

WHERE IS THIS?  See [2] Sigma User Guide – Maintain Tariffs for details on how to configure and maintain Tariffs, Tariff Entries and Cost Definitions used in Tenant Billing. 

Tenant Billing Item Configuration Screens

Accessing Tenant Billing Item Configuration Screens

These screens are normally accessed from the Data Selector pane of the Sigma Browser screen having first searched for an Item using one of the views (e.g. Tree Selector, Item Finder, etc) as described in the following sub-sections:

  • Maintain Tenant Providers (see section 2.2).
  • Maintain Tenants (see section 2.3).
  • Maintain Tenant Accounts (see section 2.4).
  • Maintain Tenant Adhoc Charges (see section 2.5).
  • Maintain Configuration of Tenant Adhoc Charges (see section 2.6).
  • Maintain Tariff Connectors (see section 2.7).
  • Maintain Supply Point Contract Containers (see section 2.8).
  • Maintain Channel Data Quality (see section 2.9).

The screens to maintain Tenant Adhoc Charges (see section 2.5) and to maintain the configuration of Tenant Adhoc Charges (see section 2.6) can only be accessed from the Tenant Account Editor (see section 2.4.2 and 2.4.3).
It is also possible to access the Tenant Account Editor (see section 2.4.3) from various Tenant Billing Activity screens, for example within the Tenant Approve and Issue Bills Activity it is possible to view the Tenant Account linked to a Tenant Bill (see [3] Sigma User Guide – Manage Tenant Bills for further details).

Maintaining the Tenant Provider

A Tenant Provider represents the Organisation / Site Manager that is billing the Tenants and holds the Contracts and Tariffs for Tenant Billing.
It is possible This section shows how to:

  • View all Tenant Providers that are configured under an Organisation.
  • Add a Tenant Provider under an Organisation.View/edit an existing Tenant Provider under an Organisation.
  • Delete Edit an existing Tenant Provider under an Organisation.

Tenant Provider

...

To view Tenant Providers under an Organisation:

Open a Sigma Browser Activity  e.g. the Tenant Account Link Generator Activity

Select the Tree Selector view in the Data Selector pane

...

Double click on the Organisation 

Double click on TENANT PROVIDER

The Tenant Provider(s)

...

are displayed

...

Image Removed

Image Added

Adding a Tenant Provider

To add a Tenant Provider under an Organisation:

  • Right-click on the Organisation
  • Click Add 
  • Click Tenant Provider 

...

Image Added

Alternatively:

Right click on TENANT PROVIDER 

Click Add Tenant Provider

Image Added


Configure the Tenant Provider details as follows:

FieldDescription
Provider Name  name of the Tenant Provider
Description  description of the Tenant Provider (optional)
EAN Location Number 

mandatory field. It is needed so that Tenant Bills can be loaded into Sigma but can be any value

Arbitrary Reference (optional). This can be used to record information about the Tenant Provider that is relevant to your business
VAT Registration Number (optional). This will typically appear on Tenant invoices where they are created
Financial Code (optional). This can be used to record information about the Tenant Provider that is relevant to your business. It can also be included in export files generated by the Tenant Accounts Link Generator Activity
Receipt Email Address XXXXXXXXXXXXXXXXXXXXXXEnter the email address
Location tab (optional). Click on the tab and enter address details for the Tenant Provider. This will typically appear on Tenant invoices where they are created


Image Added

Click OK 

The Tenant Provider details are saved and the Tenant Provider Editor closes.

Alternatively, click the Cancel button to abandon the changes and close the Tenant Provider Editor.

Image Removed

...

Maintaining a Tenant Provider

To view/ edit an existing Tenant Provider under an Organisation:

Select the Tenant Provider in the Data Selector pane

Right

...

click on the Tenant Provider

...

Click Edit

The Tenant Provider Editor opens with the saved details for the Tenant Provider

Image Added

Change the details of the Tenant Provider as required

...

Deleting a Tenant Provider

To delete an existing Tenant Provider under an Organisation:

  • Select the Tenant Provider in the Data Selector pane
  • Right click on the Tenant Provider and click  Delete item

Image Removed

  • The Confirm Delete pop-up opens:
  • Select an Admin user from the User dropdown list
  • Enter the correct Password for this user
  • Click OK to confirm the removal of the Tenant Provider.
  • The Confirm Delete pop-up closes and the Tenant Provider is no longer displayed in the Data Selector pane
    • Note: If any Tenant Billing Groups exist that reference this Tenant Provider, they should first be removed first
    • Note: Any Contracts defined under the Tenant Provider will also be deleted and so any future attempts to bill Supply Point Contract Containers that reference these Contracts will fail

Maintaining Tenants

A Tenant represents an end-Customer that is billed by the Tenant Provider.
It is possible to:

  • View all Tenants that are configured under an Organisation.
  • Add a Tenant under an Organisation.
  • View/edit an existing Tenant under an Organisation.
  • Delete an existing Tenant under an Organisation.

Viewing Tenants

To view Tenants under an Organisation:

  • Open a Sigma Browser Activity that displays the Data Selector pane
  • Select the Tree Selector view 
  • Click on the Tree View so that the Organisation is visible
  • Click [TENANT] 
  • The Tenant(s) configured under the Organisation are displayed

Image Removed

Adding a Tenant

To add a Tenant under an Organisation:

  • Right click on the Organisation
  • Click Add 
  • Click Tenant

Image Removed

  • The Tenant Editor opens
  • Configure the Tenant details as follows:

...

Click OK to save

The Tenant details are saved and the Tenant Editor closes

Image Removed

Viewing /Editing the Tenant

To view/edit an existing Tenant under an Organisation:

  • Select the Tenant in the Data Selector pane
  • Right click on the Tenant
  • Click Edit

Image Removed

  • The Tenant Editor opens with the details for the Tenant
  • Amend the details of the Tenant as required
  • Click OK 
  • The Tenant details are saved and the Tenant Editor closes.

Deleting a Tenant

To delete an existing Tenant under an Organisation:

  • Select the Tenant in the Data Selector pane
  • Right click on the Tenant
  • Click Delete Item 

Image Removed

Maintaining Tenant Accounts

A Tenant Account is used for managing Tenant Bills. One Tenant Account will exist for each Supply Point being billed. Each Tenant can have one or many Tenant Accounts.
It is possible to:

  • View all Tenant Accounts that are configured under a Tenant.
  • Add a Tenant Account under a Tenant.
  • View/edit an existing Tenant Account under a Tenant.
  • Delete an existing Tenant Account under a Tenant.

Viewing Tenant Accounts

To view Tenant Accounts under a Tenant:

  • Open a Sigma Browser Activity that displays the Data Selector pane, e.g. the Tenant Account Link Generator Activity 
  • Select the Tree Selector view in the Data Selector pane
  • Double click on the Tree View so that the Tenants are visible and expand the [TENANT ACCOUNT] item types underneath each Tenant
  • The Tenant Account(s) configured under the Tenants are displayed

Image Removed

Adding a Tenant Account

A Tenant Account need to be created for each Supply Point that represents the supply of a Commodity to the Tenant.
To add a Tenant Account under a Tenant:

  • Right click on the Tenant
  • Click Add 
  • Click Tenant Account 

Image Removed

  • The Tenant Account Editor opens.
  • Configure the Tenant Account details as follows:

...

Enter the Account Number of the Tenant Account.

Note: As there is a one-to-one relationship between a Tenant Account and a Supply Point, it is good practice is to enter the Supply Point Name for consistency.

...

  • Click OK 

The Tenant Account details are saved and the Tenant Account Editor closes.

Image Removed

Viewing / Editing a Tenant Account

To view/edit an existing Tenant Account under an Organisation:

  • Right click on the Tenant Account
  • Click Edit

Image Removed

  • The Tenant Account Editor opens with the details for the Tenant Account
  • Change the details of the Tenant Account as required
  • Click OK.
  • The Tenant Account details are saved and the Tenant Account Editor closes.

Deleting Tenant Account

To delete an existing Tenant Account under a Tenant:

  • Right click on the Tenant
  • Click Delete item 

Image Removed

Maintaining Tenant Adhoc Charges

A Tenant Adhoc Charge represents a miscellaneous charge (or credit) that is not defined within a Tariff.
The Tenant Adhoc Charges that have been added to Tenant Account are displayed in the Tenant Account Editor.
It is possible to:

  • Add a Tenant Adhoc Charge to a Tenant Account.
  • View/edit a Tenant Adhoc Charge that was previously added to a Tenant Account:
  • Delete a Tenant Adhoc Charge that was previously added to a Tenant Account:

Adding a pre-existing Tenant Adhoc Charge

Adhoc Charfges can be added when you add a Tenant Account,or when you edit an existing Tenant Account  in the Tenant Account Editor. 

To add a Tenant Adhoc Charge to a Tenant Account:

  • Right click on the Tenant Account
  • Click Edit to open the Tenant Account Editor

Image Removed

  • Click Add Charge  Image Removed
  • The Tenant Adhoc Charge Selector pop-up opens with a list of all pre-existingTenant Adhoc Charges that can be applied to Tenant Accounts.

Image Removed

  • Highlight a pre existing Tenant Adhoc Charge
  • Click OK 
  • The Tenant Adhoc Charge Selector pop-up closes and the Tenant Account Editor is updated to display the Tenant Adhoc Charge details. The Tenant Adhoc Charge will be applied on future Tenant Bills for this Tenant Account.

Image Removed

Viewing / Editing a Tenant Adhoc Charge

To view/edit a Tenant Adhoc Charge that has been added to a Tenant Account:

  • Select the Tenant Adhoc Charge in the Tenant Account Editor
  • Click on the Edit Charge option

Image Removed

  • The Tenant Adhoc Charge Editor opens with saved details of the Tenant Adhoc Charge that has been applied to the Tenant Account

Image Removed

  • Change the details of the Tenant Adhoc Charge as required:
    • Select a value from the Charge frequency dropdown list (Once only or Recurring)
    • If Charge frequency is 'Recurring' define the effective period of the recurring charge as follows:
      • Untick the None checkbox next to the Active from date to define the start of the effective period of the recurring charge (either by using the Date Picker or selecting Day, Month and Year values from the dropdown lists)
      • Untick the None checkbox next to the Active to date to define the end of the effective period of the recurring charge (either by using the Date Picker or selecting Day, Month and Year values from the dropdown lists)
    • Tick the Override Default checkbox and enter a value in the Amount field to override the default charge amount configured for the Tenant Adhoc Charge 
  • Click OK 
  • The Tenant Adhoc Charge details are saved, the Tenant Adhoc Charge Editor closes and the Tenant Account Editor is updated to display the Tenant Adhoc Charge details. Any changes to the Tenant Adhoc Charge will be applied on future Tenant Bills for this Tenant Account

Deleteing a Tenant Adhoc Charge

To delete a Tenant Adhoc Charge that has been added to a Tenant Account:

  • Select the Tenant Adhoc Charge in the Tenant Account Editor
  • Click Delete Charge
  • Click OK

Image Removed

  • The Tenant Adhoc Charge is no longer displayed in the Tenant Account Editor and will not be applied on any future Tenant Bills for this Tenant Account.

Maintaining Configuration of Tenant Adhoc Charges

While adding a Tenant Adhoc Charge to a Tenant Account it is possible to:

  • Configure a new Tenant Adhoc Charge.
  • View/edit a configured Tenant Adhoc Charge.
  • Remove a configured Tenant Adhoc Charge.

Configuring a New Tenant Adhoc Charge

To configure a new Tenant Adhoc Charge:

  • Right click on the Tenant Account
  • Click Edit

Image Removed

  • This opens the Tenant Adhoc Charge Selector pop-up
  • Click  Add Charge
  • The Tenant Adhoc Charge Setup pop-up opens

Image Removed

  • Click Add Charge
  • The Tenant Adhoc Charge Selector pop-up opens

Image Removed

  • The Tenant Adhoc Charge Setup pop-up opens
  • Configure the Tenant Adhoc Charge details as follows:

...

Image Removed

  • Click OK 
  • The Tenant Adhoc Charge Setup pop-up closes and the Tenant Adhoc Charge Selector is updated to display the configured Tenant Adhoc Charge details.

Viewing / Editing a Configured Tenant Adhoc Charge

To view/edit a pre-existing Tenant Adhoc Charge:

  • While adding a Tenant Adhoc Charge to a Tenant Account in the Tenant Adhoc Charge Selector pop-up, highlight a configured Tenant Adhoc Charge
  • Click Edit Charge 

Image Removed

  • The Tenant Adhoc Charge Setup pop-up opens with saved configuration details for the Tenant Adhoc Charge
  • Highlight the Charge line
  • Click Edit Charge

Image Removed

  • The Tenant Adhoc Charge Editor pop-up opens

Image Removed

  • Change the configuration details of the Tenant Adhoc Charge details as required
  • Click OK
  • The Tenant Adhoc Charge Setup pop-up closes and the Tenant Adhoc Charge Selector is updated to display the configured Tenant Adhoc Charge details.

Remove Configured Tenant Adhoc Charge

To remove a configured Tenant Adhoc Charge:

  • Right click on the Tenant
  • Click Edit
  • Highlight the Charge in the Tenant Adhoc Charge Selector pop-up
  • Click  Delete Charge

Image Removed

  • The configured Tenant Adhoc Charge is no longer displayed in the Tenant Adhoc Charge Selector pop-up

Maintaining Tariff Connectors

A Tariff Connector can be configured under a Supply Point when charges within a Tariff need to be created based on different sources of data, e.g. Meters, Sub Meters, Virtual Meters, Associated Data, Monitoring Points and Accounts (i.e. Supplier Bills).
Once configured, a Tariff Connector can be referenced from a Tariff Entry.
It is possible to:

  • Add a Tariff Connector under a Supply Point.
  • View/edit an existing Tariff Connector under a Supply Point.
  • Delete an existing Tariff Connector under a Supply Point.

Adding Tariff Connector

To add a Tariff Connector under a Supply Point:

  • Highlight the Supply Point in the Data Selector pane
  • Right click on the Supply Point
  • Click  Add 
  • Click  Tariff Connector

 Image Removed

  • The Tariff Connector Editor opens.
  • Configure the Tariff Connector details as follows:

...

Enter the Name of the Tariff Connector.

...

Select a value from the TSP Data Type dropdown list. This indicates the specific parts of the data that will be included when sourcing the data.

Note: TSP stands for "Times Series Producer". A TSP is an Item that produces time series data (e.g. a Channel produces consumption data or an Account produces bill data).

The following values can be selected from the dropdown list if the selected TSPs includes Accounts:

  • CCL As Percentage
  • CCL ExTax
  • CCL IncTax
  • Consumption
  • Energy Consumption
  • Energy Cost ExTax
  • Energy Cost IncTax
  • Total cost
  • Total cost ExTax
  • Volumetric Consumption

Other pre-configured values are also available for other TSPs, e.g. Consumption by Mass, Conversion factor, etc.

Additional TSP Data Type values can be manually configured using the Database Object Setup Activity.

...

Select the Data Quality of the data stream from the dropdown list (Primary, Secondary, Tertiary or Sample).

  • Select 'Primary' if the data stream provided by the Tariff Connector is to be used in Tenant Billing by default.
  • Select another value if the data stream provided by the Tariff Connector is to be used as an alternative source when recalculating a Tenant Bill 

...

Select a Tariff Source from the dropdown list. This allows the data stream provided by the Tariff Connector to be accessed when defining a Tariff Entry within a Tariff.

The following pre-configured values can be selected:

  • Consumption
  • Bill Consumption
  • Bill Total cost ExTax
  • Bill Total Cost
  • Bill Energy Cost ExTax
  • Bill Energy Cost IncTax

Additional Tariff Source values can be manually configured using the Database Object Setup Activity

...

Select an Item Type from the Selecting from Items of Type dropdown list (Account, Associated Data, Meter, Monitoring Point, Sub Meter or Virtual Meter). This controls the Item Type that is displayed in the Unselected box as follows:

If the Show all checkbox is unticked, only TSPs (of the selected Item Type) that are configured under the same Supply Point as the Tariff Connector that are not already selected are displayed the Unselected box.

If the Show all checkbox is ticked, all TSPs (of the selected Item Type) that are not already selected are displayed the Unselected box.

Click on one or more TSPs displayed in the Unselected box and drag them to the Selected box to include these TSPs in the Tariff Connector.

Note: Tariff Connectors can be configured with multiple TSP data sources from different TSPs. All TSP data sources referenced in a Tariff Connector are combined into a single data stream for Tenant Billing.

  • Click  OK 
  • The Tariff Connector details are saved and the Tariff Connector Editor closes. The Tariff Connector will be applied on future Tenant Bills for Supply Point Contract Containers that reference this Tariff Connector (via the Tenant Provider Contract / Tariff / Tariff Entry).

Image Removed

View/Edit Tariff Connector

To view/edit an existing Tariff Connector under a Supply Point:

  • Highlight the Tariff Connector in the Data Selector pane
  • Right click on the Tariff Connector
  • Click Edit

Image Removed

  • The Tariff Connector Editor opens with the saved details for the Tariff Connector
  • Change the details of the Tariff Connector as required
  • Click OK
  • The Tariff Connector details are saved and the Tariff Connector Editor closes. Any changes to the Tariff Connector will be applied on future Tenant Bills for Supply Point Contract Containers that reference this Tariff Connector (via the Tenant Provider Contract / Tariff / Tariff Entry).

Delete Tariff Connector

To delete an existing Tariff Connector under a Supply Point:

  • Highlight the Tariff Connector in the Data Selector pane
  • Right click on the Tariff Connector
  • Click Delete item 

Image Removed

Maintaining Supply Point Contract Containers

A Supply Point Contract Container defines a relationship between a Tenant Provider Contract, a Tenant Account and one or more Meters, Sub Meters or Virtual Meters for an effective period of time.
During the period of time that a Supply Point Contract Container is effective, the Tenant linked to the Tenant Account will be billed for the Commodity specified in the Supply Point using:

  • The Tariff that is configured under the selected Tenant Provider Contract;
  • The consumption data from the Periodic and Non-periodic Channels linked to the selected Meters, Sub Meters, Virtual Meters and Tariff Connectors.

It is possible to:

  • Activate a Supply Point Contract Container to enable billing a Tenant for a Commodity from a specified date.
  • Terminate a Supply Point Contract Container to disable billing a Tenant for a Commodity from a specified date.

Activating Supply Point Contract Container

To enable billing a Tenant for a Commodity from a specified date:

  • Highlight the Supply Point that represents the supply of the Commodity to the Tenant in the Data Selector pane
  • Right click on the Supply Point
  • Click  Edit 

Image Removed

  • The Supply Point Editor opens with the saved details for the Supply Point. Select the 'Tenant' Service Type
  • Click Manage

Image Removed

  • The Manage Contract for Tenant pop-up opens.

Image Removed

  • Select the Add Later button, untick the No start date checkbox and enter the Start date (either by using the Date Picker or selecting the day, month and year from the dropdown lists).
  • Select a Tenant Provider Contract from the Current Contract dropdown list.
  • Click on the Search icon next to the Current Tenant Account field.

Image Removed

  • The Tenant Account Selector pop-up opens with the saved details of the Supply Point Contract Container.

Image Removed

  • Enter text in the Search field and click on the Search icon to display a list of all Tenant Accounts filtered by the text entered.

Image Removed

  • Select a Tenant Account and click the OK button. The Tenant Account Selector pop-up closes and the Supply Point Editor is updated to display the Tenant Account in the Current Tenant Account field
  • Alternatively, click the Cancel button to close the Tenant Account Selector pop-up and redisplay the Supply Point Editor unchanged
  • Select the Meters, Sub Meters and/or Virtual Meters that will be used for Tenant Billing in the Available Meters list and drag them into the Selected Meters list
  • Click the OK button. The Contract details are saved, the Manage Contract for Tenant pop-up closes and the Supply Point Editor is updated to display the Supply Point Contract Container details. The Supply Point Contract Container will be considered for inclusion in any future Tenant Bills Runs where the Start date is on or before the Bill Run End Date
  • Alternatively, click the Cancel button to abandon the changes, close the Manage Contract for Tenant pop-up and redisplay the Supply Point Editor unchanged

CONTINUE FROM HERE.................. I dont have the TENANT account in my supply point?

Terminating Supply Point Contract Container

To disable billing a Tenant for a Commodity from a specified date:

  • Select the Supply Point that represents the supply of the Commodity to the Tenant in the Data Selector pane.
  • Right-click on the Supply Point and click on the Edit option.

Image Removed

  • The Supply Point Editor opens with the saved details for the Supply Point. Select the 'Tenant' Service Type and click on the Manage button.

Image Removed  I dont see the Tenant Account?

  • The Manage Contract for Tenant pop-up opens with the list of all Supply Point Contract Containers that have been created for the Supply Point displayed in the Contract history box.

Image Removed

  • Select the Supply Point Contract Container that has been created to bill the Tenant for the Commodity. Untick the No end date checkbox and enter the End date (either by using the Date Picker or selecting Day, Month and Year values from the dropdown lists).
  • Click the OK button. The Contract details are saved, the Manage Contract for Tenant pop-up closes and the Supply Point Editor is updated to display the Contract details. The Supply Point Contract Container will not be considered for inclusion in any future Tenant Bills Runs where the End date is after the Bill Run Start Date.
  • Alternatively, click the Cancel button to abandon the changes, close the Manage Contract for Tenant pop-up and redisplay the Supply Point Editor unchanged.

 Maintaining Channel Data Quality

The Channel Data Quality selected for a Periodic or Non-periodic HFD Channel defines the priority of consumption data from this Channel when used in Tenant Billing.

Define Priority of Consumption Data from Channel

To define the priority of consumption data from a Channel to be used in Tenant Billing:

  • Select the Channel in the Data Selector pane.
  • Right-click on the Channel and click on the Edit option.

Image Removed

  • The Channel Editor opens with the saved details for the Channel.

Image Removed

...

  • Select 'Primary' if consumption data from the Channel is to be used in Tenant Billing by default.
  • Select another value if consumption data from the Channel is to be used as an alternative source when recalculating a Tenant Bill (see [3] Sigma User Guide – Manage Tenant Bills for further details).

...

.  For example, the Provider Name or VAT Registration Number

Click OK

The Tenant Provider details are saved and the Tenant Provider Editor closes