Standard Usage Identifier

The following standard usage identifiers are delivered with the solution. Each usage identifier is associated with a unit of measure. You must activate the identifiers along with the units of measure that are associated with your utility, or add additional identifiers, if necessary. You can also change the colors associated with each entry to match your utility branding colors. All standard usage identifiers are delivered inactive.

Code	Description	Associated Unit of Measure
KWH--	Kilowatt Hour	KWH
KWH-ON-	Kilowatt Hour - Peak	KWH
KWH-OFF-	Kilowatt Hour - Off-peak	KWH
KWH-MID-	Kilowatt Hour - Mid	KWH
KW--	Kilowatt	KW
TH--	Therm	TH
GAL--	Gallons	GAL

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

Task	Configuration	Comments
Fetch a standard usage identifier	GET /utilitiesAdmin/v1/standardUsageIdentifier?q=active=true Example: GET https://<hostname>/api/utilitiesAdmin/v1/standardUsageIdentifier?q=active=true A specific identifier can be fetched using: GET /utilitiesAdmin/v1/standardUsageIdentifier/{id} Example: GET https://<hostname>/api/utilitiesAdmin/v1/standardUsageIdentifier/KW--
Activate a standard usage identifier	POST /CXIPlatformService/v1/CXIReferenceEntity/standardUsageIdentifier Example: POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/standardUsageIdentifier { "items": [ { "operation": "update", "data": { "id": "KWH--", "active": true } } ] }	Complete this task for every standard usage identifier associated with your utility. Multiple standard usage identifier can be activated together by adding them to the “items” list.
Edit a standard usage identifier	POST /CXIPlatformService/v1/CXIReferenceEntity/standardUsageIdentifier Example: POST https://<hostname>/api/CXIReferenceEntity/v1/CXIReferenceEntity/standardUsageIdentifier { "items": [ { "operation": "update", "data": { "id": "KW--", "color": "#DE7F11", "unitOfMeasure": "KW", "active": true } } ] }	Multiple standard usage identifier can be edited together by adding them to the “items” list.
Create a new standard usage identifier	POST /CXIPlatformService/v1/CXIReferenceEntity/standardUsageIdentifier Example: POST https://<hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/standardUsageIdentifier { "items": [ { "operation": "create", "data": { "id": "KL--", "usageIdentifier": "KL--", "color": "#DE7F11", "unitOfMeasure": "KL", "active": true, "description": "ORA_UER_USAGE_IDENT_KL_ON" // Lookup Code } } ] }	Oracle recommends using the same value for 'id' and 'usageIdentifier'. Also, 'description' is a translatable field, so the value should be the relevant lookup code created under the lookup type ORA_UER_USAGE_IDENTIFIER. Multiple standard usage identifier can be created together by adding 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.