Advanced Rich Text Editor (Vuram)

IMPORTANT: Select component plug-ins are experiencing issues due to a recent browser update. If you encounter any problems with previously functional component plug-ins, please create a support case. If you notice other component plug-ins that are not functioning correctly, please create additional support cases for each instance.

Overview

The Rich Text Editor Component can be used on Appian interfaces where you want to show the rich text information in readable format to the end user. We can use the component to show it as an email subject typing interface.

With this component you can add images, customize tables etc. This also has a functionality called placeholders using which you can use the same information in multiple items in the editor without retyping.
Additionally it allows uploading of images which get stored in the specified Appian folder (requires separate install of the Rich Text Editor Connected System Plug-in).

Note:

  1. It is recommended to use one ARTE Component in a Page/Interface.
  2. We do not encourage to use Short as height in the component.

Key Features & Functionality

Parameters:

  • Label : Text to display as the field label.
  • Label Position: Determines where the label appears. Valid values: “ABOVE” (default), “ADJACENT”, “JUSTIFIED”, “COLLAPSED”.
  • Height: Determines the layout height. Valid values: “SHORT”, “MEDIUM”, “TALL”, “AUTO” (default).
  • MaxSize: Maximum size of the rich text data. Default:10000
  • Placeholder : Placeholder text to display in the component wherever you want.
  • richTextValue: Rich text to display in the field.
  • richTextSaveInto: One or more variables that are updated with the richText value when the user changes it. Use a!save() to save a modified or alternative value to a variable
  • IsReadOnly: Determines if the field should display as editable or not. Valid Values : True or False
  • allowImageUpload : Determines if image upload are allowed. Default: false.
  • imageStorageConnectedSystem: The instance of the connected system used to store images from the rich text editor. This is required if allowImageUpload is set to TRUE. You can download the Connected System from the Appian App Market.
  • Show Usage Bar: Provide false to hide the usage bar at the bottom of editor. Default true
  • Enable Fullpage Output: Enabling fullpage exposes <head>, <body> and various meta tags in richText output. Default true.
  • Enable Spell Checker: Provide true to enable the spell checker. Default false.
  • Uploaded Images Doc Ids SaveInto- Document Ids of all uploaded images will be saved into this rule variable.
  • Exported PDF Id - Returns the document ID of the exported PDF.
  • Enable Export Pdf- Provide false to disable the 'Export as PDF' button. Default: True
Anonymous
  • Hi Juan,

    Thanks for reaching out!

    Could you please answer the following questions:

    1. From which source was the image uploaded/copied (Screenshot, local upload, copied from Word, etc.)?
    2. What is the image extension?
    3. Is the 'allowImageUpload' parameter set to true?
    4. Are the uploaded/copied document IDs reflected in the 'uploadedImagesDocIds' parameter?

  • Hi Team,

    When trying to download the new plugin version, we're getting the following error which isn't present if we try to download other plugins (for example Excel Tools). Please check if upload was done properly Slight smile


     

  • v1.6.0 Release Notes
    1. Added new parameters ‘pasteAsText’, ‘limitExceededMessage’ and ‘imageValidation’.
    2. Character count is displayed in the usage bar.
    3. Functionality changes in ‘allowImageUpload’ parameter.
    4. Fixed minor bugs.

  • Hello Vuram team,

    First of all, thank you for your work, it is very useful.

    We have an issue when inserting images in the editor. We have installed the connected system plugin and completed all the configuration, but when displaying the image it is not possible.
    Attached is a screenshot of how it is displayed.

    When reviewing the HTMl and accessing the link to the image, this is downloaded from Appian without problem.

    I have investigated and I have not seen any report about this operation, so I guess we have implemented something wrong.
    Could you tell us what?

    Thank you very much in advance.
    Best regards

  • Hi Priyesh,

    Thanks for reaching out

    1. If the 'allowImageUpload' parameter is set to false, the image will not be uploaded to Appian, but the editor will still accept the image.
    2. We will analyze this issue and fix it in the upcoming release if it persists.

  • Hello Vuram Team,

    We are facing below issues while using richTextEditorField for our Application-

    1. Users are able to upload/ copy paste images, even though allowImageUpload  is set to false.
    2. We have set maxsize to 65000. When user is adding a image that is breaching the limit of 65K , validation is not getting triggered properly and user is able to create the record with more chars than the defined limit.
      When user tries to update the same record later, he is unable to do so due to validation coming.

      Ideally validation should have come in the first place itself when user is creating the record.

    Hoping for a quick resolution.

    Thank You.

  • v1.5.3 Release Notes
    • Optimized code for improved performance.

  • Hi ravis,

    Thanks for reaching out, The reduction in the default height is actually intentional and part of the updates made in the latest version. To achieve the height you've shown in the snapshot, you can set the height value to "SHORT" in the configuration. However, please note that this setting won't allow for auto-adjustment of the height.

    Thank you

  • Hello there,

    After the version upgradation of the Rich Text Editor plugin the default height (current configuration: height: "AUTO") of the editor has been reduced (please refer below code and snap).
    May you please fix this or suggest a solution.
    Or please let me know if I am configuring in a wrong way.
    Thank you for your consideration.



    Earlier with the same (above snap) configuration, the height was fine and auto adjustable (please see below snap) according to the input text:



    But now after the version upgradation, height has been changed so how can we achieve the earlier one:




    Plugin Version:




  • Hi  ,


    The reported issue is probably not because of the component plugin. Instead, try contacting Appian support or raise a support ticket with Appian. This could be the best way to get it fixed.

    Regards,
    Vignesh E