Service Discovery (SERF)

From Earth Science Information Partners (ESIP)
Revision as of 14:20, July 8, 2015 by Scgordon (talk | contribs)

The Service Entry Resource Format (SERF) is a NASA documentation dialect for service discovery, selection and usage.

==SERF for Service Discovery - Required==

The Service Entry Resource Format (SERF) is the de-facto GCMD standard for describing data services and applications. This spiral includes the fields that are required by the SERF standard. Additonal documentation is available via the following online references:

Source: Interactive SERF Guide Write a SERF Guide
ConceptDescriptionDialect (Fit) Paths
Metadata IdentifierA phrase or string which uniquely identifies the metadata file/record.DIF /dif:DIF/dif:Entry_Id
SERF /serf:SERF/serf:Entry_ID
ISO /*/gmd:fileIdentifier/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:metadataIdentifier/mcc:MD_Identifier
Resource TitleA short description of the resource. The title should be descriptive enough so that when a user is presented with a list of titles the general content of the data set can be determined.ECS /*/ecs:ShortName > /*/ecs:LongName
ECHO /*/echo:ShortName>/*/echo:LongName
DIF /dif:DIF/dif:Entry_Title
DIF /dif:DIF/dif:Data_Set_Citation/dif:Dataset_Title
SERF /serf:SERF/serf:Entry_Title
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo/fgdc:title
DCAT /dct:title
ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:citation/cit:CI_Citation/cit:title/gco:CharacterString
KeywordA word or phrase that describes some aspect of a resource. Can be one of several types.

Note: The general identification keywords usually have a type of "theme" and are refered to as "theme keywords". Other types and vocabularies are used for other information. Service Entry Resource Format (SERF) requires a Science and a Service GCMD Keyword. This concept is called "Subject" in the CSW Specification.
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:DisciplineKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:TopicKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:TermKeyword
ECS (1) /*/ecs:DisciplineTopicParameters/ecs:VariableKeyword
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:CategoryKeyword
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:TopicKeyword
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:TermKeyword
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:VariableLevel1Keyword/echo:Value
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:VariableLevel2Keyword/echo:Value
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:VariableLevel3Keyword
ECHO (1) /*/echo:ScienceKeywords/echo:ScienceKeyword/echo:DetailedVariableKeyword
DIF (1) /dif:DIF/dif:Parameters/dif:Category
DIF (1) /dif:DIF/dif:Parameters/dif:Topic
DIF (1) /dif:DIF/dif:Parameters/dif:Term
DIF (1) /dif:DIF/dif:Parameters/dif:Variable_Level_1
DIF (1) /dif:DIF/dif:Parameters/dif:Variable_Level_2
DIF (1) /dif:DIF/dif:Parameters/dif:Variable_Level_3
DIF (1) /dif:DIF/dif:Parameters/dif:Detailed_Variable
SERF /serf:SERF/serf:Keyword
FGDC (1) /fgdc:metadata/fgdc:idinfo/fgdc:keywords/fgdc:theme/fgdc:themekey
DCAT /dct:keyword
ISO (1) /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords[gmd:type/gmd:MD_KeywordTypeCode='theme']/gmd:keyword/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:descriptiveKeywords/mri:MD_Keywords[mri:type/mri:MD_KeywordTypeCode='theme']/mri:keyword/gco:CharacterString
Distribution ContactContact information for the organization or individual that distributes the resource.ECS /*/ecs:ArchiveCenter
ECHO /*/echo:ArchiveCenter
DIF /dif:DIF/dif:Data_Center/dif:Personnel/dif:Role
SERF /serf:SERF/serf:Service_Provider
FGDC /fgdc:metadata/fgdc:distinfo/fgdc:distrib/fgdc:cntinfo
DCAT /dct:contactPoint
ISO /gmd:MD_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributorContact/gmd:CI_ResponsibleParty
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributor/mrd:MD_Distributor/mrd:distributorContact/cit:CI_Responsibility
AbstractA paragraph describing the resource.

Note: This concept is called "Desciption" in Catalog Services for the Web.
ECS /*/ecs:CollectionDescription
ECHO /*/echo:Description
DIF /dif:DIF/dif:Summary/dif:Abstract
SERF /serf:SERF/serf:Summary/serf:Abstract
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:descript/fgdc:abstract
DCAT /dct:description
ISO /*/gmd:identificationInfo/*/gmd:abstract/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:abstract/gco:CharacterString
PurposeA paragraph describing the original purpose for collecting the dataset.ECS (1) /*/ecs:SuggestedUsage1
ECHO (1) /*/SuggestedUsage
DIF (1) /dif:DIF/dif:Summary/dif:Purpose
SERF /serf:SERF/serf:Summary/serf:Purpose
FGDC (1) /fgdc:idinfo/fgdc:descript/fgdc:purpose
ISO (1) /*/gmd:identificationInfo/*/gmd:purpose/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:purpose/gco:CharacterString


==SERF for Service Discovery - Highly Recommended==

The Service Entry Resource Format (SERF) is the de-facto GCMD standard for describing data services and applications. This spiral includes the fields that are highly recommended by the SERF standard. Additional documentation is available via the following online references:

Source: Interactive SERF Guide Write a SERF Guide
ConceptDescriptionDialect (Fit) Paths
Resource CitationCitation for the resource.SERF /serf:SERF/serf:Service_Citation
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/mri:citation/cit:CI_Citation
MediaMedia on which the resource is availableDIF /dif:DIF/dif:Distribution/dif:Distribution_Media
SERF /serf:SERF/serf:Distribution/serf:Distribution_Media
FGDC /fgdc:metadata/fgdc:dataqual/fgdc:lineage/fgdc:sinfo/fgdc:type
ISO /gmd:MD_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:transferOptions/gmd:MD_DigitalTransferOptions/gmd:offLine/gmd:MD_Medium/gmd:name/gmd:MD_MediumNameCode/@codeListValue
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:transferOptions/mrd:MD_DigitalTransferOptions/mrd:offLine/mrd:MD_Medium/mrd:name/cit:CI_Citation/cit:title/gco:CharacterString
Resource ContactThe organization or person responsible for answering questions about the resource.ECS /CollectionMetaDataFile/CollectionMetaDataSets/Collections/CollectionMetaData/Contact[Role='User Services']
ECHO /*/echo:Contacts/echo:Contact
DIF /dif:DIF/dif:Personnel[dif:Role='INVESTIGATOR']
DIF /serf:SERF/serf:Personnel[serf:Role='INVESTIGATOR']
SERF /serf:SERF/serf:Personnel
DCAT /dct:contactPoint
ISO /*/gmd:identificationInfo/*/gmd:pointOfContact
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:pointOfContact
Resource Cost or FeesCost associated with access to the resourceECHO /*/echo:Price
DIF /dif:DIF/dif:Distribution/dif:Fees
SERF /serf:SERF/serf:Distribution/serf:Fees
FGDC /fgdc:metadata/fgdc:distinfo/fgdc:distrib/fgdc:storder/fgdc:fees
ISO /*/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributionOrderProcess/gmd:MD_StandardOrderProcess/gmd:fees/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributionFormat/mrd:MD_Format/mrd:formatDistributor/mrd:MD_Distributor/mrd:distributionOrderProcess/mrd:MD_StandardOrderProcess/mrd:fees/gco:CharacterString
Resource FormatThe physical or digital manifestation of the resourceECS /ecs:PrimaryCSDT
ECHO /*/echo:DataFormat
DIF /dif:DIF/dif:Distribution/dif:Distribution_Format
SERF /serf:SERF/serf:Distribution/serf:Distribution_Format
DCAT /dct:format
ISO /*/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributorFormat/gmd:MD_Format/gmd:name/gco:CharacterString
ISO /*/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributionFormat/gmd:MD_Format/gmd:name/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributionFormat/mrd:MD_Format
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributor/mrd:MD_Distributor/mrd:distributorFormat/mrd:MD_Format
Instrument KeywordKeywords that describe the instrument used to collect the resource.ECHO //echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:ShortName
ECHO //echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:LongName
DIF /dif:DIF/dif:Sensor_Name/dif:Short_Name
DIF /dif:DIF/dif:Sensor_Name/dif:Long_Name
SERF /serf:SERF/serf:Sensor_Name/serf:Short_Name
SERF /serf:SERF/serf:Sensor_Name/serf:Long_Name
ISO /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords[gmd:type/gmd:MD_KeywordTypeCode='instrument']/gmd:keyword/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:descriptiveKeywords/mri:MD_Keywords[mri:type/mri:MD_KeywordTypeCode='instrument']/mri:keyword/gco:CharacterString
Resource TitleA short description of the resource. The title should be descriptive enough so that when a user is presented with a list of titles the general content of the data set can be determined.ECS /*/ecs:ShortName > /*/ecs:LongName
ECHO /*/echo:ShortName>/*/echo:LongName
DIF /dif:DIF/dif:Entry_Title
DIF /dif:DIF/dif:Data_Set_Citation/dif:Dataset_Title
SERF /serf:SERF/serf:Entry_Title
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:citation/fgdc:citeinfo/fgdc:title
DCAT /dct:title
ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:citation/cit:CI_Citation/cit:title/gco:CharacterString
Platform KeywordKeywords that describe the platform used to collect the resource.ECS /*/ecs:Platform/ecs:PlatformShortName
ECS /*/ecs:Platform/ecs:PlatformLongName
ECHO //echo:Platforms/echo:Platform/echo:ShortName
ECHO //echo:Platforms/echo:Platform/echo:LongName
SERF /serf:SERF/serf:Source_Name/serf:Short_Name
SERF /serf:SERF/serf:Source_Name/serf:Long_Name
ISO /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords[gmd:type/gmd:MD_KeywordTypeCode='platform']/gmd:keyword/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:descriptiveKeywords/mri:MD_Keywords[mri:type/mri:MD_KeywordTypeCode='platform']/mri:keyword/gco:CharacterString
Resource Quality DescriptionDescription of the quality of the resource or any quality assurance procedures followed in producing the resource.

Note: ISO-1 provides free text fields for describing quality information in the DQ_MeasureReference, DQ_EvaluationMethod, and DQ_DescriptiveResult objects.
DIF /dif:DIF/Quality
SERF /serf:SERF/serf:Quality
Project KeywordKeywords that describe the Project used to collect the resource.SERF /serf:SERF/serf:Project/serf:Short_Name
SERF /serf:SERF/serf:Project/serf:Long_Name
ISO /*/gmd:identificationInfo/*/gmd:descriptiveKeywords/gmd:MD_Keywords[gmd:type/gmd:MD_KeywordTypeCode='project']/gmd:keyword/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:descriptiveKeywords/mri:MD_Keywords[mri:type/mri:MD_KeywordTypeCode='project']/mri:keyword/gco:CharacterString
Resource Access ConstraintsInformation about any constraints for accessing the data set. This includes any special restrictions, legal prerequisites, limitations and/or warnings on obtaining the data set. Some words that may be used in this field include: Public, In-house, Limited, Additional detailed instructions on how to access the data can be entered in this field.ECS /*/ecs:AccessConstraints
ECHO /*/echo:RestrictionFlag
ECHO /*/echo:RestrictionComment
ECHO /*/echo:Visible
DIF /dif:DIF/dif:Access_Constraints
SERF /serf:DIF/serf:Access_Constraints
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:accconst
DCAT /dct:accessLevel
DCAT /dct:accessLevelComment
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:accessConstraints/gco:CharacterString
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:accessConstraints/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:otherConstraints/gco:CharacterString
Resource Use ConstraintsInformation about how the data may or may not be used after access is granted to assure the protection of privacy or intellectual property. This includes any special restrictions, legal prerequisites, terms and conditions, and/or limitations on using the data set. Data providers may request acknowledgement of the data from users and claim no responsibility for quality and completeness of data.ECHO /*/echo:RestrictionFlag
ECHO /*/echo:RestrictionComment
DIF /dif:DIF/dif:Use_Constraints
SERF /serf:DIF/serf:Use_Constraints
FGDC /fgdc:metadata/fgdc:idinfo/fgdc:useconst
DCAT /dct:dataQuality
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_Constraints/gmd:useLimitation/gco:CharacterString
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:useConstraints/gmd:MD_RestrictionCode
ISO /*/gmd:identificationInfo/*/gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_Constraints/mco:useLimitation/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:useConstraints/mco:MD_RestrictionCode
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/*/mri:resourceConstraints/mco:MD_LegalConstraints/mco:otherConstraints/gco:CharacterString
Distribution ContactContact information for the organization or individual that distributes the resource.ECS /*/ecs:ArchiveCenter
ECHO /*/echo:ArchiveCenter
DIF /dif:DIF/dif:Data_Center/dif:Personnel/dif:Role
SERF /serf:SERF/serf:Service_Provider
FGDC /fgdc:metadata/fgdc:distinfo/fgdc:distrib/fgdc:cntinfo
DCAT /dct:contactPoint
ISO /gmd:MD_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:distributor/gmd:MD_Distributor/gmd:distributorContact/gmd:CI_ResponsibleParty
ISO-1 /mdb:MD_Metadata/mdb:distributionInfo/mrd:MD_Distribution/mrd:distributor/mrd:MD_Distributor/mrd:distributorContact/cit:CI_Responsibility
Service LocationEndpoint for accessing the service.SERF /serf:SERF/serf:Service_Citation/serf:URL
DCAT /dct:webService
ISO /*/gmd:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/gmd:CI_OnlineResource/gmd:linkage/gmd:URL
ISO-1 /mdb:MD_Metadata/mdb:identificationInfo/srv:SV_ServiceIdentification/srv:containsOperations/srv:SV_OperationMetadata/srv:connectPoint/cit:CI_OnlineResource/cit:linkage/gco:CharacterString
Resource LanguageThe language of the resource.DIF /dif:DIF/dif:Data_Set_Language
SERF /serf:SERF/serf:Service_Language
DCAT /dct:Language
ISO /*/gmd:identificationInfo/gmd:MD_DataIdentification/gmd:language/gco:CharacterString
ISO-1 /mdb:MD_Metadata/mdb:defaultLocale/lan:PT_Locale/lan:language/lan:LanguageCode
ISO-1 /mdb:MD_Metadata/mdb:otherLocale/lan:PT_Locale/lan:language/lan:LanguageCode

xPath Note: The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords. Fit: The fit of the dialect path with the concept is estimated on a scale of 1 = excellent two-way fit, 2 = one-way fit or some other problem, 3 - extension required.


Data Usability