Get Usage Request Message Mapping Details

Refer to the Get Usage Request Integration Process description for processing details on this integration point.

CCB Usage Request Message			MDM Usage Request Message			DVM Mapping
Element	Parent Element	Type	Element	Parent Element	Type	DVM
requestDetails		Outermost Tag	D2-CalculateUsage MultipleRequests		Outermost Tag
usageCalculationCalType	requestDetails	Field	usageRequestMode			OUCCB2_OUMDM2_UsageRequestMode
mode	requestDetails	Field	mode	D2-CalculateUsage MultipleRequests	Field
language*	requestDetails	Field
			requests	D2-CalculateUsage MultipleRequests	Group
request	requestDetails	List	requestsList	requests	List
			usId	requestsList	Field
saId	request	Field	externalId	requestsList	Field
rateSchedule	request	Field	usageGroupExternalId	requestsList	Field
rateScheduleSeq	request	Field	usageGroupExternalId Seq	requestsList	Field
			usageGroup	requestsList	Field
billCondition	request	Field	billCondition	requestsList	Field
intervalProcessing	request	Group	intervalMC	requestsList	Group
startDateTime	intervalProcessing	Field	startDateTime	intervalMC	Field
endDateTimeFrom	intervalProcessing	Field	endDateTimeFrom**	intervalMC	Field
endDateTimeTo	intervalProcessing	Field	endDateTimeTo**	intervalMC	Field
customElements	intervalProcessing	Group
scalarProcessing	request	Group	scalarMC	requestsList	Group
startDateTime	scalarProcessing	Field	startDateTime	scalarMC	Field
endDateTime	scalarProcessing	Field	endDateTimeFrom	scalarMC	Field
			endDateTimeTo	scalarMC	Field
billingOption	scalarProcessing	Field	endRangeOption	scalarMC	Field	OUCCB2_OUMDM2_BillingOption
minDaysOffset	scalarProcessing	Field	minDaysOffset	scalarMC	Field
maxDaysOffset	scalarProcessing	Field	maxDaysOffset	scalarMC	Field
allowEstimate	scalarProcessing	Field	allowEstimate	scalarMC	Field	OUCCB2_OUMDM2_AllowEstimate
estimateDate	scalarProcessing	Field	estimateDate	scalarMC	Field
customElements	scalarProcessing	Group
			dateBreaks	requestsList	Group
dateBreaks	request	List	dateBreaksList	dateBreaks	List
breakDateTime	dateBreaks	Field	dateBreak	dateBreaksList	Field
hypotheticalCalculation	request	Group	hypotheticalCalculation	requestsList	Group
usageAdjustments	hypotheticalCalculation	List	usageAdjustments	hypotheticalCalculation	List
usageAdjustmentFactor	usageAdjustments	Field	usageAdjustmentFactor	usageAdjustments	Field
value	usageAdjustments	Field	value	usageAdjustments	Field
customElements	request	Group
			customElements	requestsList	Group

responseDetails		Outermost Tag
			responses	D2-CalculateUsage MultipleRequests	Group
response	responseDetails	List	responsesList	responses	List
saId	response	Field	externalId	responsesList	Field
rateSchedule	response	Field	usageGroupExternalId	responsesList	Field
rateScheduleSeq	response	Field	usageGroupExternalId Seq	responsesList	Field
usagePeriod	response	Group
startDateTime	usagePeriod	Field	startDateTime	responsesList	Field
endDateTime	usagePeriod	Field	endDateTime	responsesList	Field
customElements	usagePeriod	Group
isSkipped	response	Field	skipped	responsesList	Field
skipReasonDescription	response	Field	skipReasonDescription	responsesList	Field
			skipReason	responsesList	Field
			summaryUsagePeriods	responsesList	Group
usagePeriods	response	List	summaryUsagePeriods List	summaryUsagePeriods	List
			sequence	summaryUsagePeriodsList	Field
startDateTime	usagePeriods	Field	startDateTime	summaryUsagePeriodsList	Field
endtDateTime	usagePeriods	Field	endDateTime	summaryUsagePeriodsList	Field
standardStartDateTime	usagePeriods	Field	standardStartDateTime	summaryUsagePeriodsList	Field
standardEndtDateTime	usagePeriods	Field	standardEndtDateTime	summaryUsagePeriodsList	Field
usageRequestType	usagePeriods	Field	usageType	summaryUsagePeriodsList	Field	OUMDM2_OUCCB2_UsageType
			SQs	summaryUsagePeriodsList	Group
serviceQty	usagePeriods	List	SQsList	SQs	List
seq	serviceQty	Field	sqSequence	SQsList	Field
uom	serviceQty	Field	uom	SQsList	Field	OUMDM2_OUCCB2_UOM
tou	serviceQty	Field	tou	SQsList	Field	OUMDM2_OUCCB2_TOU
sqi	serviceQty	Field	sqi	SQsList	Field	OUMDM2_OUCCB2_SQI
qty	serviceQty	Field	quantity	SQsList	Field
spi	serviceQty	Field	secondsPerInterval	SQsList
intervals	serviceQty	Group	intervals	SQsList	Group
iL	intervals	List	mL	Intervals	List
s	iL	Field	s	mL	Field
q	iL	Field	q	mL	Field
c	iL	Field	c	mL	Field
			dt	mL	Field
			highlightDateTimes	SQsList	Group
			highlightDateTimesList	highlightDateTimes	List
			sequence	highlightDateTimesList	Field
			highlightDateTime	highlightDateTimesList	Field
			highlightType	highlightDateTimesList	Field
			highlightCondition	highlightDateTimesList	Field
			highlightDerived Condition	highlightDateTimesList	Field
			highlightEstimation Indicator	highlightDateTimesList	Field
customElements	usagePeriods	Group
spUsagePeriod	response	List	summaryUsagePeriods List	summaryUsagePeriods	List
startDateTime	spUsagePeriod	Field	startDateTime	summaryUsagePeriodsList	Field
endDateTime	spUsagePeriod	Field	endDateTime	summaryUsagePeriodsList	Field
			spSQs	summaryUsagePeriodsList	Group
serviceQty	spUsagePeriod	List	spSQsList	spSQs	List
seq	serviceQty	Field	spSQsequence	spSQsList	Field
spId	serviceQty	Field	spId	spSQsList	Field
uom	serviceQty	Field	uom	spSQsList	Field	OUMDM2_OUCCB2_UOM
tou	serviceQty	Field	tou	spSQsList	Field	OUMDM2_OUCCB2_TOU
sqi	serviceQty	Field	sqi	spSQsList	Field	OUMDM2_OUCCB2_SQI
qty	serviceQty	Field	quantity	spSQsList	Field
			highlightDateTimes	spSQsList	Group
			highlightDateTimesList	highlightDateTimes	List
			sequence	highlightDateTimesList	Field
			highlightDateTime	highlightDateTimesList	Field
			highlightType	highlightDateTimesList	Field
			highlightCondition	highlightDateTimesList	Field
			highlightDerived Condition	highlightDateTimesList	Field
			highlightEstimation Indicator	highlightDateTimesList	Field
customElements	spUsagePeriod	Group
			SPs	summaryUsagePeriodsList	Group
			SPsList	SPs	List
			sequence	SPsList	Field
			spId	SPsList	Field
			externalPremiseId	SPsList	Field
			market	SPsList	Field
			Device	SPsList	Group
			deviceList	device	List
			Sequence	deviceList	Field
			badgeNumber	deviceList	Field
			serialNumber	deviceList	Field
			fromDateTime	deviceList	Field
			toDateTime	deviceList	Field
			items	summaryUsagePeriodsList	Group
			itemsList	items	List
			itemSeq	itemsList	Field
			itemType	itemsList	Field
			itemCount	itemsList	Field
			startDateTime	itemsList	Field
			endDateTime	itemsList	Field
			dailyServiceQuantity	itemsList	Field
			uom	itemsList	Field
			spItems	summaryUsagePeriodsList	Group
			spItemsList	spItems	List
			itemSeq	spItemsList	Field
			itemType	spItemsList	Field
			itemCount	spItemsList	Field
			startDateTime	spItemsList	Field
			endDateTime	spItemsList	Field
			quantity	spItemsList	Field
			uom	spItemsList	Field
			spId	spItemsList	Field
			customElements	summaryUsagePeriodsList	Group
scalarProcessing	response	Group	scalarDetails	responsesList	Group
isEstimate	scalarProcessing	Field	isEstimate	scalarDetails	Field	OUMDM2_OUCCB2_IsEstimate
reads	response	List	scalarDetailsList	scalarDetails	List
readSeq	reads	Field	sequence	scalarDetailsList	Field
spId	reads	Field	spId	scalarDetailsList	Field
startReadDateTime	reads	Field	startDateTime	scalarDetailsList	Field
endReadDateTime	reads	Field	endDateTime	scalarDetailsList	Field
uom	reads	Field	uom	scalarDetailsList	Field	OUMDM2_OUCCB2_UOM
tou	reads	Field	tou	scalarDetailsList	Field	OUMDM2_OUCCB2_TOU
sqi	reads	Field	sqi	scalarDetailsList	Field	OUMDM2_OUCCB2_SQI
startReading	reads	Field	startMeasurement	scalarDetailsList	Field
endReading	reads	Field	endMeasurement	scalarDetailsList	Field
measuredQty	reads	Field	quantity	scalarDetailsList	Field
finalQty	reads	Field	finalQuantity		Field
finalUom	reads	Field	finalUom	scalarDetailsList	Field
finalTou	reads	Field	finalTou	scalarDetailsList	Field
finalSqi	reads	Field	finalSqi	scalarDetailsList	Field
sphowToUse	reads	Field	spHowToUse	scalarDetailsList	Field	OUMDM2_OUCCB2_SPHowToUse
reghowToUse	reads	Field	mcHowToUse	scalarDetailsList	Field
constant	reads	Field	appliedMultiplier	scalarDetailsList	Field
measuresPeakQuantity	reads	Field	measuresPeakQuantity	scalarDetailsList	Field	OUMDM2_OUCCB2_MeasuresPeakQuantity
usePercent	reads	Field	usePercent	scalarDetailsList	Field
			startMeasurement Condition	scalarDetailsList	Field
			startEstimationIndicator	scalarDetailsList	Field
			endMeasurement Condition	scalarDetailsList	Field
			endEstimationIndicator	scalarDetailsList	Field
			measurementCondition	scalarDetailsList	Field
			customElements	scalarDetailsList	Group
customElements	reads	Group
			exceptions	responsesList	Group
exceptionInfo	response	List	exceptionsList	exceptions	List
sequence	exceptionInfo	Field	sequence	exceptionsList	Field
messageCategory***	exceptionInfo	Field
messageNumber***	exceptionInfo	Field
			messageCategory	exceptionsList	Field
			messageNumber	exceptionsList	Field
comments	exceptionInfo	Field	comments	exceptionsList	Field
			messageParameters	exceptionsList	Group
messageParameters	exceptionInfo	List	messageParametersList	messageParameters	List
parameterSequence	messageParameters	Field	sequence	messageParametersList	Field
messageParameter Value	messageParameters	Field	parameter	messageParametersList	Field
			parameterType	messageParametersList	Field
customElements	response	Group
			customElements	responsesList	Group

NOTES:

* Language coming from Oracle Utilities Customer Care and Billing is passed to Oracle Utilities Meter Data Management through the SOAP Header when invoking the Oracle Utilities Meter Data Management service.

** MDM //scalarMC/endDateTimeFrom and //scalarMC/endDateTimeTo are populated accordingly:

- //scalarMC/endDateTimeFrom - concatenate CCB endDateTime

(/requestDetails/request/scalarProcessing/endDateTime) and 12am (-00.00.00)

- //scalarMC/endDateTimeTo - concatenate CCB endDateTime

(/requestDetails/request/scalarProcessing/endDateTime) and 11:59pm (-23.59.59)

*** CCB Message Category and Message Number are obtained form the Configuration Properties file, CCB2.Generic.MessageCategory and CCB2.Generic.MessageNumber respectively.

Get Usage Request Message Mapping Details

Refer to the Usage Adjustment Request Integration Process description for processing details on this integration point.

CCB Usage Request Message				MDM Usage Request Message			DVM Mapping
Element		Parent Element	Type	Element	Parent Element	Type	DVM
				D2-UsageTransactionUpdate Inbound		Outermost Tag
input			Outermost Tag	input	D2-UsageTransactionUpdate Inbound	Field
externalSystem		input	Field	externalSystem	input	Field
usageTransactions		input	Group	usageTransactions	input	Group
usageTransactionList		usageTransactions	List	usageTransactionList	usageTransactions	List
externalId		usageTransactionList	Field	externalId	usageTransactionList	Field
usedOnBill		usageTransactionList	Field	usedOnBill	usageTransactionList	Field
	linkedToFrozenBillSegment	usageTransactionList	Field	linkedToFrozenBillSegment	usageTransactionList	Field

Usage Transaction Info Update Request Message Mapping Details

Refer to the Usage Transaction Info Update Integration Process description for processing details on this integration point.

CCB Usage Request Message				MDM Usage Request Message			DVM Mapping
Element		Parent Element	Type	Element	Parent Element	Type	DVM
				D2-UsageTransactionUpdate Inbound		Outermost Tag
input			Outermost Tag	input	D2-UsageTransactionUpdate Inbound	Field
externalSystem		input	Field	externalSystem	input	Field
usageTransactions		input	Group	usageTransactions	input	Group
usageTransactionList		usageTransactions	List	usageTransactionList	usageTransactions	List
externalId		usageTransactionList	Field	externalId	usageTransactionList	Field
usedOnBill		usageTransactionList	Field	usedOnBill	usageTransactionList	Field
	linkedToFrozenBill Segment	usageTransactionList	Field	linkedToFrozenBillSegment	usageTransactionList	Field