Please select one of the links below to view the information related to that topic or question.
Search Tips:
OAIPMH Online Help
- Summary
- Identify
- ListMetadataFormats
- GetRecord
- ListIdentifiers
- ListRecords
- Example Requests
- Testing Resumption Token
Export metadata to JSON Help
Instructions for Citation Export
- Instructions for Citation Export
- Export Citation from Single Document
- Export Citations from All Documents in Search Results
- Export Citations from Multiple Documents
FAQs:
- What is a Collection?
- What documents are listed in the "Recent Additions" area of the site?
- What is a facet?
- How can I suggest another facet to be added to the site?
- What is the small "i" icon located within the site?
- How can I remove a selected facet to broaden my search results?
- After narrowing results with both a Volume and Issue facet, how can I quickly view all of the orginially available Volumes for that Collection?
- Can I sort my Search Results?
- How often is the Home page updated?
The system performs the query based upon these below fields:
- Title
- Description
- Personal Authors
- Corporate Authors
- Conference Authors
- Genre
- Subject
- Source
- Funding
- DOI
- Publisher site url
- The Document itself
However, if you are searching for a phrase containing more than one word, quotation marks play a role. For example, entering "bicycles and pedestrians" (with quotation marks) will return fewer results than entering bicycles and pedestrians (without quotation marks). For more information see item 3 below, regarding what you want to search for.
Special Characters
Search term containing colon : can be searched by using quotation marks in the search. User can also remove colon : in the search term and then search for it.
The default is to search across all of ROSA P ("All Collections").
- To specify a single collection, select an item from the Collections drop-down list.
You can select up to three search categories and corresponding keywords using the fields above or you can select only one field and click the Search button.
- Select where you want to search from the Category drop-down list:
Advanced Search Categories:- Title
- Description
- Personal Creator
- Corporate Creator
- Publication Date
- DOI Url
- DOI
- Contract Number
- Report Number
- Keywords
- Input what you want to search for.
Note: If you enter two words separated by a space, one combined result set is returned. This input acts like first word OR second word.
For example, keying public transit returns a list of documents that contain the word public combined with a list of the documents that contain the word transit.
However, to obtain a more precise match from your search, phrases must be enclosed in quotation marks. Keying"public transit" (with quotation marks) returns the list of documents that contain the entire phrase public transit.
Special Characters
Search term containing colon : can be searched by using quotation marks in the search. User can also remove colon : in the search term and then search for it.
Advanced Search Category: Document TypeYou can now search on documents by the type of works they were published as; a book, journal article, newsletter, poster, report,etc. Select "Document Type" in the category drop-down, pick a specific document type in the drop-down that appears to the right, then click the "Search" button.
Document Type drop-down-options:
Advanced Search Category: Published DateTo search for a document by published date, select "Published Date" from the category drop-down and then enter either a date range in both fields that appear on the right or a single date in the first field. The following formats are accepted: MM/DD/YY, MM/YYYY, or YYYY
You can type the date directly within the fields or you can utilize the date picker by clicking the calendar icon to the right of each field. After entering the published date or date range, click the "Search" button.
Published Date, date picker drop down:
Advanced Search Category: LanguageThe site has documents in several different languages. To search for documents written in a specific language select "Language" in the category drop-down, pick a specific language in the drop-down that appears to the right, and then click the "Search" button.
Language drop-down options:
- To add additional search criteria, select the appropriate Boolean operator from the drop-down menu.
The following table describes the Boolean operators.AND Narrows your search and retrieve records containing all of the words it separates.
The search retrieves documents that use both search terms you entered.
OR Broadens your search and retrieve records containing any of the words it separates.
This search includes results that contain either of the search terms you entered.
NOT Narrows your search by excluding Articles that do not contain the term following it.
-
When all three drop-downs are used, it is assumed that parentheses go around the first two phrases. Refer to the following example below:
- (A AND/OR/NOT B) AND/OR/NOT C
- The search first gets a result completing (A AND/OR/NOT B).
- Next, it completes AND/OR/NOT C on the returned result.
- Lastly, the search results are displayed.
Note: By clicking on the "x" icon in any Search text box, you can clear that field. Or you can click the "Clear All" link to clear all the text boxes.
How are documents scored ?
Here is the link if anyone would like to know exact mathematical formulas used behind calculating score.
Mathematical formulas used behind calculating score
By default, a "TF-IDF" based Scoring Model is used. The basic scoring factors:
- TF stands for term frequency - the more times a search term appears in a document, the higher the score
- IDF stands for inverse document frequency - matches on rarer terms count more than matches on common terms
- coord is the coordination factor - if there are multiple terms in a query, the more terms that match, the higher the score
- lengthNorm - matches on a smaller field score higher than matches on a larger field
- index-time boost - if a boost was specified for a document at index time, scores for searches that match that document will be boosted.
- query clause boost - a user may explicitly boost the contribution of one part of a query over another.
- Title^10
- Contract Number^10
- Subject/TRT Terms^10
- Publication/Report Number^10
- Creator^5
- Corporate Creator^5
- Corporate Publisher^5
- Description^2
- Content Notes^2
- Published Date^2
- Full Text^2
Doing an explicit sort in the SOLR query will ignore the relevancy scores.
OAI-PMH specification is defined as a RESTful service, where each request requires certain attributes. A "verb" is described as to what is being asked. each verb can have different attributes.
A full description of the specifications can be found here.
OAI Verbs: Based on the 2.2 spec, the available verbs are: (the verbs are case sensitive)
- Identify
- ListMetadataFormats
- GetRecord
- ListIdentifiers
- ListRecords
This verb simply presents some metadata about the respository as a whole to the user:
Full URL: http://<host>/fedora/oai?verb=Identify
Extra parameters: none.
Retrieve the metadata formats available from a repository. Only oai_dc is currently available.
Full URL: http://<host>/fedora/oai?verb=ListMetadataFormats
Extra Parameters:
- identifier (optional). if retrieving information about a specific format.
GetRecord
Retrieve an individual metadata record from a repository
Full URL: http://<host>/fedora/oai?verb=GetRecord&Identifier=<id>&metadataPrefix=<value>
Extra Parameters:
- identifier (required): the identifier for a given object
- metadataPrefix (required): specifies the metadataPrefix of the format that should be included in the metadata part of the returned record . Only oai_dc is supported.
This verb retrieves only headers rather than records. Useful if looking only for the metadata.
Full URL: http://<host>/fedora/oai?erb=ListIdentifiers&metadataPrefix=<value>
Extra Parameters:
- metadataPrefix (required): specifies the metadataPrefix of the format that should be included in the metadata part of the returned records. Only oai_dc is supported.
- from (optional): timestap for upperbound value of records to retrieve.
- until (optional): timestamp for lowerbound value of records to retrieve.
- set (optional): filter by set on selective haversting (not supported)
- resumptionToken: pagination functionality.
ListRecords
Similar to ListIdentifiers, but this method retrieves all records and not only headers.
FullURL: http://<host:<port>/fedora/oai?verb=ListRecords&metadataPrefix=<value>
Extra parameters:
Same as ListIdentifiers. (see above)
Examples:
https://rosap.ntl.bts.gov/fedora/oai?verb=Identify
https://rosap.ntl.bts.gov/fedora/oai?verb=ListMetadataFormats
https://rosap.ntl.bts.gov/fedora/oai?verb=ListSets
https://rosap.ntl.bts.gov/fedora/oai?verb=ListIdentifiers&metadataPrefix=oai_dc
Note: the resumptionToken parameter is mutually exclusive with other parameters. It is used to paginate through results and the token is given by each request under the tag <resumptionToken> at the end of the response.
Ex.: <resumptionToken expirationDate="2012-08-21T09:33:05Z" cursor="100">e80b606013a0a8274d91bb6b95d94bba</resumptionToken>
The first request will pass the appropriate values for other parameters, including metadataPrefix, from and util. subsequent pages have to pass only resumptionToken.
Testing Resumption Token
To test the resumptionToken through the browser, enter this URL:
Then, you will see a value for resumptionToken at the very bottom of the page. Get that value and enter it into the URL like this:
https://rosap.ntl.bts.gov/fedora/oai?verb=ListRecords&resumptionToken ={RESUMPTION_TOKEN_HERE}
example:
- https://<host>/fedora/export/download: Retrieve meta data from the repository as a file to be downloaded. The data will be in the format of JSON.
- https://<host>/fedora/export/download/collection/{pid}: Retrieve meta data of objects in a collection or multiple collections as a json file to be downloaded. For multiple collection, pids will be passed as a single value separated by ",", e.g. /fedora/export/download/collection/pid1,pid2,pid3
- https://<host>/fedora/export/view: Retrieve meta data from the repository to be viewed as a json file
- http://<host>/fedora/export/download/collection/{pid}: View meta data of objects in a collection as json data
- The following meta data will be returned: PID, mods.*, dc.*, keywords, fgs.*, rdf.*
- A data range can be passed as a SOLR date string to the request as parameters:
-
- from: e.g from=2017-01-01T00:00:00Z
- until: e.g until=2017-11-02T00:00:00Z
http://<host>/fedora/export/download/collection/{pid}?from=2017-01-01T00:00:00Z&until=2017-11-02T00:ListMetadataFormats00:00Z
- The number of records returned each time can be specified by the request parameter "rows", e.g rows=200
- The start record can be specified by the request parameter "start", e.g start=150
- If "rows" not specified and it is download, then all applicable data will be retrieved. Therefore, it is strongly recommended that the date range or a collection is passed to the request.
- If "rows" not specified and it is view, then by default only 100 rows of data will be returned each time, to view more, pass to the request the resumptionToken from the result.
Users of ROSA P can generate bibliographic citations from one or more documents.
- Click on the title to a document.
- Click on the Export Citations button.
- A dropdown list for selecting the file format will be displayed
- Select RIS for the file format
- Option will be displayed to Open, Save or Cancel the exported citation.
-
To view the citation data in a citation reader like EndNote, save the file and open it from the reader.
- From the search results page in Stacks, click on the Select Docs for Citation Export button.
- A link, Select all docs (Max 200), is displayed under the button and checkboxes are displayed next to every document listed in the search results
- Select all documents from the search results list by clicking the Select all docs (Max 200) link.
- After the button is clicked:
- The checkboxes near the first 200 documents in the search results are checked
- The Select Docs for Citation Export button color is changed to orange
- The Select all docs (Max 200) is changed to Unselect all
- Click the Select Docs for Citation Export button
- An option is displayed to Open, Save or Cancel the selected citations.
-
To view the citation data in a citation reader like EndNote, save the file and open it from the reader.
- From the search results page in Stacks, click on the Select Docs for Citation Export button.
- A link, Select all docs (Max 200), is displayed under the button and checkboxes are displayed next to every document listed in the search results.
- Click on the checkboxes of one or more of the documents on the page.
- The Select Docs for Citation Export button color is changed to orange.
- Click the Select Docs for Citation Export button.
- An option is displayed to Open, Save or Cancel the selected citations.
A Collection includes documents that address a shared topic.
Searching within a collection allows you to narrow your search results.
The documents that are listed in this area of ROSA P site are the twenty documents that were most recently updated or added to the site. These documents are sorted by most recently updated or added to least by default and they may or may not be the most recently published documents.
A facet allows you to narrow your Search based on pre-defined topic categories.
You can email us at publishinghd@cdc.gov.
The small "i" icon is a tooltip. When you hover your cursor over the icon, additional information is displayed to help explain that section of the site.
There are multiple ways to deselect a facet; Click the "x" to the left of the facet in the "Narrowed by" section above your results or deselect it within the "Narrow Results" box to the left of your results.
Simply click the "x" next to the selected Volume and this action will also remove the selected Issue as well.
Search results within a collection can be sorted by Relevance, Last Modified Date, Title, and Published Date.
The content for Recently Added and Popular Articles modules are updated every week. The Featured Article and In the Spotlight are updated every other month. The Featured Collection is updated whenever a new Collection has been added to the ROSA P site.
To view a list of previous Spotlights, click the "Spotlight Archive" link at the bottom of the module.