Skip to content

User Activity Configuration

The platform records everything users do in a complete audit trail. This page covers the lists that organise that activity log, including the update reasons staff pick when they make a change. See User Management for how the log is used day to day.

Every login, record change and bill generation is recorded in the user activity log with a timestamp and details, so you can investigate issues and demonstrate compliance. The two lists below classify those entries. The log is also available through the User Activity Log API.

An activity type categorises what a user did, such as Login, Customer Update, Bill Generation or Payment Received. Types let you filter the log and spot patterns, and they are colour-coded in reports for quick scanning.

This section defines the name and display characteristics of the activity type, including the type name, display class for styling, and position for ordering in lists.

FieldDescription
TypeName of the activity type
Type Display ClassCSS class name used for styling this activity type in displays
Type Display PositionNumeric position for ordering this activity type in sorted lists

This section defines what type of activities this activity type represents, such as creation, modification, approval, or other database operations, along with security and integration settings.

FieldDescription
Create ActivityWhether this activity type represents the creation of new records
Modification ActivityWhether this activity type represents the modification of existing records
Drop ActivityWhether this activity type represents the dropping (deactivation) of records
Reinstate ActivityWhether this activity type represents the reinstatement (reactivation) of records
Delete ActivityWhether this activity type represents the permanent deletion of records
Approval ActivityWhether this activity type represents the approval of records or transactions
Unapproval ActivityWhether this activity type represents the removal of approval from records or transactions
Reallocation ActivityWhether this activity type represents the reallocation of resources or assignments
Collection ActivityWhether this activity type represents payment collection activities
Cancellation ActivityWhether this activity type represents the cancellation of services or transactions
DPO Restricted
Security Rate Limited
Queue WebhookWhether to queue webhook notifications when activities of this type are logged

This section controls how and where this activity type is displayed in the user interface, including display duration, visibility settings, and data retention policies.

FieldDescription
Retain For Days
Display For DaysNumber of days to display this activity type in recent activity lists
Always DisplayWhether to always display this activity type regardless of other display settings
Display on LinkedWhether to display this activity type when showing activities for linked records
HiddenWhether this activity type is hidden from normal users; only super users can see hidden types

An activity reason is a standard explanation staff choose when they make a change, such as “Customer requested change”, “Correcting billing error” or “Account review”. Recording the Update Reason consistently makes patterns clear and shows auditors that changes are properly justified. Set up reasons that match your processes and compliance needs.

Basic identification information for this activity reason.

No fields defined for this section.

Name and display settings for this activity reason.

FieldDescription
ReasonThe name of this activity reason
Reason Display ClassCSS class for styling this reason in the interface
Reason Display PositionDisplay order position for this reason in lists

Availability settings controlling when this reason can be used.

FieldDescription
OnObject types this reason is valid for
On ActionsSpecific actions this reason is valid for
For Expert Mode OnlyWhether this reason is only available in expert mode

Additional configuration for reason requirements.

FieldDescription
Require ReasonWhether additional reason text is required when using this reason
Require Reason (Expert Mode)Whether additional reason text is required in expert mode
Is CreateWhether this reason is flagged as a create action
Is ModificationWhether this reason is flagged as a modification action
Is DropWhether this reason is flagged as a drop action
Is ReinstateWhether this reason is flagged as a reinstate action
Is DeleteWhether this reason is flagged as a delete action
Is ApprovalWhether this reason is flagged as an approval action
Is UnapprovalWhether this reason is flagged as an unapproval action
Is ReallocationWhether this reason is flagged as a reallocation action
Is CollectionWhether this reason is flagged as a collection action
Is CancellationWhether this reason is flagged as a cancellation action
Queue WebhookWhether using this reason queues the related webhook

Need a complete, well-organised audit trail for compliance? see how SAFE Billing Platform tracks every change