Advanced Rich Text Editor (Vuram)

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 Plugin from https://community.appian.com/b/appmarket/posts/rich-text-editor-image-upload-connected-system).

Note

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

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 AppMarket.
  • 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 Save Into - Number (Integer) Document Id of the exported pdf document will be saved into this rule variable.
  • Enable Export Pdf- Provide false to disable the 'Export as PDF' button. Default: True
Anonymous
  • I can see a while ago that a new parameter has been added for "browser based spell check". That was part of version 1.1.0

    In particular I need to know what to do so that I get Greek spelling check inside Appian editors.

    What needs to be done at the browser level? (install a dictionary? install any browser plugin?) Can you please elaborate?

  • Release Notes - v1.2.1
    • Fixed a bug in Placeholder parameter
  • Release Notes - v1.2.0
    • 'enableExportPdf’ parameter is added to enable or disable the ‘Export PDF’ option
    • Placeholder parameter is updated to hold multiple values.
    • Formatting is maintained when we paste the content into the editor.
  • Hi,

    We found a bug in the rich text editor component: The "undo" button in the component does not appear to save the new rich text value into saveInto variable. While in the interface the most recent change does seem to be undone when the "undo" button is clicked, it does not save the new value into the variable we are saving to.

    Steps to reproduce:

    1. Input some text to the rich text editor component
    2. Click "Undo" arrow button
    3. The most recent change was undone
    4. However, when inspecting the variable that was saved to, it remained the same as before the "Undo" button is clicked (i.e. there is a discrepancy between what we see on the interface and the value of the variable we save to)

    Thanks.

  • Hi

    We are using getContentService() method to store the uploaded document to the Appian. Since Connected System Java API doesn't have an API yet to store and retrieve the Appian documents, we are using the deprecated API from Appian Public Java APIs.

    Thanks.

  • Hi,

    Thanks for providing this as a plugin and we try to use this for the use case to edit comments and highlight values.

    Observed that after 21.1,we receive a notification on health check as below,

    Advanced Rich Text Editor (com.vuram.advancedrichtexteditor.csp) references deprecated Appian APIs
    [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getContentService(com.appiancorp.services.ServiceContext)

    Could you please help me understand the error or any information will be much helpful

  • Hi,
    are you able to elaborate if you are going to consider adding the 'requiredMessage' parameter to your Component in
    the next release? 

    We would like to request an enhancement: Adding the parameter 'requiredMessage' to the component.
    Doing so would achieve full compatibility with the Paragraph field.

    requiredMessage (Text)Custom message to display when the field's value is required and not provided.

  • Hi team,

    We utilise this plugin on our application.  We would like to include images (.png / .jpeg etc) images within the rich text editor.

    Whilst there is the ability to add these via your connected system, it is my understanding that the image will only render if the recipient has access to our application.  Please let me know if I am incorrect.

    Is the ability to simply copy and paste an image into the rich text editor is on your roadmap, and that the image will render if the recipient is not an application user?

    If you have any questions, please let me know.

    Cheers,

    Bernie

  • v1.1.4 Release Notes
    • Fixed the bug that when the editor loads for the 1st time, whether passing in anything (valid HTML, text) to richTextValue via local variable or rule input, the editor does not display the value.
  • We would like to request an enhancement: Adding the parameter 'requiredMessage' to the component.
    Doing so would achieve full compatibility with the Paragraph field.

    requiredMessage (Text): Custom message to display when the field's value is required and not provided.

    Thanks for consideration in the next release. Would help us a lot.