Upgrade Readiness Checks

Oracle periodically performs some prechecks to determine your upgrade readiness so that your upgrade runs smoothly. If the prechecks don't pass, you may need to perform tasks to correct the issues. You can see the precheck status of your Oracle Integration Generation 2 instance, or run a precheck again, in the instance's Settings page. For more, see Check Upgrade Readiness and Correct Precheck Issues in Provisioning and Administering Oracle Integration 3.

The following prechecks are performed for Visual Builder instances in Oracle Integration Generation 2:

• Is a custom endpoint defined in the Visual Builder instance?

  The instance cannot be upgraded to Oracle Integration 3 if a custom endpoint is defined in the Visual Builder instance. To upgrade the instance, wait until Oracle starts upgrades for custom endpoints, or, if you want to move forward with the upgrade now, delete the custom endpoint from your Visual Builder instance.

  After the instance is upgraded to Oracle Integration 3, you can define a new custom endpoint in the Visual Builder instance.

  Note:

  A custom endpoint defined in a Visual Builder instance is not the same as a custom endpoint created in Oracle Integration.
• Does Visual Builder use an Oracle database instance?

  If you are using your own Oracle database instance (BYODB) with your Visual Builder instance, the instance can be upgraded to Oracle Integration 3. However, Autonomous Transaction Processing (ATP) must be up and running during the upgrade. Make sure you complete the additional tasks described in Prepare Visual Builder for the Upgrade below.

Prepare Visual Builder for the Upgrade

Examine your applications, especially your live and staged applications, to check whether they might break due to any of the Known Issues for Live/Staged Apps Post-Upgrade to Oracle Integration 3. For these cases, follow the relevant instructions in Tasks to Complete After the Upgrade below.

• Confirm that you have upgraded your applications to the supported VB runtime and JET versions, and verify that your applications work correctly. If you miss this step, your staged or live application might stop working after the upgrade. For more, see Visual Builder apps on obsolete VB runtime versions in Known Issues for Oracle Integration 3.

• If you use the "delegate authentication" authentication type in any service connections or backends, you must switch the authentication type to "Oracle Cloud Account". The "delegate authentication" authentication type is deprecated. After you change the authentication type, test your service connections and apps to confirm that they still work correctly.

• 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 Update Your ATP Wallet and Reset an Expired Password.

Tasks to Complete After the Upgrade

• Configure an IAM policy for Visual Builder in Oracle Integration 3. See Set the IAM Policy for Managing the Visual Builder Instance.
• Update the allowlist and network access rules to add the Visual Builder service VCN OCID in Oracle Integration 3. See Allow Your Instance to Access Services.
• Update backends and service connections.

  • Oracle Integration 3 does not accept Basic Auth, and recommends OAuth. For more details, see When is Basic Authentication Supported in Oracle Integration 3?

    After migration, you need to update backends and service connections to the Oracle Integration REST API that use Basic Auth, to change them to use an appropriate OAuth mechanism (OAuth 2.0 Resource Owner Password is the most similar to Basic Auth). For backends and service connections connecting to Oracle Integration REST API using "Oracle Cloud Account" authentication, you don't need to change the authentication.

  • If your backend (or service connection) had the connection type set to "Dynamic, Service supports CORS", confirm this is set to "Always Use Proxy". This is to avoid any Chrome 119 issues that might arise due to redirects of the Oracle Integration REST API.
  • If your service connections to Integration REST APIs were created from the catalog, they will continue to work after the migration (provided Basic Auth is replaced with a suitable OAuth mechanism, and the connection type is updated to "Always Use Proxy").

  • Service connections to the Oracle Integration design-time (or factory) APIs, created using the endpoint flow in Visual Builder, that are not listed in the catalog, will not work after the migration, and you need to update them.

    An example of such an endpoint is a lookup endpoint (see Lookups REST Endpoints in REST API for Oracle Integration 3). When you test them in the service connection's Test tab, these endpoints will typically give error code HTTP 403, with the error "Unable to verify URL against allowed list". See SendRequest in REST API for Oracle Integration 3 for more on the design-time URL and factory APIs.

    To rework these service connections using a custom backend:

    1. Create a custom backend called icsFactoryApi (for example). For the URL, use the design-time URL (for example, https://design.integration.region.ocp.oraclecloud.com), and use OAuth authentication (generally OAuth 2.0 Resource Owner Password). Set the connection type to "Always Use Proxy" (recommended).
    2. For existing service connections based on design-time APIs:
       1. Change the URL from vb-catalog://backends/ics to point to vb-catalog://backends/icsFactoryAPI. (If the URL is https://<integration_base_url>, then replace <integration_base_url> with vb-catalog://backends/icsFactoryAPI).
       2. Navigate to the Request tab, and then add the static query parameter of "integrationInstance", and add the appropriate value.
    3. The static query parameter introduced this way becomes part of the visual application code. This parameter will be different for different Integration instances, so you would need to update the parameter if you import the app to another instance (for example, a prod instance). If you use a build pipeline, you would need to modify the parameter in the packaging jobs.
  • (Optional, but recommended) Set and store the details about the authentication type, connection type, and credentials on the backend, and have all the service connections based on the backend. Defining details only on the backend can help you manage the details, so you don't have to duplicate them as much. See the blog post Streamlining Service Connections to use Backends for more information.

• PWA apps installed on user devices will stop receiving automatic updates after your Visual Builder instance is upgraded from Oracle Integration Gen 2 to Oracle Integration 3.

  After the upgrade:

  1. Republish the PWAs.
  2. Provide users with the new URL. You should instruct the users that they need to uninstall the old apps and install the new ones from the new Visual Builder location in Oracle Integration 3.

  The apps will receive automatic updates after they are re-installed. For more, see PWA app no longer receives updates automatically after migration to OIC 3 in Known Issues for Oracle Integration 3.

• If your application code has any references to the Oracle Integration Gen 2 Visual Builder URL, you need to update them to the new Oracle Integration 3 VB URL after the upgrade for your apps to work correctly. For more, see Unable to access VB business object URLs from service connections in live app and Custom code accessing pre-upgrade Visual Builder URL failing in Known Issues for Oracle Integration 3.