ATO content restructure

The ATO content restructure page is used to communicate:

  1. any significant structural and/or functional changes the ATO has made to the SBR site where ATO information is published, and
  2. major modifications to the high level ATO artefact suite that have a material impact on technical development for those looking to implement ATO web services.

information Information previously published on this page has been removed and is now accessible as a word document, with the prior version of the High Level Document map PDF embedded as an image. Removed content can be found here.

15thSeptember 2016

Changes made by the ATO on 15th September 2016 have been summarised as follows:

Background

With the introduction of multiple message formats (i.e. XBRL and XML) being offered over both SBR Core Services and ebMS3 platforms in 2016, it was recognised by the ATO that some templates were inadequate in terms of supporting Software Developers to implement a service that is deployed in two or more formats.  An additional complexity was also noted when a service is deployed on both platforms, as the technical implementation requirements per platform can be unique and may have differing business behaviours (such as 'fire and forget' on one platform yet interactive on the other).

After Consultation with the Software Developer Technical Working Group (SWD TWG) from 21st July through to 08th September 2016, consensus was reached to modify the ATO artefact suite. The most significant change is the ATO will no longer produce service/product Message Implementation Guides (MIGs) and the information will now be detailed in a central ATO Service Registry. The ATO Common MIG (cMIG) still exists as an overarching pertinent document.

To support those changes, the ATO has modified some existing pages, described new terminology, included additional communication/development artefacts and changed base artefact templates.

SBR ATO web page enhancements

The ATO has modified SBR ATO pages as follows:

Page/Information Change description Rationale for change
Australian Taxation Office (ATO) page

Additional sections and artefacts added for:

  • ATO Service Registry (SR)
  • SBR ATO Site and Document Maps
  • ATO Artefacts and Location (AL)
Having these artefacts on this page gives a contextual view of ATO services, site structure, document suite and artefact locations.
  Page subscription function added. As the main ATO page, subscription function enables interested parties notification of page updates - specifically the ATO Artefacts and Location spreadsheet.
ATO Common Information Artefacts

Additional sections and artefacts added for:

  • ATO Service Registry (SR)
  • SBR ATO Site and Document Maps (SDMPS)
The ATO Service Registry now replaces service/product specific MIGs.

The SBR ATO Site and Document Maps artefact provides information on site structures for ATO content on sbr.gov.au and SBR Share File, common Acronyms/Initialisms and the High Level Document map.

These two artefacts will be replicated on each ATO Domain page (i.e. Employer Obligations) under the heading 'ATO Common Information Artefacts' with other ATO common documents.
ATO Content Restructure

This page has been updated to:

  • Add informational content on September 2016 changes.
  • Remove previous content to a word document, along with the prior High Level Document map.
This page communicates changes and allows previous change content to be accessible.

Whilst the High Level Document map is contained within the SBR ATO Site and Document Maps artefact, this page links to a revised PDF due to multiple Business Implementation Guides containing hyperlinks.

ATO terminology explained

The ATO has used the term 'Message Implementation Guide' to describe technical information and specifications needed to develop ATO SBR web services. Over time, this term has changed slightly due to the actual artefact suites deployed. The table below describes the evolution of the term and the context of where it used now.

Artefact Term Description Period deployed Status
(service/product)Message Implementation Guide (MIG)

A single word document that describes for a specific service and message/s:

  • service configuration data,
  • message structure,
  • validation rules, and
  • business implementation.
2010 to 2013 No longer produced yet maintained where necessary.
(service/product)
Revised MIG (rMIG) suite
  • A suite of artefacts comprised of:
  • a MIG word document describing configuration data with some business content
  • Message Structure Table/s (MSTs) spreadsheet containing Context and Message structures.
  • a Validation Rule (VR) spreadsheet describing rule implementation.
  • Schematron files with technical rule implementation
2014 to September 2016 No longer produced yet maintained where necessary.

Note: The ATO will remove the rMIG word document as this content is available in the ATO Service Registry. The MSTs and VRs will remain in the template of deployment unless a significant service update requires redeployment in the 2016 format.
ATO Common Message Implementation Guide (cMIG) The ATO Common MIG (cMIG) describes the common implementation of services/messages for the ATO. Any variations are noted in the ATO Service Registry. 2014 onward

The cMIG is still a pertinent technical document that will continue to be updated by the ATO to support common implementation facets.

ATO Service Suite

The ATO Service Suite terms is now used to encompass artefacts previously covered in the 'rMIG' suite. The service/product MIG information is now within the ATO Service Registry (SR). The ATO SR is not incorporated as part of service suite physical package, yet is an integral part of the overall technical development and deployment suite.

September 2016 onward This term will be used from September 2016 to describe the previous 'rMIG' suite of artefacts.

ATO artefact suite changes

The ATO has modified its development artefact suite.

information The latest version of the High Level Document Map can be found here.

The table below describes the major changes to the overall document map.

Artefact Change type Change description Rationale for change Period deployed

(service/product)

Revised Message Implementation Guide  (rMIG) document

Maintained for past years for a period of time.

Deleted from the September 2016 suite.

No longer deployed for new services published September 2016 and onward.

Information is now contained within a central ATO Service Registry (SR).

Note: The ATO will, over time, remove the rMIG word document as this content is available in the ATO Service Registry.

2014 to 14.09.2016

ATO Service Registry (SR) New from September 2016 The ATO Service Registry (SR) is a single point of ATO service/message configuration data for web services offered by the ATO over the SBR platforms dating back to 2010.

The ATO SR replaces the word version of service/product MIGs.

Note: Prior MIG documents from 2010 to 2013 will continue to exist. Configuration data is also detailed in the ATO SR.

15.09.2016 onward
ATO Site and Document Maps (SDMPS) New from September 2016

The ATO SDMPS provides the site structures for ATO content on sbr.gov.au and SBR Share File, along with links to pages and content where possible.

A description of the full form name of Acronyms/Initialisms commonly referenced by the ATO in respect to SBR services, messages and documents is included.

It also incorporates the High Level Document map.

ATO SDMPS is a high level visual representation of content that is published relevant to ATO SBR web services.

It is provided as a supporting artefact to facilitate understanding of the ATO structure and enable ease of access via hyperlinks where possible.

15.09.2016 onward
ATO Artefacts and Location (AL) New from September 2016

The ATO Artefacts and Location (AL) spreadsheet provides links to updated information and gives a high level synopsis of change.

The ATO AL spreadsheet is an important communication product to notify of changes to development artefacts.

This is the driver of the subscription service.
15.09.2016 onward

ATO artefact template changes

Artefact Change description Rationale for change Period deployed
Package Content Notes (PCNs)

References to MIG word document have been removed and structure updated to provide more clarity on technical changes such as schematron and known issues.

This change is to support the new Service Suite and for the ATO to articulate changes in a more overt manner. September 2016 onward

Message Structure Tables (MSTs) spreadsheets

Additional columns have been added which are described in the ATO Common MIG (cMIG) These changes have been made after SWD consultation to support multiple message formats and provide clarity on message implementation. September 2016 onward
Validation Rules (VR) spreadsheets Additional columns have been added which are described in the ATO Common MIG (cMIG) These changes have been made after SWD consultation to support multiple message formats and provide clarity on validation rules. September 2016 onward

Last updated: 09 Mar 2017
Page ID: 41043