Activity formatter

The activity formatter provides an easy way to track items not saved with a field in the record, for example, journal fields like comments and work notes.

The activity formatter is enabled by default on the Task [task] table and other tables that extend the Task table, such as the Incident [incident] table. It is also enabled on the Approvals [sysapproval_approver] table.

You can filter the content that appears on the activity formatter and participate in the record feeds on the record. You can create an activity formatter for any form and configure properties that control what fields appear in the formatter.

In UI16, the activity formatter shows updates in real time so you can see the latest information without refreshing the form. User presence enables you to see when other users are entering comments.

Figure 1. UI16 activity formatter
UI16 activity formatter
Figure 2. UI11 activity formatter
UI11 activity formatter

Create an activity formatter

You can create an activity formatter for any audited table.

Before you begin

Role required: admin

Procedure

  1. Navigate to System UI > Formatters.
  2. Click New.
  3. Enter a name for the formatter, such as Activities (task).
  4. Select a Table.
  5. Enter activity.xml in the Formatter field.
  6. Leave the Type as Formatter.
  7. Click Submit.

Result

Note: You can create more than one activity formatter for a table, however, the system does not allow you to add more than one activity formatter to a form.

What to do next

Add the new activity formatter to forms as needed.

Add the activity formatter to a form

Add an activity formatter to any form to track journal fields on the form.

Before you begin

Role required: personalize_form

Procedure

  1. Verify that the table associated with the form is audited.
  2. Configure the form layout to add Activities (filtered).

Enable the Live Feed-Activity toggle

The Live Feed-Activity toggle allows users to switch between the activity feed and the document feed for a record.

Before you begin

Role required: admin

About this task

Use live feed to interact with other users on a record by posting messages and adding attachments to the feed. Use the activity formatter to see an overall summary of activity for the record.

Figure 3. Live Feed/Activity toggle
Live Feed/Activity toggle
  • The glide.ui.show_live_feed_activity property is enabled. Navigate to Collaborate > Feed Administration > Properties and enable the Toggle the display of the live feed tab in the activity formatter option.

Procedure

  1. Verify that the live feed and record feed plugins are active.
  2. View the form to ensure that the activity formatter is visible. If not, configure the form to add it.
  3. Set the live_feed dictionary attribute to true on the form.
    This action adds live feed to the activity formatter.
  4. Complete the following steps to enable the system property.
    1. Navigate to Collaborate > Feed Administration > Properties.
    2. Enable the Toggle the display of the live feed tab in the activity formatter option (glide.ui.show_live_feed_activity property).

Customize activities

You can customize which fields appear in the activity formatter. You can add or remove fields from the list of activities that users can select when they open the activity filter.

Before you begin

Role required: personalize_form

About this task

Figure 4. Customize the fields that appear in the activity filter
Customize the fields that appear in the activity filter

Procedure

  1. Perform the appropriate action for your version of the UI:
    UI16
    1. Click the activity filter icon (Toggle activity filter icon).
    2. At the bottom of the list, click Configure available fields.
    UI15 or UI11 Right-click the Activity header and select Configure Activities.
  2. In the slushbucket, select the desired fields in the Available column and move them to the Selected column.
    The activities appear in alphabetical order, regardless of the order in the Selected column.
    Note: In UI16, Configure available fields is responsible for the order of the Additional Comments and Work Notes fields.
  3. Click Save to add them to the activity formatter and the filter.

What to do next

Administrators can also modify the system property Incident activity formatter fields(glide.ui.incident_activity.fields). Access this property through System Properties > UI Properties. The system automatically synchronizes the values in the system property and the selections you made.

Configure the email property for activity formatter

The system property glide.ui.activity.email_roles enables you to control which roles can see emails in the activity formatter.

Before you begin

Role required: admin

About this task

In the activity formatter, users see activity only for fields they have permission to read. For example, self-service users might see the activity formatter on the self-service view of the Incident form, but they do not see work notes, unless security rules have been customized to allow this.

If the Sent/Received Emails field is included in the activities list, all users see all emails. No determination is made whether an end user, for example, should see an email containing work notes. Configure this property to restrict this capability to specified roles.

Note: Email does not appear as an activity until it is sent. If email properties are not configured for outbound delivery, the message can be found by navigating to System Mailboxes > Outbox.

Procedure

  1. Navigate to System Properties > UI Properties.
  2. Locate the property labeled List of roles (comma separated) that can view emails in the Activity Formatter when "Sent/Received Emails" are included.
  3. Add roles to the property, separated by commas.
    These are the only roles that can see email in the activity formatter. All other roles are prevented from seeing email. If no roles are listed, all users can see email. The itil role is on the list by default.
  4. Click Save.

Configure the max activity size property

Use the glide.max_activity_size property to increase the amount of content that can be visible in the Activity Formatter.

Before you begin

Role required: admin

About this task

The default size for an activity is 100 * 1024, which causes large amounts of content to be hidden in the Activity Formatter. You can change the default value by adding the glide.max_activity_size property.

Procedure

  1. Type sys_properties.list in the Application Navigator.
  2. Click New and enter the following values.
    Field Description
    Name glide.max_activity_size
    Type integer
    Value 102400

    Use this field to increase the number of content allowed in the Activity Formatter. This value should be in bytes, for example 100 * 1024, or 102400.