wiki:S3

Context Navigation

Version 60 (modified by Fran Boon, 11 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:

S3 API Documentation (Epydocs)

Sahana Eden Essential Guide (book):

Authentication, Authorization, Accounting

Authentication, Authorization, Accounting
- OrgAuth
- Record Approval

Logging

S3Log

RESTful API

API

Generating XML Forms (XForms)

Framework

Implementing RESTful Controllers (s3_rest_controller)
Extending the RESTful API by implementing S3Method

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
- which S3FilterWidgets are displayed on datatable, datalist and Summary views.
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)