Oracle Cloud Infrastructure Documentation

Complete Post-Upgrade Tasks

Oracle upgrades your Oracle Integration Generation 2 development instances first. Complete all post-upgrade tasks within three days of the upgrade date, so that you can report any issues. Oracle upgrades your production instances about two weeks after your development instances.

Completing post-upgrade tasks is critical to make sure users can access the new instance, data going to and from integrations can be sent through the firewall, and integrations work as expected.

If you experience any issues after the upgrade, enter a service request (SR) on My Oracle Support or troubleshoot the issues. See Troubleshoot Upgrade Issues.

Note

You'll see your stopped Oracle Integration Generation 2 instance in the Oracle Cloud Infrastructure Console for a period of time after the upgrade. Do not update, start, or delete this instance. Oracle removes it on your behalf when it is no longer needed.
Make sure the upgrade has completed before starting these tasks. See What to Do During Upgrade.

Summary of Post-Upgrade Tasks

Impact When Tasks to complete

Ensure access to the instance

Immediately after upgrade
  1. Check the new Oracle Integration 3 instance
  2. Update the IAM policy with the new OCID
  3. Get the URL for the new instance and share it

Ensure connectivity

Immediately after upgrade
  1. Complete network rules configuration
  2. Upload new identity certificates for connections
  3. Regain connectivity with agents that weren't upgraded
  4. File Server: add the File Server IP address to your internal firewall allowlist

    Complete this task within one week after upgrade.

  5. File Server: update integrations and SFTP clients to use the new IP and port values

    Complete this task within one week after upgrade.

Ensure integrations work

Immediately after upgrade
  1. Change Oracle Integration built-in API calls from Basic Authentication to OAuth
  2. Check integrations if you selected Ignore activation failures or Ignore start schedule failures
  3. Take care of any requests that were rejected during the upgrade downtime

Complete post-upgrade tasks for ignored precheck failures

Immediately after upgrade

 Complete Post-Upgrade Tasks for Ignored Precheck Failures

Complete Visual Builder post-upgrade tasks

Immediately after upgrade

 Complete Post-Upgrade Tasks for Visual Builder

Complete Process Automation post-upgrade tasks

Immediately after upgrade

 Complete Post-Upgrade Tasks for Process Automation

Complete post-upgrade verification

Within two weeks of upgrade

 Follow Your Organization's Verification Procedures

Ensure Access to the Instance

Task Who When Tasks to complete

Check the new Oracle Integration 3 instance

Administrator Immediately after upgrade Sign in to your Oracle Integration 3 instance using your existing credentials. Use your existing Oracle Integration Generation 2 bookmark (which redirects to the new URL) or use the new URL for the Oracle Integration 3 instance. See Access an Oracle Integration Instance.

The upgrade completed if the interface looks like this:
Screenshot of Oracle Integration 3, with the text "Create and monitor" at the top of the right pane

The upgrade is still in progress if:
  • You sign in and a page indicates that the service is unavailable.
  • You sign in and the user interface looks like this:

    Screenshot of Oracle Integration Generation 2, with the text "Try a Recipe" at the top of the right pane

Update the IAM policy with the new OCID

IAM policy administrator

 Immediately after upgrade If your organization restricted access to the Oracle Integration Generation 2 instance based on the instance's Oracle Cloud ID (OCID), update the IAM policy to point to the new Oracle Integration 3 instance OCID.

Caution:

Users won't be able to sign in to Oracle Integration 3 until you update the OCID in the IAM policy.
  1. Sign in to Oracle Cloud Infrastructure Console.
  2. Get the new OCID value for the Oracle Integration 3 instance. See Viewing Instance Details.
  3. Update the OCID in your IAM policy. For instructions on updating the statements in an existing policy, see Using the Console in the Oracle Cloud Infrastructure documentation.

Get the URL for the new instance and share it

 Administrator Immediately after upgrade Get the URL for the new Oracle Integration 3 instance and share it with everyone who needs it. Existing bookmarks also redirect to the new URL, but you want to make sure everyone has the new URL. This is in the following format:

https://design.integration.region.ocp.oraclecloud.com/?integrationInstance=query_parameter_repersenting_instance

To get the new URL:

  1. Sign in to the Oracle Cloud Infrastructure Console.
  2. Open the navigation menu and click Developer Services.
  3. Under Application Integration, click Integration.
  4. Click the name of the new Oracle Integration 3 instance.
  5. To the right of the Service console URL field, click Copy.
  6. Share the URL with anyone who needs it.

Ensure Connectivity

Task Who When Tasks to complete

Complete network rules configuration

 Network administrator Prior to upgrade or immediately after upgrade If any of your integration connections target an Oracle Cloud Infrastructure service that supports network rules, such as Oracle Cloud Infrastructure Object Storage or Oracle Autonomous Database, and you've enabled those rules, you must complete any network rules configuration, including adding the Oracle Integration Service VCN to the rule.
  1. Sign in to Oracle Cloud Infrastructure Console.
  2. Get the OCID value for the Oracle Integration 3 instance.

    See Viewing Instance Details.

  3. Follow the rules for your target service. For example, for Oracle Autonomous Database Serverless, see Configure Access Control Lists When You Provision or Clone an Instance in Using Oracle Autonomous Database Serverless.
  4. If the Oracle Cloud Infrastructure service you're accessing is in a different region than your Oracle Integration instance, allowlist the OIC Outbound IP address you collected when you updated your other allowlists prior to upgrade.

Upload new identity certificates for connections

 Developer with connections that use identity certificates

Only one person from your organization needs to perform these steps

 Immediately after upgrade Identity certificates establish client identity during two-way SSL communication. Connections that are based on the AS2 Adapter and the REST Adapter can use identity certificates.

If your instance includes connections that use identity certificates, perform the following steps:

  1. Upload a new identity certificate.

    See Upload an SSL Certificate in Using Integrations in Oracle Integration 3.

  2. Test the connections that use the identity certificate so that their status changes from Draft to Configured.

    See Test the Connection in Using Integrations in Oracle Integration 3.

  3. Activate any integrations that use the connections.

    See Activate an Integration in Using Integrations in Oracle Integration 3.

Regain connectivity with agents that weren't upgraded

 Developer with agents that weren't upgraded Immediately after upgrade Agents that weren't reachable during upgrade or didn't meet upgrade requirements weren't upgraded. After upgrade, if you see a message stating that some agents didn't meet upgrade eligibility and weren't upgraded, perform the following steps.

Prerequisites

Ensure connectivity from your connectivity agents to Oracle Identity Cloud Service (IDCS) and Oracle Integration 3:

  • You should have added the IDCS and Oracle Integration 3 IP addresses and URLs to your allowlists prior to upgrade, as described in Update Allowlists.
  • Add the Oracle Integration 3 design-time IP address to your allowlists. Use the following command to get the design-time IP address, replacing region with the region from your Oracle Integration 3 URL:

    nslookup design.integration.region.ocp.oraclecloud.com

To manually upgrade your agents and regain connectivity with them:

  1. Stop the connectivity agent.
  2. Make sure that the agent prerequisites are complete:
    1. Ensure that the connectivity agent is using JDK 17. If it isn't, set the JAVA_HOME and PATH environment variables to JDK17.
    2. Ensure that the agent is using the PKCS12 KeyStore. If it isn't, convert it using the following steps.
      1. On the server that hosts the connectivity agent, create a backup of the keystore.jks file, which is located in the following folder:

        Agent_Install_Location/agenthome/agent/cert

      2. Move the backup file to a different folder.
      3. Convert the JKS KeyStore to the PKCS12 KeyStore by running the following command from the command line:

        keytool -importkeystore -srckeystore keystore.jks -destkeystore keystore.p12 -srcstoretype JKS -deststoretype PKCS12 -deststorepass changeit -srcstorepass changeit

      4. Delete the keystore.jks file in the following location:

        Agent_Install_Location/agenthome/agent/cert

  3. Download the agent installer ZIP file from Oracle Integration 3.
    1. In the navigation pane, click Design, then Agents.
    2. Click Download, then Connectivity agent.
  4. Extract oic_conn_agent_installer.zip to a new directory on your connectivity agent server.
  5. Delete your existing connectivity agent lib folder under Agent_Install_Location/agenthome/ and replace it with the lib folder from the ZIP file.
  6. Delete your existing version file under Agent_Install_Location/agenthome/ and replace it with the version file from ZIP file.
  7. Delete your existing connectivityagent.jar file under Agent_Install_Location and replace it with the connectivityagent.jar file from ZIP file.
  8. Delete your existing cpi_upgradeutility.jar file under Agent_Install_Location and replace it with the cpi_upgradeutility.jar file from ZIP file.
  9. In Oracle Integration 3, on the Agents page, hover over the agent group, click Actions Actions icon, then select Download config.

    This step downloads a preconfigured InstallerProfile.cfg file for the agent group.

  10. Delete your existing InstallerProfile.cfg file under Agent_Install_Location and replace it with the InstallerProfile.cfg file you downloaded in the previous step.
  11. Restart the connectivity agent by running the following command:

    java -jar connectivityagent.jar

  12. Reactivate the integrations that are in the upgraded agent group.

File Server: add the File Server IP address to your internal firewall allowlist

File Server administrator and developer Within one week of upgrade If your organization restricts the sites that internal resources can access, add the new File Server IP address to your internal firewall allowlist.

The Oracle Integration Generation 2 IP address continues working for four months after the upgrade, and then Oracle retires them. However, Oracle recommends updating your firewall allowlist to use the new IP address now. That way, you don't risk forgetting to update the allowlist in the future.

To get the File Server IP address:

  1. Sign in to Oracle Integration 3.
  2. In the navigation pane, click Settings, then File Server, then Settings.
  3. Under General, obtain the IP address for the File Server SFTP server.

File Server: update integrations and SFTP clients to use the new IP and port values

File Server administrator and developer Within one week of upgrade If you use File Server, update your integrations and SFTP clients so that they use the new IP and port values.

The Oracle Integration Generation 2 IP and port values continue working for four months after the upgrade, and then Oracle retires them. However, Oracle recommends updating your integrations and SFTP clients to use the new values now. That way, you don't risk forgetting to update these values in the future.

  1. Sign in to Oracle Integration 3.
  2. In the navigation pane, click Settings, then File Server, then Settings.
  3. Under General, obtain the IP and port values for the File Server SFTP server.
  4. Update all integrations that call File Server so that they use the new IP and port values.
  5. Update all SFTP clients so that they use the new IP and port values.

Ensure Integrations Work

Task Who When Details

Change Oracle Integration built-in API calls from Basic Authentication to OAuth

Developer Prior to upgrade or immediately after upgrade If you didn't already update your API calls to use OAuth while completing prerequisites or pre-upgrade tasks, do so immediately after upgrade.

In Oracle Integration Generation 2, you could use Basic Authentication to use the Oracle Integration REST API and File Server REST API. In Oracle Integration 3, you must use OAuth. You need to update any clients, scripts, integrations, and commands that use the Oracle Integration REST API or the File Server REST API to connect using OAuth. For more information on authentication method support, see When is Basic Auth Supported in Oracle Integration 3. For details on using OAuth with the Oracle Integration REST API, see Security, Authentication, and Authorization, or with the File Server REST API, see Security, Authentication, and Authorization.

Check integrations if you selected Ignore activation failures or Ignore start schedule failures

 Administrator Immediately after upgrade If you configured your upgrade settings to proceed with the upgrade even if Oracle couldn't activate an integration or restart a schedule, take the appropriate steps:
  • If you selected Ignore activation failures, check the status of all your integrations, and activate integrations as needed.
  • If you selected Ignore start schedule failures, check the schedules of your integrations, and manually start them if needed.

Take care of any requests that were rejected during the upgrade downtime

 Designated team members Immediately after upgrade

Oracle Integration rejected all requests that were sent during the upgrade downtime. If needed, take action on requests that any clients sent to Oracle Integration during the downtime.

Complete Post-Upgrade Tasks for Ignored Precheck Failures

If you selected to ignore precheck failures, perform the steps associated with any failed prechecks:

Precheck Connection tasks Integration tasks Other tasks
Delayed (Asynchronous) Response   After upgrade, you must rework or recreate integrations that used delayed (asynchronous) response with one of the following adapters:
  • Oracle CX Sales and B2B Service Adapter
  • Oracle ERP Cloud Adapter
  • Oracle HCM Cloud Adapter
  • Oracle Field Service Cloud Adapter
  • Salesforce Adapter
  • ServiceNow Adapter
Application-driven integrations: Application-driven integrations are changed to a draft state during upgrade. You must rework those integrations using the following steps:
  1. Create a simple invoke for success callbacks.
  2. Create an additional invoke for failure callbacks under the fault handler to catch the correct fault.
  3. Recreate your data mappings.

Basic routing integrations: Basic routing integrations aren't supported in Oracle Integration 3 and will show a blank canvas. You must delete those integrations and recreate them as application-driven integrations.

 
Unsupported Adapters During upgrade, connections that used the following unsupported adapters were deleted:
  • Automation Anywhere Adapter
  • Evernote Adapter
  • Oracle Messaging Cloud Service Adapter
  • Oracle Monetization Cloud Adapter
  • Oracle Taleo Business Edition (TBE) Adapter
  • UiPath Robotic Process Automation Adapter

You must create REST Adapter connections to replace the deleted unsupported adapter connections.

 During upgrade, integrations that used unsupported adapters are changed to a draft state and any scheduled runs are canceled.

You must rework those integrations using the following steps:

  1. Delete the invoke corresponding to the unsupported adapter connection and replace it with the new REST Adapter connection.
  2. After the integration is configured and activated,start the schedule.
  
Custom Adapters During upgrade, connections that used the custom adapters were deleted.

You must create new connections using equivalent Oracle Integration 3 adapters to replace the deleted custom adapter connections.

During upgrade, integrations that used unsupported adapters are changed to a draft state and any scheduled runs are canceled.

You must rework those integrations using the following steps:

  1. Delete the invoke corresponding to the custom adapter connection and replace it with the new connection you created.
  2. After the integration is configured and activated, start the schedule.
  
Multiple Read File   During upgrade, integrations that used the Read Multiple File operation are changed to a draft state.

You must rework those integrations so that they don't use this pattern. For example, use a listFile operation to list the files, and use a for-each action to read each file individually.

  
Unsupported REST Types During upgrade, connections that used the following unsupported REST types were changed to a draft state.
  • Metadata Catalog URL
  • Swagger Definition URL
  • RAML Definition URL

You must update those connections using one of the following methods:

  • If you were using RAML or the Oracle metadata catalog, you can ask your REST service provider for a Swagger definition (if available). Oracle Fusion Applications should have a Swagger option available as this is a guideline for all Oracle Fusion Applications.

    If an alternative spec is not available, use the basic template in the REST Adapter by selecting REST API Base URL as the connection URL and defining the target API request using the Adapter Endpoint Configuration Wizard.

  • Another option if you were using RAML, is to convert RAML into an OpenAPI specification.
  • If you were using the Swagger definition URL, you can use the REST Adapter's new unified option to specify all OpenAPI specifications in a single field. This option provides more robust and complete support for the Swagger/OpenAPI specifications.

See Configure Connection Properties for Invoke Connections in Using the REST Adapter with Oracle Integration 3.

During upgrade, integrations that used unsupported REST types were changed to a draft state and any scheduled runs were canceled.

You must rework those integrations using the following steps:

  1. Activate the integration
  2. After the integration is activated, start the schedule.
  
Basic Routing Duplicate App Name   Basic routing integrations aren't supported in Oracle Integration 3 and will show a blank canvas. You must delete those integrations and recreate them as application-driven integrations.  
Publish/Subscribe Integrations   Integrations that published messages or subscribed to messages from Oracle Integration, must be converted to event-driven orchestrations. You must delete the integrations and recreate them based on the precheck instructions for Publish/Subscribe Integrations.  
Custom Endpoint URL     Your custom endpoint wasn't migrated during upgrade.

You must recreate your custom endpoint.

Complete Post-Upgrade Tasks for Visual Builder

To complete migration, perform the following steps:

Task Who When Tasks description
Update DNS record for custom endpoint Administrator Immediately after upgrade If you're using Visual Builder and you have a custom endpoint or alternate custom endpoints, update the custom endpoint DNS record's CNAME with the Visual Builder instance host name.

Complete additional post-upgrade tasks

 Development Operations team Immediately after upgrade Complete the tasks described in Tasks to Complete After the Upgrade in Administering Oracle Visual Builder in Oracle Integration 3.

Complete Post-Upgrade Tasks for Process Automation

Perform the following steps to complete migration to Process Automation in Oracle Integration 3.

Note

If you performed a manual migration of actively-used process applications, you don't need to perform these post-upgrade tasks.

Application-Level Post-Upgrade Tasks for Process Automation

Perform the following tasks for each Process application.

Task Who When Details

Update role mappings

 Developer/Administrator Immediately after upgrade Role assignments have changed in Oracle Integration 3, so you must map your existing roles to the new roles. See Configure Roles for Process Applications in Using Oracle Cloud Infrastructure Process Automation.

Process owners

Add members who had the following roles to the Process Owner role in the new application:

  • <application-name>.ProcessOwner
  • <application-name>.AnalyticsViewer
  • auto-handler for the swim-lane

Process reviewers

Add members who had the <application-name>.ProcessReviewer role to the Process Reviewer role in the new application.

Members with swimlane roles

Add members who had a swim-lane role to the role assigned to the swimlane in the new application.

Groups

Change the old group to a role in the new application, and either add the group to the new role or add the members of the group to the new role.

Roles

Change the old role to a role in the new application, and add members to the new role.

Members who can start a process

In the process start properties, select the members who can start the process from one of the following options:

  • Role members with at least Use permission: Allows any user assigned a role with Use or Manage permission to see and start the application. Note that in a structured process, a user does not need to be assigned to the swimlane to start the process.
  • All users and external applications: Allows any user or external application with access to Process Automation to see and start the application.

Dynamic process roles

Add members who had dynamic process roles to the dynamic process roles in the new application.

Update connector credentials

 Developer/Administrator Immediately after upgrade Credentials aren't migration to Oracle Integration 3, so you must reconfigure authentication for your REST connectors. If there are multiple applications connecting to the same server you may want to create a global credential that can then be reused across applications. See Configure Basic Auth Security in Using Oracle Cloud Infrastructure Process Automation.

Fix any errors and warnings

 Developer/Administrator Immediately after upgrade Because there are differences in process features between Oracle Integration Generation 2 and Oracle Integration 3, you'll need to validate your application and fix any errors or warnings. See "How are applications validated?" in Applications at a Glance in Using Oracle Cloud Infrastructure Process Automation.

Activate application

 Developer/Administrator Immediately after upgrade After you've resolved all validation errors, activate your application so new instances can be triggered and worked on. See Activate Applications in Using Oracle Cloud Infrastructure Process Automation.

Access Mapping Post-Upgrade Tasks for Process Automation

Some access mapping tasks are completed automatically during upgrade and some are your responsibility.

During upgrade, a new Oracle Identity Cloud Service (IDCS) App is added to help with mapping.

The following IDCS roles are automatically mapped from Oracle Integration Generation 2 to Oracle Integration 3 during upgrade.

Oracle Integration Generation 2 Oracle Integration 3
ServiceDeveloper ServiceDeveloper
ServiceAdministrator ServiceAdministrator
ServiceUser N/A
ServiceMonitor N/A
ServiceDeployer ServiceDeployer
ServiceViewer N/A
ServiceInvoker N/A
ServiceEndUser N/A

Service-Level Post-Upgrade Tasks for Process Automation

Depending on how you use Process, you'll perform different service-level steps after upgrade to Oracle Integration 3. Perform any steps that apply to your implementation.

Task Who When Details

Allowlist the new Process Automation URL

Developer Immediately after upgrade

Add the new Process Automation URL to your allowlists. To find the new URL, click Process in the Oracle Integration 3 menu. You'll be redirected to the Process Automation URL.

Update integrations to call Process Automation

 Developer Immediately after upgrade

Process APIs and endpoints have changed after the upgrade. As a result, you must update any integrations that use the Process action to use the REST adapter instead. See REST API for Oracle Cloud Infrastructure Process Automation.

Update Visual Builder applications to call Process Automation

 Developer Immediately after upgrade

Process APIs and endpoints have changed after the upgrade. As a result, you must update any Visual Builder application that calls Process, replacing any deprecated interaction patterns. See Connect to Oracle Process Automation APIs in Building Responsive Applications with Visual Builder Studio.

Update external clients to call Process Automation

 Developer Immediately after upgrade

If you're using Process CCA components in external applications, they won't work after the upgrade to Oracle Integration 3. You must transition to using the new Process Automation CCA components to leverage the APIs. See REST API for Oracle Cloud Infrastructure Process Automation.

Share the new Process Automation URL

Administrator Immediately after upgrade

The URL used to access and interact with Process Automation has changed after the upgrade. Share the new URL with anyone who needs to administer Process Automation, start a new process, or view and act on their tasks.

Follow Your Organization's Verification Procedures

Task Who When Details

Complete your organization's post-upgrade verification tasks

 Designated team members Within two weeks after upgrade

Complete your organization's post-upgrade verification tasks, such as performing regression testing.

Perform integration load testing in a development/stage instance before moving integrations to a production instance.