Closes #14591: Saved table configurations (#19101)

* Add SavedTableConfig

* Update table configuration logic to support TableConfigs

* Update table config link when updating table

* Correct docstring

* Misc cleanup

* Use multi-select widgets for column selection

* Return null config params for tables with no model

* Fix auto-selection of selected columns

* Update migration

* Clean up template

* Enforce enabled/shared flags

* Search/filter by table name

* Misc cleanup

* Fix population of selected columns

* Ordering field should not be required

* Enable cloning for TableConfig

* Misc cleanup

* Add model documentation for TableConfig

* Drop slug field from TableConfig

* Improve TableConfig validation

* Remove add button from TableConfig list view

* Fix ordering validation to account for leading hyphens

Author: jeremystretch

docs/models/extras/tableconfig.md

@@ -0,0 +1,43 @@
+# Table Configs
+
+This object represents the saved configuration of an object table in NetBox. Table configs can be crafted, saved, and shared among users to apply specific views within object lists. Each table config can specify which table columns to display, the order in which to display them, and which columns are used for sorting.
+
+For example, you might wish to create a table config for the devices list to assist in inventory tasks. This view might show the device name, location, serial number, and asset tag, but omit operational details like IP addresses. Once applied, this table config can be saved for reuse in future audits.
+
+## Fields
+
+### Name
+
+A human-friendly name for the table config.
+
+### User
+
+The user to which this filter belongs. The current user will be assigned automatically when saving a table config via the UI, and cannot be changed.
+
+### Object Type
+
+The type of NetBox object to which the table config pertains.
+
+### Table
+
+The name of the specific table to which the table config pertains. (Some NetBox object use multiple tables.)
+
+### Weight
+
+A numeric weight used to influence the order in which table configs are listed. Table configs with a lower weight will be listed before those with a higher weight. Table configs having the same weight will be ordered alphabetically.
+
+### Enabled
+
+Determines whether this table config can be used. Disabled table configs will not appear as options in the UI, however they will be included in API results.
+
+### Shared
+
+Determines whether this table config is intended for use by all users or only its owner. Note that deselecting this option does **not** hide the table config from other users; it is merely excluded from the list of available table configs in UI object list views.
+
+### Ordering
+
+A list of column names by which the table is to be ordered. If left blank, the table's default ordering will be used.
+
+### Columns
+
+A list of columns to be displayed in the table. The table will render these columns in the order they appear in the list. At least one column must be selected.

mkdocs.yml

@@ -233,6 +233,7 @@ nav:
             - NotificationGroup: 'models/extras/notificationgroup.md'
             - SavedFilter: 'models/extras/savedfilter.md'
             - Subscription: 'models/extras/subscription.md'
+            - TableConfig: 'models/extras/tableconfig.md'
             - Tag: 'models/extras/tag.md'
             - Webhook: 'models/extras/webhook.md'
         - IPAM:

netbox/extras/api/serializers.py

@@ -12,4 +12,5 @@
 from .serializers_.configtemplates import *
 from .serializers_.savedfilters import *
 from .serializers_.scripts import *
+from .serializers_.tableconfigs import *
 from .serializers_.tags import *

netbox/extras/api/serializers_/tableconfigs.py

@@ -0,0 +1,22 @@
+from core.models import ObjectType
+from extras.models import TableConfig
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import ValidatedModelSerializer
+
+__all__ = (
+    'TableConfigSerializer',
+)
+
+
+class TableConfigSerializer(ValidatedModelSerializer):
+    object_type = ContentTypeField(
+        queryset=ObjectType.objects.all()
+    )
+
+    class Meta:
+        model = TableConfig
+        fields = [
+            'id', 'url', 'display_url', 'display', 'object_type', 'table', 'name', 'description', 'user', 'weight',
+            'enabled', 'shared', 'columns', 'ordering', 'created', 'last_updated',
+        ]
+        brief_fields = ('id', 'url', 'display', 'name', 'description', 'object_type', 'table')

netbox/extras/api/urls.py

@@ -14,6 +14,7 @@
 router.register('custom-links', views.CustomLinkViewSet)
 router.register('export-templates', views.ExportTemplateViewSet)
 router.register('saved-filters', views.SavedFilterViewSet)
+router.register('table-configs', views.TableConfigViewSet)
 router.register('bookmarks', views.BookmarkViewSet)
 router.register('notifications', views.NotificationViewSet)
 router.register('notification-groups', views.NotificationGroupViewSet)

netbox/extras/api/views.py

@@ -131,6 +131,17 @@ class SavedFilterViewSet(NetBoxModelViewSet):
     filterset_class = filtersets.SavedFilterFilterSet
 
 
+#
+# Table Configs
+#
+
+class TableConfigViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = TableConfig.objects.all()
+    serializer_class = serializers.TableConfigSerializer
+    filterset_class = filtersets.TableConfigFilterSet
+
+
 #
 # Bookmarks
 #

netbox/extras/filtersets.py

@@ -32,6 +32,7 @@
     'ObjectTypeFilterSet',
     'SavedFilterFilterSet',
     'ScriptFilterSet',
+    'TableConfigFilterSet',
     'TagFilterSet',
     'TaggedItemFilterSet',
     'WebhookFilterSet',
@@ -326,6 +327,59 @@ def _usable(self, queryset, name, value):
         return queryset.filter(Q(enabled=False) | Q(Q(shared=False) & ~Q(user=user)))
 
 
+class TableConfigFilterSet(ChangeLoggedModelFilterSet):
+    q = django_filters.CharFilter(
+        method='search',
+        label=_('Search'),
+    )
+    object_type_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=ObjectType.objects.all(),
+        field_name='object_type'
+    )
+    object_type = ContentTypeFilter(
+        field_name='object_type'
+    )
+    user_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=User.objects.all(),
+        label=_('User (ID)'),
+    )
+    user = django_filters.ModelMultipleChoiceFilter(
+        field_name='user__username',
+        queryset=User.objects.all(),
+        to_field_name='username',
+        label=_('User (name)'),
+    )
+    usable = django_filters.BooleanFilter(
+        method='_usable'
+    )
+
+    class Meta:
+        model = TableConfig
+        fields = ('id', 'name', 'description', 'table', 'enabled', 'shared', 'weight')
+
+    def search(self, queryset, name, value):
+        if not value.strip():
+            return queryset
+        return queryset.filter(
+            Q(name__icontains=value) |
+            Q(description__icontains=value) |
+            Q(table__icontains=value)
+        )
+
+    def _usable(self, queryset, name, value):
+        """
+        Return only TableConfigs that are both enabled and are shared (or belong to the current user).
+        """
+        user = self.request.user if self.request else None
+        if not user or user.is_anonymous:
+            if value:
+                return queryset.filter(enabled=True, shared=True)
+            return queryset.filter(Q(enabled=False) | Q(shared=False))
+        if value:
+            return queryset.filter(enabled=True).filter(Q(shared=True) | Q(user=user))
+        return queryset.filter(Q(enabled=False) | Q(Q(shared=False) & ~Q(user=user)))
+
+
 class BookmarkFilterSet(BaseFilterSet):
     created = django_filters.DateTimeFilter()
     object_type_id = MultiValueNumberFilter()

netbox/extras/forms/bulk_edit.py

@@ -21,6 +21,7 @@
     'JournalEntryBulkEditForm',
     'NotificationGroupBulkEditForm',
     'SavedFilterBulkEditForm',
+    'TableConfigBulkEditForm',
     'TagBulkEditForm',
     'WebhookBulkEditForm',
 )
@@ -201,6 +202,34 @@ class SavedFilterBulkEditForm(BulkEditForm):
     nullable_fields = ('description',)
 
 
+class TableConfigBulkEditForm(BulkEditForm):
+    pk = forms.ModelMultipleChoiceField(
+        queryset=TableConfig.objects.all(),
+        widget=forms.MultipleHiddenInput
+    )
+    description = forms.CharField(
+        label=_('Description'),
+        max_length=200,
+        required=False
+    )
+    weight = forms.IntegerField(
+        label=_('Weight'),
+        required=False
+    )
+    enabled = forms.NullBooleanField(
+        label=_('Enabled'),
+        required=False,
+        widget=BulkEditNullBooleanSelect()
+    )
+    shared = forms.NullBooleanField(
+        label=_('Shared'),
+        required=False,
+        widget=BulkEditNullBooleanSelect()
+    )
+
+    nullable_fields = ('description',)
+
+
 class WebhookBulkEditForm(NetBoxModelBulkEditForm):
     model = Webhook
 

netbox/extras/forms/filtersets.py

@@ -31,6 +31,7 @@
     'LocalConfigContextFilterForm',
     'NotificationGroupFilterForm',
     'SavedFilterFilterForm',
+    'TableConfigFilterForm',
     'TagFilterForm',
     'WebhookFilterForm',
 )
@@ -249,6 +250,36 @@ class SavedFilterFilterForm(SavedFiltersMixin, FilterForm):
     )
 
 
+class TableConfigFilterForm(SavedFiltersMixin, FilterForm):
+    fieldsets = (
+        FieldSet('q', 'filter_id'),
+        FieldSet('object_type_id', 'enabled', 'shared', 'weight', name=_('Attributes')),
+    )
+    object_type_id = ContentTypeMultipleChoiceField(
+        label=_('Object types'),
+        queryset=ObjectType.objects.public(),
+        required=False
+    )
+    enabled = forms.NullBooleanField(
+        label=_('Enabled'),
+        required=False,
+        widget=forms.Select(
+            choices=BOOLEAN_WITH_BLANK_CHOICES
+        )
+    )
+    shared = forms.NullBooleanField(
+        label=_('Shared'),
+        required=False,
+        widget=forms.Select(
+            choices=BOOLEAN_WITH_BLANK_CHOICES
+        )
+    )
+    weight = forms.IntegerField(
+        label=_('Weight'),
+        required=False
+    )
+
+
 class WebhookFilterForm(NetBoxModelFilterSetForm):
     model = Webhook
     fieldsets = (

netbox/extras/forms/model_forms.py

@@ -2,6 +2,7 @@
 import re
 
 from django import forms
+from django.contrib.postgres.forms import SimpleArrayField
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
@@ -21,6 +22,7 @@
 )
 from utilities.forms.rendering import FieldSet, ObjectAttribute
 from utilities.forms.widgets import ChoicesWidget, HTMXSelect
+from utilities.tables import get_table_for_model
 from virtualization.models import Cluster, ClusterGroup, ClusterType
 
 __all__ = (
@@ -37,6 +39,7 @@
     'NotificationGroupForm',
     'SavedFilterForm',
     'SubscriptionForm',
+    'TableConfigForm',
     'TagForm',
     'WebhookForm',
 )
@@ -301,6 +304,65 @@ def __init__(self, *args, initial=None, **kwargs):
         super().__init__(*args, initial=initial, **kwargs)
 
 
+class TableConfigForm(forms.ModelForm):
+    object_type = ContentTypeChoiceField(
+        label=_('Object type'),
+        queryset=ObjectType.objects.all()
+    )
+    ordering = SimpleArrayField(
+        base_field=forms.CharField(),
+        required=False,
+        label=_('Ordering'),
+        help_text=_(
+            "Enter a comma-separated list of column names. Prepend a name with a hyphen to reverse the order."
+        )
+    )
+    available_columns = SimpleArrayField(
+        base_field=forms.CharField(),
+        required=False,
+        widget=forms.SelectMultiple(
+            attrs={'size': 10, 'class': 'form-select'}
+        ),
+        label=_('Available Columns')
+    )
+    columns = SimpleArrayField(
+        base_field=forms.CharField(),
+        widget=forms.SelectMultiple(
+            attrs={'size': 10, 'class': 'form-select select-all'}
+        ),
+        label=_('Selected Columns')
+    )
+
+    class Meta:
+        model = TableConfig
+        exclude = ('user',)
+
+    def __init__(self, data=None, *args, **kwargs):
+        super().__init__(data, *args, **kwargs)
+
+        object_type = ObjectType.objects.get(pk=get_field_value(self, 'object_type'))
+        model = object_type.model_class()
+        table_name = get_field_value(self, 'table')
+        table_class = get_table_for_model(model, table_name)
+        table = table_class([])
+
+        if columns := self._get_columns():
+            table._set_columns(columns)
+
+        # Initialize columns field based on table attributes
+        self.fields['available_columns'].widget.choices = table.available_columns
+        self.fields['columns'].widget.choices = table.selected_columns
+
+    def _get_columns(self):
+        if self.is_bound and (columns := self.data.getlist('columns')):
+            return columns
+        if 'columns' in self.initial:
+            columns = self.get_initial_for_field(self.fields['columns'], 'columns')
+            return columns.split(',') if type(columns) is str else columns
+        if self.instance is not None:
+            return self.instance.columns
+
+
 class BookmarkForm(forms.ModelForm):
     object_type = ContentTypeChoiceField(
         label=_('Object type'),

netbox/extras/graphql/filters.py

@@ -34,6 +34,7 @@
     'JournalEntryFilter',
     'NotificationGroupFilter',
     'SavedFilterFilter',
+    'TableConfigFilter',
     'TagFilter',
     'WebhookFilter',
 )
@@ -262,6 +263,19 @@ class SavedFilterFilter(BaseObjectTypeFilterMixin, ChangeLogFilterMixin):
     )
 
 
+@strawberry_django.filter(models.TableConfig, lookups=True)
+class TableConfigFilter(BaseObjectTypeFilterMixin, ChangeLogFilterMixin):
+    name: FilterLookup[str] | None = strawberry_django.filter_field()
+    description: FilterLookup[str] | None = strawberry_django.filter_field()
+    user: Annotated['UserFilter', strawberry.lazy('users.graphql.filters')] | None = strawberry_django.filter_field()
+    user_id: ID | None = strawberry_django.filter_field()
+    weight: Annotated['IntegerLookup', strawberry.lazy('netbox.graphql.filter_lookups')] | None = (
+        strawberry_django.filter_field()
+    )
+    enabled: FilterLookup[bool] | None = strawberry_django.filter_field()
+    shared: FilterLookup[bool] | None = strawberry_django.filter_field()
+
+
 @strawberry_django.filter(models.Tag, lookups=True)
 class TagFilter(BaseObjectTypeFilterMixin, ChangeLogFilterMixin, TagBaseFilterMixin):
     color: Annotated['ColorEnum', strawberry.lazy('netbox.graphql.enums')] | None = strawberry_django.filter_field()

netbox/extras/graphql/schema.py

@@ -32,6 +32,9 @@ class ExtrasQuery:
     saved_filter: SavedFilterType = strawberry_django.field()
     saved_filter_list: List[SavedFilterType] = strawberry_django.field()
 
+    table_config: TableConfigType = strawberry_django.field()
+    table_config_list: List[TableConfigType] = strawberry_django.field()
+
     journal_entry: JournalEntryType = strawberry_django.field()
     journal_entry_list: List[JournalEntryType] = strawberry_django.field()