Skyline.DataMiner.Dev.Utils.Solutions.CostAndBilling.Common 1.0.2

Skyline.DataMiner.Dev.Utils.Solutions.CostAndBilling.Common

Project Type: NuGet Project

Size: XL

Summary

Provides the core models and repositories for reading and writing DataMiner Cost & Billing DOM data — rate cards (cost and billing), contracts, contract-rate card assignments, billable items, billable events, groups, nodes, items, value units, app data, and errors. Every repository implements the shared IRepository<T> contract, exposing Read(), Read(Guid), Count(), Delete(Guid), ReadPaged(), Create, Update, and bulk equivalents through the ICostAndBillingHelper entry point. It is consumed indirectly by the Automation, GQI, and Protocol packages, and is typically not referenced directly by solution developers.

Getting Started

Prerequisites: A running DataMiner 10.6.4+ system with the SDM Registration package installed. The Cost & Billing Solution itself is installed together with this library, so there is no separate installation step for it.

The ICostAndBillingHelper exposes a repository per entity (rate cards, contracts, billable items, etc.). Every repository implements the shared IRepository<T> contract, giving you Read(), Read(Guid), Count(), Delete(Guid), ReadPaged(), Create, Update and bulk equivalents out of the box.

Read all cost ratecards:

ICostAndBillingHelper helper = connection.GetCostAndBillingHelper();

List<CostRatecard> ratecards = helper.CostRatecard.Read().ToList();

Read a single ratecard by identifier:

CostRatecard ratecard = helper.CostRatecard.Read(Guid.Parse("ratecard-id"));

Create and update entities:

var ratecard = new CostRatecard
{
    Name = "My Ratecard",
};

helper.CostRatecard.Create(ratecard);

ratecard.Name = "My Updated Ratecard";
helper.CostRatecard.Update(ratecard);

Delete an entity:

helper.CostRatecard.Delete(Guid.Parse("ratecard-id"));

Assembly

Assembly Name: Skyline.DataMiner.Dev.Utils.Solutions.CostAndBilling.Common

Public API

• ICostAndBillingHelper — the main entry point, exposing one repository per entity: CostRatecard, BillRatecard, ValueUnit, Contract, AppData, Item, Group, ContractRatecardAssignment, BillableEvent, Node, BillableItem, and Error, plus IsInstalled() to verify that the Cost & Billing Solution is registered on the DataMiner System.
• ConnectionExtensions.GetCostAndBillingHelper(this IConnection) — creates an ICostAndBillingHelper for a given IConnection. For unit testing, mock the public ICostAndBillingHelper interface directly (e.g. with Moq).
• Repository interfaces (Repositories/), one per entity — ICostRatecardRepository, IBillRatecardRepository, IValueUnitRepository, IContractRepository, IAppDataRepository, IItemRepository, IGroupRepository, IContractRatecardAssignmentRepository, IBillableEventRepository, INodeRepository, IBillableItemRepository, IErrorRepository — all extending the shared IRepository<T> contract (Read(), Read(Guid), Count(), Delete(Guid), ReadPaged(), Create, Update, and bulk equivalents).
• Models (Models/) — the entity classes returned/consumed by the repositories, e.g. CostRatecard, BillRatecard, Rate, RateUnit, Contract, BillingType, BillableEvent, BillableItem, ValueUnit, Group, Item, Node, AppData, ContractRatecardAssignment, Error, plus their associated status/state enums (e.g. BillableEventStatus, GroupStates, ItemStates, GeneralState).
• CostRatecardExposers / BillRatecardExposers (Exposers/) — field exposers used to build DOM filters/queries against ratecard fields.