RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.
Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
notelogo
The CRM Notes widget is used for viewing, editing, and deleting notes attached to a particular, retrieved record. This widget can be configured to allow users to add, edit, and delete notes as well as allow file attachments to be uploaded. 

Configuration

Basic Setup

  1. From the Portal Connector widget list, click and drag the CRM Notes widget into the body of your form.

  2. The CRM Notes widget has a variety of options that you can configure. Click on the edit button to display the prompt, which should look like this: 

    CRM Notes Properties 3.0

Appearance 

When you are finished configuring the Basic settings of the widget, click on the Appearance tab. The prompt should look like this: 

Notes Appearance Properties

Attachments 

hen you are finished configuring the Appearance settings of the widget, click on the Attachments tab. The prompt should look like this:

 Notes Attachments Properties

    When you are finished configuring the widget, click the save button to save it.


    When you are finished configuring the widget, click the save button to save it.

Widget Properties

Basic Properties

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Allow Uploading Attachments

The Allow Uploading Attachments checkbox will allow users to add attachments to a widget in the form of a file upload.

Allow Downloading Attachments

The Allow Downloading Attachments checkbox will allow users to download attachments.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

Max Notes

The Max Notes text box allows you to set the amount of notes that are allowed to be visible at once. The default of zero means that all notes will be retrieved and shown. If there are more notes than the maximum number of allowed notes, the notes widget will be ordered by last modified.

Height

The Height property determines the height of the widget element in pixels.

Prefix Filter

The Prefix Filter option allows you to filter notes by prefix with the option of including or disregarding notes that belong to a particular prefix. For example, you might have a set of notes with the prefix of ‘Bug’ to keep track of bugs. This means that every single note will be prefixed with 'Bug' by default. The List of Filters text box will allow you to enter as many prefixes as you would desire, each one separated by a semi-colon (Bug;Feature;Change). The Hide Prefix checkbox will allow you to hide the prefix from the title of each note.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Adding Notes - notes

The Allow Adding Notes checkbox allows the user to add a note about a particular, retrieved record.

Allow Editing Notes

The Allow Editing Notes checkbox allows the user to edit existing notes about a particular record.

Allow Deleting Notes

The Allow Deleting Notes checkbox allows the user to delete an existing note about a particular record.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Select a Template

The Select a Template drop down list will allow you to select a template for your product to use with the option of creating a new template. If a template is selected, you will be given the additional option of editing the selected template.

Allow Uploading Attachments

The Allow Uploading Attachments checkbox will allow users to add attachments to a widget in the form of a file upload.

Allow Downloading Attachments

The Allow Downloading Attachments checkbox will allow users to download attachments.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

Max Notes

The Max Notes text box allows you to set the amount of notes that are allowed to be visible at once. The default of zero means that all notes will be retrieved and shown. If there are more notes than the maximum number of allowed notes, the notes widget will be ordered by last modified.

Height

The Height property determines the height of the widget element in pixels.

Prefix Filter

The Prefix Filter option allows you to filter notes by prefix with the option of including or disregarding notes that belong to a particular prefix. For example, you might have a set of notes with the prefix of ‘Bug’ to keep track of bugs. This means that every single note will be prefixed with 'Bug' by default. The List of Filters text box will allow you to enter as many prefixes as you would desire, each one separated by a semi-colon (Bug;Feature;Change). The Hide Prefix checkbox will allow you to hide the prefix from the title of each note.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Adding Notes - notes

The Allow Adding Notes checkbox allows the user to add a note about a particular, retrieved record.

Allow Editing Notes

The Allow Editing Notes checkbox allows the user to edit existing notes about a particular record.

Allow Deleting Notes

The Allow Deleting Notes checkbox allows the user to delete an existing note about a particular record.

API

get_dataFieldName()

Returns developer name for the control.

Returns

String