Integration Flows
The integration supports the following processes:
Enrollment Request (Edge DERMS Initiated)
When customers enroll their smart controllable device(s) in a program through the head-end system provider or aggregator/vendor, such as Ecobee or Google Nest, the enrollment requests are sent to Oracle Utilities Live Energy Connect.
This integration process sends the enrollment request that Oracle Utilities Edge Distributed Energy Resources Management System received from Oracle Utilities Live Energy Connect to Oracle Utilities Customer Program Management Cloud Service.
The integration then sends the list of responses for each enrollment request back to Oracle Utilities Edge Distributed Energy Resources Management System when the process is completed.
The following diagram shows a graphical representation of the Enrollment Request integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives an enrollment request message from Oracle Utilities Edge Distributed Energy Resources Management System. The incoming request message can contain multiple enrollment requests, but the CPMCS REST API can only accept a single enrollment request.
2. The integration loops through each incoming request:
• Transforms the enrollment request payload to Oracle Utilities Customer Program Management Cloud Service format.
• Invokes the Program Enrollment CPMCS REST endpoint to create the enrollment in Oracle Utilities Customer Program Management Cloud Service in PENDING status.
• Response per enrollment request coming from Oracle Utilities Customer Program Management Cloud Service are collected and later returned to Oracle Utilities Edge Distributed Energy Resources Management System. If an error is encountered, the process continues to the next enrollment request.
• If the enrollment is successfully created, it will store the enrollment ID in the response collection to Oracle Utilities Edge Distributed Energy Resources Management System.
• If Oracle Utilities Customer Program Management Cloud Service returns an ERROR, store the error in the response collection to Oracle Utilities Edge Distributed Energy Resources Management System.
3. After all the records are processed, it transforms the Oracle Utilities Customer Program Management Cloud Service response into the Oracle Utilities Edge Distributed Energy Resources Management System response payload.
• It will set the overall ackType field in the response with the following code:
• SUCCESS, if all enrollment responses from Oracle Utilities Customer Program Management Cloud Service have the SUCCESS value in the responseCode field.
• FAILURE, or ERROR if at least one responseCode within the enrollment responses from Oracle Utilities Customer Program Management Cloud Service contains one of those values.
• It will send the responses collected from Oracle Utilities Customer Program Management Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
4. For technical faults encountered in the process, such as Oracle Utilities Customer Program Management Cloud Service unavailable, the integration will set the overall ackType to “FAILURE”.
• If it encounters a technical error while processing an enrollment request, but can continue processing the collection, the error details will be captured inside the response back to Oracle Utilities Edge Distributed Energy Resources Management System and an error email notification is sent out on the first time the error is encounter.
• If it faults and cannot continue processing the collection, Oracle Integration Cloud will try to send a response back to Oracle Utilities Edge Distributed Energy Resources Management System with the details and will also send an email notification with the error details via a common error handler to the users configured in the 'to' recipients of lookup OUTL-BRT-DACS_DRMS_Email_ID.
• If Oracle Integration Cloud is trying to send a failure response to Oracle Utilities Edge Distributed Energy Resources Management System, and it fails, it will send an email notification with the error details via a common error handler to the users configured in the 'to' recipients of lookup OUTL-BRT-DACS_DRMS_Email_ID.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Enrollment Request |
Integration Process Identifier | OUTL-BA-DRMS_DACS_ENROLLRQ |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: enroll • Method: POST • URI: /enroll-to-dacs |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: X1-ProgramEnrollment • Operation Name: enrollProgram • Method: POST • URI:/enroll |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_ EnrollmentStatus • OUTL-BRT-DACS_DRMS_AssetSpec • OUTL-BRT-DACS_DRMS_AssetType |
Enrollment Sync Process
When customers enroll, unenroll, add or replace a controllable device(s) in a program successfully in Oracle Utilities Customer Program Management Cloud Service, the enrollment information is sent to Oracle Utilities Edge Distributed Energy Resources Management System.
The same enrollment synchronization process is also used to send the completed DER Registration from Oracle Utilities Customer Program Management Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
This integration process keeps enrollment or registration information synchronized between Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System.
After Oracle Utilities Edge Distributed Energy Resources Management System processes the request, it sends an acknowledgment along with the device(s)' headend registration status back to Oracle Utilities Customer Program Management Cloud Service.
The enrollment synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Enrollment Sync (CPMCS Initiated)
The following diagram shows a graphical representation of the Enrollment Sync integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives a request from Oracle Utilities Customer Program Management Cloud Service.
2. Transform the payload to Oracle Utilities Edge Distributed Energy Resources Management System format.
3. Invoke the Oracle Utilities Edge Distributed Energy Resources Management System enrollment service endpoint.
4. If the REST service returns:
• Status 200 (OK),
• Enrollment Sync integration will finish the initial request by returning the incoming "syncRequestId" into the response "externalId".
• Error Status, such as 400 or 500,
• Throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Enrollment Sync |
Integration Process Identifier | OUTL-BA-DACS_DRMS_ENROLL_SYNC |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
trigger | Outbound Message Type: X1-NMSDASMSG (Asset Customer) |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: enroll • Method: POST • URI: /enroll |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing |
Enroll and Device Headend Status Acknowledgment (Edge DERMS Initiated)
The following diagram shows a graphical representation of the Enrollment Sync Acknowledgment integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives the Oracle Utilities Edge Distributed Energy Resources Management System enrollment and device headend status acknowledgment.
2. Transforms the payload to Oracle Utilities Customer Program Management Cloud Service format.
3. Invokes the CPMCS REST endpoint Program Enrollment - postAcknowledgment to send the enrollment synchronization acknowledgment and the device’s headend registration status.
4. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Enroll and Device Headend Status Ack |
Integration Process Identifier | OUTL-BA-DERMS_DACS_EN_DVSTAT_ACK |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: enrollAckAll • Method: POST • URI: /enroll-ack-all-to-dacs |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: X1-ProgramEnrollment • Operation Name: postAcknowledgement • Method: POST • URI: /postAcknowledgement |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_DeviceHeadendStatus |
Device Status Check and Acknowledgment
This integration process sends a device status check from Oracle Utilities Customer Program Management Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System to retrieve the latest device communication status for the device. Oracle Utilities Edge Distributed Energy Resources Management System then gets the device communication status from Oracle Utilities Live Energy Connect.
After obtaining the status from Oracle Utilities Live Energy Connect, Oracle Utilities Edge Distributed Energy Resources Management System sends an asynchronous response back to Oracle Utilities Customer Program Management Cloud Service for the corresponding device status check request.
Device status check request and response are asynchronous processes:
Device Status Check (CPMCS Initiated)
The following diagram shows a graphical representation of the Device Status Check integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives a device status request from Oracle Utilities Customer Program Management Cloud Service.
2. Transforms the payload to the Oracle Utilities Edge Distributed Energy Resources Management System format.
3. Invokes the Oracle Utilities Edge Distributed Energy Resources Management System Status Check REST Service.
4. If the REST service returns:
• Status 200 (OK), end the process.
• Error Status, such as 400 or 500, an error email notification with the error details is sent via common error handler. The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Device Status Check |
Integration Process Identifier | OUTL-BA-DACS_DRMS_DEVICE_STATUS |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
trigger | Outbound Message Type: X1-CTRLDVCS (Controllable Device Status Check) |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: statusCheck • Method: POST • URI: /status-check |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Routing |
Device Status Check Acknowledgment (Edge DERMS Initiated)
The following diagram shows a graphical representation of the Device Status Check Response integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST AP and performs the following activities:
1. The process is triggered when it receives the device status from Oracle Utilities Edge Distributed Energy Resources Management System.
2. Transforms the payload to the Oracle Utilities Customer Program Management Cloud Service format.
3. Invokes the CPMCS REST endpoint Controllable Device Status - postControllableDeviceStatus REST Service using the Utilities Adapter.
4. If the REST service returns:
• Status 200 (OK), the process returns a response to Oracle Utilities Edge Distributed Energy Resources Management System with the Oracle Utilities Customer Program Management Cloud Service boStatus in the response responseCode and a SUCCESS ackType.
• Error Status, such as 400 or 500, the process returns a response to Oracle Utilities Edge Distributed Energy Resources Management System with a FAILURE ackType.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Device Status Ack |
Integration Process Identifier | OUTL-BA-DACS_DRMS_DEVICE_STATUS |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: deviceStatusCheckAck • Method: POST • URI: /status-check-ack-to-dacs |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: X1-ControllableDeviceStatus • Operation Name: postControllableDeviceStatus • Method: POST • URI: /response |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup | OUTL-BRT-DACS_DRMS_ConfigProps |
Program Event Status Update (Edge DERMS Initiated)
When Oracle Utilities Edge Distributed Energy Resources Management System creates an event, it may include multiple stages. Each stage represents a defined time window for a specific program, and each stage maps to a corresponding Oracle Utilities Customer Program Management Cloud Service program event.
When the overall event transitions to SCHEDULED status, Oracle Utilities Edge Distributed Energy Resources Management System sends an outbound message to Oracle Utilities Customer Program Management Cloud Service for each stage to create the associated program events.
When an event stage changes status in Oracle Utilities Edge Distributed Energy Resources Management System, the corresponding status update details are sent to Oracle Utilities Customer Program Management Cloud Service.
Note: Not all status updates are sent out from Oracle Utilities Edge Distributed Energy Resources Management System. This can be configured in the DRMS Parameters Table, attribute name OIC_NOTIFY_STAGE_STATUSES.
The following diagram shows a graphical representation of the Program Event Stage Status integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives the stage and status information from Oracle Utilities Edge Distributed Energy Resources Management System. The message received is a JSON payload.
2. Transforms the payload to Oracle Utilities Customer Program Management Cloud Service format.
3. Depending on the incoming stage status, Oracle Integration Cloud invokes one of the following operations from Program Event on the CPMCS REST endpoint:
• Map to createProgramEvent for a “scheduled” status value.
• Map to actionProgramEvent for all other values.
4. Return a positive response to Oracle Utilities Edge Distributed Energy Resources Management System.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler Oracle Integration Cloud process to the users defined in 'to' recipients in lookup OUTL-BRT-DACS_DRMS_Email_ID.
• Return a negative response to Oracle Utilities Edge Distributed Energy Resources Management System.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS ProgramEvent Status Update |
Integration Process Identifier | OUTL-BA-DRMS_DACS_STAGE_STAT_UPD |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • Service Name: NMS-DACSOutbound • OperationId: stageStatusChange • Method: POST • URI: /stage-status-to-dacs |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: X1-ProgramEvent • OperationName: createProgramEvent and actionProgramEvent • Method: POST • createProgramEvent URI: / • actionProgramEvent URI: /lifecycle |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_EventType • OUTL-BRT-DACS_DRMS_StageStatus |
Event Device Reservation (Edge DERMS Initiated)
When controllable devices are selected to participate in an upcoming event, Oracle Utilities Edge Distributed Energy Resources Management System notifies Oracle Utilities Customer Program Management Cloud Service of the devices reserved for that event.
An Oracle Utilities Edge Distributed Energy Resources Management System event can have multiple stages where each stage represents a specific program over a defined time window. When stages are scheduled, Oracle Utilities Edge Distributed Energy Resources Management System sends an outbound message for each stage.
This integration process then sends the devices reserved for the stage to Oracle Utilities Customer Program Management Cloud Service and returns an acknowledgment to Oracle Utilities Edge Distributed Energy Resources Management System indicating whether processing completed successfully or ended with an error.
The following diagram shows a graphical representation of the Event Device Reservation integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when Oracle Utilities Edge Distributed Energy Resources Management System invokes the REST endpoint to send the device reservation information for a specific stage or program event to Oracle Utilities Customer Program Management Cloud Service. The message received is a JSON payload with a CSV file attachment. The JSON message contains the stage information and the CSV file contains the devices participating in the stage.
2. Before sending the file, the integration invokes F1-HealthCheckRest Rest endpoint to check if Oracle Utilities Customer Program Management Cloud Service environment is up and accessible.
• If the REST service returns HTTP status 200, CPMCS is accessible and proceed to Step 3.
• Else:
• Transforms the Negative Acknowledgment message. Send 'FAILURE' ackType to Oracle Utilities Edge Distributed Energy Resources Management System so it can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• Invokes the DERMS Event Reservation Acknowledgment REST endpoint.
3. Uses Stage File operation “ReadFileinSegments” to read the file in segments of 1000 records with parallel processing option.
• Transforms the stage and device reservation payload from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Customer Program Management Cloud Service format.
• Invokes the CPMCS REST endpoint Program Event Participation-reserveDevice to pass the Program Event Device Reservation information to Oracle Utilities Customer Program Management Cloud Service.
• If any of the REST service invocation returns an HTTP Error status:
• Transforms the Negative Acknowledgment message. Send 'FAILURE' ackType to Oracle Utilities Edge Distributed Energy Resources Management System so it can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• It is expected that Oracle Utilities Customer Program Management Cloud Service will not return any business faults but handle these with a To-Do task instead.
• Invokes Oracle Utilities Edge Distributed Energy Resources Management System Event Reservation Acknowledgment REST endpoint.
4. After all the records in the file are processed:
• A positive acknowledgment with a 'SUCCESS' ackType is sent to Oracle Utilities Edge Distributed Energy Resources Management System by invoking the Oracle Utilities Edge Distributed Energy Resources Management System Event Reservation Acknowledgment REST endpoint.
• A process completed email notification is sent to the users defined in to.processnotification recipients in lookup OUTL-BRT-DACS_DRMS_Email_ID.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler OIC process to the users defined in 'to' recipients in lookup OUTL-BRT-DACS_DRMS_Email_ID.
• A negative Acknowledgment with 'FAILURE' ackType is sent to Oracle Utilities Edge Distributed Energy Resources Management System so Oracle Utilities Edge Distributed Energy Resources Management System can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Event Device Reserve |
Integration Process Identifier | OUTL_BA_DRMS_DACS_EVT_DVCRESV |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: deviceReservation • Method: POST • URI: /device-reservation-ack |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for DACS-DERMS |
invoke | • Web Service Name: X1-ProgramEventParticipation • Operation Name: reserveDevice • Method: POST • URI: /reserveDevice |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • operationId: deviceReservationAck • Method: POST • URI: /device-reservation-ack |
Local Integrations | • OU CPMCS DERMS CommonErrorHandler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_EventType • OUTL-BRT-DACS_DRMS_Routing |
Event Device Outcome (Edge DERMS Initiated)
Customers enrolled in an active program may be requested to participate in program events for a defined duration.
After an event or event stages are complete, Oracle Utilities Edge Distributed Energy Resources Management System receives the actual participation results for all devices from Oracle Utilities Live Energy Connect.
Oracle Utilities Edge Distributed Energy Resources Management System then aggregates the post-event outcomes for all controllable devices that were called to participate and sends it to Oracle Utilities Customer Program Management Cloud Service through a file extract.
The extract may include data from one or multiple events, and each participating device is represented by a single record. Example: If a service point has two linked devices and both participate in an event, the file will contain two outcome records - one per device.
When the file is ready, Oracle Utilities Edge Distributed Energy Resources Management System sends the JSON outbound message with the file attached.
The integration process sends the post event outcome file from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Customer Program Management Cloud Service and returns an acknowledgment to Oracle Utilities Edge Distributed Energy Resources Management System indicating whether processing completed successfully or failed with an error.
The following diagram shows a graphical representation of the Event Device Outcome integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when Oracle Utilities Edge Distributed Energy Resources Management System invokes the REST endpoint to send the post event outcome information to Oracle Utilities Customer Program Management Cloud Service. The message received is a JSON payload with a CSV file attachment.
2. Before sending the file, the integration invokes F1-HealthCheckRest Rest endpoint to check if the Oracle Utilities Customer Program Management Cloud Service environment is up and accessible.
• If the REST service returns HTTP status 200, Oracle Utilities Customer Program Management Cloud Service is accessible and proceed to Step 3.
• Else,
• Transforms the Negative Acknowledgment message. Send 'FAILURE' ackType to Oracle Utilities Edge Distributed Energy Resources Management System, so Oracle Utilities Edge Distributed Energy Resources Management System can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• Invokes the Oracle Utilities Edge Distributed Energy Resources Management System Event Outcome Acknowledgment REST endpoint.
3. Uses Stage File operation “ReadFileinSegments” to read the file in segments of 1000 records with parallel processing option and loops through each incoming request:
• Transforms the event outcome request payload from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Customer Program Management Cloud Service format.
• Invokes the CPMCS REST endpoint Program Event Participation - postEventOutcome to update event outcome from the participated device reservation. The event outcome status will be changed accordingly.
• If any of the REST service invocation returns an HTTP Error status:
• Transforms the Negative Acknowledgment message. Send 'FAILURE' ackType to Oracle Utilities Edge Distributed Energy Resources Management System so it can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• It is expected that Oracle Utilities Customer Program Management Cloud Service will not return any business faults but handle these with a To-Do task instead.
• Invokes the Oracle Utilities Edge Distributed Energy Resources Management System Device Outcome Acknowledgment REST endpoint.
4. After all the records in the file are processed:
• A positive acknowledgment with a 'SUCCESS' ackType is sent to Oracle Utilities Edge Distributed Energy Resources Management System by invoking the Oracle Utilities Edge Distributed Energy Resources Management System Device Outcome Acknowledgment REST endpoint.
• A process completed email notification is also sent to the users defined in to.processnotification recipients in lookup OUTL_BRT_DACS_DRMS_Email_ID.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler OIC process to the users defined in 'to' recipients in lookup OUTL_BRT_DACS_DRMS_Email_ID.
• A negative Acknowledgment with 'FAILURE' ackType is sent to Oracle Utilities Edge Distributed Energy Resources Management System so Oracle Utilities Edge Distributed Energy Resources Management System can auto retry the failed message according to the MAX_RETRIES setting in their DRMS_PARAMENTERS table.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Edge Distributed Energy Resources Management System and Oracle Utilities Analytics Insights artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Event Device Outcome Process |
Integration Process Identifier | OUTL-BA-DRMS_DACS_EVT_OUTC_TRNFR |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: deviceOutcomeToDACS • Method: POST • URI: /device-outcome-to-dacs |
Target Connection (Oracle Utilities Adapter) | OU REST DACS for CPMCS-DERMS |
invoke | • Web Service Name: X1-ProgramEventParticipation • Operation Name: postEventOutcome • Method: POST • URI: / postEventOutcome |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: deviceOutcomeAck • Method: POST • URI: /device-outcome-ack |
Local Integrations | OU CPMCS DRMS Common Handler |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_EventOutcome • OUTL-BRT-DACS_OUAI_Routing |
Customer Event Opt Out Update (CPMCS Initiated)
When a customer is notified by the utility of an upcoming event, they may choose not to participate and communicate their decision by phone or email.
When a CSR receives this request from a customer, a CSR manually updates the Preemptive Opt-Out field from the default “No” to “Yes” in Oracle Utilities Customer Program Management Cloud Service application. Once set to “Yes”, Oracle Utilities Customer Program Management Cloud Service sends a real-time outbound message to Oracle Utilities Edge Distributed Energy Resources Management System for each device that has been opted out of an upcoming event.
Upon receiving the message, Oracle Utilities Edge Distributed Energy Resources Management System sends an instruction to Oracle Utilities Live Energy Connect to have the external system (Head End/Aggregator) cancel the control commands for the opted-out devices for that particular event.
After processing the request message, Oracle Utilities Edge Distributed Energy Resources Management System returns a synchronous response to Oracle Integration Cloud indicating whether the request was processed successfully.
The following diagram shows a graphical representation of the Event Customer Opt Out Update integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and does the following:
1. The process is triggered when it receives a request from Oracle Utilities Customer Program Management Cloud Service.
2. Transforms the payload to Oracle Utilities Edge Distributed Energy Resources Management System format.
3. Invokes the Oracle Utilities Edge Distributed Energy Resources Management System Event Opt Out service endpoint.
4. If the REST service returns:
• Status 200 (OK), check the Oracle Utilities Edge Distributed Energy Resources Management System response ackType.
• If it is ‘SUCCESS’, the flow will finish successfully.
• Else, throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
• Error Status, such as 400 or 500,
• Throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Customer Event Opt-Out Update |
Integration Process Identifier | OUTL-BA-DACS_DERMS_EVTOPTOUT_UPD |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
Trigger | Outbound Message Type: X1-EPOPTOMSG (Event Participation Opt Out) |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: dacsOptOut • Method: POST • URI: /dacs-opt-out |
Local Integrations | OU CPMCS DERMS Common Error Handler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing |
Customer Unavailability Update (CPMCS Initiated)
Customer’s unavailability to participate in upcoming events over a specified period is recorded in Oracle Utilities Customer Program Management Cloud Service. Customer can notify the utility of their unavailability for a given date and time range via phone or email and a real-time outbound message is sent to Oracle Utilities Edge Distributed Energy Resources Management System for each device that has been marked as unavailable.
When Oracle Utilities Edge Distributed Energy Resources Management System receives the message, it will send a message to Oracle Utilities Live Energy Connect to instruct the external system (Head End/Aggregator) to cancel the control commands on the end devices unavailable for a specific period.
After processing the request, Oracle Utilities Edge Distributed Energy Resources Management System provides a synchronous response to Oracle Integration Cloud whether the request was processed successfully.
Currently, only newly created customer unavailability records in Oracle Utilities Customer Program Management Cloud Service are sent over to Oracle Utilities Edge Distributed Energy Resources Management System.
The following diagram shows a graphical representation of the Customer Unavailability Update integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and does the following:
1. The process is triggered when it receives a request from Oracle Utilities Customer Program Management Cloud Service.
2. If the CPMCS action field is “ADD” (which mean it is a new customer unavailability record), then:
• Proceed to the transformation.
• Else, stop the process.
3. Transforms the payload to Oracle Utilities Edge Distributed Energy Resources Management System format.
4. Invokes the Oracle Utilities Edge Distributed Energy Resources Management System Event Opt Out service endpoint.
5. If the REST service returns:
• Status 200 (OK), check the Oracle Utilities Edge Distributed Energy Resources Management System response ackType.
• If it is “SUCCESS”, the flow will finish successfully.
• Else, throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
• Error Status, such as 400 or 500,
• Throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
6. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Customer Unavailability Update |
Integration Process Identifier | OUTL-BA-DACS_DERMS_EVT_CUST_UNAVAIL_UPD |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
Trigger | Outbound Message Type: X1-CUSTUNAVL (Customer Unavailability) |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: dacsOptOut • Method: POST • URI: /dacs-opt-out |
Local Integrations | OU CPMCS DERMS Common Error Handler |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing |
Program Rule Sync Process
The utility can define and maintain a set of event-related constraints or rules for each program.
Programs and their associated rules are managed in Oracle Utilities Customer Program Management Cloud Service by the Program Manager. When a program rule is created or updated, the program along with its associated rules is synchronized with Oracle Utilities Edge Distributed Energy Resources Management System to give Oracle Utilities Edge Distributed Energy Resources Management System the ability to calculate device availability. Only rules that are linked to a program are included in the synchronization.
Once the synchronization is complete, an acknowledgment is sent back to Oracle Utilities Customer Program Management Cloud Service.
The program rule synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Program Rule Sync (CPMCS Initiated)
The following diagram shows a graphical representation of the Program Rule Sync integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives a request from Oracle Utilities Customer Program Management Cloud Service.
2. Transforms the payload to Oracle Utilities Edge Distributed Energy Resources Management System format.
3. Invokes the Oracle Utilities Edge Distributed Energy Resources Management System update program service endpoint.
4. If the REST service returns:
• Status 200 (OK),
• Invokes the internal Oracle Utilities DERMS CPMCS Program Rule Sync Ack Oracle Integration Cloud integration process.
• Error Status, such as 400 or 500,
• Throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Program Rule Sync |
Integration Process Identifier | OUTL-BA-DACS_DERMS_PROGRULE_SYNC |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DRMS for DACS-DERMS |
trigger | Outbound Message Type: X1-GEDPGRMSG (Program Rule) |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: updateProgram • Method: POST • URI: /update-program |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing • OUTL-BRT-DACS_DRMS_CycleFrequency • OUTL-BRT-DACS_DRMS_WeekDay • OUTL-BRT-DACS_DRMS_AllowEventDays |
Program Rule Sync Acknowledgment (OIC Initiated)
The following diagram shows a graphical representation of the Program Rule Sync Acknowledgment integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API, called internally by the CPMCS-DERMS Program Rule Sync OIC integration process, and performs the following activities:
1. The process is triggered after it receives an Http 200 synchronous response from Oracle Utilities Edge Distributed Energy Resources Management System update program REST API.
2. Transforms the Oracle Utilities Edge Distributed Energy Resources Management System update program response payload to Oracle Utilities Customer Program Management Cloud Service format.
3. Invokes the Oracle Utilities Customer Program Management Cloud Service Sync Request Update REST endpoint to send the acknowledgment.
4. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Enroll Sync Ack |
Integration Process Identifier | OUTL-BA-DRMS_DACS_SYNC_ACK |
Integration Project Name | OU CPMCS DERMS |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: F1-SyncRequest • Method: PATCH • URI: /{syncRequestId} |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID |
Aggregator Sync Process
Distributed Energy Resources devices can be enrolled and managed by an aggregator. This model is maintained in Oracle Utilities Customer Program Management Cloud Service.
When an aggregator is created or updated in Oracle Utilities Customer Program Management Cloud Service, the information is synchronized to Oracle Utilities Edge Distributed Energy Resources Management System.
Once the synchronization is complete, an acknowledgment is sent back to Oracle Utilities Customer Program Management Cloud Service.
The aggregator synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Aggregator Sync (CPMCS Initiated)
The following diagram shows a graphical representation of the Aggregator Sync integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. The process is triggered when it receives a request from Oracle Utilities Customer Program Management Cloud Service.
2. Transforms the payload to Oracle Utilities Edge Distributed Energy Resources Management System format.
3. Invokes the Oracle Utilities Edge Distributed Energy Resources Management System update aggregator service endpoint.
4. If the REST service returns:
• Status 200 (OK),
• Invokes the internal Oracle Utilities DERMS CPMCS Aggregator Sync Ack Oracle Integration Cloud integration process.
• Error Status, such as 400 or 500,
• Throws a fault back to Oracle Utilities Customer Program Management Cloud Service and an error email notification with the error details is sent via the common error handler.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Aggregator Sync |
Integration Process Identifier | OUTL-BA-DACS_DERMS_AGGREG_SYNC |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
trigger | Outbound Message Type: X1-GEDAGRMSG (Aggregator) |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: updateAggregator • Method: POST • URI: /update-aggregator |
Local Integrations | OU CPMCS DERMS CommonErrorHandler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing |
Aggregator Sync Acknowledgment (OIC Initiated)
The following diagram shows a graphical representation of the Aggregator Sync Acknowledgment integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API, called internally by the CPMCS-DERMS Aggregator Sync OIC integration process, and performs the following activities:
1. The process is triggered after it receives an Http 200 synchronous response from Oracle Utilities Edge Distributed Energy Resources Management System update aggregator REST API.
2. Transforms the Oracle Utilities Edge Distributed Energy Resources Management System update aggregator response payload to Oracle Utilities Customer Program Management Cloud Service format.
3. Invokes the Oracle Utilities Customer Program Management Cloud Service Sync Request Update REST endpoint to send the acknowledgment.
4. For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler.
• The process returns a fault to Oracle Utilities Customer Program Management Cloud Service.
• The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS Aggregator Sync Ack |
Integration Process Identifier | OUTL-BA-DERMS_DACS_AGGSYNC_ACK |
Integration Project Name | OU CPMCS DERMS |
Target Connection (Oracle Utilities Adapter) | OU REST CPMCS for CPMCS-DERMS |
invoke | • Web Service Name: F1-SyncRequest • Method: PATCH • URI: /{syncRequestId} |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID |
SP Network Location Transfer (Edge DERMS Initiated)
To enable device grouping in Oracle Utilities Customer Program Management Cloud Service, the system needs to know the network hierarchy of each service point to associate devices with service transformers, feeders, and substations.
Oracle Utilities Edge Distributed Energy Resources Management System generates a file extract containing nominal network details, such as transformer, feeder and substation, linked to each service point. Once the file is ready, it sends a JSON outbound message with the file attached to Oracle Integration Cloud.
Oracle Utilities Edge Distributed Energy Resources Management System supports both initial data loads and subsequent incremental updates, including additions and modifications to existing records.
This integration process transfers the service point network location file from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Customer Program Management Cloud Service content server. The file is received either from an on-premises FTP Server or from an OCI Object Storage location, based on the configured preference.
No acknowledgment is required upon completion, as this is a direct file transfer with no transformation performed in the integration.
Internally, the integration invokes one of the following Oracle Integration Cloud flows, depending on the selected file transfer method:
• OU CPMCS Common OS Transfer
• OU CPMCS Common FTP Transfer
The following diagram shows a graphical representation of the SP Network Location Transfer integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and does the following:
1. The process is triggered when Oracle Utilities Edge Distributed Energy Resources Management System invokes the REST endpoint to send the SP Network Location information to Oracle Utilities Customer Program Management Cloud Service. The message received is a JSON payload with a CSV file attachment.
2. Based on the value set in the dacs.file.target.transfer.pref property, the process sends the file to a child OIC process.
a. The 2 child OIC processes that can be called are OU CPMCS Common FTP Transfer and OU CPMCS Common OS Transfer.
• If the property value is ‘os’, it is routed to the OU CPMCS Common OS Transfer child process. This file is sent to CPMCS OCI Object Storage. The file location is set in the dacs.os.namespace and dacs.spNtwkLoc.os.bucketname properties.
• If property value is ‘ftp’, it is routed to OU CPMCS Common FTP Transfer child process. This file is sent to the CPMCS FTP location. The file location is set in property dacs.spNtwkLoc.ftp.input.directory.
b. If the child process returns HTTP status 200, the file transfer was successfully completed. Otherwise, an error occurred during the file transfer.
3. After the child process is completed, a Process Complete Notification email is sent to dacs.to.process.notification recipients defined in the OUTL-BRT-DACS_DRMS_Email_ID lookup. This process complete email can contain a success or error file transfer information.
4. Error Handling.
For any errors encountered in this process:
• An error email notification with error details is sent via the common error handler Oracle Integration Cloud process.
5. The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Edge Distributed Energy Resources Management System and Oracle Utilities Customer Program Management Cloud Service artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DERMS CPMCS SP Network Location Transfer |
Integration Process Identifier | OUTL-BA-DERMS_DACS_SPNWLOC_TRNFR |
Integration Project Name | OU CPMCS DERMS |
Source Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
Trigger | • DERMS Service Name: NMS-DACSOutbound • OperationId: exportCustomerModel • Method: POST • URI: /network-model-to-dacs |
Target Connection (REST Adapter) | OU REST MP OIC for CPMCS-DERMS (Connecting to internal OU CPMCS Common OS and FTP Transfer OIC flows passing file as attachment) |
Local Integrations | • OU CPMCS Common OS Transfer • OU CPMCS Common FTP Transfer • OU CPMCS DERMS Common Error Handler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID • OUTL-BRT-DACS_DRMS_Routing |
Send Device Score (CPMCS Initiated)
Oracle Utilities Customer Program Management Cloud Service calculates and maintains a device score for each controllable device enrolled in a program and periodically sends this information to Oracle Utilities Edge Distributed Energy Resources Management System via a file extract. The score is determined based on factors, such as equipment specifications, monthly or annual capacity, device participation history, and other relevant criteria.
This integration process transfers the device score from Oracle Utilities Customer Program Management Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System, enabling it to support eligibility evaluation during event planning.
Oracle Utilities Customer Program Management Cloud Service can place the file on an on-premises FTP Server or in an OCI Object Storage location. Oracle Utilities Edge Distributed Energy Resources Management System receives the files through a REST web service.
The device score file transfer is handled by the following Oracle Integration Cloud integration flows depending on the file transfer preference:
The following diagram shows the Device Score related processes:
Device Score FTP Transfer (CPMCS Initiated)
This integration process retrieves device score data file(s) from an FTP storage location where Oracle Utilities Customer Program Management Cloud Service uploads them and sends it to Oracle Utilities Edge Distributed Energy Resources Management System through a REST API call.
The following diagram shows a graphical representation of the Device Score Transfer integration process from an FTP Server:
Processing Details
This is a scheduled integration process deployed on Oracle Integration Cloud and performs the following activities:
1. The process is triggered by a schedule or it can also be triggered manually.
• Define the integration schedule for this process and make sure the Smart Control Device Score Extract Job (X1-SDCSE) schedule in Oracle Utilities Customer Program Management Cloud Service is always run first, so the file is available to be processed by the integration.
• A couple of the default values used in this integration are defined in the OUTLBRT-DACS_DRMS_ConfigProps. Make sure to define the properties needed for this integration.
2. It invokes the FTP adapter to list files from the Oracle Utilities Customer Program Management Cloud Service on-premises location obtained from the file path set in the dacs.dvcScore.ftp.input.directory property. It will retrieve files matching the prefix set in the dacs.dvcScore.extract.filename.prefix property.
Note: The value dacs.dvcScore.extract.filename.prefix should match the beginning of the parameter filename in Oracle Utilities Customer Program Management Cloud Service Batch X1-SDCSE.
• If no file is found and notification.email.process.nofile.flag is true (by default it is false), it will send a no file found email notification to to.process.notification recipients defined in lookup OUTL-BRT-DACS_DRMS_EMAIL_ID and the process will stop.
• If files are found, go to the next step.
3. For each file, do the following:
• Invoke the FTP Adapter with Download File operation to get the actual file to process.
• Invoke DERMS Device Score REST API and send the file as a binary attachment.
• If Oracle Utilities Edge Distributed Energy Resources Management System returns an HTTP 200 or 202, invoke the FTP adapter to rename the source file obtained from the server by adding the prefix set in the dacs.prefixtag.fileuploaded property and the next file in the list is processed.
4. After the successful transfer of all files, if the notification.email.process.complete.flag is true, a Process Complete email notification is sent to to.process.notification recipients defined in the OUTL-BRT-DACS_DRMS_Email_ID lookup.
5. Error Handling.
For any errors encountered in this process:
• Invoke the FTP Adapter to rename the source file obtained from the server by adding the prefix set in property dacs.prefixtag.filenotuploaded.
• An error email notification with error details is sent via the common error handler Oracle Integration Cloud process to the users defined in to recipients in lookup OUTL-BRT-DACS_DRMS_Email_ID.
• If the error happens while processing the list of files, the Process Complete email notification is also sent out containing the summary of files transferred and not transferred.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Device Score FTP Transfer |
Integration Process Identifier | OUTL-BA-DRMS_DACS_SEND_DVCSCORE |
Integration Project Name | OU CPMCS DERMS |
Source Connection (FTP Adapter) | OU FTP CPMCS for CPMCS-DERMS |
Target Connection (Oracle Utilities Adapter) | OU REST DERMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: deviceScore • Method: POST • URI: /device-score/{file-name} |
Local Integrations | OU CPMCS DERMS Common Error Handler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID |
Device Score OS Transfer (CPMCS Initiated)
This integration process retrieves the device score data file(s) from an OCI Object Storage location where Oracle Utilities Customer Program Management Cloud Service uploads them, and then transfers the file(s) to Oracle Utilities Edge Distributed Energy Resources Management System through a REST API call.
The following diagram shows a graphical representation of the Device Score Transfer integration process from an OCI Object Storage location:
Processing Details
This is a scheduled integration process deployed on Oracle Integration Cloud and performs the following activities:
1. The process is triggered by a schedule or can also be triggered manually.
a. Define the integration schedule for this process and makes sure the Smart Control Device Score Extract Job (X1-SDCSE) schedule in Oracle Utilities Customer Program Management Cloud Service is always run first, so the file is available to be processed by the integration.
b. A couple of the default values used in this integration are defined in the OUTL-BRT-DACS_DRMS_ConfigProps. Make sure to define the properties needed for this integration.
2. It invokes the Object Storage - List Objects REST API to get the list of files found in the Oracle Utilities Customer Program Management Cloud Service Object Storage bucket, set in the properties dacs.os.dvcScore.bucketname and dacs.os.namespace. It will retrieve files matching the prefix set in property dacs.dvcScore.extract.filename.prefix.
Note: The value dacs.dvcScore.extract.filename.prefix should match the beginning of the parameter filename in Oracle Utilities Customer Program Management Cloud Service Batch X1-SDCSE.
• If no file is found and notification.email.process.nofile.flag is true (by default it is false), it will send a no file found email notification to to.process.notification recipients defined in lookup OUTL-BRT-DACS_DRMS_EMAIL_ID and the process will stop.
• If files are found, proceed to the next step.
3. For each file, do the following:
a. Invoke the Object Storage: Gets Object REST API to get the actual file to process.
b. Invoke DERMS Device Score REST API and sends the file as a binary attachment.
• If Oracle Utilities Edge Distributed Energy Resources Management System returns an HTTP 200 or 202, it invokes the REST API RenameObject to rename the source file obtained from the server by adding the prefix set in property dacs.prefixtag.fileuploaded and the next file in the list is processed.
4. After the successful transfer of all files, if the notification.email.process.complete.flag is true, a Process Complete email notification is sent to to.process.notification recipients defined in lookup OUTL-BRT-DACS_DRMS_Email_ID.
5. Error Handling.
For any errors encountered in this process:
• Invoke the REST API RenameObject to rename the source file obtained from the server by adding the prefix set in property dacs.prefixtag.filenotuploaded.
• An error email notification with error details is sent via the common error handler Oracle Integration Cloud process to the users defined in to recipients in lookup OUTL-BRT-DACS_DRMS_Email_ID.
• If the error happens while processing the list of files, the Process Complete email notification is also sent out containing the summary of files transferred and not transferred.
Technical Details
The following table describes the integration processes and the respective Oracle Cloud Infrastructure Object Storage and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Device Score OS Transfer |
Integration Process Identifier | OUTL-BA-DRMS_DACS_SEND_DVCSCOREC |
Integration Project Name | OU CPMCS DERMS |
Source Connection (REST Adapter) | OU REST CPMCS Object Storage for CPMCS-DERMS |
Target Connection (Oracle Utilities Adapter) | OU REST DRMS for CPMCS-DERMS |
invoke | • DERMS Service Name: NMS-DACSInbound • OperationId: deviceScore • Method: POST • URI: /device-score/{file-name} |
Local Integrations | OU CPMCS DERMS Common Error Handler |
Lookup | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID |
Common Integration Flows
This section describes the shared logic used across integrations. To promote reuse and consistency, these logics are implemented within common integration flows that can be invoked by other integration processes. These common components include design standards, email formatting, and reusable integration patterns, such as:
File to File Transfer
Many integrations involve transferring files between applications. The source and target locations may reside either in folders on an on-premises server or in cloud-based object storage, depending on the capabilities supported by the respective applications during implementation.
Note: Oracle Utilities Edge Distributed Energy Resources Management System uses REST APIs for sending and receiving files. Oracle Utilities Customer Program Management Cloud Service supports both FTP and Object Storage as content storage options.
If the source application supports both FTP and object storage, two separate Oracle Integration Cloud (OIC) flows are created, one for each transfer method. This duplication is required because an integration cannot be activated unless all referenced connections are properly configured.
To provide flexibility, a file transfer preference property must be defined to determine the target transfer method. The valid values are: “os” or “ftp”.
• If set to “os”, a child Oracle Integration Cloud flow is called to transfer the file to a target object storage location.
• If set to “ftp”, a child Oracle Integration Cloud flow is called to transfer the file to a target ftp location.
Common Child File Transfer OIC Flows (OIC Initiated)
• OU CPMCS Common FTP Transfer
• OU CPMCS Common OS Transfer
All child Oracle Integration Cloud flows are exposed as a REST API with multipart request media type to pass a json request message with a file attachment. They are setup similarly to receive the endpoint information to send to an FTP or Object Storage location.
To Object Storage | To FTP Server |
|---|---|
Object Name | File Name |
Namespace and Bucket Name | Directory |
Stream Reference | File Reference |
Technical Details
The following tables describe the integration processes and the respective Oracle Utilities Customer Program Management Cloud Service artifacts used in the integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS Common FTP Transfer |
Integration Process Identifier | OUTL-BA-DACS_FTP_TRANSFER |
Integration Project Name | OU CPMCS DERMS |
Source Connection (REST Adapter-Trigger) | OU REST for CPMCS-DERMS |
Target Connection (FTP Adapter) | OU FTP CPMCS for CPMCS-DERMS |
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS Common OS Transfer |
Integration Process Identifier | OUTL-BA-DACS_OS_TRANSFER |
Integration Project Name | OU CPMCS DERMS |
Source Connection (REST Adapter-Trigger) | OU REST for CPMCS-DERMS |
Target Connection (REST Adapter) | OU REST CPMCS Object Storage for CPMCS-DERMS |
Common Error Handler (OIC Initiated)
This integration process is used to send email notification in case of errors in Oracle Integration Cloud.
The following diagram shows a graphical representation of the Common Error Handler integration process:
Processing Details
The integration process deployed on Oracle Integration Cloud is exposed as a REST API and performs the following activities:
1. This process is invoked internally by other Oracle Integration Cloud flows when a technical error occurs in any of the main integration flow.
2. The request message received is processed based on the notification.email.error.flag and notification.type.email property names in the OUTL-BRT-DACS_DRMS_ConfigProps lookup. If both are set to true, then an email notification will be sent on error.
Technical Details
The following table describes the integration processes and the respective artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CPMCS DERMS Common Error Handler |
Integration Process Identifier | OUTL-BA-DACS_DRMS_ERROR |
Integration Project Name | OU CPMCS DERMS |
Source Connection | local integration |
trigger | /receiveMessage |
Lookup For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications. | • OUTL-BRT-DACS_DRMS_ConfigProps • OUTL-BRT-DACS_DRMS_Email_ID |