contents   previous   next

1.4  Creating a new catalog step by step

This example shows how to create a new catalog, step by step. The catalog will contain records of three different types for holding data about experiments, protocols, and samples. There will be three distinct classes called "Experiments", "Protocols" and "Samples", and can be any number of records of each class.

This example is relevant if you'd like to use Catalyzer as an electronic notebook for gathering structured information - it also introduces the underlying concepts of Catalyzer.


Catalyzer operates in two modes - Catalog editing mode and Class editing mode. Catalog editing mode is for changing the content of the catalog; class editing mode is for changing the structure. You can switch between modes using the View>Catalog and View>Class main menu options, or the buttons on the toolbar. The section on switching Catalog modes has more details.

  1. Start by creating an empty catalog File>New

    Start with an empty catalog


  2. This catalog is going to contain details of Experiments, Protocols and Samples, so start by creating separate folders for these. right-click (CTRL-click on Mac) on the root folder, and Add Using Class>Folder:-

    Add a folder


    Rename the folder as Experiments (double-click on name)


  3. Add extra folders for Samples and Protocols. You can either do this as before (right-click : Add), or you can just press Enter again after typing in the Experiments name to add an extra folder.

    Three folders


  4. The next step is to tell Catalyzer what information is relevant to include about Experiments, Samples and Protocols. The specification of what is needed for each type of record is called a Class in Catalyzer. Switch to the Class Window to add/edit classes.

    Switching to the Class Window


    Switching to the Class Window using the toolbar


  5. Compared with the Catalog Window, the Class Window has two additional panes; at the bottom left is a list of Classes (initially just Folder and Record), and on the right hand side is the Field Details Panel, containing details of an individual field of a class.

    The Class window


  6. To add the Classes for Experiment, Sample and Protocol, click the Add.pngAdd button in the Classes list (or select Add from the right-click menu).

    Adding a new class


    Renaming the new class


    You can add the other classes (Protocol and Sample) by pressing Enter after you've renamed the first.

    Added all three classes


  7. The next step is to add the Fields for the classes. Select the Experiment class in the list, and then add a field using the middle panel Add.png Add button.

    Adding a field to the Experiment class


    Adding and renaming fields in the Experiment class


    Add as many fields as you need to record the relevant information for a single experiment.
  8. Repeat the process to add fields to Protocol and Sample classes (Select the class in the Classes list at the bottom left, add fields using the Add.png button on the middle panel, and set the field name on the right hand panel). If you want to have multi-line entry for a field, change the field type to "Text Box":-

    Set the Field Type to 'Text Box' to add a multi-line description field


    For Samples, you might want to keep track of their location (perhaps room, freezer, shelf). There could be a restricted choice of different rooms. In this case you can simplify the data entry process by converting the room field to a Radio Buttons push button:

    Setting up the Sample class. Initially the Field Type is 'Text'


    Switching the Field Type to 'Radio Buttons' lets you create a menu of buttons


  9. Having created the necessary classes, you can now start adding some different Experiment, Protocol and Sample records to the catalog. First, switch back to Catalog mode.

    Switching back to Catalog Editing Mode


  10. To add an Experiment to the Experiments folder, use right-click Add Using Class>Experiment

    Add an Experiment to the Experiments folder


    Once you have added a record, you can enter data for the fields you created:-

    Adding details for an Experiment


    If you need to change fields, return to the Class Window and add/remove them.
  11. You can add entries for the different Samples and Protocols in the same way.

    This Sample record specifies the room and supplier


  12. It is often useful to make links between records. For example, there could be a link to a Protocol from each Experiment record. To do this, switch back to the Class window and add a field of type Reference to class Protocol.

    Adding a Protocol reference from the Experiment


    Clicking on the browse button (highlighted below) shows a reference chooser which lets you select the target protocol:

    Selecting the protocol for an experiment


    Clicking the "+" button next to the reference expands it inline, so you can see the details for the protocol next to the experiment:

    The experiment record linked to its protocol


  13. It is also useful to link to data files and documents. This can be done with the Resource field type. For example, to add a link to a Word document describing a protocol:

    The protocol record linked to a document



Once you have created a number of useful classes (such as the Experiment, Sample and Protocol classes described above), you can reuse them in multiple catalogs. Existing classes can be imported into a new catalog by selecting File>Import>Classes and types from the main File menu.