Module Documentation: eml-protocol
Back to EML Contents
The EML Protocol Module is used to describe methods and identify the proccesses that have been used to define / improve the quality of a data file, also used to identify potential problems with the data file.

Element Definitions:

eml-protocol
Content of this field: Description of this field:
Elements: Required?: How many:
A sequence of (
identifierOptionalMultiple Times
protocolOptionalMultiple Times
)
Attributes: Required?: Default Value:

Tooltip:
EML Protocol
Summary:
A set of fields that contains method, processing, and quality control information.
Description:
eml-protocol is a set of fields that contains method, processing, and quality control information. It may consist of paragraphs of descriptive text that describes the methods to be employed, or optionally references to literature citations that do the same. Likewise, descriptions of pre and post processing of data files may be described within.
Example:
Please see the examples for the sub-fields.
Lineage:
Derived from EML 1.4: eml-status, and eml-quality modules.
identifier
Content of this field: Description of this field:
Elements: Required?: How many:
Attributes: Required?: Default Value:

Tooltip:
Unique identifier
Summary:
The unique identifier of this metadata file or object.
Description:
The identifier field provides a unique identifier for this metadata documentation. It will most likely be part of a sequence of numbers or letters that are meaningful in a larger context, such as a metadata catalog. That larger system can be identified in the "system" attribute. Multiple identifiers can be listed corresponding to different catalog systems.
Example:
<identifier system="metacat">nceas.3.2</identifier>
Lineage:
The 'identifier' field is derived from the eml-dataset meta_file_id filed in EML 1.4.
method
Content of this field: Description of this field:
Elements: Required?: How many:
A sequence of (
paragraphOptionalMultiple Times
lit:citationOptionalMultiple Times
)
Attributes: Required?: Default Value:

Tooltip:
method information
Summary:
Information about the methods employed in collecting or generating a data set or other resource.
Description:
The method field allows for repeated paragraphs of text that describe the methodology for a project, experiment, or particular data table. Likewise, a literature citation may be provided that describes the methodology that was employed.
Example:
<paragraph> 1.Collect tissues from algae of interest. </paragraph> <paragraph> a.We are currently collecting Egregia menziezii, Mazzaella splendens, M. flaccida, Hedophyllum sessile, Postelsia palmaeformis and Fucus gardneri.We stopped collecting Neorhodomela larix and Odonthalia floccosa because they can be heavily fouled and we feared that would skew the results. </paragraph> <paragraph> b.We collect a 7-10 cm blade or branch from each plant. For Egregia, try to sample small, young plants or take the base of the blade. For Postelsia, take a few of the blades. The other plants are small enough so a whole blade can be taken. </paragraph> </paragraph>
Lineage:
Derived from EML 1.4
processingStep
Content of this field: Description of this field:
Elements: Required?: How many:
A sequence of (
paragraphOptionalMultiple Times
lit:citationOptionalMultiple Times
)
Attributes: Required?: Default Value:

Tooltip:
Processing Step
Summary:
Information on pre or post processing actions for a data set.
Description:
Step defines the quality control or quality assurance procedures that were applied to the corresponding data file. For example, a shell-script that 'greps' for an alpha-character within a datafile that is supposed to contain only numeric characters
Example:
<paragraph> 2.Freeze tissues at -20C until they can be dried. Dry tissue in drying oven (60C, at least 24h). </paragraph> <paragraph> Grinding: All glassware and plasticware should be acid washed in 10% HCl. Place dried algal sample in plastic vial with ground glass ball. For very hard to grind tissue such as M. splendens, two balls may be used. Place vials in grinder. Only two vials can go in the mill at one time. Grind for 2-5 minutes. Tissue should be fine powder. Place ground tissue in small screw cap vials and store in drying oven or dessication chamber. </paragraph>
Lineage:
Introduced in EML 2.0
qualityControl
Content of this field: Description of this field:
Elements: Required?: How many:
A sequence of (
paragraphOptionalMultiple Times
lit:citationOptionalMultiple Times
)
Attributes: Required?: Default Value:

Tooltip:
Quality Control
Summary:
Information on possible errors or on the quality of a data set.
Description:
The qualityControl field provides a location for the description of possible errors in a data set, or a description of the quality of the data set based on the the processing steps or methods employed in collecting the data.
Example:
<paragraph> Once the data file is received, verify it's integrity by comparing it's checksum with the pre-calculated MD5 checksum by running the md5 command on the file. If they match, the file transferred correctly. </paragraph>
Lineage:
Introduced in EML 2.0
protocol
Content of this field: Description of this field:
Type: ProtocolType
Attributes: Required?: Default Value:

Tooltip:
Protocol Information
Summary:
A container for methods and protocol-related information
Description:
The protocol field provides a container for other related fields such as methods, processingStep, and qualityControl.
Example:
Please see the examples for the sub-fields.
Lineage:
Introduced in EML 2.0
paragraph
Content of this field: Description of this field:
Type: xs:string
Attributes: Required?: Default Value:

Tooltip:
Paragraph
Summary:
A field for text paragraphs
Description:
The paragraph field is used as a generic field for text. It allows the text to be divided into distinct paragraphs within an EML file.
Example:
Any text, really, could be part of a single paragraph element...Please look at the examples for each of the protocol sub-fields.
Lineage:
Derived from EML 1.3

Attribute Definitions:

system

Type: xs:string

Use: optional

Complex Type Definitions:

ProtocolType
Content of this field: Description of this field:
Elements: Required?: How many:
A sequence of (
methodOptionalMultiple Times
processingStepOptionalMultiple Times
qualityControlOptionalMultiple Times
)
Attributes: Required?: Default Value:

Tooltip:
ProtocolType
Summary:
A reusable container for protocol-related information
Description:
The ProtocolType container defines a number of reusable fields that can be referenced from multiple EML modules.
Example:
Please see the examples for the sub-fields.
Lineage:
Introduced in EML 2.0

Simple Type Definitions:

Web Contact: jones@nceas.ucsb.edu