Existing Users

Documentation

Dashboard / Managing Data Schema

Developers of a site can use our easy Schema Manager to add / edit the data fields available in their site. A collection of fields is called a 'schema' and you can manage the schema of a page or module by using the 'manage schema' link at the top right of the editing window. Please note: you must be a 'developer' of a site to use this feature.

To add a new field, click the Add a New Field link. The fields are also sortable -- this is strictly for display purposes. At this time, there are the following field types, with more added as we develop them:

  • Short Text
  • Long Text (Plain)
  • Long Text (Rich)
  • Image
  • Option
  • List

Most of these types are flexible and interchangeable because they are all stored ultimately as text, with the important exception of the "List" type. This type creates a List Module inside of another module, which allows site editors to add items to a list with a common data schema.

Field Key corresponds to the unique identifier used for the field you're adding. This key should have no spaces or special characters, as it is used in the API to wrap the data for that field in a unique node.

Field Display Title is the string used in the Dashboard tool to identify the field for editing. This is strictly for display only, is completely optional, and should be descriptive when confusion might exist about what the data in the field represents.

Field Type is perhaps the most important setting for a field. This not only defines the types of data to be stored, but it also defines the interface in which users will edit that data. The field types are listed above, at the beginning of this document.

Is Label is a special designation for one field per module / list. This tells the Dashboard which field to use when referring to the module. This is particularly important for lists of data, where items need to be listed.

Details are only available currently for the Option field type. This space will be used for defining further details about a field. For example, this is where you define the list of options to appear in an Option dropdown. Instructions will be available, per field type, when details are needed.

About BitsyBox

BitsyBox is a hosted content storage platform that offers two products that work in perfect harmony. The first is an easy-to-use web interface that lets site owners edit and update their content. The second is a robust API for developers to quickly access that content from their website or application code.

Resources

We've fully documented BitsyBox to make it easy -- so easy in fact, we guarantee you can integrate a new or existing website in just a few minutes. More Support

Screencasts

Check out our library of streaming videos, professionally produced to help guide you through your integration with BitsyBox.
View Screencasts

© Copyright 2009 BitsyBox LLC - Terms of Service - Privacy - Service Status