wiki:S3

Version 66 (modified by Dominic König, 8 years ago) ( diff )

--

S3 API Guide

This page links to all wiki pages describing how to make use of the S3 framework when developing Eden modules or other applications connecting to Eden via web services.

External links:

Authentication, Authorization, Accounting

Logging

RESTful API

API

Framework

Core Classes

Configuration

Deployment Settings

deployment_settings

Configure

A lot of configuration options are stored as key/value pairs against the tablename using:

s3db.configure(tablename, key=value)

These values can be read using:

value = s3db.get_config(tablename, "key")

These settings may have defaults defined within the core models (modules/s3db/*.py) or default controllers (controllers/*.py) - possibly conditional based on the values of deployment_settings or which method is being invoked.

Settings can also be customised within the customise_*_resource() or customise_*_controller() functions within a Template.

The value can be a simple string, a complex object or sometimes a generator function.

Example settings include:

  • list_fields
    • which fields get displayed as columns in datatables (& currently which are read from the database for use in datalist renderers, but this should change soon as we migrate to S3DataListLayout())
  • filter_widgets
  • report_options
    • the axes & other options to configure S3Report for both standalone /report pages & widgets e.g. in Summary views.
  • orderby
    • The default sort order for datatables & datalists (datalists can specify list_orderby if they wish this to be different from that used by datables)

NB If the value is a complex object, then customising this doesn't require re-storing the value as the object is edited in-place.

See Also

Context

Database

Models

Export/Import

Subscriptions and Notifications

GUI

Pages

Tables and Lists

Reports

Filter Forms

CRUD Forms

Form Widgets

GIS/Mapping

Overview

Location Tracking

Related BluePrints


DeveloperGuidelines

Note: See TracWiki for help on using the wiki.