The Barbican

A barbican (from Old French: barbacane) is a fortified outpost or gateway, such as an outer defense of a city or castle, or any tower situated over a gate or bridge which was used for defensive purposes.

The Barbican decides what a given user can read or write from/to a document. The following constraints apply:

  • Documents can only be read when they have a Form item and the form item is configured in keepconfig to be accessible
  • Only the fields that are configured can be created, read or updated
  • Exception: if NO fields are configured, all fields on the form are accessible. It is recommended as best practice to define fields, because this constitutes the schema for the document at this mode, and a warning will be logged to the console if not set. On write access, this ensures unexpected fields are not submitted.
  • Items in the document are not accessible when there is no matching field on the form or no field configured in the keepconfig

Field Access in Barbican

The Barbican functions effectively as the Schema definition for the KEEP API

Reading documents

Reading documents in Barbican

Updating documents

Updating documents in Barbican

Creating documents

Creating documents in Barbican

Further readings

Check the pages on the Admin GUI and the Tutorial