= 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''||whether to show a button for adding a record to the table||boolean|| || ||''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 (or tuple of strings)||[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''||Defines realm to be updated when realm_entity field is updated||List of strings||[wiki:S3/S3AAA/OrgAuth OrgAuth]|| ||''realm_entity''||Function to determine realm_entity field (unless a global function has been defined)||function returning a pe_id||[wiki:S3/S3AAA/OrgAuth OrgAuth]|| ||''owner_group''|| || || || ||''update_realm''||Determines whether the realm of the entity should be updated when table is modified||Boolean||[wiki:S3/S3AAA/OrgAuth OrgAuth]|| == Filter == ||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =|| ||''context''||Adds filters according to links to other tables||Dict||[wiki:S3/Context Context]|| ||''filter_advanced''||Adds a button to show more/less filter options||Boolean, or list/tuple of label and button class|| || ||''filter_widgets''||Defines filters to be displayed for the table||List of instances of S3 Filters|| || ||''filter_clear''||Adds an action-link to clear the filter (False by default)||Boolean, or list/tuple of label and button class|| || ||''filter_formstyle''||Provides a custom formstyle for a !FilterForm||Function returning a DIV instance|| || ||''filter_submit''||Specifies label and class of button||Tuple||[http://getbootstrap.com/css/#buttons Bootstrap button classes]|| == Timeplot == ||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =|| ||''timeplot_options''||Dictionary of options for timeplot||Dict||[wiki:BluePrint/TimePlot Blueprint]|| == PDF/XLS Exports == ||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =|| ||''report_hide_comments''||Whether comments fields are hidden (default is False)||Boolean|| || ||''report_filename''|| || || || ||''report_formname''|| || || || ||''report_groupby''||Group the records by their values in this field (default is None)||String (field name)|| || == Pivot Table Reports == ||= '''Option''' =||= '''Short Description''' =||= '''Value''' =||= '''See Also''' =|| ||''report_fields''||Pivot table reports will be offered for the fields listed here||List of Strings (of field names) or of Tuples of (label, field name)|| || ||''report_options''||Storage of: rows, cols, fact, methods and defaults||Storage|| || ||''report_advanced''||Adds a button to hide/show report options (default True)||Boolean, or List/Tuple of label and button class|| || ||''report_submit''||Determines whether to update filters automatically, or require a submit button (default False)||Boolean|| || ||''report_formstyle''||Sets formstyle for the report table||Boolean|| || == 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''||Determines whether to use a toggle for more/less options for the filters||Boolean, or list/tuple with labels and optional button class|| || ||''map_submit''||Determines whether to require a submit action to apply filters||Boolean, or list/tuple with labels/button class|| || ||''marker_fn''||Custom marker to be added to records in the resource for the map||Function taking record as argument|| || ||''popup_edit_url''|| ||URL instance|| || ||''popup_url''|| ||URL instance|| || == 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''|| || || ||