Templates

Overview

You may find you want to reuse content or repeat the structure of your RSpace documents, sometimes many times or with small variations. RSpace provides several ways of reusing elements of work you have done:

  • Templates and Snippets take portions of existing documents and store them as starting points for making new documents
  • Forms define a reusable structure for a document (with no content in the structure), and that structure is used each time a new document is made based on the form. You can create a template from a form-based document to have both a reusable document structure (from the Form), and reusable content (from the Template).

If you are new to RSpace and have been tasked with building workflows for your organization, the overall process typically looks like this:

  1. Create a Form made up of fields arranged in a sequence. Each field corresponds to a step, an event, or data / metadata that needs to be collected.
  2. Use the Form to create an empty RSpace document.
  3. Locate your new document in your Workspace, verify that the fields meet your needs. If necessary, add exemplar content, or additional instructions to the fields. For example, if the workflow will be used to create a sequence of replicate experiments, many of the initial steps may be the same for each replicate, so you can save time by entering default values in some of the fields.
  4. Save the document as a Template.
  5. To distribute the Template to others, locate the Template in your Workspace > Templates area and share as needed with groups or individuals with either read or edit permission.
  6. (Optional) You can use the RSpace digital signature feature to sign the Template to prevent further changes and show that the Template has been approved by one or more lab mates.

In general, we recommend that you use Templates rather than Forms to distribute approved workflows to groups and individuals. Most of the time, a Form is merely an intermediate step.

Templates

Templates are reusable documents that can be used to generate new content quickly and easily when some elements do not change. Templates are made from an existing document, allowing a choice of what to keep from the original.

Creating Templates

From a Document

The quickest way to create a template is from a simple document. In this case you don’t have the option of the different field formats (e.g. dates, multi-choice options) a form offers, but it takes less time.

To create a Template from a document:

  1. Find the document in the Workspace and open it
  1. Click the Save as Template button
  1. A dialogue box will appear asking you to name the Template and which fields you wish to include content from (for a simple document there will only be one field, ‘Data’). Click OK

  1. Your Template will now appear in the Templates folder in your Workspace.

From a Form

Templates may also be created from documents with multiple fields and field types using Forms.

  1. To create a template from a Form, you must first save the Form as a document
  2. Open the document created from a form in RSpace.
  1. At this stage, you may fill the fields of your form-based document that will remain the same between experiments.

  1. Select ‘Save as Template’
  1. You can give your Template a name. In the ‘Include contents from these fields’ section, select the boxes of the fields you have filled in, which will remain constant throughout the experiments (Protocol in this example), and leave fields which vary with each experiment unticked (Notes and Concentration in this example), then click OK.
  1. Your Template will now appear in the ‘Templates’ section of your Workspace.

Creating a Document from a Template

  1. In the Workspace, select Create, then From Template
  1. Search and select the template you want to use, give the new document a name, and click on Create
  1. You will be redirected to your newly created document. You can edit the fields and save as you would normally in a document.


How did we do?


Powered by HelpDocs (opens in a new tab)