OIC Project & Connection Status Monitoring Using Factory APIs
Overview
This solution automates OIC project and connection health monitoring using OIC Factory APIs.
The integration outlines:
- Retrieves all projects configured for monitoring.
- Retrieves connections for each project.
- Checks the status of every connection.
- Generates a consolidated CSV report.
- Calculates Success/Failure counts.
- Sends an email with the summary in the email body and the detailed report as an attachment.
High-Level Flow
Scheduler
|
MAIN Integration
|
Get Project List
|
For Each Project
|
Get Connections
|
For Each Connection
|
Get Connection Status
|
Append Result to Report
|
Calculate Success/Failure Count
|
Send Email
/ \
Body CSV Attachment
Detailed flow:
Scheduler Integration
Integration: SCH_Project_Connection_Monitor
The Scheduler integration triggers the Main integration based on the configured schedule.
SCH--> Invoke --> MAIN
Main Integration
Integration: MAIN_Project_Connection_Monitor
The Main integration performs the complete monitoring process.
Step 1 – Get Projects
Project information can be maintained/configured through an OIC Lookup.
MAIN >> Read Project Lookup >> Get Project List
The project list is then processed one by one.
For each project, invoke the OIC Factory API to retrieve its connections.
For Each Project >> Get Connections
Note: Here. We have have used hasmore looping concept as it can have huge nunber of projects.
Step 3 – Get Connection Status
For every connection, invoke the Factory API and capture the status. >> write into a file >> read the content >> apend each connection status
Example:
Project Connection Status
------------------------------------------------
HCM_PROJECT HCM_REST_CONNECTION SUCCESS
HCM_PROJECT UCM_CONNECTION FAILURE
ERP_PROJECT ERP_REST_CONNECTION SUCCESS
For scope fault:
Step 4 – Generate Report
Append each connection result to a CSV file using the OIC Stage File action.
Project Name,Connection Name,Type,Status
HCM_PROJECT,HCM_REST_CONNECTION,REST,SUCCESS
HCM_PROJECT,UCM_CONNECTION,REST,FAILURE
ERP_PROJECT,ERP_REST_CONNECTION,REST,SUCCESS
Step 5 – Calculate Counts
Maintain counters during processing:
Total Projects
Total Connections
Success Count
Failure Count
Logic:
IF Status = SUCCESS
SuccessCount++
ELSE
FailureCount++
The processing continues even if an individual connection fails.
5. Email Notification
After all projects and connections are processed, send an email.
Email Body
OIC Connection Health Report
Execution Date : 05-Sep-2026
Total Projects : 5
Total Connections : 32
Successful : 29
Failed : 3
Overall Status : FAILURE
Please find the detailed report attached.
The generated CSV report is attached to the email.
Example:
OIC_Connection_Status_20260905.csv
EmailBody:
<tr style="background-color:#D9EAF7;">
<th>Project Identifier</th>
<th>Success Count</th>
<th>Failure Count</th>
</tr>
fn:concat($EmailBody,
'<tr>',
'<td>',$fO_project/ns22:project/ns22:ProjectIdentifier,
'</td>',
'<td style="color:green;font-weight:bold;text-align:center;">',
$fO_project/ns22:project/ns22:Success,
'</td>',
'<td style="color:red;font-weight:bold;text-align:center;">',
$fO_project/ns22:project/ns22:Failure,
'</td>',
'</tr>'
)
Benefits
This provides a single automated health report for the OIC environment without manually checking projects and connections. It can easily be extended to include failed connection details, error messages, environment name, project-wise counts, HTML email tables, and Teams/Slack notifications.
No comments:
Post a Comment