Loading...

Activity Feed

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.3 +
activity-feed-widget

The Portal Connector Activity feed widget allow you to display activities from CRM on a form in your Sitefinity site. These can be any (or all) of the standard activities that come with CRM as well as custom activities created in CRM. Activities can be added, edited, deleted and filtered from the list.

activity-feed

Configuration

Required Entities

The Activity Feed widget depends on several CRM entities being added to The Portal Connector. If you are only intending on using the Activity Feed without any ability to add or edit activities, the only required entity is Activity (activitypointer). 

If you intend to allow adding and/or activities, you may need to add the following entities depending on which ones you want to add/edit:

  • Appointment
  • Email
  • Fax
  • Letter
  • Phone Call
  • Task

In addition to the above list, you may need to add any custom activity type entities you want to support. Custom activity entities are fully supported. 

Basic


Make sure you have a CRM Form Configuration and a TPC Form Layout already attached and configured.
Drag and drop the Activity Feed widget from The Portal Connector tools into the TPC Form Layout and click edit to display the properties prompt.

On the Basic tab, you can configure the following:

  • Title: The title displayed on the form.
  • Add Mode / Edit Mode: How the activity will be added or edited.
    • DifferentPage: The form will open another page and return to this one after successful submission.
    • Popup: The form will open in a modal window on the current page and close after successful submission.
  • Primary Activity Type: The activity type that will be shown on the 'Add New' button. All others will be in the dropdown.
  • Hidden: The activity feed widget will be hidden. You can use the Rules Manager or custom JavaScript to show is as needed.
  • Is Filterable: Enables a dropdown with a checklist of activity types on the form used for filtering of the activities feed.
 

Appearance

On the Appearance tab, individual Activity types are configured as well as the number of activities displayed per page. You can also configure the following:

  • Use Icon: The default option for displaying an icon next to each activity. Selectin this option will expose a field containing the CSS classes that will be applied.
  • Use Image: Selecting this option will expels an image picker allowing you to select an image for the Sitefinity Imager Library to use as the activity icon. Because images will be scaled down, it is recommended that you use an image of the exact size needed (42px by 42px).
  • Allow Creating: Checking this option exposes a page picker to select a page where you have configured a form for creating activities of this type. The activity will appear in the Add dropdown button. Only activities with this checked and correctly configured will appear in the button.
  • Allow Editing: As with Allow Creating, this option exposes a page picker to select a page where you have configured a form for editing activities of this type. An edit button will appear under the activity icon.
  • Allow Deleting: Checking this option will cause a Delete button to appear under the activity icon.
  • Render as HTML: Selecting this option will treat the description field on the activity as HTML. This option is selected by default on the Email activity type but is available for all activity types. This allows custom activity types to use an HTML field and have it render correctly.

Widget Properties

Basic Properties

Title

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

IsHidden

Allows you to hide the widget when this property is set to true

IsFilterable

Enable filtering 

Hide Title

You can hide the title by setting the property value to true

PageSize

You can set the how many records to show in the page by updating this property.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

CharacterLength

The number of characters displayed before the rest is hidden behind a "More" link

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.

Title

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

IsHidden

Allows you to hide the widget when this property is set to true

IsFilterable

Enable filtering 

Hide Title

You can hide the title by setting the property value to true

PageSize

You can set the how many records to show in the page by updating this property.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

CharacterLength

The number of characters displayed before the rest is hidden behind a "More" link

API

toggle()

Toggles the visibility of the widget on the form.

Returns

None

get_addButton()

Returns the add button element associated with the widget.

Returns

jQuery Object     

enable()

Enables the widget on the form.

Returns

None

get_container()

Returns the container element of the widget.     

Returns

jQuery Object   

hide()

Hides the widget from the form.

Returns

None

get_input()

Returns the input of the widget.

Returns

jQuery Object

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_type()

Returns the widget type.

Returns

String

readonly()

Sets the widget state to read only.

Returns

None

get_windowPlaceholder()

Returns the Kendo Window place holder.

Returns

jQuery Object     

get_pager()

Returns the Kendo Pager Object of the widget.

Returns

Kendo Object: kendo.ui.Pager

show()

Shows the widget on the form.

Returns

None

get_model()

Returns the model object of the widget, which contains several useful properties related to the widget.

Returns

Object

get_pagerInput()

Returns the input element of the Kendo Pager Object associated with the widget.

Returns

jQuery Object

get_viewTemplate()

Returns the view template of the widget.

Returns

jQuery Object  

get_kendoWindow()

Returns the Kendo Window Object of the widget (add/edit set to popup window).     

Returns

Kendo Object: kendo.ui.Window

get_listView()

Returns the Kendo ListView Object.     

Returns

Kendo Object: kendo.ui.ListView

set_value()

Sets the value of the widget.

Returns

None

disable()

Disables the widget on the form.

Returns

None

get_type()

Returns the widget type.

Returns

String

Full API With Examples

Examples of Activity Feed Configuration