Event Data Component

On This Page

SAIL Design System guidance available for Event History List

The event history list component should allow users to see all relevant event data at a glance. Check out the design guidance page to learn how to display your data in a structured, easy-to-scan layout to help your users find what they need.

Function

a!eventData( recordType, filters, timestamp, user, eventTypeName, details, recordTypeForTag, recordIdentifier, comment, allowUsersToComment, baseRecordIdForComment, allowUsersToReply, notificationUrl )

This function determines the event data to display for a single record type in the Event History List component.

See also: Configure Record Events

Parameters

Name	Keyword	Types	Description
Record Type	recordType	Record Type	A reference to a record type, configured using the `recordType!` domain. For example, `recordType!Order`. If you configured record events, use the Event History record type.
Filters	filters	Any Type	A single logical expression or a list of query filters, which are applied together with an `AND` operation, can be provided to apply additional filters to the record set. Queries also inherit the record-level security or default filters defined on the referenced record type. When filtering, use only record fields or related record fields from the referenced record type. Record types sourced from a web service or other expression only support this parameter if they use optimized data access.
Timestamp	timestamp	Record Field	A record field of type Date and Time, Date, or Time that displays the timestamp when an event occurred. The list of event data will be sorted in descending order by this field. If you generated an Event History record type, use the `timestamp` field from that record type. For example, `recordType!Order Event History.fields.timestamp`.
User	user	Any Type	A record field of type User that displays who completed the event. If you generated an Event History record type, use the `user` field from that record type. For example, `recordType!Order Event History.fields.user`.
Event Type Name	eventTypeName	Any Type	A record field of type Text that displays the type of event that occurred. If you generated an Event Type Lookup record type, use the `eventType` relationship on the Event History record type to select the `name` field. You must use the `fv!data` prefix to access the data in this field. For example, `fv!data[recordType!Order Event History.relationships.eventType.fields.name]`.
Additional Details	details	Text	Any additional information about the event. If you generated an Event History record type, this field is not automatically included, but can be manually added by a developer. You must use the `fv!data` prefix to access the data in this field. For example, `fv!data[recordType!Order Event History.fields.details]`.
Record Type for Tag	recordTypeForTag	Record Type	The record type linked in the tag for an event.
Record Identifier for Tag	recordIdentifier	Record Field	A record field that contains the record identifier associated with each event. This parameter is used to configure the link in a tag. This field is typically the common field used in the relationship between the base record type and event history record type.
Comment	comment	Record Field	A record field of type Text that displays the comment. If you generated an Event History record type, use the `comment` field from that record type. For example, `recordType!Order Event History.fields.comment`.
Allow users to add comments	allowUsersToComment	Boolean	Determines if users can add top-level comments on the component. Top-level comments appear inline with other events and are automatically captured as events in the selected record type. If you selected a generated Event History record type, these comments are stored in the `comment` field. Set eventStyle to `“LIST_WITH_COMMENTS”` to allow users to add top-level comments. Default: `false`.
Base Record Id	baseRecordIdForComment	Any Type	The identifier for a specific record in the base record type that is used to link comments and subscribers to a record. For example, if you are displaying events about orders, this parameter should reference the identifier of the specific order a comment is about or that a user is subscribed to. The identifier must be the same data type as the primary key field in the base record type. For more information, see enable user collaboration.
Allow users to reply	allowUsersToReply	Boolean	Determines if users can start threaded conversations on the component. Comments and replies in threaded conversations will be automatically captured in the Reply Thread record type. If you generated a Reply Thread record type, comments and replies in threaded conversations are stored in the `reply` field. The event history list component can display a maximum of 500 items in each thread. Default: `false`.
Notification URL	notificationUrl	Text	The URL to include in email notifications to users who are subscribed to conversations on an event history list component. Create a URL to the specific record using a!urlForRecord().

Usage considerations

Where to use this function

The a!eventData() function can be used only in the eventData parameter of an Event History List component. A single Event History List component can have up to five a!eventData() functions.

Recommended record types

You can select any record type in the recordType parameter, but the a!eventData() function is specifically meant for an Event History record type that's used in your record events configuration.

If you generated an Event History record type, you can easily map your generated fields to the parameters in a!eventData().

For example, let's say you configured record events on an Order record type by generating an Event History record type and an Event Type Lookup record type. You can configure the a!eventData() function using the fields automatically generated on the event history record types:

...
 eventData: {
      a!eventData(
        recordType: recordType!Order Event History,
        timestamp: recordType!Order Event History.fields.timestamp,
        user: recordType!Order Event History.fields.user,
        eventTypeName: fv!data[recordType!Order Event History.relationships.eventType.fields.eventName],
        details: if(
          isNullOrEmpty(fv!data[recordType!Order Event History.fields.user]),
          a!automationType(fv!data[recordType!Order Event History.fields.automationId]) & " completed this order.",
          {}
        ),
        recordTypeForTag: recordType!Order,
        recordIdentifier: recordType!Order Event History.fields.recordId
      )
    },
...

Examples

See the Event History List component for full examples using this function.

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Incompatible
Offline Interfaces	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling	Incompatible	Cannot be used in autoscaled processes.
Event Consumer Filter Conditions	Compatible	Can be used in filter conditions.
Event Consumer Event Handlers	Compatible	Can be used in event handler expressions.

Feedback

Was this page helpful?