Skip to main content

Oracle APEX 19.2 onwards

This document covers step-by-step instructions for installing the plug-in sample application in Oracle APEX versions 19.2 and above but prior to APEX version 22.2. For Oracle APEX 22.2 onwards please follow instructions described here.

Installation pre-requisites

  • Oracle Database 12c or above
  • Oracle Application Express (APEX) 19.2 or above installed
  • the schema implementing an application where the plug-in will be installed must be REST enabled.
  • the plug-in bundle is downloaded in extracted on the desktop

Import sample application

Log into your Oracle APEX application builder and click Import button.

image-20240226135107547

In the Oracle APEX import wizard:

  1. Go to extracted the plug-in zip archive
  2. Select file app_apex192_unitedcodes_rich_text_editor_pro.sql from extracted plug-in zip archive
  3. Click Next Button

image-20240226135143186

In the Import (File Import Configuration) wizard click Next button.

image-20240226135235636

In the Install Database Application (Install) wizad:

  1. (Optional) Set Parsing Schema
  2. (Optional) Set Install As Application
  3. Click Install Application button

image-20240226135352252

Oracle APEX import wizard is installing the sample application. Don't close the browser tab and wait until the process is finished.

image-20240226135529735

Once, the sample application is created, the Install Application wizard starts. Do the following:

  1. Set Install Supporting Objects to Yes
  2. Click Next button

image-20240226135607569

In the Install Application (Validations) wizard:

  1. (Optional) Preview Installation Script
  2. Click Next button

image-20240226135705042

In the Install Application (Confirmation) wizard:

  1. (Optional) Preview Installation Script
  2. Click Next button

image-20240226135854313

Oracle APEX Install Application wizard is installing the sample application supporting objects creating database objects. Don't close the browser tab and wait until the process is finished.

image-20240226135916904

The Install Application wizard might finish with errors due to the plug-in access token type SQL. Click Install Summary button to verify errors.

image-20240226140125999

If the only error is regarding Create access token type script, the installation is successful. See the sub section Compile access token type.

image-20240226140024711

Compile access token type

For some reason Oracle APEX display error when installing type with static and member methods. To be sure that the access token type is valid you can recompile the access token type.

Go to SQL Workshop \ SQL Commands

  1. Execute the following code ALTER TYPE UC_RTE_ACCESS_TOKEN COMPILE;
  2. Click Run button
  3. In the result, the SQL Commands should print Type altered.

image-20240226140818318

Activate plug-in license

Once the sample application is installed, the plug-in license must be activated. Otherwise, the plug-in will raise PL/SQL error UC-20011: The plug-in license not found. Read on how to activate the plug-in license here.

Run application

Navigate ro installed sample application and click Run Application.

image-20240226141616732

From the home page you can easily test most plug-in features using exposed buttons and settings region.

image-20240226142049183

Click the button Sample Application Checks in application navigation bar to open dialog showing sample application CLOB support status. Since the sample application is installed in Oracle APEX prior to 22.2, the APEX session state doesn't support CLOB values.

The main feature of the plug-in is support for CLOB values using the supporting plug-ins and the plug-in PL/SQL API. The sample application presents CLOB handling for Oracle APEX versions prior to 22.2.

image-20240226141539434

Enable CLOB support after upgrading APEX to 22.2 or above

If the sample application was installed in Oracle APEX prior to 22.2, but then the APEX version has been upgraded to 22.2 onwards, the plug-in can be CLOB enabled without the need to reinstall the sample application or plug-ins.

Firstly, check the sample application checks

image-20240302184122933

The sample application checks modal page shows that:

  • Supported the Oracle APEX version supports CLOB values in session state
  • Not supported the plug-in instance is not yet CLOB enabled
  • Not supported the home page item implementing the plug-in is not yet CLOB enabled

Enabling the plug-in to support CLOB values is only the matter of updating the plug-in Standard Attributes in shared components and existing page items using APEX page designer.

Firstly, enable the plug-in CLOB support. Go to the sample application Shared Components

image-20240302182243552

In shared components go to Other Components \ Plug-ins

image-20240302182303821

Open UC - Rich Text Editor Pro (page item) definition.

image-20240302182351605

Go to the plug-in Standard Attributes, enable Session State Supports CLOB, and click Apply Changes button.

image-20240302182642626

After updating the plug-in, run the sample application home page and open the sample application checks modal. The modal page will show the following information:

  • Supported the APEX version supports CLOB values in session state
  • Supported the plug-in instance is not yet CLOB enabled
  • Not supported the home page item (P1_FROALA) implementing the plug-in is not yet CLOB enabled

image-20240302190714933

Open the sample application Home (1) page using APEX page designer and:

  1. Select page item P1_FROALA
  2. Set Session State \ Data Type to CLOB
  3. Save and run the page

image-20240302185248163

Saving page changes raise an error

If saving a page results in error presented below, the attribute must be firstly set to VARCHAR2 and then to CLOB.

image-20240302185631280

  1. Set Session State \ Data Type to VARCHAR2
  2. Save page
  3. Set Session State \ Data Type to CLOB
  4. Save and run page

Once, the page item has been updated, the sample application checks modal page will show the following result:

  • Supported the APEX version supports CLOB values in session state
  • Supported the plug-in instance is not yet CLOB enabled
  • Supported the home page item implementing the plug-in is not yet CLOB enabled

image-20240302185738662

Now, the sample application exported from Oracle 19.2 and migrated to Oracle APEX 22.2 onwards has been CLOB enabled.