Use Rich Text in Business Object Fields

In a Rich Text-enabled Field in a Business Object (example: Incident Description), you can provide and format text and insert images using Rich Text options.

Good to know:

  • To accommodate Rich Text and save space, consider combining some Fields in your Form design (example: Combine the Description and Solution/Workaround fields in a Knowledge Article).
  • If you copy/paste fully formatted Rich Text into a Business Object Field in the Desktop Client, it might render differently in the Browser Client. For best results, remove the formatting from the copied text and paste it into the Field as plain text. Then, you can apply formatting using the Rich Text Editor in CSM.
  • Images inserted into Rich Text Fields in the Desktop Client will show up in the Browser Client and Portal, and vice versa.

To access and use Rich Text:

  1. (Desktop Client) Click in a Rich Text Field, and then press F8.
    Tip: You can also access the Rich Text Zoom window by right-clicking and selecting Zoom, or by clicking the Zoom button.
  2. (Browser Client and Portal) Click in a Rich Text field, and then click the Toggle Toolbar button.
  3. Format text using either the formatting options in the Rich Text Zoom window (Desktop Client), or in the Rich Text Editor (Browser Client and Portal).
  4. Insert hyperlinks:
    1. (Desktop Client) Right-click the Rich Text Field or Rich Text Zoom window, and then click Insert Hyperlink.

      Tip: You can also click Insert>Hyperlink from the Rich Text Zoom window menu bar.

    2. (Browser Client and Portal) Click the Insert Hyperlink button in the Rich Text Editor.
    3. Provide the hyperlink in the popup window.

      Tip: In the Browser Client and Portal, you can provide text and a tooltip for the hyperlink. The text is a name for the hyperlink that shows as linked text instead of the URL, and the tooltip is a word or phrase that shows when the mouse pointer hovers over the hyperlink. Select Open Link in New Window to open a separate window when you click on the link.

    4. Click OK or Insert.

      The hyperlink is inserted into the Rich Text Field.

      Tip: You can also copy/paste hyperlinks directly into Rich Text Fields.
  5. Insert images:
    1. (Desktop Client) Right-click the Rich Text Field or Rich Text Zoom window, and then select Images>Open Image.

      Tip: You can also click Insert>Picture from the Rich Text Zoom window menu bar.

    2. (Browser Client and Portal) Click the Insert Image button on the Rich Text toolbar.
    3. Browse to the location of the image you want to insert, select the file, and then click Open.

      The image is inserted into the Field at the current cursor position, in the default image format (JPEG or PNG) configured in the Global Rich Text settings in CSM Administrator.

      Tip: In the Desktop Client, you can copy images onto the clipboard (Right-click>Copy or CTRL+C) and paste them into Rich Text Fields (Right-click>Paste or CTRL+V). (Copy/paste does not work in the Browser Client or Portal.)
  6. Resize images:
    • (Desktop Client) To resize a single image, right-click the image in a Rich Text Field, and then select one of the following options from the Images category in the context menu:
      • Full-size Image: Select this option to resize the image to its full size.
      • Thumbnail Image: Select this option to resize the image to the default thumbnail size configured in CSM Administrator (the default size is displayed in parentheses next to the menu selection).
    • (Desktop Client) To resize all images in a Rich Text-enabled Field, select one of the following options from the Images category in the context menu:
      • Resize All Images: Select this option to open a sub-menu, and then resize images to either Thumbnail Images (default thumbnail size) or Full-Size Images.
      • Default Image Size: Select this option to open a sub-menu, and then select to size images as small thumbnails, medium thumbnails, large thumbnails, or full-size images.

        Note: You can only set the default image size if the option was enabled in CSM Administrator (Allow User to Override Image Display Mode is selected in Field Properties). Selecting a default image size sets the default way that images are displayed in all Fields of the same type for a particular Business Object (example: if you select small thumbnails as the default image size for an image in an Incident Description field, all images in all Incident Description fields will be sized as small thumbnails).

    • (Browser Client and Portal) In the Rich Text Editor for a Business Object Field, select an image, and then click the Insert Image button.
      1. Image Settings window: Select a radio button to resize the image to a small thumbnail, medium thumbnail, large thumbnail, or full-size image.
      2. Click Save.

        Note: In the Browser Client and Portal, there is no option to resize all images in a Rich Text-enabled Field. You can only resize one image at a time.

  7. View images in a separate window.
    • (Desktop Client) Double-click an image to open it in the software associated with the file extension (example: If the image is a JPEG file, it will open in the image viewer that is associated with JPEG files on the User's computer).

      Tip: You can also click Open Image in External Viewer from the Images category in the context menu.

    • (Browser Client and Portal) In the Rich Text Editor for a Business Object Field, select an image, and then click the Insert Image button. Click the Open Image in New Tab link to open the image in a new tab in your browser.
  8. Click OK in the Rich Text Zoom window (Desktop Client) or Rich Text Editor (Browser or Portal Client) to save your formatting changes.
© Copyright 2018 Cherwell Software, LLC. All rights reserved.