= Table Configuration Settings =
[[TOC]]

  - '''TO BE COMPLETED'''

== CRUD ==

=== General ===

These options affect all interactive CRUD functions:

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''insertable''||whether new records can be inserted into the table||boolean|| ||
||''editable''||whether records in the table can be edited||boolean|| ||
||''deletable''||whether records in the table can be deleted||boolean|| ||
=== Forms ===

These options are relevant for CRUD forms:

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''subheadings''||Subheadings to insert into CRUD forms||structure|| ||
||''mark_required''||Enforce fields to be marked as required in forms||list of field names|| ||
||''onvalidation''||Hook to validate records||function|| ||
||''create_onvalidation''||Hook to validate new records (overrides onvalidation for create)||function|| ||
||''update_onvalidation''||Hook to validate record updates (overrides onvalidation for update)||function|| ||
||''onaccept''||Hook to perform post-commit actions||function|| ||
||''create_onaccept''||Hook to perform post-commit actions for new records (overrides onaccept for create)||function|| ||
||''update_onaccept''||Hook to perform post-commit actions for record updates (overrides onaccept for update)||function|| ||
||''create_next''||target for redirection after successful create||URL|| ||
||''update_next''||target for redirection after successful update||URL|| ||
||''post_process''||post-process hook for old {{{EmbeddedComponentWidget}}} (no longer used)||function|| ||
=== Data Tables / Data Lists ===

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''list_fields''||fields to show in data tables / lists||list of field names|| ||
||''linkto''||URL to link the ID column in data tables to (usually overridden by s3.actions)||URL|| ||
||''linkto_update''||URL to link the ID column in data tables to (overrides linkto if the user is permitted to update)||URL|| ||
||''extra_fields''||fields to be loaded regardless whether they are in list_fields or not (e.g. because they are needed for virtual fields)||list of field names|| ||
||''listadd''||whether to provide an embedded create-form in data table views||boolean|| ||
||''addbtn''|||| || ||
||''list_layout''||card renderer for data lists||function or class|| ||
||''orderby''||default orderby for data tables/lists||expression|| ||
||''list_orderby''||default orderby for data lists (overrides orderby for data lists)||expression|| ||
=== Delete ===

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''delete_next''||target for redirection after delete||URL|| ||
||''ondelete_cascade''||Hook to perform cascade actions before delete||function|| ||
||''ondelete''||Hook to perform post-delete actions||function|| ||

== Super-Entities ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''super_entity''||Set tablename of Super-Entity table||String||[wiki:S3/S3Model/SuperEntities Super-Entities]||
||''%s_fields''||Define field mapping for Super-Entity||Dict||[wiki:S3/S3Model/SuperEntities#DefininganInstanceofaSuper-Entity Defining a Super-Entity Instance]||

== Auth ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''realm_components''|| || || ||
||''realm_entity''|| || || ||
||''owner_group''|| || || ||
||''update_realm''|| || || ||

== Filter ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''context''|| || || ||
||''filter_advanced''|| || || ||
||''filter_widgets''|| || || ||
||''filter_widgets''|| || || ||
||''filter_clear''|| || || ||
||''filter_formstyle''|| || || ||
||''filter_submit''|| || || ||

== Timeplot ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''timeplot_options''|| || || ||

== PDF/XLS Exports ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''report_hide_comments''|| || || ||
||''report_filename''|| || || ||
||''report_formname''|| || || ||
||''report_groupby''|| || || ||

== Pivot Table Reports ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''report_fields''|| || || ||
||''report_options''|| || || ||
||''report_advanced''|| || || ||
||''report_submit''|| || || ||
||''report_formstyle''|| || || ||

== Saved Filters / Notifications ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''notify_fields''|| || || ||
||''notify_renderer''|| || || ||
||''notify_subject''|| || || ||
||''notify_template''|| || || ||
||''filter_actions''|| || || ||

== Mapping ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''map_advanced''|| || || ||
||''map_submit''|| || || ||
||''marker_fn''|| || || ||
||''popup_edit_url''|| || || ||
||''popup_url''|| || || ||

== Hierarchy ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''hierarchy''|| || || ||

== Record Merger ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''referenced_by''|| || || ||

== Messaging ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''msg_recipient_type''|| || || ||
||''msg_contact_method''|| || || ||

== Profile Pages ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''profile_widgets''|| || || ||
||''profile_layers''|| || || ||
||''profile_cols''|| || || ||
||''profile_title''|| || || ||
||''profile_header''|| || || ||

== Record Approval ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''requires_approval''|| || || ||
||''onapprove''|| || || ||
||''onreject''|| || || ||

== XML/JSON Exports ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''xml_post_render''|| || || ||

== Imports ==

||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =||
||''oncommit_import_item''|| || || ||
||''onconflict''|| || || ||
||''xml_post_parse''|| || || ||
||''deduplicate''|| || || ||