Configuring Rich Text Capabilities

Rich Text features are controlled at a system level with the Enable HTLM5 Features check box located on the General tab of the Base Project. This check box is enabled by default.

You can control users' ability to use the Rich Text Editor and the rendering of formatted text in individual elements as described in the following table:

Element Control Setting Default Behavior
Text fields (Memo and Journal only) Enable Rich Text setting for each field. Set in SBM Composer. Enabled for newly added fields.
Notes Render HTML in Notes option. Set in SBM System Administrator. Enabled for all notes. On-premise customers can disable this setting for their entire system.
E-mail messages Always enabled. Use HTML templates to ensure content is rendered correctly. See Selecting E-mail and Notification Templates.

The following sections provide guidance on enabling or disabling the Rich Text Editor and HTML rendering of text.

If you disable Rich Text capabilities after formatted data has been added to fields, notes, and e-mail messages, the data may be garbled or unreadable. In this case, you must manually modify data to remove formatting tags.

Enabling the Rich Text Editor for Text Fields

The Rich Text Editor allows users to apply basic formatting to Text fields (Memo and Journal). This setting can only be applied in SBM Composer.

To enable the Rich Text Editor for individual fields:

  1. In SBM Composer, open the process app that contains the fields for which you want to enable Rich Text editing.
  2. In the App Explorer, select the Data Design filter, and then select the table that contains the fields.
  3. Select a Text field, and then select the Enable Rich Text check box located on the Options tab.
  4. Repeat step 3 for each Text field as needed.
  5. Deploy the process app.
Note: If you enable Rich Text for a field, but HTML5 features are disabled for your system, users can manually type HTML tags into the field, and they will be rendered on State form.

Formatting Default Values for Text Fields

You can use the Rich Text Editor to apply formatting to default values for Text fields (Memo and Journal).

Default values can contain hyperlinks and links to images, but cannot contain images or file attachments.

To use the Rich Text Editor to format default values in SBM Composer, first select the Enable HTML5 Features check box located on the Forms page of the Application tab. The editor will be available for Text fields for which the Enable Rich Text check box is selected.

In SBM Application Administrator, you can apply formatting when you override default values for Text fields for projects and transitions if the Enable Rich Textcheck box is selected for the field.

Selecting E-mail and Notification Templates

To ensure that Rich Text formatting is correctly rendered in e-mail messages generated by the Notification Server, you must select HTML templates for notifications and for e-mails sent from items.

For notifications, e-mail templates are selected on the General page for each notification.

For e-mail messages sent by users as they work with items, templates are selected on the Notification Server tab of the Mail Services page in SBM Configurator. (An HTML template is selected for on-demand customers.)

Disabling Rich Text Capabilities for Your System

SBM's Rich Text capabilities require that users access the system with browsers that support HTML5. If users must access the system with an older browser, such as Internet Explorer 8 (IE8), you can disable Rich Text and other advanced HTML capabilities for your entire system.

For details, refer to Enabling System Settings From the Base Project.

Disabling Rich Text Capabilities for Notes

On-premise customers can disable the Rich Text Editor and HTML rendering of information in notes added to items.

To disable Rich Text and HTML capabilities for notes:
  1. Open SBM System Administrator.
  2. Select the Settings from the Options menu.
  3. Select the HTML tab.
  4. Clear the Render HTML in Notes check box.
  5. Restart IIS.