Working with the Template Library Tool

March 2013

Some best practices when designing and constructing/editing a template

  • Consider how other people might conceivably use an attribute
  • Use general attribute names - don't name things "1a, 1b," etc. Those are often very specific to a particular field form.
  • For domain lists, think carefully about whether it will make sense for individual templates to define their own sets of values.
    • If something like "highway", then allow templates to add/remove values
    • If using a standard set of codes that have real business meaning, then not allowing modifications may be more desirable
  • If developing a template for data collection via the handheld tool for which you would potentially use Kestrel as your future database, please review the section pertaining to compatability with Kestrel to ensure a streamlined import process which accommodates all of your data. The handheld system can accommodate many more cases (ie. headings, aliases, ...) which are not supported within Kestrel and therefore special consideration for Kestrel limitations should be made.

Submit a new/edited template(s)

Once you have finalized your template (whether new or edited), submit a ticket within Kestrel Technical Support, identifying the Application as Kestrel and the Component as Template Library Tool. Include the name and version of the template as well as a list of newly created or edited Attributes.


Questions?

Submit any questions you have about the tool or the template(s) you have created to Kestrel Technical Support, identifying the Application as Kestrel and the Component as Template Library Tool.


Report bugs, suggest feature requests, enhancements,?

Submit information on any bugs or problems you encounter, along with suggestions for new features or feature enhancements to Kestrel Technical Support, identifying the Application as Kestrel and the Component as Template Library Tool.


Compatibility with Kestrel

(NOTE: This applies only to those Kestrel clients wishing to use a new/revised template within the Kestrel online observation data entry tool)

To ensure a template can be used with Kestrel

  • The template's record type must be Observation
  • The template cannot contain subforms
  • The template cannot contain headings
  • The first five attributes must be, in order:
    • Species (NatureServe)
    • Observation Date (NatureServe)
    • Location (NatureServe)
    • Primary Observer (NatureServe)
    • Sensitive (NatureServe)
  • The five attributes listed above must be required
    • Edit the template
    • Click the binoculars icon next to the attribute
    • Select Yes from the Required dropdown list
  • All attribute references must support comments
    • Edit the template
    • Click the binoculars icon next to the attribute
    • Select Yes from the Comments? dropdown list
  • The "Taxa Present" property of the template must be set to "Present"
    • Edit the template
    • Select the main form
    • Click the binoculars icon of the Selected Form
    • Select Present from the Taxa Present dropdown list
  • If appropriate for your agency (ie. French translation for Parks Canada Agency) translations must be provided, within the attribute record, for the attribute name, help text, and domain values for new attributes as well as reflecting updates to existing attributes.
  • Attributes that have a data type of "Reference" can only reference Person records
  • Attributes with a data type of Date are not supported in Kestrel. Use the Date/Time and Date/Time Range data types instead.
  • Included attributes can only use the supported validation rules which include: numeric range, max days beyond today (date), e-mail string pattern, domain values
  • Additional validation rules cannot be specified by the template. For example, a template cannot add, remove, or modify domain values.
  • Any customizations made to an attribute's help text or label within the template will be ignored and any headings will be ignored

Submit a new/edited template(s)

Once you have finalized your template (whether new or edited), submit a ticket within Kestrel Technical Support, identifying the Application as Kestrel and the Component as Template Library Tool. Include the name and version of the template as well as a list of newly created or edited Attributes.