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. |
FunctionCopy link to clipboard
a!eventData( recordType, filters, timestamp, user, eventTypeName, details, recordTypeForTag, recordIdentifier, comment, allowUsersToComment, baseRecordIdForComment, allowUsersToReply )
This function determines the event data to display for a single record type in the Event History List component.
See also: Configure Record Events
ParametersCopy link to clipboard
Name | Keyword | Types | Description |
---|---|---|---|
Record Type |
|
Record Type |
A reference to a record type, configured using the |
Filters |
|
Any Type |
A single logical expression or a list of query filters, which are applied together with an |
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 |
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 |
Event Type Name |
|
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 |
Additional 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 |
Record Type for Tag |
|
Record Type |
The record type linked in the tag for an event. |
Record Identifier for Tag |
|
Record Field |
The record identifier that links your Event History record type to your base record type. |
Comment |
|
Record Field |
A record field of type Text that displays the comment. If you generated an Event History record type, use the |
Allow users to add comments |
|
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 will be stored in the |
Base Record Id for Comment |
|
Any Type |
The identifier that will link a comment to a specific record in the base record type. For example, if you are displaying events about orders, this parameter should reference the identifier of the specific order the comment is about. The identifier must be the same data type as the primary key field in the base record type. For more information, see allow users to collaboration |
Allow users to reply |
|
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 will be stored in the |
Usage considerationsCopy link to clipboard
Where to use this functionCopy link to clipboard
This function can only be used to configure the Event History List component. For the fastest configuration, we recommend using design mode to configure this component.
Recommended record typesCopy link to clipboard
You can select any record type in the recordType parameter, but this function works best when you select 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 those generated fields to the parameters in this function.
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. To configure this function to display the order event history, you'd select the following fields:
Parameter | Example Event History Record Field |
---|---|
timestamp | recordType!Order Event History.fields.timestamp |
user | recordType!Order Event History.fields.user |
eventTypeLookup | recordType!Order Event History.relationships.eventType.fields.name |
Then, if you are logging the specific automation type that completed an event, you could use the following expression in the details parameter to show which type of automation completed the order:
1
2
3
4
5
if(
isNullOrEmpty(recordType!Order Event History.fields.user),
a!automationType(recordType!Order Event History.fields.automationId) & " completed this order.",
{}
)
Copy
ExamplesCopy link to clipboard
See the Event History List component for examples using this function.
Feature compatibilityCopy link to clipboard
The table below lists this component's compatibility with various features in Appian.
Feature | Compatibility | Note |
---|---|---|
Portals | Incompatible | |
Offline Mobile | 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. |