admin.rst

Admin Integration

To allow viewing previous model versions on the Django admin site, inherit from the simple_history.admin.SimpleHistoryAdmin class when registering your model with the admin site.

This will replace the history object page on the admin site and allow viewing and reverting to previous model versions. Changes made in admin change forms will also accurately note the user who made the change.

Clicking on an object presents the option to revert to that version of the object.

(The object is reverted to the selected state)

Reversions like this are added to the history.

An example of admin integration for the Poll and Choice models:

from django.contrib import admin
from simple_history.admin import SimpleHistoryAdmin
from .models import Poll, Choice

admin.site.register(Poll, SimpleHistoryAdmin)
admin.site.register(Choice, SimpleHistoryAdmin)

Changing a history-tracked model from the admin interface will automatically record the user who made the change (see /user_tracking).

Displaying custom columns in the admin history list view

By default, the history log displays one line per change containing

• a link to the detail of the object at that point in time
• the date and time the object was changed
• a comment corresponding to the change
• the author of the change

You can add other columns (for example the object's status to see how it evolved) by adding a history_list_display array of fields to the admin class

from django.contrib import admin
from simple_history.admin import SimpleHistoryAdmin
from .models import Poll, Choice


class PollHistoryAdmin(SimpleHistoryAdmin):
    list_display = ["id", "name", "status"]
    history_list_display = ["status"]
    search_fields = ['name', 'user__username']

admin.site.register(Poll, PollHistoryAdmin)
admin.site.register(Choice, SimpleHistoryAdmin)

Disabling the option to revert an object

By default, an object can be reverted to its previous version. To disable this option globally, update your settings with the following:

SIMPLE_HISTORY_REVERT_DISABLED = True

When SIMPLE_HISTORY_REVERT_DISABLED is set to True, the revert button is removed from the form.

Enforcing history model permissions in Admin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To make the Django admin site evaluate history model permissions explicitly, update your settings with the following:

SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS = True

By default, SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS is set to False. When set to False, permissions applied to the Poll model (from the examples above), also apply to the history model. That is, granting view and change permissions to the Poll model implicitly grants view and change permissions to the Poll history model.

The user below has view and change permissions to the Poll model and the Poll history model in admin.

user.user_permissions.clear()
user.user_permissions.add(
    Permission.objects.get(codename="view_poll"),
    Permission.objects.get(codename="change_poll"),
)

The user below has view permission to the Poll model and the Poll history model in admin.

user.user_permissions.clear()
user.user_permissions.add(
    Permission.objects.get(codename="view_poll"),
)

When SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS is set to True, permissions to history models are assigned and evaluated explicitly.

The user below does not have view permission to the Poll history model in admin, even though they have view permission to the Poll model.

# SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS = True in settings
user.user_permissions.clear()
user.user_permissions.add(
    Permission.objects.get(codename="view_poll"),
)

The user below has view permission to the Poll model and the Poll history model.

# SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS = True in settings
user.user_permissions.clear()
user.user_permissions.add(
    Permission.objects.get(codename="view_poll"),
    Permission.objects.get(codename="view_historicalpoll"),
)

The user below has view permission to the Poll history model, but will need to access the page with a direct URL, since the Poll model will not be listed on the admin application index page, nor the Poll changelist.

# SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS = True in settings
user.user_permissions.clear()
user.user_permissions.add(
    Permission.objects.get(codename="view_historicalpoll"),
)