Complete Pre-Upgrade Tasks

There are several tasks you must complete as your upgrade date approaches to prevent errors during upgrade and to allow you to smoothly transition to the new Oracle Integration 3 instance after upgrade.

Connectivity Agent Pre-Upgrade Tasks

Task Typical owner Tasks description

Prepare for conversion to OAuth 2.0

Development Operations team In Oracle Integration Generation 2, the connectivity agent uses basic authorization to invoke Oracle Integration endpoints. Oracle Integration 3 instead uses OAuth 2.0 token-based authentication, which is more secure. During the upgrade, your connectivity agents connections are automatically converted from using basic authentication to using OAuth 2.0, so you don't need to manually recreate any connections yourself.

However, before upgrade you must prepare for this conversion by allowing egress from the agent network to Oracle Integration design-time and runtime, and to the Oracle Identity Cloud Service or the identity domain as described in Update Allowlists.

And, after upgrade, as a result of the new authentication method, you'll see additional traffic to your firewall. This additional traffic occurs because the connectivity agent must communicate with the server to get new tokens.

For more information on OAuth 2.0 support in Oracle Integration 3, see When is Basic Authentication Supported in Oracle Integration 3?.

Update your allowlist settings

Development Operations team If your organization uses allowlists, you must update your allowlist settings for your connectivity agents. The Allowlist status column in the Connectivity Agent Status section shows the status of all the connectivity agents in your instance, indicating whether the allowlist has been updated appropriately.

As your upgrade window nears, perform the tasks described in Update Allowlists.

Agents that are offline during upgrade or don't meet upgrade requirements won't be upgraded, in which case you'll need to perform post-upgrade steps to regain connectivity.

Set the proxy server's Cache property

Development Operations team Set your proxy server's Cache property for the Oracle Integration URLs to refresh as frequently as possible.

For example, if your proxy server uses the Cache-ExpiresDefault property, set it to now.

Instance Pre-Upgrade Tasks

Task Typical owner Tasks description

Start capturing the activity stream in Oracle Cloud Infrastructure Console

Administrator If you don't already, start capturing the activity stream in Oracle Cloud Infrastructure Console.

Here's why: The activity stream isn't migrated. But if you capture this data in the Oracle Cloud Infrastructure Console, you'll still have access to historical data. See Capture the Activity Stream in Oracle Cloud Infrastructure Console.

Complete network rules configuration

Network administrator This task can be completed pre-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.

See Ensure Connectivity.

B2B for Oracle Integration Pre-Upgrade Tasks

Task Typical owner Tasks description

Ensure all B2B passwords for keystore match

Administrator Ensure that all passwords for the keystore file are identical. Your identity certificate file (JKS) requires two sets of passwords: Key Passwords and Keystore Password. All the passwords must be identical. If they're not identical, edit the passwords to match, and re-upload the keystore file.

If you don't have the keystore file that was last uploaded, recreate the file.

When uploading the certificate:

  • For Type, select X.509 (SSL Transport).
  • For Category, select Identity.

See Upload an SSL Certificate in Using Integrations in Oracle Integration Generation 2.

Caution:

If you don't complete this step, the upgrade will fail.

Integrations Pre-Upgrade Tasks

Task Typical owner Tasks description

Determine what to do with failed instances

Development Operations team Failed integration instances fall into one of the following categories, which determines how you can handle them:
  • Failed asynchronous instances - recoverable

    Resubmit the failed instances and clear the queue. See Resubmit Failed Messages.

    If you have a failed asynchronous instance when your instance is upgraded, you can't resubmit the failed instance in Oracle Integration 3—at least not right away. You can't resubmit because runtime data, including errors and all activity stream data, isn't migrated to Oracle Integration 3 as part of the upgrade. However, after the upgrade completes, you can run the integration in Oracle Integration 3, collect error data, and then resubmit.

  • Failed synchronous instances - non-recoverable

    You can't resubmit synchronous integration instances, so they are not recoverable.

Note

If you capture activity stream data in the Oracle Cloud Infrastructure Console, you can still view historical activity for the integration. See Capture the Activity Stream of Integrations in the Oracle Cloud Infrastructure Console.

Decide what to do with asynchronous messages

Development Operations team Decide what to do with asynchronous messages from the client side for the duration of the downtime.

Here's why: During the downtime, Oracle Integration rejects all incoming requests. To prepare, you have the following options:

  • Before the upgrade starts, suspend all asynchronous messages on the client side.

    With this approach, the client doesn't send the messages, and Oracle Integration doesn't reject them.

    If you choose this option, make sure you know the start and end times of the upgrade.

  • After the upgrade finishes, determine the appropriate next steps for the rejected messages.

Ensure your Visual Builder applications call APIs from Integrations REST endpoints

Development team If you created Visual Builder applications by creating a service connection from the catalog and they call REST APIs other than Integrations REST Endpoints, you must rewrite the applications by creating a service connection from the catalog, and the applications must use OAuth to authenticate.

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

Developer If you didn't already update your API calls to use OAuth while completing prerequisites, do so now or 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.

Adapters Pre-Upgrade Tasks

Task Typical owner Tasks description

Stop using decommissioned Microsoft adapters

Development team Microsoft decommissioned the Microsoft Outlook REST APIs in November 2022. If you use any of the following adapters, you must use the Microsoft Graph REST APIs instead.
  • Microsoft Office 365 Calendar Adapter

    See Invoke Operations Page in Using the Microsoft Office 365 Calendar Adapter with Oracle Integration 3.

  • Microsoft Office 365 People Adapter

    See Invoke Operations Page in Using the Microsoft Office 365 People Adapter with Oracle Integration 3.

  • Microsoft Office 365 Outlook Adapter

    See Invoke Operations Page in Using the Microsoft Office 365 Outlook Adapter with Oracle Integration 3.

Visual Builder Pre-Upgrade Tasks

Task Typical owner Tasks description

Prepare VBCS for upgrade

Development Operations team If you use Visual Builder with your own Oracle database instance (BYODB), there are several steps you need to take to prepare for upgrade:
  1. Keep Autonomous Transaction Processing (ATP) up and running during the upgrade.
  2. If you have an allowlist (also known as an ACL) configured in ATP, add the Visual Builder VCN OCID to the ATP allowlist.
  3. Ensure that the user name and password for your ATP instance are configured correctly in Visual Builder.
  4. Reset the expired password or wallet that is used for connecting to ATP.
    1. Download the latest wallet. See Download Database Connection Information in Using Oracle Autonomous Database Serverless.
    2. Upload the wallet on the instance's Tenant Settings page. See Reset Expired Credentials For Your Oracle DB Instance.