Modifying the Rich Text Editor User Interface

The rich text editor extends the capabilities of a long edit box to display rich text or editable rich text at runtime. PeopleTools 8.61 and later versions render the rich text editor based on CKEditor v5.. The following topics describe the user interface of CKEditor v5 and its use.

Important! To stay current with the latest information on rich text editor, subscribe to the following technical bulletin on My Oracle Support: Tech Update - Oracle Replaces CKEditor with ORTL for Rich Text Editing in PT 8.61.04 and 8.60.14 (Doc ID 3022567.1)

This example illustrates an editable rich text-enabled long edit box at runtime.

Runtime long edit box showing rich text functionality

The rich text editor enables you to add rich formatting of text content, including common structural treatments such as lists; formatting treatments such as bold, underline, and italic text; drag-and-drop inclusion; paste-as-text; and sizing of images. The rich text editor toolbar is extensible through the use of HTML definitions that define your configuration, which enables you to design and implement an interface that is specific to the needs of your users.

Important! Use caution when modifying the rich text editor interface; it is recommended that you never include or enable the Source button in the toolbar.

By default, CKEditor files can be accessed without authentication on the web server. Oracle recommends that after your PeopleSoft Internet Architecture installation, you make sure to secure any files or folders at the web server level as needed. To secure CKEditor files, security has to be setup at web server level. How you configure this security varies according to your web server product.

For information on implementing security on Oracle WebLogic see Securing Servlets on WebLogic.

CKEditor v5 does not provide a default configuration file. If you want to create a custom configuration file, you may copy the PeopleTools delivered configuration file for CKEditor v5.

To create a custom configuration:

  1. In Application Designer, search for the PeopleTools delivered configuration file (PT_RTE_CFG), and copy the code in the configuration file.

  2. Create a new HTML definition.

  3. Paste the code into the HTML definition.

  4. Save the HTML definition. Prefix the definition name with PT_RTE_CFG for example, PT_RTE_CFG_MYCONFIG.

    Note: Only HTML definitions with the PT_RTE_CFG prefix appear in the Configuration Settings Id drop-down list box.

  5. Modify the code in the HTML definition as necessary and save. The code might look like this example:

    const cketoolbarconfig =  [
                'heading',
                'findAndReplace',
                'italic',
                '|',
                'link',
                'numberedList',
                '|',
                'indent',
                'outdent',
                'alignment:left',
                'alignment:right',
                'alignment:center',
                'alignment:justify',
                '|',
                'InsertImage',
                'blockQuote',
                'insertTable',
                'undo',
                'redo',
                'SpecialCharacters',
                'fontSize',
                'fontFamily',
                'fontColor',
                'fontBackgroundColor'
            ];
  6. To use the new configuration, open the Long Edit Box Page Field Properties dialog box; select the Options tab; click the Configuration Settings Id drop-down list box; and then select the HTML definition name from the list of values that appear.

    See Setting Options Properties.

A plug-in enables you to create an application-specific toolbar button.

See CKEditor v5 API Documentation.

By default, when you upload images the system stores them in the PTRTDB table. The default URL ID is PT_RTE_IMG_DB_LOC. To create a different storage location and URL ID, follow these steps:

  1. Create a new record definition.

  2. Insert the FILE_ATTDET_SBR subrecord.

  3. Save and then build the record definition.

  4. Clone these record definitions:

    • PTRTDB_BMP

    • PTRTDB_GIF

    • PTRTDB_JPG

  5. Save the record definitions, name them like this: <myrecord>_BMP, <myrecord>_GIF, and <myrecord>_JPG.

    The following image types are supported: JPG, BMP, GIF, PNG, and SVG.

  6. For each record, open the SQL Editor and change the FROM statement in the SQL to this:

    FROM PS_<your record name from step 3>
  7. Save and build each view.

Note: FTP storage is not supported.

Note: It often will require end users to refresh a page or access it twice in order to display an image in a rich text editor field after the following events: browser cache has been cleared, web server cache has been cleared, the posting using the rich text editor field (such as a job posting) is new.

PeopleTools 8.61 renders the rich text editor based on CKEditor v5, which does not support certain features available in CKEditor v4. You can no longer use the CKEditor v4 features listed in the following table.

Important! To stay current with the latest information on desupported features, subscribe to the following technical bulletin on My Oracle Support: Data Compatibility with Updated Rich Text Editor Technology in PeopleTools (Doc ID 2945233.1)

The following CKEditor v4 features are desupported. Features identified as plug-ins are rendered as button in the rich text editor toolbar.

Feature

Description

Anchor plug-in

This plug-in provides the capability to insert anchors with some properties; this is part of the Links plug-in.

Button (form control) plug-in

This plug-in adds a button form control element in the editor content.

Check box (form control) plug-in

This plug-in adds a check box form control element in the editor content.

Custom style files

The use of custom style files with Application Designer is desupported.

Custom template files

The use of custom template files with Application Designer is desupported.

Elements Path plug-in

This plug-in displays a list of HTML element names in the current cursor position. By default, the list appears at the bottom of the editor interface and can give you contextual information about the content that you are creating.

Insert Smiley plug-in

This plug-in provides a set of emoticons to insert into the editor via a dialog window.

Maximize plug-in

This plug-in adds a toolbar button maximizing the editor inside a browser window.

New Page plug-in

This plug-in adds a toolbar button that clears the editing area and creates a new page.

Radio button (form control) plug-in

This plug-in adds a radio button form control element in the editor content.

Selection field (form control)plug-in

This plug-in adds a selection field (a drop-down) form control element in the editor content.

Show Blocks plug-in

This plug-in adds the command to visualize all block-level elements by surrounding them with an outline and displaying their element name at the top left.

Text area (form control) plug-in

This plug-in adds a text area (a long edit box) form control element in the editor content.

Text field (form control) plug-in

This plug-in adds a text field (an edit box) form control element in the editor content.

Toolbar

In CKEditor v4, the toolbar is collapsible. Click the triangle located next to the toolbar to toggle between visible and collapsed.