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 Digital Asset 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: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 DACS 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 Digital Asset Cloud Service format.
Invokes the Program Enrollment DACS REST endpoint to create the enrollment in Oracle Utilities Digital Asset Cloud Service in PENDING status.
Response per enrollment request coming from Oracle Utilities Digital Asset 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 Digital Asset 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 Digital Asset 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 Digital Asset 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 Digital Asset Cloud Service contains one of those values.
It will send the responses collected from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
4. For technical faults encountered in the process, such as Oracle Utilities Digital Asset 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 Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DERMS DACS Enrollment Request
Integration Process Identifier
OUTL-BA-DRMS_DACS_ENROLLRQ
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DRMS for DACS-DERMS
trigger
DERMS Service Name: NMS-DACSOutbound
openAPIUrl: https://{host}:{port}/nms-drms/
outbound/openapi.json
OperationId: enroll
Method: POST
URI: /enroll-to-dacs
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
Web Service Name: X1-ProgramEnrollment
Computed URL: https://{host}:{port}/{tenant}/{domain}/ccs/rest/apis/cross/digitalAssets/programEnrollments
Method: POST
URI:/enroll
Local Integrations
OU DACS 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, or replace their smart controllable device(s) in a program successfully in Oracle Utilities Digital Asset Cloud Service, the enrollment information is sent to Oracle Utilities Edge Distributed Energy Resources Management System.
It also uses the enrollment sync process to send out DER Registration completed in Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
This integration process synchronizes the enrollment or registration information from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
After Oracle Utilities Edge Distributed Energy Resources Management System processes the request, it sends an acknowledgment back to Oracle Utilities Digital Asset Cloud Service.
The enrollment synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Enrollment Sync (DACS Initiated)
The following diagram shows a graphical representation of the Enrollment Sync integration process:Shows a graphical representation of the 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 Digital Asset 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 Digital Asset 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 Digital Asset Cloud Service.
The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Assets Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DACS DERMS Enrollment Sync
Integration Process Identifier
OUTL-BA-DACS_DRMS_ENROLL_SYNC
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
trigger
Outbound Message Type: X1-NMSDASMSG (Asset Customer)
Target Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port} /nms-drms/rest/v1/openapi.json
OperationId: enroll
Method: POST
URI: /enroll
Local Integrations
OU DACS DERMS CommonErrorHandler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
OUTL-BRT-DACS_DRMS_Routing
Enrollment Sync Acknowledgment (Edge DERMS Initiated)
The following diagram shows a graphical representation of the Enrollment Sync Acknowledgment integration process:Shows a graphical representation of the 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 sync acknowledgment.
2. Transforms the payload to Oracle Utilities Digital Asset Cloud Service format.
3. Invokes the Oracle Utilities Digital Asset 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 Digital Assets Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts
Value
Integration Process Name
OU DERMS DACS Enroll Sync Ack
Integration Process Identifier
OUTL-BA-DRMS_DACS_SYNC_ACK
Integration Project Name
OU DACS DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
Web Service Name: F1-SyncRequest
Computed URL: https://{host}:{port}/{tenant}/{domain /ouaf/rest/apis/common/sync/syncRequest
Method: PATCH
URI: /{syncRequestId}
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
Device Status Check and Acknowledgment
This integration process sends a device status check from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System to retrieve the most recent communication status for the device. Oracle Utilities Edge Distributed Energy Resources Management System then gets the device status from Oracle Utilities Live Energy Connect.
When Oracle Utilities Edge Distributed Energy Resources Management System gets the device status from Oracle Utilities Live Energy Connect, it sends and asynchronous response back to Oracle Utilities Digital Asset Cloud Service for the corresponding device status check request.
Device status check request and response are asynchronous processes:
Device Status Check (DACS Initiated)
The following diagram shows a graphical representation of the Device Status Check integration process:Shows a graphical representation of the 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 Digital Asset 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 Digital Asset Cloud Service.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Assets Cloud Service and Oracle Utilities Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DACS DERMS Device Status Check
Integration Process Identifier
OUTL-BA-DACS_DRMS_DEVICE_STATUS
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
trigger
Outbound Message Type: X1-CTRLDVCS
(Controllable Device Status Check)
Target Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port} /nms-drms/rest/v1/openapi.json
OperationId: statusCheck
Method: POST
URI: /status-check
Local Integrations
OU DACS 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:Shows a graphical representation of the 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 Digital Asset Cloud Service format.
3. Invokes the Oracle Utilities Digital Asset Cloud Service 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 Digital Asset Cloud Service boStatus in the Oracle Utilities Edge Distributed Energy Resources Management System 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 Digital Assets Cloud Service and Oracle Utilities Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DERMS DACS Device Status Ack
Integration Process Identifier
OUTL-BA-DACS_DRMS_DEVICE_STATUS
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
trigger
DERMS Service Name: NMS-DACSOutbound
openAPIUrl: https://{host}:{port}/nms-drms/outbound/openapi.json
OperationId: deviceStatusCheckAck
Method: POST
URI: /status-check-ack-to-dacs
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
Web Service Name: X1-CtrlDvcStatusCheckResp
Computed URL: https://{host}:{port}/{tenant}/
{domain}/ouaf/rest/apis/cross/digitalAssets/ controllableDeviceStatus
Method: POST
URI: /response
Local Integrations
OU DACS 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 can have multiple stages in it where each stage consists of a specific time frame for a specific program. Each stage is equivalent to a Oracle Utilities Digital Asset Cloud Service program event.
When the event transitions to SCHEDULED status, Oracle Utilities Edge Distributed Energy Resources Management System sends an outbound message for each stage in the event to Oracle Utilities Digital Asset Cloud Service for program event creation.
When an event stage status transitions to a different status in Oracle Utilities Edge Distributed Energy Resources Management System, the status update information is also sent to Oracle Utilities Digital Asset Cloud Service.
Note: Not all status updates are sent out from DERMS. 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: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 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 Digital Asset Cloud Service format.
3. Depending on the incoming stage status, Oracle Integration Cloud invokes one of the following operations from Program Event on the DACS REST endpoint:
Map to createProgramEvent for a “scheduled” status value.
Map to actionProgramEvent for all other values.
4. 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 Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DERMS DACS ProgramEvent Stage Status Update
Integration Process Identifier
OUTL-BA-DRMS_DACS_STAGE_STAT_UPD
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
trigger
Service Name: NMS-DACSOutbound
openAPIUrl: https://{host}:{port}/nms-drms/outbound/openapi.json
Method: POST
URI: /stage-status-to-dacs
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
DACS Web Service Name: X1-ProgramEvent
Computed URL: https://{host}:{port}/{tenant}/ {domain}/ ouaf/rest/apis/cross/service/ programEvent
Method: POST
createProgramEvent URI: /
actionProgramEvent URI: /lifecycle
Local Integrations
OU DACS 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 Digital Asset Cloud Service of the devices reserved for the specific event.
An Oracle Utilities Edge Distributed Energy Resources Management System event can have multiple stages and a stage consist of a specific time frame for a specific program. Oracle Utilities Edge Distributed Energy Resources Management System sends an outbound message for each stage in the event when they are scheduled.
This integration process sends the devices reserved for a stage to Oracle Utilities Digital Asset Cloud Service. It then sends an acknowledgment back to Oracle Utilities Edge Distributed Energy Resources Management System when the process is completed or encountered an error.
The following diagram shows a graphical representation of the Event Device Reservation integration process: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 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 Digital Asset 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 the Oracle Utilities Digital Asset Cloud Service environment is up and accessible.
If the REST service returns HTTP status 200, DACS 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 Digital Asset Cloud Service format.
Invokes the Program Event Participation-Reserve Device DACS REST endpoint to pass the Program Event Device Reservation information to Oracle Utilities Digital Asset 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 Digital Asset 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 Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DERMS DACS Event Device Reserve
Integration Process Identifier
OUTL_BA_DRMS_DACS_EVT_DVCRESV
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
DACS Web Service Name: X1-ProgramEventParticipation
Computed URL: https://{host}:{port}/{tenant}/{domain}/ccs/rest/apis/cross/service/programEventParticipation
Method: POST
URI: /reserveDevice
Target Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port}/nms-drms/rest/v1/openapi.json
Method: POST
URI: /event-reservation-ack
Local Integrations
OU DACS 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 are called upon to participate in program events for a specific duration.
After program events or stages have completed, Oracle Utilities Edge Distributed Energy Resources Management System receives the actual outcome of all devices’ event participation from Oracle Utilities Live Energy Connect (LEC).
Oracle Utilities Edge Distributed Energy Resources Management System aggregates and sends both Oracle Utilities Digital Asset Cloud Service and Oracle Utilities Analytics Insights the post event outcome for all controllable devices called to participate in an event or events through a file extract.
The data in the file can be from one or multiple events. Each device that is called to participate in an event will have one record in the file. Example, if a service point has 2 devices linked to in and both participated in an event, then each device will have one outcome record in the file.
Once the file is ready, Oracle Utilities Edge Distributed Energy Resources Management System sends the JSON outbound message with the file attachment.
The integration process sends the post event outcome file from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Digital Asset Cloud Service and sends an acknowledgment back to Oracle Utilities Edge Distributed Energy Resources Management System when the process is completed or encountered an error.
The following diagram shows a graphical representation of the Event Device Outcome integration process: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 Oracle Utilities Edge Distributed Energy Resources Management System invokes the REST endpoint to send the post event outcome information to Oracle Utilities Digital Asset 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 Digital Asset Cloud Service environment is up and accessible.
If the REST service returns HTTP status 200, Oracle Utilities Digital Asset 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 Digital Asset Cloud Service format.
Invokes the Program event participation post event outcome Oracle Utilities Digital Asset Cloud Service rest endpoint 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 Digital Asset 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 DACS Event Device Outcome Process
Integration Process Identifier
OUTL-BA-DRMS_DACS_EVT_OUTC_TRNFR
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
DACS Web Service Name: X1ProgramEventParticipation
Computed URL: https://{host}:{port}/{tenant}/ {domain}/rest/apis/cross/service/ programEventParticipation
Method: POST
URI: / postEventOutcome
Target Connection (Oracle Utilities
Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port} /nms-drms/ rest/v1/openapi.json
OperationId: deviceOutcomeAck
Method: POST
URI: /device-outcome-ack
Local Integrations
OU DACS 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 (DACS Initiated)
When a customer receives a notification from the Utility of an upcoming event, the customer can choose to not participate in that scheduled event. They can inform the utility through a call or email.
When a CSR receives this request from a customer, the CSR manually updates the Preemptive Opt-Out field from the default “No” option to “Yes” in the Oracle Utilities Digital Asset Cloud Service application. After this opt-out flag is updated to “Yes”, Oracle Utilities Digital Asset Cloud Service sends a real-time outbound message to notify Oracle Utilities Edge Distributed Energy Resources Management System of each device that has been opted out of an upcoming event.
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 that opt-out for that particular event.
After procesing the request message, Oracle Utilities Edge Distributed Energy Resources Management System will send a synchronous response to Oracle Integration Cloud whether it was successfully processed or not in Oracle Utilities Edge Distributed Energy Resources Management System.
The following diagram shows a graphical representation of the Event Customer Opt Out Update integration process: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 does the following:
1. The process is triggered when it receives a request from Oracle Utilities Digital Asset 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 Digital Asset 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 Digital Asset 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 Digital Asset Cloud Service.
The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management Systemartifacts used in this integration process:
Artifacts
Value
Integration Process Name
OU DERMS DACS Customer Event Opt-Out Update
Integration Process Identifier
OUTL-BA-DACS_DERMS_EVTOPTOUT_UPD
Integration Project Name
OU DACS DERMS
Source Connection
(Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
Trigger
Outbound Message Type: X1-EPOPTOMSG
(Event Participation Opt Out)
Target Connection
(Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port}/nms-drms/ rest/v1/openapi.json
OperationId: dacsOptOut
Method: POST
URI: /dacs-opt-out
Local Integrations
OU DACS DERMS Common Error Handler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
OUTL-BRT-DACS_DRMS_Routing
Program Rule Sync Process
A set of event related constraints or rules can be maintained for each program by the utility.
The Program and its associated program rules are mastered in Oracle Utilities Digital Asset Cloud Service to be managed by the Program Manager. When a program rule is created or updated, the Program along with these rules are synchronized to Oracle Utilities Edge Distributed Energy Resources Management System. Only program rules linked to a program are synchronized to Oracle Utilities Edge Distributed Energy Resources Management System.
This integration process synchronizes the program rules from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System to give Oracle Utilities Edge Distributed Energy Resources Management System also the ability to calculate device availability.
The integration then sends an acknowledgment back to Oracle Utilities Digital Asset Cloud Service.
The program rule synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Program Rule Sync (DACS Initiated)
The following diagram shows a graphical representation of the Program Rule Sync integration process:
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 a request from Oracle Utilities Digital Asset 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 DACS Program Rule Sync Ack Oracle Integration Cloud integration process.
Error Status, such as 400 or 500,
Throws a fault back to Oracle Utilities Digital Asset 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 Digital Asset Cloud Service.
The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Assets Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DACS DERMS Program Rule Sync
Integration Process Identifier
OUTL-BA-DACS_DERMS_PROGRULE_SYNC
Integration Project Name
OU DACS 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 DACS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port}/nms-drms/ rest/v1/openapi.json
OperationId: updateProgram
Method: POST
URI: /update-program
Local Integrations
OU DACS 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: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, called internally by the DACS-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 Digital Asset Cloud Service format.
3. Invokes the Oracle Utilities Digital Asset 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 Digital Assets Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts
Value
Integration Process Name
OU DERMS DACS Enroll Sync Ack
Integration Process Identifier
OUTL-BA-DRMS_DACS_SYNC_ACK
Integration Project Name
OU DACS DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
Web Service Name: F1-SyncRequest
Computed URL: https://{host}:{port}/{tenant}/ {domain /ouaf/rest/apis/common/sync/ 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 Digital Asset Cloud Service.
Once an Aggregator is successfully created or updated in Oracle Utilities Digital Asset Cloud Service, it is synchronized to Oracle Utilities Edge Distributed Energy Resources Management System and Oracle Utilities Live Energy Connect.
This integration process synchronizes the aggregator information from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System.
The integration then sends an acknowledgment back to Oracle Utilities Digital Asset Cloud Service.
The aggregator synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows:
Aggregator Sync (DACS Initiated)
The following diagram shows a graphical representation of the Aggregator Sync integration process: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 a request from Oracle Utilities Digital Asset 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 DACS Aggregator Sync Ack Oracle Integration Cloud integration process.
Error Status, such as 400 or 500,
Throws a fault back to Oracle Utilities Digital Asset 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 Digital Asset Cloud Service.
The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DACS DERMS Aggregator Sync
Integration Process Identifier
OUTL-BA-DACS_DERMS_AGGREG_SYNC
Integration Project Name
OU DACS DERMS
Source Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
trigger
Outbound Message Type: X1-GEDAGRMSG (Aggregator)
Target Connection (Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port}/nms-drms/ rest/v1/openapi.json
OperationId: updateAggregator
Method: POST
URI: /update-aggregator
Local Integrations
OU DACS DERMS CommonErrorHandler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
OUTL-BRT-DACS_DRMS_Routing
Aggregator Sync Acknowledgment (Edge DERMS Initiated)
The following diagram shows a graphical representation of the Aggregator Sync Acknowledgment integration process: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, called internally by the DACS-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 Digital Asset Cloud Service format.
3. Invokes the Oracle Utilities Digital Asset 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 Digital Asset Cloud Service.
The integration flow will stop processing.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process:
Artifacts
Value
Integration Process Name
OU DERMS DACS Aggregator Sync Ack
Integration Process Identifier
OUTL-BA-DERMS_DACS_AGGSYNC_ACK
Integration Project Name
OU DACS DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DACS for DACS-DERMS
invoke
Web Service Name: F1-SyncRequest
Computed URL: https://{host}:{port}/{tenant}/ {domain /ouaf/rest/apis/common/sync/ 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 support device grouping in DACS, DACS needs to know the network hierarchy of a service point (SP) so that it can associate devices with service transformers, substations and zones.
Oracle Utilities Edge Distributed Energy Resources Management System creates the file extract containing the nominal network information, namely the Transformer, Feeder and Substation, linked to an SP. Once the file is ready, Oracle Utilities Edge Distributed Energy Resources Management System sends the JSON outbound message with the file attachment to Oracle Integration Cloud.
Edge DERMS can send the initial load and any following updates, add or updates to existing records, as part of the incremental sync.
This integration process transfers the SP network location file from Oracle Utilities Edge Distributed Energy Resources Management System to Oracle Utilities Digital Asset Cloud Service and no acknowledgment needs to be returned to Oracle Utilities Edge Distributed Energy Resources Management System when the process is completed. This is just a file transfer, and no transformation will be done in the integration.
The following diagram shows a graphical representation of the SP Network Location Transfer integration process: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 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 Digital Asset 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 DACS Common FTP Transfer and OU DACS Common OS Transfer.
If the property value is ‘os’, it is routed to the OU DACS Common OS Transfer child process. This file is sent to DACS 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 DACS Common FTP Transfer child process. This file is sent to the DACS 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 Digital Asset Service artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DERMS DACS SP Network Location Transfer
Integration Process Identifier
OUTL-BA-DERMS_DACS_SPNWLOC_TRNFR
Integration Project Name
OU DACS DERMS
Source Connection
(Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
Trigger
DERMS Service Name: NMS-DACSOutbound
OperationId: exportCustomerModel
Target Connection
(REST Adapter)
OU REST MP OIC for DACS-DERMS
(Connecting to internal OU DACS Common OS and FTP Transfer OIC flows passing file as attachment)
Local Integrations
OU DACS Common OS Transfer
OU DACS Common FTP Transfer
OU DACS DERMS Common Error Handler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
OUTL-BRT-DACS_DRMS_Routing
Send Device Score (DACS Initiated)
Oracle Utilities Digital Asset Cloud Service computes and maintains the device score for each controllable device enrolled in a program and sends the information periodically to Oracle Utilities Edge Distributed Energy Resources Management System through a file extract. The calculation depends on factors, such as equipment specifications, monthly/annual capacity, device participation history, and more.
This integration process transfers the device score from Oracle Utilities Digital Asset Cloud Service to Oracle Utilities Edge Distributed Energy Resources Management System to facilitate its eligibility evaluation during event planning.
Oracle Utilities Digital Asset Cloud Service can place the file in an On Premise FTP Server or in an Oracle Integration Cloud Object Storage location and 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:THis diagram shows the Device Score related processes in the integration.
Device Score FTP Transfer (DACS Initiated)
This integration process retrieves the device score data file(s) from an FTP content storage location where Oracle Utilities Digital Asset Cloud Service uploads files 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:Shows a graphical representation of the Device Score FTP Transfer integration process.
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 Digital Asset 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 Digital Asset 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 Digital Asset 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 lookup OUTL-BRT-DACS_DRMS_Email_ID.
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 Digital Asset Cloud Service and Oracle Utilities Edge Distributed Energy Resources Management System artifacts used in this integration process.
Artifacts
Value
Integration Process Name
OU DACS DERMS Device Score FTP Transfer
Integration Process Identifier
OUTL-BA-DRMS_DACS_SEND_DVCSCORE
Integration Project Name
OU DACS DERMS
Source Connection
(FTP Adapter)
OU FTP DACS for DACS-DERMS
Target Connection
(Oracle Utilities Adapter)
OU REST DERMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port} /nms-drms/ rest/v1/openapi.json
OperationId: deviceScore
Method: POST
URI: /device-score/{file-name}
Local Integrations
OU DACS DERMS Common Error Handler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
Device Score OS Transfer (DACS Initiated)
This integration process retrieves the device score data file(s) from an Oracle Integration Cloud Object Storage location where Oracle Utilities Digital Asset Cloud Service uploads files and transfer it 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 Oracle Integration Cloud Object Storage:Shows a graphical representation of the integration process.
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 Digital Asset 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 Digital Asset 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 Digital Asset 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 DACS DERMS Device Score OS Transfer
Integration Process Identifier
OUTL-BA-DRMS_DACS_SEND_DVCSCOREC
Integration Project Name
OU DACS DERMS
Source Connection (REST Adapter)
OU REST DACS Object Storage for DACS-DERMS
Target Connection (Oracle Utilities Adapter)
OU REST DRMS for DACS-DERMS
invoke
DERMS Service Name: NMS-DACSInbound
openAPIUrl: https://{host}:{port} /nms-drms/ rest/v1/openapi.json
OperationId: deviceScore
Method: POST
URI: /device-score/{file-name}
Local Integrations
OU DACS DERMS Common Error Handler
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
Common Integration Flows
This section focuses on the common logic that is used throughout the integration. The common logic is placed in common integration flows to be reused or called by the other integrations flows. It can be categorized in design standards, email format, and common integration.
File to File Transfer
Many integrations move files from one application to another. Source and target locations can be a folder in an on-premises server or a cloud object storage. This is dependent on what the source and target applications support during the implementation.
Note: Oracle Utilities Edge Distributed Energy Resources Management System uses REST APIs to send and receive files. Oracle Utilities Digital Asset Cloud Service supports both FTP and Object Storage as its content server.
If the source application supports both FTP and object storage as it’s content server, then there will be two Oracle Integration Cloud flows to support each entry point. It is duplicated because an integration cannot be activated if one of the connections is not setup.
To allow customers to decide how to transfer files to a target location, a file target transfer preference property must be set to determine where to transfer the file. 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.Shows a graphical representation of the integration process.
 
If set to “ftp”, a child Oracle Integration Cloud flow is called to transfer the file to a target ftp location.Shows a graphical representation of the integration process.
Common Child File Transfer OIC Flows (OIC Initiated)
OU DACS Common FTP Transfer
OU DACS 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
Filename
Namespace
Name
Bucket Name
Directory
File Reference
File Reference
Technical Details
The following tables describe the integration processes and the respective Oracle Utilities Digital Asset Cloud Service artifacts used in the integration process.
Artifacts
Value
Integration Process Name
OU DACS Common FTP Transfer
Integration Process Identifier
OUTL-BA-DACS_FTP_TRANSFER
Integration Project Name
OU DACS DERMS
Source Connection (REST Adapter-Trigger)
OU REST for DACS-DERMS
Target Connection (FTP Adapter)
OU FTP DACS for DACS-DERMS
 
Artifacts
Value
Integration Process Name
OU DACS Common OS Transfer
Integration Process Identifier
OUTL-BA-DACS_OS_TRANSFER
Integration Project Name
OU DACS DERMS
Source Connection (REST Adapter-Trigger)
OU REST for DACS-DERMS
Target Connection (REST Adapter)
OU REST DACS Object Storage for DACS-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: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 DACS DERMS Common Error Handler
Integration Process Identifier
OUTL-BA-DACS_DRMS_ERROR
Integration Project Name
OU DACS DERMS
Source Connection
local integration
trigger
/receiveMessage
Lookup
OUTL-BRT-DACS_DRMS_ConfigProps
OUTL-BRT-DACS_DRMS_Email_ID
For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications.