Projects in BatteryDB
Projects are a simple but effective tool for grouping batteries, devices, and tests together in a way that will allow easy retrieval of all the items inside that project.
First Create your new Project
-
Creating a project is done in the same way as creating any other object
- See here for a full tutorial on creating objects
-
The only required field for creating a Project is to give it a unique name, something clear with explicit boundaries for what is included is best
-
Projects also have an optional notes field, which is a free form text box that support markdown for the addition of any other information or details you wish to include in your project
Attaching Projects to Batteries, Devices, and Tests
-
Now that we have created a Project we can use it when creating or editing other objects and attach the project to them
-
On eligible create and edit forms you will see the projects menu, which looks like a scroll down list of all the project names. You can select as few or as many of them as you would like.
- multiple selection looks different on every device, in general you can use ctr+click or command+click for windows and mac respectively
-
Once the object is saved you will be able to filter by project and easily group all these items together
Sorting By Project
-
After all the relevant items have been attached to a project you can easily sort them using the project drop down in any of the list views to only display objects linked to that project
-
The usefulness of projects shines in particular when using the REST API which will allow you to make complicated queries much simpler by using the project filter when calling the API
- For more information regarding the REST API see here: Access the REST API