Micro-applications for content and data storage
An example of a fully-configured space
space:configure
Job and remains consistent throughout the Space’s lifecycle (though you can change it via the API at any time). This ensures all data imported into the Space follows the same structure and validation rules you’ve defined.
App settings with Spaces named "Projects"
space:configure
Job for you to configure the Space. In your job listener, you can create workbooks, sheets, and actions, as well as configure the Space’s theme and metadata. This workbook and sheet configuration defines your Space’s Blueprint - the data schema that controls how your data should look, behave, and connect.
ack
to acknowledge the job, update
to update the job’s progress, and complete
or fail
to complete or fail the job.As in other places throughout the documentation, you could use the Job Handler plugin to handle the job lifecycle for you. This may be useful if you have a particularly complex space configuration with custom logic, but don’t need complete control over the job’s entire lifecycle.However, for most implementations, we recommend using the Space Configure plugin. This plugin takes care of even more of the heavy lifting for you; not only does it handle the Job lifecycle, but it also takes care of all of the API calls necessary to configure the Space and create its Workbooks and documents.With this plugin, you can configure your entire space with a single configuration object rather than perforing any API calls.For example, this listener implementation configures a space with a Blueprint containing two workbooks and a Welcome Guide document – both defined in another file – as well as adding some light theming: