A step-by-step guide to creating a data product page

These instructions will take you through the process of adding a data product page.

If you have any questions, contact the Content Manager.

 

On this page

How to add a new data product

Data product page structure

Instructions for completing the six tabs:

Saving your data product

     


    How to add a new data product

    1) Log in to the CMI. 

    2) Select 'Manage' (in the top left corner) > 'Content' > 'Add content' > 'Data product'.

    3) Fill in the fields as directed below. 

     

    TIP: 'Manage' > 'Content' is the place to go to access all published and unpublished content.
    This includes all data products, processing steps and contacts.

     


    Data product page structure

    Header

    header

    The data product header contains key information which users can see at a glance:

    • Title (plain English alias)
    • Full technical product name
    • Version (refers to Collection) and Latest Release badge (if applicable)
    • Product ID
    • Program
    • Resource type
    • Date modified

     

    Body

    tabs

    The data product page fields are organised into six different tabs:

    Basics - an introduction to the product in plain English. Much of this section will be mapped to other service and catalogue descriptions (e.g. eCat, web services, DEA Maps, GSKY). For more information about where this content can be mapped, see External resource mappings

    Access - any information related to the access of the product (e.g. links to data, important reference numbers).

    Details - technical information, including accuracy/limitations, quality assurance, websites and references.

    Processing - data sources, processing steps and algorithms.

    Media - example images, files and related case studies.

    Credits - authors, licences, contact details and acknowledgements.

    TIP: Select a tab to edit its content. To save, click 'Next' > 'Save'.

     

     


    Basics

    This tab should be written in plain English and provide an overview of what the product is. There's plenty of room for technical detail later on in the 'Details' tab, so keep it simple and concise here. Explain your product like you would to someone who has no geoscience background.

    TIP: If you need any help with this section, speak to the Content Manager. 

    General information

    Title - Create a simple, short, unique title using plain English (e.g. Fractional Cover 2 (Landsat)). Do not use ID references and minimise acronyms.

    Full technical name - This corresponds to the Data product naming convention

    Theme - This is a high-level tag that will be found on the home page and search panel.

    Resource type - Select baseline, derivative or data service.

    Program - Select Digital Earth Australia, Marine or Copernicus Australasia.

    Version - Use semantic versioning (major.minor.patch). E.g. 3.0.0.

    Latest version - Check this box if this is the latest version of the product. This will display the 'latest release' badge.

    Project Lead (for approval purposes) - Select from dropdown menu.

    Branch Head (for approval purposes) - Select from dropdown menu.

     

    Background

    Set the scene (think broadly):

    • Why was the product developed?
    • What is the problem we're addressing?

    (150 words max.)

    Example

    Intertidal zones are those which are exposed to the air at low tide and underwater at high tide. These include sandy beaches, tidal flats, rocky shores and reefs.

    Intertidal zones form critical habitats for a wide range of organisms, but are faced with increasing threats, including coastal erosion and a rise in sea levels.  

    Accurate elevation data that describes the height and shape of the coastline can help predict when and where these threats will have the greatest impact. This data is challenging to map given the dynamic nature of intertidal zones and length of the Australian coastline.

     

    What this product offers

    Provide a broad description of the product:

    • What it can provide for the user
    • The main selling point
    • How this product addresses the problem

    Use text only (no images), as this field will be used in other services (e.g. eCat). See External resource mappings

    (150 words max)

    Example

    This product visualises the intertidal zones off the coast of Australia. It calculates the geometric median (geomedian) of the highest and lowest 20% of the observed tidal range in Digital Earth Australia’s archive of Landsat satellite images.

    The archive of Landsat images has been paired with regional tidal modelling, generated by Oregon State Tidal Prediction software. This allows the archive to be sorted by tide height rather than date, so the intertidal zone can be visualised at any stage of the tide regime.

    The data has been captured on a 25m spatial scale.

     

    Applications

    List some examples of how your data product can be used in practice. Think about your product's direct, real-world applications. 

    • How can the product be used?
    • How can it help people?
    • What difference can it make?

    Use bullet points and keep the list concise.

    Example

    • Understanding the extent and topography of the Australian intertidal zone
    • Environmental monitoring of migratory bird species
    • Habitat mapping in coastal regions
    • Hydrodynamic modelling
    • Geomorphology studies of features in the intertidal zone

     

    Related products

    List any related products that you think users might also be interested in.

    E.g. If this is a derivative product, consider listing the product from which it is derived.

    List any associated statistics products.

    If this is an Analysis Ready Data product, list its sub-products.

    Note that this field is an 'entity reference', so it can only reference products that already exist on the CMI.

     

    Publications

    List any direct publications written for the product.

    Note that there is a 'References' field under the 'Details' tab for all other references.

    Use the American Psychological Association 7th Edition style; e.g.:

    Li, F., Jupp, D. L. B., Reddy, S., Lymburner, L., Mueller, N., Tan, P., & Islam, A. (2010). An evaluation of the use of atmospheric and BRDF correction to standardize Landsat data. IEEE Journal of Selected Topics in Applied Earth Observations and Remote Sensing, 3(3), 257–270. https://doi.org/10.1109/JSTARS.2010.2042281

    TIP: Visit ZoteroBib, search for your paper, select the APA 7th Ed. style, and copy and paste the references into this field. 
    List them alphabetically (by first author surname). 

     

    Tags

    We want users to be able to find your product.

    The CMI keyword search searches the title, tags and abstract.

    Choose tags that represent your product's content. Consider using keywords that aren't featured in your title.

    Example

    Product: Wetness Percentiles 2 (Landsat)

    Tags: tasseled cap, groundwater, wetlands, salt flats, statistics

     

     


    Access

    Data access

    This table summarises the data product's reference codes, data links and related records. 

    TIP: If the fields are not applicable, leave them blank.
    Field Details
    Links to data Enter any URLs to data / catalogues, such as:
    - THREDDS
    - DEA Access
    Links to maps Enter any URLs to data / catalogues, such as:
    - DEA Maps / NationalMap
    - AusSeabed
    Web services Enter any URLs to web services, such as:
    - WMS
    - GSKY
    eCat URL Completed by the Content Manager after the eCat record is created.
    The Persistent Identifier URL is used; i.e.
    http://pid.geoscience.gov.au/dataset/ga/eCatID
    The URL label is the eCat ID.
    Product ID Enter the Open Data Cube product ID.
    This should correspond to the Data product naming convention.
    Open Data Cube product configuration Enter the URL for the product's GitHub configuration;
    e.g. https://github.com/GeoscienceAustralia/dea-config/tree/master/dev_3-0-0/products/ga-landsat-ard-3-0-0.
    NCI project code Enter NCI project code.
    NCI product name Enter NCI product name.
    Access constraints Describe who is permitted to access the data.
    Use constraints Describe any restrictions on the use of the data;
    e.g. 'Legislation disallows specific use for zoning'.
    Security classification Set to 'Unclassified' by default.
    Update frequency Set to 'As needed' by default.
    Product lifespan Enter start and end date/times.

     

    Access notes

    Enter any specific instructions that may help the user with accessing or using the data. This could include:

    • how to load the product layer on DEA maps
    • how access the product in Sandbox
    • how to access the product in THREDDS

    Add subheadings to help structure your content. Use Heading 4.

    Note that there is also a data access document that gives a general overview of data services and catalogues.

    TIP: These Access notes can be mapped to other service descriptions. See External resource mappings.

    Example

    DEA Maps

    To view this product on DEA Maps:

    1) Open DEA Maps.

    2) Select 'Add data'.

    3) Select 'Coastal' > 'Low tide satellite images' > 'Low tide Landsat satellite images'. Click 'Add to the map'.

    4) Select 'Coastal' > 'High tide satellite images' > 'High tide Landsat satellite images'. Click 'Add to the map'.

     

     


    Details

    Technical information

    This is a catch-all for technical details, which:

    • aren't included in the 'Basics' tab
    • don't fall under 'Accuracy and limitations' and 'Quality assurance' (these chapters are to follow)

    It is recommended you use subheadings to help structure your content. Use Heading 4.

    Accuracy and limitations

    Include any information regarding the product's accuracy or limitations of the data. 

    Quality assurance

    Describe any procedures that have been put in place to provide quality assurance.

    Software

    Provide the software as bullet points.

    If applicable, provide hyperlinks by selecting the 'Link' icon on the text field menu.

    Example

    The following software was used to generate this product:

     

    Relevant websites

    Provide any relevant websites that might be useful to the user.

     

    References

    Treat this field as a bibliography; i.e. include:

    • any publications listed in 'Basics' tab > 'Publications'
    • references that have been referred to in the product page
    • any other references that are relevant to the product

    Use the American Psychological Association 7th Edition style; e.g.:

    Li, F., Jupp, D. L. B., Reddy, S., Lymburner, L., Mueller, N., Tan, P., & Islam, A. (2010). An evaluation of the use of atmospheric and BRDF correction to standardize Landsat data. IEEE Journal of Selected Topics in Applied Earth Observations and Remote Sensing3(3), 257–270. https://doi.org/10.1109/JSTARS.2010.2042281

    TIP: Visit ZoteroBib, search for your paper, select the APA 7th Ed. style, and copy and paste the references into this field. 
    List them alphabetically (by first author surname). 

     

     


    Processing

    Lineage

    Summarise the origins of the data and how it was derived at each stage; i.e.:

    • who collected the data
    • when and how the data was collected
    • how the data was processed

    Data sources

    Select existing items from the autocomplete list, or add a new item by selecting 'New content'.

    Processing steps

    Select existing items from the autocomplete list, or add a new item by selecting 'New content'.

    Major algorithms

    Select existing items from the autocomplete list, or add a new item by selecting 'New content'.

    Schema / spatial extent

    Select existing items from the autocomplete list, or add a new item by selecting 'New content'. A map of the spatial extent will be automatically generated.

     

     


    Media

    Case studies

    Link to the URLs of any associated Case Studies that are published on other sites (e.g. DEA website, CopHub website).

    Example images

    Upload any example images you would like to include. Consider including images that demonstrate how useful or practical your product is.

    Files

    Upload any files if applicable. Maximum 2 MB per file.

    Header image

    This refers to the image located on the left-hand side of the data product header. Select an image that nicely represents your product! Consider zooming into and cropping large images to show detail.

     

     


    Credits

    Owner

    For GA data products, the owner will typically be the Commonwealth of Australia (Geoscience Australia).

    Custodian

    For GA data products, the custodian will typically be the Commonwealth of Australia (Geoscience Australia).

    Principal contributors

    List all people who contributed to this product.

    Select existing items from the autocomplete list, or add a new contact.

    Subject matter experts

    These are the people whom you would consult with if you had any technical questions.

    Select existing items from the autocomplete list, or add a new contact.

    Licence

    Set to 'CC BY Attribution 4.0 International License' by default.

    Rights statement

    Set to '© Commonwealth of Australia (Geoscience Australia) 2021. Creative Commons Attribution 4.0 International License' by default.

    Acknowledgments

    Enter any people or organisations whom you would like to acknowledge.

    Example

    The authors would like to thank the following organisations:

    • NASA
    • Environment Canada
    • CSIRO
    • NOAA / ESRL / PSD
    • NGA
    • USGS / EROS Center
    • Spectral Sciences, Inc.

    Review documents

    Document Details
    Author's checklist Select from the autocomplete list
    Reviewers' checklists Select from the autocomplete list
    Approver's checklist Select from the autocomplete list
    Approver's checklist - HPRM reference Completed by the Content Manager
    PMP - HPRM reference Completed by the Content Manager
    Published date Put in todays date. Will be updated by content manager on publication

     


    Saving your data product

    1) Click 'Next' at the bottom of the page. This will take you to the final workflow page. 

    2) Change the moderation state in the drop-down menu, if required. Make any revision notes if necessary.

    3) Click 'Save'.

    NOTE: The system also autosaves every 60 seconds.

    Canceling your data product edits

    Click 'Cancel' at the bottom of the page. This will take you back a page, and remove all edits