This page is for digital service providers (DSPs) who require information about SBR's implementation support products..
Find out about:
- Web Services Implementation Guide (WIG)
- Web Services Description Language (WSDL's)
- Reference Client
- Message Implementation Guide (MIG)
- Schematron files
- Taxonomy architecture
- Taxonomy files
- Identity management client
Web services Implementation Guide (WIG)
SBR's Web services Implementation Guide (WIG) describes common technical components and services that are re-used by all SBR AU Reports. The common services include:
- a single gateway that exposes four web services and supports industry standard web service protocols for message exchange
- a standard business document header
- a secure token server
- a harmonised set of error conditions and exception codes.
Web services Implementation Guide
Web services Description Language (WSDL)
The Web services Description Language (WSDL) is the standard syntax for the definition of web services defined by the world wide web consortium (W3C). A WSDL describes the service, the information exchanged, and the technical protocols used for the exchange.
SBR provides generic ‘list’, ‘prefill’, ‘prelodge’ and ‘lodge’ web services together with a WSDL for each. This collection also includes the XML Schema for the SBR standard business document header which is a mandatory part of every message.
The Reference Client file provides DSPs with a sample implementation file for Core Services 2010. The Reference Client shows how to package the XBRL documents into a SOAP message for transmitting to Core Services.
The Reference Client is available for both the .NET and Java programming languages.
You need to email a request to SBRServiceDesk@sbr.gov.au to obtain a copy of the Reference Client and associated documentation. This is due to licensing conditions.
Message Implementation Guide (MIG)
There is a Message Implementation Guide (MIG) for each report in scope for SBR. The guide is the entry point for DSPs wanting to support a specific SBR report (eg business activity statement, or payroll tax). In many cases there are several interactions around a specific form (eg ‘list’ previous lodgments, ‘prefill’ with government data, ‘calculate’ an obligation, and ‘lodge’ a report). The MIG provides the business interaction models and the data element content, contexts, and business rules for each requesting/responding message that supports the implementation of a business service.
The Common MIGs are available on each report page, together with agency specific MIGs.
Reports available for SBR development of each agency
Schematron is a rule-based validation language for making assertions about the presence or absence of patterns in XBRL trees. Schematron XSLT style sheets are used to implement any business validation rules including simple calculations.
For each form there may be a (one) Schematron file. However, not every form will require a Schematron file.
XBRL is a common reporting language, based on international standards and best practice. The SBR Taxonomy is made up of a structured list of reporting definitions, references, rules and relationships that support all of the SBR reports in scope.
The taxonomy architecture document describes the architecture of the SBR taxonomy and shows how the library of harmonised data elements (the SBR AU Taxonomy) is packaged and how the data elements are re-used across government reports (the SBR AU Reports). The document also defines the version control processes and how to navigate the taxonomy. The taxonomy architecture document is complemented by a description of SBR naming conventions.
The Taxonomy Architecture and SBR Naming Convention documents are available on the Re-usable components page.
This is the collection of XML schemas and XML link-bases, optimised for financial reporting, that constitute the SBR taxonomy.
The SBR AU Taxonomy contains a complete set of harmonised data elements and associated definitions for information to be exchanged between business and government under SBR. Like a dictionary, the SBR AU Taxonomy uniquely defines each data element, with each equivalent to one of the individual pieces of information sought on a government report (ie form).
The SBR AU Report reflects the specific message interaction for each agency report supported by SBR. This is achieved by importing and re-using data elements and their associated definitions from the SBR AU Taxonomy. Like words from a dictionary, individual entries from the SBR AU Taxonomy list are combined to define the complete content of each agency report. There is at least one taxonomy report (and sometimes several) for each agency report/form supported by SBR.
Machine readable code is available from the Index of /taxonomy/
Identity management client
The SBR solution leverages a new multi-agency authentication credential that will be accepted by all participating agencies. The document suite explains how the credential is issued and managed. It also explains how it is linked to agency business services to authorise primary credential holders or their delegates (employees or intermediaries).
The Identity management client provides both .NET and Java programming language APIs, sample code, and user guides for the Key Store and Token Request to facilitate authenticated connectivity to Core Services for both test and production environments.
You need to email a request to the SBRServiceDesk to obtain a copy of the Reference Client and associated documentation. This is due to licensing conditions.
Technical documentation for the Identity management client is included in the following files:
- SBR Identity management client overview
- imclient-java (zip file)
- imclient-dotnet (zip file)
Within each zip file you will find the following sub-directories:
- key store
- Token request (only the token request source code is provided in the October 2009 release).
SBR is currently assessing the feasibility of releasing source code for the Key store and you will be advised of the outcome in due course. Please note that sample code is embedded within the User guides under the Token request sub-directory for both .NET and Java. The purpose of the sample code is to show how the two APIs work together to facilitate authenticated connectivity to Core Services.
For further information on SBR implementation support products, contact the SBR Service Desk.