Appendix: Samples of PBC XML contracts

Creation

Creating settlement retailer

Settlement retailer id, name, and retailer type are required fields. Default of effective dates are BOT to EOT.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ConfigurationBatch xmlns="http://www.itron.com/mdm/configuration/2008/04">
	<ConfigurationTransfers>
		<ConfigurationTransfer xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
			<ConfigurationUpdate i:type="RetailSettlementPoint">
				<RetailSettlementPointID>RSTPT_NY_CZ_1</RetailSettlementPointID>
				<Description>This is point test 3</Description>
				<RetailSettlementPointVersions>
					<RetailSettlementPointVersion>
						<RetailSettlementPointType>RST1</RetailSettlementPointType>
						<RetailSettlementPointStatus>Active</RetailSettlementPointStatus>
						<LinkedSettlementRetailerID>Retailer_NY_CZ_1</LinkedSettlementRetailerID>
						<LinkedSettlementZoneID>CentralZone_NY</LinkedSettlementZoneID>
						<EnergyReportingID>ERep_2</EnergyReportingID>
						<ICapReportingID>ICAPRep_2</ICapReportingID>
						<IsReportable>1</IsReportable>
						<MeteringAuthID>NGrid Metering 1</MeteringAuthID>
					</RetailSettlementPointVersion>
				</RetailSettlementPointVersions>
				<RetailStptServicePoint>SP_RSTPT_NY_CZ_1</RetailStptServicePoint>
			</ConfigurationUpdate>
		</ConfigurationTransfer>
	</ConfigurationTransfers>
	<ProcessingStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
		<Requested>1</Requested>
		<Success>1</Success>
		<Warn>0</Warn>
		<Fail>0</Fail>
	</ProcessingStatistics>
</ConfigurationBatch>

Creating settlement enrollment

Settlement enrollment id, name, and enrollment type are required fields. Default of effective dates are BOT to EOT.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ConfigurationBatch xmlns="http://www.itron.com/mdm/configuration/2008/04">
	<ConfigurationTransfers>
		<ConfigurationTransfer xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
			<ConfigurationUpdate i:type="SettlementEnrollment">
				<SettlementEnrollmentID>Enrollment1</SettlementEnrollmentID>
				<SettlementEnrollmentName>Enrollment1_Name</SettlementEnrollmentName>
				<Description>This is settlement enrollment test 1</Description>
				<SettlementEnrollmentVersions>
					<SettlementEnrollmentVersion>
						<SettlementEnrollmentType>SettlementEnrollmentType</SettlementEnrollmentType>
						<SettlementCustomerClass>Residential</SettlementCustomerClass>
						<LinkedRetailSettlementPointID>RetailSTPT_A</LinkedRetailSettlementPointID>
						<EffectiveDates>
							<EffectiveStartDate>2022-01-01T00:00:00Z</EffectiveStartDate>
						</EffectiveDates>
					</SettlementEnrollmentVersion>
				</SettlementEnrollmentVersions>
				<LinkedServicePointID>2811007_01</LinkedServicePointID>
			</ConfigurationUpdate>
		</ConfigurationTransfer>
	</ConfigurationTransfers>
	<ProcessingStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
		<Requested>1</Requested>
		<Success>1</Success>
		<Warn>0</Warn>
		<Fail>0</Fail>
	</ProcessingStatistics>
</ConfigurationBatch>

Creating retail settlement point

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ConfigurationBatch xmlns="http://www.itron.com/mdm/configuration/2008/04">
	<ConfigurationTransfers>
		<ConfigurationTransfer xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
			<ConfigurationUpdate i:type="RetailSettlementPoint">
				<RetailSettlementPointID>RSTPT_NY_CZ_1</RetailSettlementPointID>
				<Description>This is point test 3</Description>
				<RetailSettlementPointVersions>
					<RetailSettlementPointVersion>
						<RetailSettlementPointType>RST1</RetailSettlementPointType>
						<RetailSettlementPointStatus>Active</RetailSettlementPointStatus>
						<LinkedSettlementRetailerID>Retailer_NY_CZ_1</LinkedSettlementRetailerID>
						<LinkedSettlementZoneID>CentralZone_NY</LinkedSettlementZoneID>
						<EnergyReportingID>ERep_2</EnergyReportingID>
						<ICapReportingID>ICAPRep_2</ICapReportingID>
						<IsReportable>1</IsReportable>
					</RetailSettlementPointVersion>
				</RetailSettlementPointVersions>
				<RetailStptServicePoint>SP_RSTPT_NY_CZ_1</RetailStptServicePoint>
			</ConfigurationUpdate>
		</ConfigurationTransfer>
	</ConfigurationTransfers>
	<ProcessingStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
		<Requested>1</Requested>
		<Success>1</Success>
		<Warn>0</Warn>
		<Fail>0</Fail>
	</ProcessingStatistics>
</ConfigurationBatch>

Moving or switching enrollments among retail settlement points

Move an enrollment from one retail settlement point to another retail settlement.

Existing settlement enrollment version is optional, it automatically ends the link of the existing retail settlement point at “start time” and create a new link to the new retail settlement point start as “start time”. The following two examples show with or without existing retail settlement point information.

Providing a new linked retail settlement point only, no existing linked retail settlement point information

Switch Enrollment_A from RetailSTPT_A (BOT-EOT) to RetailSTPT_B at 2022-05-13T00:00:00Z.

Providing all version data

Switch Enrollment_A from RetailSTPT_A (BOT-EOT) to RetailSTPT_B at 2022-05-13T00:00:00Z.

Correction

The corrected retailer/enrollment/retail settlement point ID must exist.

Make a correction to an existing retailer/enrollment/retail settlement point.

Replacing settlement retailer ID (retailer_A with new_retailer_A)

Replacing settlement enrollment ID (enrollment_A with new_enrollment_A)

Replacing a retail settlement point ID (retailSTPT_A with new_retailSTPT_A)

Delete

Set Delete to true to remove retailer enrollment and/or retail settlement point from IEE.

Deleting settlement retailer

Check market/zone for deletion. Remove all linked retail settlement points.

Note: The Delete Settlement Retailer operation is only successful when there are no active retail settlement points present.

Deleting settlement enrollment

Remove the linked retail settlement point and service point.

Deleting retail settlement point

Remove the linked settlement zone, retailer, enrollment.

Linkage

Linking a new or existing enrollment to a service point and/or retail settlement point.

Linking a service point and retail settlement point while creating a settlement enrollment

Linking a service point or retail settlement point to an existing standalone settlement enrollment

Creating or assigning an enrollment into a retailer

Use Case 1: Enrolling an enrollment under a retailer with retail settlement point

Prerequisites:

• RetailSettlementPoint: ID = RetailSTPT1

• SettlementEnrollment (optional): ID = STPTEnroll1

• RetailSTPT1 links RetailerID1

Note: If STPTEnroll1 is not existing then create STPTEnroll with default values (see Retail settlement point) if they are not provided in the request. A settlement retailer (RetailerID1) only has one active retail settlement point.

Before

After

Request

Use Case 2: Enrolling an enrollment under a retailer in a zone

Prerequisites:

• RetailSettlementPoint: ID = RetailSTPT3

• SettlementZone: ID = Zone2

• SettlementRetailer: ID = RetailerID1

• SettlementEnrollment (optional): ID = STPTEnroll1

• RetailSTPT3 links RetailerID1 and Zone2

Note: If STPTEnroll1 does not exist, create STPTEnroll1 with default values (see Retail settlement point) if they are not provided in the request.

Note: If finding more than one retail STPTs, the first one out of the many retail STPTs are enrolled. If unable to find a retail STPT, the request is rejected. A settlement retailer (RetailerID1) only has one active retail settlement point.

Before

After

Request