ATO AUSKEY.0001 2016 Package v1.0 Contents

Standard
Business
Reporting
Australian Taxation Office
AUSKEY 2016 Package v1.0 Contents
Date: 23rd February 2017
This document and its attachments are Unclassified
For further information or
questions, contact the SBR
Service Desk at
[email protected] or
call 1300 488 231. International
callers may use +61-2-6216
5577
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
VERSION CONTROL
Version
Release date
Description of changes
1.0
23/02/2017
This document has been updated for the February EVTE and PROD
releases.
Section 2 Package contents
Updated:
The following artefacts were updated with functional changes:
Refer to the artefacts change history for further information.

auskey.0001.lodge.request.01.00.xsd
TFS Defect 232015:
AUSKEY22 does not allow up to 4 digits.
Max length
From: 2
To: 4
TFS Defect 241524:
AUSKEY23 is not enforced as a mandatory field in the xsd.
Min
From: 0
To: 1
The following artefacts were updated with non-functional changes:
Refer to the artefacts change history for further information.

ATO AUSKEY.0001 2016 Message Repository.xml
CR4002:
Added multiple new IEH messages into the message repository.
Removed:
The following Message Implementation Guide (MIG) documents have
been removed. See section 1.4.1 of this document for details:

ATO AUSKEY.0001 2016 Message Implementation Guide.docx
Message Implementation Guide (MIG) documents have been
replaced by the ATO Service Registry which is published under
the ATO Common information artefacts section on all ATO pages
on sbr.gov.au.
Section 3 Known Issues
Updated to include known issues, and future scope.
Known issues:
UNCLASSIFIED

TFS 232015

TFS241524
PAGE 2 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
COPYRIGHT
© Commonwealth of Australia 2017 (see exceptions below).
This work is copyright. Use of this Information and Material is subject to the terms and conditions in the
"SBR Disclaimer and Conditions of Use" which is available at http://www.sbr.gov.au. You must ensure
that you comply with those terms and conditions. In particular, those terms and conditions include
disclaimers and limitations on the liability of the Commonwealth and an indemnity from you to the
Commonwealth and its personnel, the SBR Agencies and their personnel.
You must include this copyright notice in all copies of this Information and Material which you create. If
you modify, adapt or prepare derivative works of the Information and Material, the notice must still be
included but you must add your own copyright statement to your modification, adaptation or derivative
work which makes clear the nature of your modification, adaptation or derivative work and you must
include an acknowledgement that the adaptation, modification or derivative work is based on
Commonwealth or SBR Agency owned Information and Material. Copyright in SBR Agency specific
aspects of the SBR Reporting Taxonomy is owned by the relevant SBR Agency.
UNCLASSIFIED
PAGE 3 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
Table of contents
1
Introduction ........................................................................................................................ 5
1.1
Document purpose .................................................................................................... 5
1.2
Audience.................................................................................................................... 5
1.3
Purpose of this package ............................................................................................ 5
1.4
Summary of artefacts in the ato packages ................................................................. 5
1.4.1 In general ............................................................................................................... 5
1.4.2 Circumstances where artefacts are not present in a package ................................ 6
1.4.3 New Services ......................................................................................................... 6
1.4.4 New Message associated with services (child relationship) ................................... 6
2 Package contents............................................................................................................... 7
3 Known issues and future scope.......................................................................................... 8
Appendix A – Prior Version History ........................................................................................... 9
UNCLASSIFIED
PAGE 4 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
1 INTRODUCTION
1.1
DOCUMENT PURPOSE
The purpose of this document is to advise software developers of the package contents for
Standard Business Reporting (SBR) ABN Registration Auskey (AUSKEY.0001 2016) suite
provided by the Australian Taxation Office (ATO).
1.2
AUDIENCE
The audience for this Package Content Note is software developers who have or are
interested in developing AUSKEY services in the SBR Core Services platform.
1.3
PURPOSE OF THIS PACKAGE
The purpose of this package is to streamline the way message artefacts are presented to
software developers.
All relevant message artefacts that comprise the AUSKEY suite are contained within one zip
file. The package will be versioned up each time artefacts are added or updated.
1.4
SUMMARY OF ARTEFACTS IN THE ATO PACKAGES
1.4.1 In general
For each service, the following artefacts have been/will be released under this package title:
 Message Structure Tables (MSTs),
 XSD Message Instances
 Validation Rules (VRs)
Note:
From September 2016 the Message Implementation Guide/s (MIGs) will not be
produced and will be replaced by the ATO Service Registry which is published
under the ATO Common information artefacts section on all ATO pages on
sbr.gov.au.
UNCLASSIFIED
PAGE 5 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
1.4.2 Circumstances where artefacts are not present in a package
The table in Section 2 Package Contents reflects the status of artefacts in the Package Status
column and needs to be read in conjunction with the Comments column in order to
understand the scale of change that may be applicable.
The table below describes the terminology used in the Package Status column and the
business description of the package status:
Package
Status
Pending
New
Updated
Present
Removed
Business Description
The artefact is currently under development and is expected to be released in a future
package.
The artefact is new for the package and has not been published previously. This would
usually occur when an artefact has previously been marked as Pending (under
development) or a new Government/ATO initiative sees the development of new
services/messages to be deployed.
The artefact has changed since the last public release for this package. It could occur as
a result of refining service/messages due to feedback or defects.
The artefact is within the package and has had no change from the prior package for this
year or a previous/forward year where artefacts cross multiple years.
The artefact was within the package in a prior release but has been removed as it is not
relevant for the service/suite in question. This could occur due to Government
legislation waiting on Royal Assent not being passed or other factors.
1.4.3 New Services
The following new service is available on the SBR Core Platform.
Description
AUSkey – Lodge Request
Interaction
Lodge
Product
AUSKEY
Detailed information on each service can be found in the relevant MIG document.
1.4.4 New Message associated with services (child relationship)
There are no new messages for this release.
UNCLASSIFIED
PAGE 6 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY 2016 PACKAGE V1.0 CONTENTS
2 PACKAGE CONTENTS
The table below outlines the package contents.
Name
Document
Date
29/09/2016
ATO AUSKEY.0001 2016 Message Implementation
Guide.docx
ATO AUSKEY.0001 2016 Request Message Structure
Table.xlsx
ATO AUSKEY.0001 2016 Response Message Structure
Table.xlsx
Document
Status
Draft
Version
Comments
0.1
Removed as MIGs are no longer
produced and have been replaced by
the ATO Service Registry.
Version set to final with no functional
changes.
Version set to final with no functional
changes.
Driver: TFS Defect 232015
AUSKEY22 max length modified from 2
to 4
Driver: TFS Defect 241524
AUSKEY23 changed from optional to
mandatory to align with MST
Version set to final with no functional
changes.
Version set to final with no functional
changes.
Driver: CR4002
Added multiple IEH message updates
23/02/2017
Final
1.0
23/02/2017
Final
1.0
auskey.0001.lodge.request.01.00.xsd
23/02/2017
Final
1.0
auskey.0001.lodge.response.01.00.xsd
23/02/2017
Final
1.0
ATO AUSKEY.0001 2016 Validation Rules.xlsx
23/02/2017
Final
1.0
ATO AUSKEY.0001 2016 Message Repository.xml
23/02/2017
Final
1.0
Total artefacts in this Package:
UNCLASSIFIED
Package Status
Removed
Present
Present
Updated
Present
Present
Updated
06
Present artefacts
04
New artefacts
00
Updated artefacts
02
Pending artefacts
00
Removed artefacts
01
PAGE 7 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY 2016 PACKAGE V1.0 CONTENTS
3 KNOWN ISSUES AND FUTURE SCOPE
The following is a list of issues or future work to be implemented for this tax time. There may be impacts to successful development until the
issues are resolved or the further work implemented.
Issue
Impacted
Service
Incident
Number
Telephone Area code only accepts
AUSKEY
2 digits
n/a
Country code is not being
enforced by the xsd as being
mandatory
n/a
UNCLASSIFIED
AUSKEY
Internal
Reference
Resolution
EVTE
Deployment
TFS 232015
The telephone area code has been modified in
the AUSKEY request xsd to allow between two
and four digits.
February
TFS 241524
Modify the auskey request xsd to align with
the AUSKEY request MST
February
PAGE 8 OF 9
STANDARD BUSINESS REPORTING
ATO AUSKEY.0001 2016 PACKAGE V1.0 CONTENTS
APPENDIX A – PRIOR VERSION HISTORY
Version
Release date
Description of changes
0.1
29/09/2016
Suitable for production release for AUSKEY 2016 containing ‘New’
artefacts.
Note:
New:







UNCLASSIFIED
‘New’ artefacts are draft for consultation and describe (at a high level) new
artefacts.
ATO AUSKEY.0001 2016 Message Implementation Guide.docx
ATO AUSKEY.0001 2016 Request Message Structure Table.xlsx
ATO AUSKEY.0001 2016 Response Message Structure Table.xlsx
auskey.0001.lodge.request.01.00.xsd
auskey.0001.lodge.response.01.00.xsd
ATO AUSKEY.0001 2016 Validation Rules.xlsx
ATO AUSKEY.0001 2016 Message Repository.xml
PAGE 9 OF 9