OIC - OIC Agent Health Check Service Using OIC Monitoring API

In many Oracle Integration Cloud (OIC) implementations, on-premise and hybrid integrations depend heavily on Connectivity Agents. If an agent becomes unavailable, integrations may fail, causing business disruptions. To proactively monitor agent availability, we developed a reusable OIC Agent Health Check Service that leverages the OIC Monitoring REST API.

Objective

The purpose of this service is to:

Monitor Connectivity Agent Groups.

Verify agent health status.

Detect offline or unhealthy agents.

Provide a reusable monitoring framework across environments.

Support automated alerting and operational dashboards.

API Used

The service invokes the OIC Monitoring API:

Http

GET /ic/api/integration/v1/monitoring/agentgroups

Oracle docs reference:

https://docs.oracle.com/en/cloud/paas/application-integration/rest-api/op-ic-api-integration-v1-monitoring-agentgroups-get.html 

Dynamic Endpoint Mapping

To make the solution reusable across environments (DEV, SIT, UAT, PROD), the endpoint URL is dynamically constructed using OIC Lookup Values.

During the mapper stage:

Environment details are read from common lookups.

Runtime Base URL is fetched dynamically.

Runtime Service Instance is fetched dynamically.

Absolute Endpoint URL is generated.

API is invoked against the appropriate OIC instance.

This approach eliminates hardcoded URLs and simplifies migration across environments.

Benefits

Environment-independent design.

Easier deployment and maintenance.

Centralized configuration management.

Reduced migration effort.

Integration Flow

Step 1: Scheduled Trigger

The integration runs on a schedule (for example every 15 or 30 minutes).

Step 2: Build Monitoring Endpoint

Mapper constructs the endpoint using lookup values and environment configuration.

Step 3: Invoke OIC Monitoring API

The service calls:

Http

GET /ic/api/integration/v1/monitoring/agentgroups

Step 4: Parse Response

Response is parsed to retrieve:

Agent Group Name

Agent Identifier

Agent Status

Connectivity Information

Step 5: Evaluate Health Status

Business rules determine whether:

Agent is Active

Agent is Offline

Agent requires attention

Step 6: Generate Alert

If any agent is unavailable, notifications can be sent through:

Email

Microsoft Teams

Slack

Incident Management Systems

Sample Response Payload

JSON

{

  "items": [

    {

      "id": "AgentGroup01",

      "name": "FinanceAgentGroup",

      "status": "ACTIVE",

      "agents": [

        {

          "agentId": "Agent001",

          "agentName": "FIN_AGENT",

          "status": "ACTIVE"

        }

      ]

    },

    {

      "id": "AgentGroup02",

      "name": "HRAgentGroup",

      "status": "INACTIVE",

      "agents": [

        {

          "agentId": "Agent002",

          "agentName": "HR_AGENT",

          "status": "INACTIVE"

        }

      ]

    }

  ]

}

Note: The actual payload structure may vary depending on the OIC version and API response.

Key Advantages

Proactive monitoring of OIC Connectivity Agents.

Faster identification of connectivity issues.

Reduced integration downtime.

Reusable common utility service.

Dynamic environment handling through lookup-driven endpoint configuration.

Easy integration with enterprise monitoring solutions.

Conclusion

The OIC Agent Health Check Service provides a centralized and reusable mechanism for monitoring Connectivity Agent availability across environments. By combining the OIC Monitoring API with dynamic endpoint configuration through lookups, organizations can build a scalable monitoring solution that improves reliability, reduces operational effort, and enables proactive issue resolution before business integrations are impacted.

OIC - OIC Integration for User and Role Synchronization Between CORS and Workforce System (WFS)

Working...

Managing user access across systems is a common enterprise requirement. In this implementation, Oracle Integration Cloud (OIC) acts as the middleware between CORS and the Workforce System (WFS) to synchronize users and their roles.

Flow 1: WFS to CORS – User and Role Export

This scheduled OIC integration runs periodically to extract user information from WFS.

Process

1. OIC Scheduler triggers the integration.
2. Lists all available files from the WFS SFTP location.
3. For each file, downloads the content.
4. Writes the files to the OIC Embedded SFTP server.
5. CORS picks up the files using a service account.

Files Transferred:

• List of Users
• User with Roles

This flow ensures CORS always has the latest user and role information from WFS.

Flow 2: CORS to WFS – User Provisioning and Role Management

This integration exposes a REST API that allows CORS to request user provisioning or role assignment/removal in WFS.

Process

1. CORS sends user details and roles through a REST request.
2. OIC validates and transforms the data into the format required by WFS.
3. Creates the appropriate provisioning file.
4. Places the file in the WFS SFTP location for processing.

Supported Actions

• Create User
• Assign Role
• Remove Role

This approach provides a simple file-based integration mechanism while maintaining system decoupling.

Flow 3: CORS to WFS – Provisioning Status Validation

After provisioning requests are submitted, CORS can verify the processing status through another REST service exposed by OIC.

Process

1. CORS sends the User ID and Role information.
2. OIC obtains an authentication token from WFS.
3. Calls WFS APIs to retrieve current users and assigned roles.
4. Compares the requested data with the actual data in WFS.

Response Logic

• Success – User exists and all requested roles are assigned.
• Pending – User exists but roles are not yet assigned.
• Error – User does not exist in WFS.

This validation mechanism provides real-time visibility into provisioning status and helps CORS track completion of access requests.

Benefits

• Automated user and role synchronization.
• Secure file transfer through SFTP.
• REST-based provisioning interface.
• Real-time status validation.
• Reduced manual user administration effort.
• Reliable integration between CORS and WFS using Oracle Integration Cloud.

This blog provides an end-to-end overview of the user provisioning and role synchronization framework implemented using OIC between CORS and Workforce System (WFS).