Integration Flows
The integration supports the following processes:
Customer Sync (Oracle Utilities Customer Cloud Service Initiated)
Oracle Utilities Customer Cloud Service manages customers (persons), accounts/service agreements (SAs), and service points (SPs). The customer data is extracted and sent to Oracle Utilities Digital Asset Cloud Service to maintain corresponding contacts, metered services, and metered service points.
Oracle Utilities Customer Cloud Service comprises two types of extraction processes:
• Initial Load Synchronization: The initial load is used to initially extract eligible Oracle Utilities Customer Cloud Service entities for loading into Oracle Utilities Digital Asset Cloud Service. The initial load process does not use synchronization requests in Oracle Utilities Customer Cloud Service. The batch job extracts the data straight to a file and no acknowledgement is expected for the initial load.
• Incremental Synchronization: The incremental synchronization process will extract additions/updates of eligible Oracle Utilities Customer Cloud Service entities to create or update in Oracle Utilities Digital Asset Cloud Service. When an eligible entity is added/updated, a synchronization request is created for the entity. The batch job will extract the entities to a file and the synchronization request is transitioned to “Awaiting Acknowledgement”, where it waits for an acknowledgement from Oracle Utilities Digital Asset Cloud Service.
Tab-delimited records are created for each extracted Oracle Utilities Customer Cloud Service entity and the records are written to a csv file.
This integration process transfers the customer data file(s) from Oracle Utilities Customer Cloud Service's content server to Oracle Utilities Digital Asset Cloud Service's content server.
Oracle Utilities Customer Cloud Service can place the customer data files in an on-premises FTP server or in an Oracle Integration Cloud Object Storage location. Oracle Utilities Digital Asset Cloud Service can pick up the files in an on-premises FTP server or in an Oracle Integration Cloud Object Storage location.
Oracle Utilities Digital Asset Cloud Service process picks up the customer data synchronization files and process the synchronization requests and send the acknowledgments back to Oracle Utilities Customer Cloud Service.
The customer data synchronization and acknowledgment are handled by the following Oracle Integration Cloud integration flows depending on the file transfer preference:
The following diagram shows a graphical representation of the Customer Sync related processes:
Customer Sync FTP Transfer (Oracle Utilities Customer Cloud Service Initiated)
This integration process retrieves the Customer Sync Data File(s) from an FTP content storage where Oracle Utilities Customer Cloud Service uploads files and transfers it to either an on-premises FTP server or to an OCI Object Storage location accessible from Oracle Utilities Digital Asset Cloud Service, where it will be read and processed later.
The following diagram shows a graphical representation of the Customer Sync integration process from an FTP Server:
Processing Details
The integration process is 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.
2. It invokes the FTP adapter to list files located in the Oracle Utilities Customer Cloud Service on-premises locations obtained from the file path set in the ccs.ftp.custsync.input.directory property. It will retrieve files matching the prefix passed over the schedule “extractedFileNamePrefix” parameter.
Note: The value passed to extractedFileNamePrefix should match the beginning of the parameter fileName used within Oracle Utilities Customer Cloud Service Batch C1-DCTEX, C1-DSPEX or C1-DMSEX.
• If no file is found and notification.email.process.nofile.flag is true (by default it is true), it will send a ‘no file found’ email notification to to.process.notification recipients defined in the OUTL-BRT-CCS_DACS_Email_ID lookup.
• If the files are found, it will continue to the next step.
3. For each file, do the following:
a. Download the file using the FTP Adapter.
b. If Oracle Utilities Digital Asset Cloud Service is configured to receive the file via FTP (property dacs.file.target.transfer.pref equals “ftp”), it will invoke the “OU CCS DACS Common FTP Transfer” Oracle Integration Cloud child process passing the necessary information to transfer the file accordingly. The OU CCS DACS Common FTP Transfer Oracle Integration Cloud child process uploads the file to the FTP server content over the path set in the dacs.ftp.custsync.output.directory property.
Note: The dacs.file.target.transfer.pref property is defaulted to “ftp”.
• If the child process returns HTTP status 200, the file transfer was successfully completed. The source file name is renamed by appending the prefix set in the ccs.prefixtag.fileuploaded property.
• Else, an error occurred during the file transfer.
c. If Oracle Utilities Digital Asset Cloud Service is configured to receive the file via object storage (dacs.file.target.transfer.pref property equals “os”), invokes the “OU CCS DACS Common OS Transfer” Oracle Integration Cloud child process passing the necessary information to transfer the file accordingly.
The OU CCS DACS Common OS Transfer Oracle Integration Cloud child process uploads the file to the Oracle Utilities Digital Asset Cloud Service Object Storage under the namespace (dacs.os.custsync.namespace) and bucketname (dacs.os.custsync.bucketname).
• If the child process returns HTTP status 200, the file transfer was successfully completed. The source file name is renamed by appending the prefix set in the ccs.prefixtag.fileuploaded property.
• Else, an error occurred during the file transfer.
4. After the successful transfer of all files, if the notification.email.process.complete.flag is true, a Process Completed email notification is sent to to.process.notification recipients defined in the OUTL-BRT-CCS_DACS_Email_ID lookup.
5. Error Handling.
For any errors encountered in this process:
• An error email notification with error details is sent via the “OU CCS DACS Common Error Handler” Oracle Integration Cloud child process to the users defined in the “to” property inside the OUTL-BRT-CCS_DACS_Email_ID lookup.
• If the error occurs while processing the list of files and notification.email.process.complete.flag is true, the Process Complete email notification is also sent out that contains the summary of files transferred and not transferred.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Cloud Service and Oracle Utilities Digital Asset Cloud Service artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CCS DACS Customer Sync FTP Transfer |
Integration Process Identifier | OUTL-BA-CCS_DACS_CUST_SYNC_FTP |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection (FTP Adapter) | OU FTP CCS for CCS-DACS |
Target Connection (REST Adapter) | OU REST OIC for CCS-DACS (Connecting to internal OU CCS DACS Common FTP Transfer OIC flow or to internal OU CCS DACS Common OS Transfer OIC flow, passing the file as an attachment) |
Local Integrations | • OU CCS DACS Common FTP Transfer • OU CCS DACS Common OS Transfer • OU CCS DACS Common Error Handler |
OIC Lookups | • OUTL-BRT-CCS_DACS_ConfigProps • OUTL-BRT-CCS_DACS_Email_ID |
Lookups Referenced
The following table describes the customized properties referenced in the integration. For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications.
DVM | Property |
|---|---|
OUTL-BRT-CCS_DACS_ConfigProps | • notification.type.email • notifcation.email.error.flag • notification.email.process.nofile.flag • notification.email.process.complete.flag • ccs.ftp.custsync.input.directory • ccs.prefixtag.fileuploaded • dacs.file.target.transfer.pref • dacs.os.custsync.bucketname • dacs.os.custsync.namespace • ccs.os.custsync.namespace • ccs.os.custsync.bucketname |
OUTL-BRT-CCS_DACS_ Email_ID | • from • to • to.process.notification |
Customer Sync OS Transfer (Oracle Utilities Customer Cloud Service Initiated)
This integration process retrieves the Customer Sync Data File(s) from an Oracle Integration Cloud Object Storage location where Oracle Utilities Customer Cloud Service uploads files and transfer it to either an on-premises FTP server or to an OCI Object Storage location accessible from Oracle Utilities Digital Asset Cloud Service, where it will be read and processed afterwards.
The following diagram shows a graphical representation of the Customer Sync integration process from an Oracle Integration Cloud Object Storage:
Processing Details
The integration process is 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.
2. It invokes the REST adapter to list files located in the Oracle Utilities Customer Cloud Service Object Storage Bucket set in the ccs.os.custsync.namespace and ccs.os.custsync.bucketname properties. It will retrieve files matching the prefix passed over the schedule parameter “extractedFileNamePrefix”.
Note: The value passed to extractedFileNamePrefix should match the beginning of the parameter fileName used within Oracle Utilities Customer Cloud Service Batch C1-DCTEX, C1-DSPEX, or C1-DMSEX.
• If no file is found and notification.email.process.nofile.flag is true (by default it is true), it will send a ‘no file found’ email notification to to.process.notification recipients defined in the OUTL-BRT-CCS_DACS_Email_ID lookup.
• If the files are found, it will continue to the next step.
3. For each file, do the following:
a. Download the file using the REST Adapter.
b. If Oracle Utilities Digital Asset Cloud Service is configured to receive the file via FTP (property dacs.file.target.transfer.pref equals “ftp”), it will invoke the “OU CCS DACS Common FTP Transfer” Oracle Integration Cloud child process passing the necessary information to transfer the file accordingly. The OU CCS DACS Common FTP Transfer Oracle Integration Cloud child process uploads the file to the FTP server content over the path set in the dacs.ftp.custsync.output.directory property.
Note: The dacs.file.target.transfer.pref property is defaulted to “ftp”.
• If the child process returns HTTP status 200, the file transfer was successfully completed. The source file name is renamed by appending the prefix set in the ccs.prefixtag.fileuploaded property.
• Else, an error occurred during the file transfer.
c. If Oracle Utilities Digital Asset Cloud Service is configured to receive the file via object storage (dacs.file.target.transfer.pref property equals “os”), invokes the “OU CCS DACS Common OS Transfer” Oracle Integration Cloud child process passing the necessary information to transfer the file accordingly.
The OU CCS DACS Common OS Transfer Oracle Integration Cloud child process uploads the file to the Oracle Utilities Digital Asset Cloud Service Object Storage under the namespace (dacs.os.custsync.namespace) and bucketname (dacs.os.custsync.bucketname).
• If the child process returns HTTP status 200, the file transfer was successfully completed. The source file name is renamed by appending the prefix set in the ccs.prefixtag.fileuploaded property.
• Else, an error occurred during the file transfer.
4. After the successful transfer of all files, if the notification.email.process.complete.flag is true, a Process Completed email notification is sent to to.process.notification recipients defined in the OUTL-BRT-CCS_DACS_Email_ID lookup.
5. Error Handling.
For any errors encountered in this process:
• An error email notification with error details is sent via the “OU CCS DACS Common Error Handler” Oracle Integration Cloud child process to the users defined in the “to” property inside the OUTL-BRT-CCS_DACS_Email_ID lookup.
• If the error occurs while processing the list of files and notification.email.process.complete.flag is true, the Process Complete email notification is also sent out that contains the summary of files transferred and not transferred.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Cloud Service and Oracle Utilities Digital Asset Cloud Service artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CCS DACS Customer Sync OS Transfer |
Integration Process Identifier | OUTL-BA-CCS_DACS_CUST_SYNC_OS |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection (REST Adapter) | OU REST CCS OS for CCS-DACS (Connecting to Object Storage) |
Target Connection (REST Adapter) | OU REST OIC for CCS-DACS (Connecting to internal OU CCS DACS Common FTP Transfer OIC flow or to internal OU CCS DACS Common OS Transfer OIC flow, passing the file as an attachment) |
Local Integrations | • OU CCS DACS Common FTP Transfer • OU CCS DACS Common OS Transfer • OU CCS DACS Common Error Handler |
OIC Lookup | • OUTL-BRT-CCS_DACS_ConfigProps • OUTL-BRT-CCS_DACS_Email_ID |
Lookups Referenced
The following table describes the customized properties referenced in the integration. For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications.
DVM | Property |
|---|---|
OUTL-BRT-CCS_DACS_ConfigProps | • notification.type.email • notifcation.email.error.flag • notification.email.process.nofile.flag • notification.email.process.complete.flag • ccs.ftp.custsync.input.directory • ccs.prefixtag.fileuploaded • dacs.file.target.transfer.pref • dacs.os.custsync.bucketname • dacs.os.custsync.namespace • ccs.os.custsync.namespace • ccs.os.custsync.bucketname |
OUTL-BRT-CCS_DACS_ Email_ID | • from • to • to.process.notification |
Customer Sync Acknowledgment (Oracle Utilities Digital Asset Cloud Service Initiated)
After Oracle Utilities Digital Asset Cloud Service processes each Customer Sync file received from Oracle Utilities Customer Cloud Service, it sends an acknowledgment message back to Oracle Utilities Customer Cloud Service through a REST web service.
The following diagram 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 enrollment acknowledgment message received into the Oracle Utilities Customer Cloud Service JSON format.
3. Invoke the Oracle Utilities Customer Cloud Service F1-SyncRequest REST endpoint to send the acknowledgment.
4. If the REST service returns Status 200 (OK), the integration process will respond synchronously with status Status 200 to Oracle Utilities Digital Asset Cloud Service.
5. For any errors encountered in this process:
• An error email notification with error details is sent via the “OU CCS DACS Common Error Handler” Oracle Integration Cloud child process to the users defined in the property “to” inside the OUTL-BRT-CCS_DACS_Email_ID lookup.
• The process will return a fault to Oracle Utilities Digital Asset Cloud Service.
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Cloud Service and Oracle Utilities Digital Asset Cloud Service artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU DACS CCS Customer Sync Ack |
Integration Process Identifier | OUTL-BA-DACS_CCS_CUST_SYNC_ACK |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection (Oracle Utilities Adapter) | OU REST DACS for CCS-DACS |
Target Connection (Oracle Utilities Adapter) | OU REST CCS for CCS-DACS |
Local Integrations | OU CCS DACS Common Error Handler |
OIC Lookup | • OUTL-BRT-CCS_DACS_ConfigProps • OUTL-BRT-CCS_DACS_Email_ID |
Lookups Referenced
The following table describes the customized properties referenced in the integration. For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications.
DVM | Property |
|---|---|
OUTL-BRT-CCS_DACS_ConfigProps | • notification.email.error.flag • notifcation.type.email.flag • ccs.error.ack.messagecategory • ccs.error.ack.messagenumber |
OUTL-BRT-CCS_DACS_ Email_ID | • from • to • to.process.notification |
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: Currently, Oracle Utilities Customer Cloud Service and Oracle Utilities Digital Asset Cloud Service support both FTP and Object Storage as its content server.
If the source application supports both FTP and object storage as its 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.
Note: Each application’s target object storage location has its own child Oracle Integration Cloud flow.
• If set to “ftp”, a child Oracle Integration Cloud flow is called to transfer the file to a target FTP location.
Note: Each application’s target FTP location has its own child Oracle Integration Cloud flow.
Common Child File Transfer Flows (Oracle Integration Cloud Initiated)
• OU CCS DACS Common OS Transfer
• OU CCS DACS Common FTP 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 | Directory |
Bucket Name | |
File Reference | File Reference |
Technical Details
The following table describes the integration processes and the respective Oracle Utilities Customer Cloud Service and Oracle Utilities Digital Asset Cloud Service artifacts used in this integration process.
Artifacts | Value |
|---|---|
Integration Process Name | OU CCS DACS Common OS Transfer |
Integration Process Identifier | OUTL-BA-CCS_DACS_OS_TRANSFER |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection (REST Adapter-Trigger) | OU REST for CCS-DRMS |
Target Connection (REST Adapter) | OU REST DACS OS for CCS-DACS |
Artifacts | Value |
|---|---|
Integration Process Name | OU CCS DACS Common FTP Transfer |
Integration Process Identifier | OUTL-BA-OUAI_DACS_FTP_TRANSFER |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection (REST Adapter-Trigger) | OU REST for CCS-DRMS |
Target Connection (FTP Adapter) | OU FTP DACS for CCS-DACS |
Common Error Handler (Oracle Integration Cloud 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 flows.
2. The request message received is processed based on the property names, notification.email.error.flag and notification.type.email, in the OUTL-BRT-CCS_DACS_ConfigProps lookup. If both are set to ‘true’, then an email notification will be sent on error.
Technical Details
The following table describes the artifacts used in this integration process:
Artifacts | Value |
|---|---|
Integration Process Name | OU CCS DACS Common Error Handler |
Integration Process Identifier | OUTL-BA-CCS_DACS_ERR_HNDLR |
Integration Package Name | outl.ba.ccs_dacs.01_23_3000 |
Source Connection | local integration |
trigger | /receiveMessage |
Lookups Referenced
The following table describes the customized properties referenced in the integration. For more information about the lookup properties, refer to Configuring Lookups, Error Handling, and Email Notifications.
DVM | Property |
|---|---|
OUTL-BRT-CCS_DACS_ConfigProps | • notifcation.type.email • notification.email.error.flag |
OUTL-BRT-CCS_DACS_Email_ID | • From • To |