UK Smart MeteringKnowledge ProjectStructured SRV and specimen referenceBrowse SRVs

Service Reference Variant

8.4 · Update Inventory

Service details

Identifiers, rules, and applicability

Service reference
8.4
Service Reference Variant
8.4
DUIS section
3.8.106
Command variants
8
DUIS possible responses
Acknowledgement
Critical
No
Sensitive response
No
Protection against replay
No
On demand
No
Future dated
No
DSP scheduled
No
DCC only
Yes
SMETS1 applicability
Yes
SAPC requirement
Not stated
DUIS applicability
3.0, 3.1, 4.0, 5.0, 5.1, 5.2, 5.3

Specific Errors

Response codes and descriptions

Response CodeResponse Code Description
E080405
The Device Status is not applicable to the Device Type
E080406
The Device Status transition is not valid
E080407
The Device ID does not exist in the Smart Metering Inventory or its status is not valid for the requested update
E080408
The Request does not include any details to be updated
E080409
The Device Type / Manufacturer / Model / Firmware Version data resulting from the changes specified by the User does not match the DCC list of equipment that has been approved for use
E080410
The User is not authorised to execute the Service Request to update the detail specified
E080411
Request to update Device Status not applicable to the Device Type
E080412
The Device Status transition is not valid
E080413
The requested MPxN update isn’t suitable for the specified Device.
E080414
The Device Status does not allow the MPxN to be updated. The Device Status must be one of ‘Whitelisted’, ‘Installed Not Commissioned’ or ‘Commissioned’ if the MPxN update is to succeed.
E080415
The User is not the Registered Supplier Party for the new MPxN specified within the UpdateMPxN part of the Service Request.

Source: DUIS 3.8.106.3

GBCS Use Case

Use cases, device coverage, and applicability

Instruction
DeleteDeviceUpdateDeviceDetails
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
DCC Only
GBCS Criticality
N/A
Sensitive Response
No
Future Dated
No
GBT
No
SMETS1 Applicable
Yes
Eligible Roles
EISEESGISSNAENOGNOOUDSP
Instruction
UpdateDeviceStatusCHUpdateDeviceStatusExceptCHUpdateMPxN
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
DCC Only
GBCS Criticality
N/A
Sensitive Response
No
Future Dated
No
GBT
No
SMETS1 Applicable
Yes
Eligible Roles
EISGISDSP

DUIS Service Definition

Data items and DCC processing

Request data items

Table 231: UpdateInventory (sr:UpdateInventory) data items
Data ItemDescription / ValuesTypeMandatoryDefaultUnits
DeviceIDDevice ID of the Device to be updated (status or details) or deleted.sr:EUI (See clause 3.10.1.3)YesNoneN/A
UpdateDeviceStatusExceptCHAn indicator giving the status to be recorded for the Device (Not applicable to CHF, GPF or Type 2 Devices) Valid set Pending InstalledNotCommissionedsr:UpdateDeviceStatusExceptCH Restriction of xs:string (Enumeration)One and only one of these items must be setNoneN/A
UpdateDeviceStatusCHAn indicator giving the SMI Status to be recorded for the CHF and its associated GPF Valid set Commissioned InstalledNotCommissioned Withdrawnsr:UpdateDeviceStatusCH Restriction of xs:string (Enumeration)NoneN/A
UpdateDeviceDetailsDetails to be updated for a Devicesr:UpdateDeviceDetailsNoneN/A
DeleteDeviceDevice, in a status of ‘Pending’, is to be deletedsr:DeleteDeviceNoneN/A
UpdateMPxNThe MPxN to be associated with the device within the Smart Metering Inventory to be updatedsr:UpdateMPxNNoneN/A
Table 232: UpdateDeviceDetails (sr:UpdateDeviceDetails) data items
Data ItemDescription / ValuesTypeMandatoryDefaultUnits
DeviceManufacturerThe name of the Device’s manufacturer With the exception of IHD and CAD: • The Device Manufacturer is the <device_model_manufacturer_identifier> from the CPL and presented in the format XXXX where each X is one of the characters 0 to 9 or A to F • This data item should match the value on the CPL For IHD and CAD this data item is free textsr:DeviceManufacturer (Restriction of xs:string (maxLength = 30))At least one data item must be setNoneN/A
DeviceModelThe model of the D With the exception of IHD and CAD: • The Device Model is the concatenation of <device_model .model_identifier>< device_model .hardware_version.version>< device_model .hardware_version.revision> from the CPL and presented in the format XXXXXXXX where each X is one of the characters 0 to 9 or A to F Where: • the first 4 characters are the model identifier • the next 2 characters are the hardware version.version • the final 2 characters are the hardware version.revision • This data item matches the value on the CPL For IHD and CAD this data item is free text evicesr:DeviceModel (Restriction of xs:string (maxLength = 30))At least one data item must be setNoneN/A
SMETSCHTSVersionThe version of SMETS or CHTS that the Device complies with. This should align with the SMETS_CHTS version version_number value contained on the CPL.sr:SMETSCHTSVersion (Restriction of xs:string (minLength = 1, maxLength = 20))At least one data item must be setNoneN/A
FirmwareVersionThe operational version of Firmware of the Device The Firmware version as held in the CPL and presented in the format XXXXXXXX where each X is one of the characters 0 to 9 or A to F. This data item should match the value on the CPL The value shall be four octets in lengthsr:FirmwareVersion Restriction of xs:string (minLength = 1, maxLength = 8)At least one data item must be setNoneN/A
ESMEVariantSee Table 229 for mapping and valid set. Values including F or G are not applicable to Devices prior to GBCS v4.0sr:ESMEVariant Restriction of xs:string (Enumeration)At least one data item must be setNoneN/A
Table 233: UpdateMPxN (sr:UpdateMPxN) data items
Data ItemDescription / ValuesTypeMandatoryDefaultUnits
ImportMPxNThe primary MPAN or MPRN for the devicesr:ImportMPxN (restriction on xs:String, minimum length = 1, maximum length = 13)No The UpdateMPxN element is a choice so it must contain only one of these 3 elementsNoneN/A
SecondaryImportMPANThe Secondary MPAN for the device - only applicable to twin element meterssr:MPAN (restriction on xs:String, minimum length = 13, maximum length = 13)NoneN/A
ExportMPANThe Export MPAN for the devicesr:MPAN (restriction on xs:String, minimum length = 13, maximum length = 13)NoneN/A

Additional System Processing - DUIS

When a User sends an Update Inventory Service Request to the DCC in respect of a Communications Hub, the DeviceId specified within the Service Request shall be that of the Communications Hub Function and not the Gas Proxy Function.

Note that where a Device has an SMI Status of ‘Recovered’ the Device’s SMI Status immediately prior to it having the SMI Status of ‘Recovery’ shall be used in validation.

This Service Request can be used by Users to perform the following four functions;

  1. Update Device details within the Smart Metering Inventory provided via Pre-Notification
    1. This functionality of the Service Request is available to all the Eligible User Roles associated with this Service Request.
    2. Only the User who originally added the Device to the Smart Metering Inventory may update these device details whilst the Device has a status of ‘Pending’.
    3. For Devices with Device Type ESME, the ESME Variant can be updated by the Registered Supplier Party for the MPAN associated with the Device if the Device has a status of ‘Whitelisted’, ‘Installed Not Commissioned’ or ‘Commissioned’. The ESME Variant and other Device details can be updated by the User who originally added the Device to the Smart Metering Inventory whilst the Device has a status of ‘Pending’.
    4. For all other Devices that have SMI Status values, only Devices in a status of ‘Pending’ can be updated.
    5. Type 2 (IHD and CAD) Devices can be updated at any time.
    6. Update most of the Device details that were initially provided to the DCC via Service Request 12.2 – Device Pre-notification (see clause 3.8.122)
    7. It isn’t possible to update a Device ID (including the GPF Device ID associated to a CHF). If it has been entered in error it has to be deleted via this Service Request and re-added via Service Request 12.2 – Device Pre-notification (see clause 3.8.122).
    8. It isn’t possible to update a Device Type. If it has been entered in error it has to be deleted via this Service Request and re-added via Service Request 12.2 – Device Pre-notification (see clause 3.8.122).
    9. Any updates to the details shared between a CHF and a GPF will be applied to both. The Device ID in the Service Request has to be that of the CHF.
  2. Delete Device details from the Smart Metering Inventory provided via Pre-Notification which have not been installed.
    1. This functionality of the Service Request is available to all the Eligible User Roles associated with this Service Request.
    2. Only the User who originally added the Device to the Smart Metering Inventory may delete these device details.
    3. For Devices that have SMI Status values, only Devices in a status of ‘Pending’ can be deleted.
    4. Type 2 (IHD and CAD) Devices can be deleted at any time.
    5. Deleting a CHF will also delete its associated GPF.
  3. Update SMI Status within the Smart Metering Inventory
    1. This functionality of the Service Request is ONLY available to the Eligible User Roles of Import Supplier and Gas Supplier who are the Responsible Supplier to the Device being updated.
    2. Different options exist for which device SMI Status values can be updated by Users depending on Device type. Functionality allows,
      1. Update the Device status for all Device Types, other than the CHF and the GPF and where the old and new status apply to the Device Type
        1. From ‘Pending’ to ‘InstalledNotCommissioned’
        2. From ‘Whitelisted’ to ‘Pending’
    3. Update the Device SMI Status for a CHF (and its associated GPF)
      1. To support the Install & Leave process and / or Install & Commission after Decommissioning or Withdrawal:
        1. From ‘Pending’ to ‘InstalledNotCommissioned’ (GPF from ‘Pending’ to ‘InstalledNotCommissioned’)
        2. From ‘InstalledNotCommissioned’ to ‘Commissioned’ (GPF no status transition)
        3. From ‘Pending’ to ‘Commissioned’ (GPF from ‘Pending’ to ‘InstalledNotCommissioned’)
      2. From ‘Commissioned’ to ‘Withdrawn’ (GPF from ‘Commissioned’ to ‘Withdrawn’ or from ‘Installed Not Commissioned’ to ‘Withdrawn’). This is the equivalent of Service Request 8.5 – Service Opt Out (see clause 3.8.102) for other Device Types. On successful completion of the Service Request, the DCC Systems will:
        1. automatically delete all active DSP Schedules on all Devices in the CHF Whitelist. For each deleted DSP Schedule a DCC Alert N37 will be sent to the User that owned it.
        2. automatically cancel all Future Dated (DSP) requests not yet sent to the Device for that CHF and all the Devices in its Whitelist. For each cancelled request a DCC Alert N36 will be sent to the sender of the Future Dated request.
  4. Update MPxN associated with the Device (or add a new association) within the Smart Metering Inventory
    1. This functionality of the Service Request shall ONLY be available to either:
      1. the Registered Supplier Party for the MPxN of the type specified in UpdateMPxN, as recorded in the Smart Metering Inventory against the DeviceID; or
      2. where no such MPxN is recorded in the Smart Metering Inventory against the DeviceID, any Supplier Party
    2. The new MPxN must be consistent with the type of Device, for example if the Secondary MPAN is updated then the device must be a twin element ESME.
    3. ONLY a single MPxN association change be changed per Service Request call
    4. If the MPxN is successfully updated in the Smart Metering Inventory, then a DCC Alert N16 is sent to the Meter’s Network Operator.

Message Patterns & Examples

Pattern explorer

Open Message Patterns →