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
  • For me placeholder is not working now. Here is my sample code.

      richTextEditorField(
                    label: "Compose Message",                
                    required: true,
                    height: "MEDIUM",
                    richTextValue: local!emailTemplates.template,
                    richTextSaveInto: local!emailTemplates.template,
                    includeHTMLlength :true,
                    enableSpellChecker: true,
                    allowImageUpload: false,
                    enableExportPdf: false,
                    placeholder: {{"Case #: {Case ID}"},
                    {"PO #: {PO Number}"},
                    {"PO Date: {PO Date}"}}
                  )

  • Hi,

    I just updated to the latest version because I was experiencing issues with images. However, even after the update, the plugin still isn’t working; I’m still having trouble, and the images aren’t loading.

    Is there a new version that you are currently working on?

    or something else that I need to configure?

  • v1.6.2 Release Notes
    • Added a disableTableProps parameter.
    • Fixed minor bugs in image validation.

  • v1.6.2 Release Notes
    • Added a disableTableProps parameter.
    • Fixed minor bugs in image validation.
  • Hi guys,

    I'm also having the same issue of broken pictures. Even the upload is not working correctly anymore after upgrading to Appian 24.2.

    Images are created in the expected folder, everything looks fine, but then the image is not read correctly by the plugin.

    If i click on "Open image in new tab" the image is shown correctly.

    Of course both parameters are set correctly:

    1- allowImageUpload

    2- imageStorageConnectedSystem

    I've also tried to re-create the connected system, with no luck.

    We were running version 1.1.1 of the Advanced Rich Text Editor plugin and version 1.0.0.0 of the Connected System plugin.

    Apparently after moving to 24.2 it stopped working and upgrading the plugin to 1.6.1 and 1.2.0 (Connected system) did not solve the issue.

    Let me know if I can give you any additional information.

    Best regards,

    Fabio

  • Hi Team

    We've been using this component for quite some time, and it has been functioning well in terms of handling images. However, recently we've encountered an issue where images are not being added or displayed to the end user, regardless of their size.

    We attempted to update the plugin to the latest version (1.6.1) to stay in line with recent updates, but the problem persists.

    Please provide a resolution as a priority.

    Thanks

    Shweta

  • Hi  ,

    Thanks for reaching out!

     We found the issue and fixed it, this solution will be available in the next release.

  • Hi there,
    Please let us know if there is an update or fix for the above issues.
    Thank you in advance. 

  • Hello  ,

    We are using version 1.6.1 of the plugin and trying to use the "imageValidation" parameter with a "maxSize" value to set a limitation on the size of the images that a user can upload in the component. As you can see from the screenshot, however, I set the maxSize to 3 KB but was still able to upload an image that far exceeds the maxSize parameter (the image in this screenshot is over 5 MB) and no validation was shown. This screenshot is a simplified example but we have also been able to submit a process from a site using a start form with the same imageValidation setup. Is there something wrong with how we set the imageValidation and maxSize values or is this a bug?

     

  • Hi ,

    1. We have created a custom function - getbase64fromhtmlimagesource() in Connected System to convert HTML images to base64 encoded images.
    2. Currently imageStorageConnectedSystem does not support this functionality, We will include it in our backlog.

    Regards,
    Ananthakrishnan S