Units of Measure

You must activate the units of measure that are associated with your utility, or add additional units of measure, if necessary. You can also update the display order of the units of measure. All units of measure are delivered inactive.

The following units of measure, and specified display order, are delivered with the solution.

Service Type Unit of Measure Display Order
Electric KW: Kilowatts 5
Electric KWH: Kilowatt Hours 10
Electric MWH: Megawatt Hours 15
Gas CCF: Hundred Cubic Feet 5
Gas TH: Thermal Units 10
Water GAL: Gallons 5

The table below provides additional details on the tasks you need to complete.

Task Configuration Comments
Fetch a unit of measure

GET /utilitiesAdmin/v1/unitOfMeasure?q=active=false

Example:

GET https://<hostname>/api/utilitiesAdmin/v1/unitOfMeasure?q=active=false

A specific unit of measure record can be fetched using:

GET /utilitiesAdmin/v1/unitOfMeasure/{id}

Example:

GET https://<hostname>/api/utilitiesAdmin/v1/unitOfMeasure/KW

Activate a unit of measure

POST /CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

{

"items": [

{

"operation": "update",

"data": {

"id": "KW",

"active": true

}

}

]

}

Complete this task for every unit of measure associated with your utility.

Multiple units of measure can be activated together by adding more of them to the “items” list.

Edit a unit of measure

POST /CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

{

"items": [

{

"operation": "update",

"data": {

"id": "KW",

"serviceType": "E",

"active": true

}

}

]

}
Multiple units of measure can be edited together by adding more of them to the “items” list.
Edit the display order of a unit of measure

POST /CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

Example:

POST https://<fabric host>/api/CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

{

"items": [

{

"operation": "update",

"data": {

"id": "<unit of measure>",             // unit of measure such as KW, CCF, etc

"serviceType": "<serviceTypeId>",     // the service type associated with the unit of measure

"displayOrder": <number>              // newly introduced config

}

}

]

}
Create a new unit of measure

POST /CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

Example:

POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/unitOfMeasure

{

"items": [

{

"operation": "create",

"data": {

"id": "CF",

"code": "CF",

"active": true,

"description": "ORA_UER_UOM_CF", // Lookup Code

"serviceType": "G"

}

}

]

}

Oracle recommends using the same value for 'id' and 'code'.

Also, 'description' is a translatable field, so the value should be the relevant lookup code created under the lookup type ORA_UER_UOM.

Multiple units of measure can be created together by adding more of them to the “items” list.

For additional information on Lookups, see Profile Options, Lookups, and Scheduled Processes in the Implementing Customer Data Management for Sales and Fusion Service Guide.