Data product publication workflow: start to finish

On this page

What are the different workflow stages?

Who is involved?

What do I need to do?

 


What are the different workflow stages?

 

workflow

 

  • STEP 1: Draft
  • STEP 2: Project Lead approval
  • STEP 3: Content Manager review
  • STEP 4: Branch Head approval
  • STEP 5: Approved
  • STEP 6: Published

 


Who is involved?

 


What do I need to do?

Product Owner

Workflow step Actions
STEP 1: Draft

Create a draft of your product page

1) Log in to the CMI.

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

For detailed instructions on how to fill out the data product fields, see A step-by-step guide to creating a data product page.

Important: The eCat team requires a download file or link to the data in order to publish the eCat record.

Make sure you provide at least one link under Access tab > Link to Data, or Media tab > Files. This could simply be the intended THREDDS destination path even if the link isn't yet live (can be edited later if necessary).

If you would like to provide a download file larger than 2MB, please provide this to the Content Manager separately.

3) Once you've completed your draft, change the moderation state to 'Project Lead approval'. The Project Lead will be notified.

Create the data product (if applicable)

4) Ensure any code changes are in git and merged into production.

5) Production run of product into staging folder.

6) Request QA/QC check from NCI via the NCI helpdesk (help@nci.org.au).

7) Once you receive approval from NCI, create a CCB request to:

STEP 2: Project Lead approval

The Project Lead may change the moderation state back to 'Draft' and request that changes be made.

1) Log in and make the recommended edits.

2) Change the moderation state to ‘Project Lead approval’ again.

STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval

The Branch Head may change the moderation state back to 'Draft' and request that changes be made.

1) Log in and make the recommended edits.

2) Change the moderation state to ‘Project Lead approval’ again.

STEP 5: Approved No action required.
STEP 6: Published

When the data product is published on eCat and CMI, the Content Manager will notify you.

When the data product is published on NCI, GSKY and DEA Maps (where applicable) you will be notified. The Content Manager will add the appropriate data links into the data product page.

Contact the Content Manager if you want to:

  • edit a product (you can either send them your edits, or ask to edit yourself)
  • unpublish a product

 

 

Project Lead

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval

You will receive an email notifying you that a data product needs to be approved by you.

1) Make sure you’re logged into the CMI.

2) Click on the data product link in the email.

3) Review / edit the data product.

4) If you would like to approve the data product, change the moderation state to ‘Content Manager review’.
The Content Manager will be notified.

If you would like the Product Owner to edit the draft, change the moderation state to ‘Draft’ and contact the Product Owner.

STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval No action required.
STEP 5: Approved No action required.
STEP 6: Published No action required.

 

 

Content Manager

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval You will receive an email notifying you that the moderation state has changed to 'Project Lead approval'.
STEP 3: Content Manager review

You will receive an email notifying you that a data product needs to be reviewed by you.

1) Make sure you’re logged into the CMI.

2) Click on the data product link in the email.

3) Review / edit the data product. Follow the detailed guidelines in the Content Manager review checklist.

4) To approve the data product, change the moderation state to ‘Branch Head approval’. The Branch Head will be notified.

STEP 4: Branch Head approval

If the Branch Head has not approved within 3 days, email their EA and request that they schedule in a calendar appointment to approve the product.

STEP 5: Approved

When the Branch Head approves the product, you will receive an email notifying you that the moderation state has been changed to 'Approved'.

Manage Branch Head approval

1) Save the Branch Head approval email in the HPRM (TRIM) folder D2019/1257 (drag the file into the folder).

2) Copy and paste the Branch Approval TRIM file number into the data product field 'Credits' tab > 'Approver's checklist - HPRM reference'.

Contact the eCat Team

3) Send the eCat Team (dataman@ga.gov.au) an email requesting that they publish the data product. Use this email template.

  • CC the Product Owner.
  • Attach the eCat XML (under 'Export' on the left-hand panel).
  • Attach the PMP PDF (under 'Export' on the left-hand panel).
  • Attach the product's CMI metadata PDF (under 'Export' on the left-hand panel).
  • Specify the data link or download file that is to be attached to the eCat record (under 'Access' tab > 'Links to data' or 'Media' tab > 'Files'). If you can't find a data link or file, request this from the Product Owner. 

Publish the page

4) When the eCat record is published, the eCat team will notify you by email. Check that the record is correct.

5) Copy and paste the eCat record number into 'Access' tab > 'eCat URL'.

6) Publish the CMI page by changing the moderation state to ‘Published’ and notify the Product Owner.

If the data product needs to be published on THREDDS, also notify the Operations Team (Arek Drozda / Lien Ly).

STEP 6: Published

Add links to data as necessary

As new links to data, services, etc. are created, the Product Owner, Core Team or Operations Team will be in contact. Add these into the 'Access' tab accordingly.

You may also need to contact the eCat Team if any download links or information needs to be edited.

The Product Owner needs to contact you if they want to edit or unpublish a data product. See Admin processes.

 

 

Branch Head

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval

No action required.

STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval

You will receive an email notifying you that a data product needs to be approved by you.

1) Make sure you’re logged into the CMI.

2) Click on the data product link in the email.

3) Review / edit the data product.

4) If you would like to approve the data product, change the moderation state to ‘Approved’.
The Content Manager will be notified.

If you would like the Product Owner to edit the draft, change the moderation state to ‘Draft’ and contact the Product Owner.

STEP 5: Approved No action required.
STEP 6: Published No action required.

 

 

eCat Team

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval No action required.
STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval No action required.
STEP 5: Approved

When a data product from the CMI needs to be published on eCat, the Content Manager will email you. They will send you:

  • the eCat XML
  • PMP with Branch Head approval TRIM number
  • any download links that need to be included

1) Publish the eCat record.

2) Notify the Content Manager when this is completed.

STEP 6: Published No action required.

 

 

Operations Team

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval No action required.
STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval No action required.
STEP 5: Approved No action required.
STEP 6: Published

When the data product page is published on CMI and eCat, the Content Manager will notify you.

1) Move data to THREDDS destination path.

2) Send request to NCI (help@nci.org.au) to publish product to THREDDS.

3) Notify Core (David Gavin / Alex Leith) that data is ready to publish. CC the Product Owner and Content Manager. Make sure you specify the final details of NCI destination path so the Content Manager can add this to the CMI page.

 

 

Core Team

Workflow step Actions
STEP 1: Draft No action required.
STEP 2: Project Lead approval No action required.
STEP 3: Content Manager review No action required.
STEP 4: Branch Head approval No action required.
STEP 5: Approved No action required.
STEP 6: Published

When the data is ready to publish, the Operations Team will notify you. 

1) Index into NCI Data Cube.

2) Publish to GSKY.

3) COG and upload to S3.

4) Publish to AWS web services.

5) Push product to DEA Maps / NationalMap.

6) Notify the Product Owner and Content Manager when complete. Specify any data or web service links that the Content Manager needs to add to the CMI page.