Manual:
Shepherd Project Administration
The Administer menu offers site managers and programmers some additional features and detailed information about the software. Many of the options on this menu are powerful features that affect many records in your database. It is recommended that you limit access to the features to trusted visitors to your site.
The following options appear on the Administer menu.
General Administration
This menu item allows access to the following options.
- Restore a deleted encounter.
- Update email address of Submitter or Photographer Across the Entire Library
- Swap old location code for new across all encounters
- Expose all approved encounters to the GBIF.
- Logs
- Set the location code for all encounters matching a string
- Set Inform Others for all encounters matching a string
These options are described in the sections that follow.
Restore a deleted encounter
To restore a deleted encounter, follow these steps:
- Choose Administer ⇒ General.
- Enter the ID of a deleted encounter into the Encounter Number field of the Restore a Deleted Encounter option.
- Click Restore.
Update email addresses across the Shepherd Project library
This option allows you to make a library-wide change to an email address of a submitter or photographer. This is useful when individuals change email addresses but still want to be kept updated of animal re-sightings.
- Enter the email address to change in the Old Email Address field. Only email addresses exactly matching the entry in this field are modified.
- Enter the new email address in the New Email Address field.
- Click Update.
Swap old location code for new across all encounters
This option allows you to make a library-wide change to a location code in all encounter records.
- Enter the location code to change in the Old Location Code. Only location codes exactly matching the entry in this field are modified.
- Enter the new location code in the New Location Code field.
- Click Update.
Expose all approved encounters to the GBIF
Click Expose to GBIF to expose all approved encounters to the Global Biodiversity Information Facility (GBIF).
The GBIF was established in 2001 to encourage free and open access to biodiversity data through the Internet.
Global Biodiversity Information Facility Home PageBy default, approved encounters are exposed to GBIF if you have properly configured a TapirLink or IPT provider to the database underlying your Shepherd Project instance.
Logs
The Shepherd Project Logs feature is under development. Site administrators should refer to the logging features of the J2EE container on which they have the Shepherd Project installed. For example, with Tomcat, Shepherd outputs issues to catalina.out. This may be different for other containers.
Set Inform Others for all encounters matching a string
This option lets you set one or more email addresses into the Others to Inform field of an encounter.
Enter a string in the Test String to Match field. The Shepherd Project adds the email addresses in the Inform Others email addresses to assign field to any encounter record that includes the matching string in any of these fields:
- Submitter Name
- Submitter email address
- Photographer Name
- Photographer email address
Note that this is a fuzzy match, so the string Robert will match with any of these records:
- Robert James
- Roberta Muldoon
- Robin Roberts
- researcher5@BrobertCorp.com.
Grid Administration
TBD
Photo Keywords
The option Administer ⇒ Photo Keywords allows you to add, delete, and modify keywords for images in your library. These keywords can be used to search for specific images. The following section describes all of these functions in detail.
KeywordsManaging individual animal adoptions
You can allow visitors to your site to adopt animals identified in your database. By adopting an animal, they can be provided with updates on the animal's status, notifications of additional sightings, and other information.
To enable adoptions on your site, set the allowAdoptions field in commonConfiguration.properties to TRUE.
#whether to display and allow adoptions - set to true for yes and false for no allowAdoptions = true
When you set the allowAdoptions parameter, to TRUE, the Shepherd Project displays the Allow Adoptions menu under Administration.
View All Adoptions
If you choose Administration ⇒ Adoptions ⇒ View All Adoptions, a table of active adoptions displays.
The adoptions table contains the information described in the following table.
| Field | Description |
|---|---|
| Thumbnail | The first column always shows a thumbnail picture of the creator of the adoption record. |
| Number | The adoption ID. This is a unique ID created when you add the adoption to the library. |
| Name | Name of the user adopting an animal. |
| Type | By default, the Shepherd Project supports three types: promotional, individual adoption, and group adoption, corporate adoption. |
| Adopted | This is a marked individual ID for an animal in your database. |
| Start Date | The starting date of the adoption period. |
| End Date | The ending date of the adoption period. Adoptions can have no end date, which means they are open ended. |
Create / Edit Adoption
If you choose Create / Edit Adoption from the Administer menu, you can add an adoption through the Create Adoption form. The following table describes the fields in the Create Adoption form.
| Field | Description |
|---|---|
| Name | Name of the user adopting an animal. |
A valid email address for the adopter. You can enter multiple emails delimited by commas, as shown in the following figure.
|
|
| image | By default, the Shepherd Project supports three types: promotional, individual adoption, and group adoption, corporate adoption. |
| Adopter quote | This is a marked individual ID for an animal in your database. |
| Marked Individual | This is a marked individual ID for an animal in your database. |
| Encounter | This is an encounter ID for an animal in your database. |
| Adoption Type | By default, the Shepherd Project supports these types:< promotional, individual adoption, and group adoption, corporate adoption. |
| Adoption Manager | By default, this is the login user name of the creator of the adoption record. |
| Adoption Start Date | The starting date of the adoption period. |
| Adoption End Date | The ending date of the adoption period. Adoptions can have no end date, which means they are open ended. |
| Adoption Notes | This is any arbitrary information describing this adoption. |
Restore a Deleted Adoption
Enter the adoption id of the deleted adoption, then click Submit.
JavaDoc
Javadoc describes all the classes and interfaces in the Shepherd Project Programming Interface. The Shepherd API allows Java programmers to customize, extend and enhance the functions in the Shepherd Project application framework.
Manual:




