SBR II Software Developer training Presented by e

  • Slides: 49
Download presentation
SBR II Software Developer training Presented by e. Commerce Service Delivery Team Australian Taxation

SBR II Software Developer training Presented by e. Commerce Service Delivery Team Australian Taxation Office 1 Unclassified – Software Developer Training - SBR 2

Overview

Overview

What is SBR Using SBR-enabled software, businesses will be able to realise the benefits

What is SBR Using SBR-enabled software, businesses will be able to realise the benefits of reporting to government directly from their financial, accounting or payroll system. A message through the system is made up of two parts Envelope (e. BMS) • A set of layered extensions to the SOAP protocol, providing security and reliability features enabling e-Commerce transactions. • ATO is using the e. BMS 3 standard with the addition of the AS 4 profile Payload (XBRL, XML, JSON) • Allows for a standard base to communicate and exchange business information between parties • This is the chosen format for SBR and provides consistent reporting for agencies using the associated AU taxonomy. 3 Unclassified – Software Developer Training - SBR 2

Taxonomies • Definitional taxonomy (SBR Taxonomy) is based on “whole of government terms” and

Taxonomies • Definitional taxonomy (SBR Taxonomy) is based on “whole of government terms” and goes through a process of verification and normalisation before approval through the SBR taxonomy advisory committee (TAC) • Reporting taxonomy – “Instance of the form” values are taken from the definitional taxonomy to make up the values in the form. • Interface is usually a message implementation guide (MIG) provided to fully describe the implementation of the reporting taxonomy. Definitional Reporting Interface 4 Unclassified – Software Developer Training - SBR 2

Business 2 Government & Business 2 Business eb. MS 3 Standards cover each of

Business 2 Government & Business 2 Business eb. MS 3 Standards cover each of the transaction below. Not every group will require every aspect of eb. MS 3, but should be able to handle the all features offered by eb. MS 3. B 2 B and B 2 G have mutual and exclusive patterns used, some outside the eb. MS 3/AS 4 standard, B 2 B Super. Stream eb. Ms 3/AS 4 GOVT AGENCY B 2 G G B 2 G ER Y EMPLO TAX PRACTITIONER MPC sub channels Bundling Alt Auth of Pull XML encryption security B 2 G B 2 B th B 2 G SUPER FUND (or administrator) Au G B 2 B L One way Push One way Pull Two way Push/Push Two way Push/pull Two way Pull/Push Username & Password Auth PKI Auth Split/Join Multi Hop endpoint Reception Awareness Reliable Messaging Compression Body Duplicate detection XML Signature Security of Attachments Transport Level Security BANK M SA SUPER FUND (or administrator) Two way Synch Multi Hop Authenticate Pull Selective Pull MPC PAYROLL PROVIDE R 5 Unclassified – Software Developer Training - SBR 2

Message Type Invocation Modes Response Time Service Level Service Invocation Type eb. MS 3

Message Type Invocation Modes Response Time Service Level Service Invocation Type eb. MS 3 MEP Single Synchronous Chatty Single-Sync-Chatty Two. Way/Synchronous Single Asynchronous Chatty Single-Async-Chatty Two-Way/Push-and. Pull Batch Asynchronous Intermediate Batch-Async. Intermediate One-Way/Push Batch-Async-Delayed One-Way/Push Batch Asynchronous Delayed One-Way/Selective. Pull Bulk Asynchronous Intermediate Bulk-Async-Intermediate One-Way/Push One-Way/Selective. Pull Bulk Asynchronous Delayed Bulk-Async-Delayed One-Way/Push One-Way/Selective. Pull Collect Asynchronous Delayed Collect-Async-Delayed Two-Way/Push-and. Pull MEP – Message Exchange Pattern 6 Unclassified – Software Developer Training - SBR 2

Some basic information on eb. MS 3/AS 4 • The eb. MS 3. 0

Some basic information on eb. MS 3/AS 4 • The eb. MS 3. 0 standard composes the fundamental Web Services standards SOAP 1. 1 [SOAP 11], SOAP 1. 2 [SOAP 12], SOAP with Attachments [SOAPATTACH], WS-Security ([WSS 10], [WSS 11]), WS-Addressing [WSADDRCORE], and reliable messaging (WS-Reliability 1. 1 [WSR 11] or WSReliable. Messaging - currently at version 1. 2 [WSRM 12]) together with guidance for the packaging of messages and receipts along with definitions of messaging choreographies for orchestrating document exchanges. • As a profile of the eb. MS 3. 0 specification, AS 4 leverages much of messaging services requirements defined in that standard. Message security is governed by the WS-Security specification with support for payload compression. AS 4 supports both document push and pull message exchange choreographies, contains an AS 2 -like business nonrepudiation of receipt, and has the support for reception awareness providing just enough reliable messaging without overspecifying the functionality. Source: http: //docs. oasis-open. org/ebxml-msg/ebms/v 3. 0/profiles/AS 4 -profile/v 1. 0/os/AS 4 -profilev 1. 0 -os. html 7 Unclassified – Software Developer Training - SBR 2

Your choices on e. BMS implementation Build, Buy or Partner. • Build • You

Your choices on e. BMS implementation Build, Buy or Partner. • Build • You do not need the full feature set of e. BMS / AS 4 to deliver services for the ATO • Understand the MEP’s needed for each service. • Services delivered for different ATO systems and B 2 B delivery require different e. BMS / AS 4 functionality. • Buy • Consider the value for money proposition of purchasing a product against delivery and maintenance effort. • You may not need to consume a fully featured e. BMS product. • Partner • Value of passing the e. BMS delivery to a 3 rd party or even have them send the data to the ATO • Potential for negotiation on what and how you send data and agreements being made between the parties. > ATO product register http: //softwaredevelopers. ato. gov. au/eb. MS 3_MSHproductsservices > ABSIA Sept expo https: //www. absia. asn. au/page/For 7 Sept 16 > ABSIA prod register https: //www. absia. asn. au/page/For 7 Sept 16 8 Unclassified – Software Developer Training - SBR 2

Account Managers The Software Developer Onboarding Team (SWDOT) develops and maintains productive relationships with

Account Managers The Software Developer Onboarding Team (SWDOT) develops and maintains productive relationships with external Software Developers, technical and internal ATO stakeholders, in order to efficiently deliver the desired Electronic Service Delivery outcomes. Upon registering to become a SBR software developer to interact with the ATO (Tax Practitioner, Employer Obligations and Super Industries), all software developers will be allocated an account manager from the ATO’s Software Onboarding team. As your account manager, the Onboarding team representatives will; • Assist with Software and technical related questions for all ATO web service delivery. • Facilitate the integration of software developer partners systems to SBR. • Be the professional advocate for software developer partners within the ATO. • Provide management and technical resolution of on-boarding issues. To register as a SBR developer http: //www. sbr. gov. au/software-developers/what-can-i-expect/registration-form 9 Unclassified – Software Developer Training - SBR 2

Important Links Software Developer detail on SBR. GOV. AU http: //www. sbr. gov. au/software-developers

Important Links Software Developer detail on SBR. GOV. AU http: //www. sbr. gov. au/software-developers SBR taxonomy architecture http: //www. sbr. gov. au/software-developers/enabling-sbr-in-my-application/sbr-taxonomy/taxonomyarchitecture SBR e. BMS web service artefacts (WIG, SDK) http: //www. sbr. gov. au/software-developers/developer-tools/new-form-pages/ebms-webservice SBR forms / services for the ATO http: //www. sbr. gov. au/software-developers/developer-tools/ato 10 Unclassified – Software Developer Training - SBR 2

Analysis and ATO documentation

Analysis and ATO documentation

ATO Documentation Details of the ATO relevant information can be found at; http: //www.

ATO Documentation Details of the ATO relevant information can be found at; http: //www. sbr. gov. au/software-developers/developer-tools/ato 12 Unclassified – Software Developer Training - SBR 2

ATO Common MIG • Defines common service behaviour for all ATO services, including: •

ATO Common MIG • Defines common service behaviour for all ATO services, including: • e. BMS 3 service invocation types, message packaging, header configuration and physical endpoints. • Standard Declarations. • General XBRL instance information (Units and measurement). • Data format validation (XBRL and JSON). • Rule expression and Structured English dictionary. • Spreadsheet definitions (MST, CST, Validation Rules) 13 Unclassified – Software Developer Training - SBR 2

ATO Service Suite Instructions specific to an ATO obligation (form, schedule or service). •

ATO Service Suite Instructions specific to an ATO obligation (form, schedule or service). • Interaction specification (including WSDL and e. BMS 3 message type) • SBDM/e. BMS 3 Header configuration variations • Specific Declarations • Associated messages(Schedules) to be used 14 Unclassified – Software Developer Training - SBR 2

Message Structure Table A definition of the data contained in the message which is

Message Structure Table A definition of the data contained in the message which is sent/received by the service including: • Facts (data elements) • Tuples(containers) • Context elements (where information is contained in the context instance e. g. TFN) • Specification for the schemas • Message may be re-used across services • Reference the SBR AU definitional taxonomy • Aliases are used to define each data item • Context instances are referred to by Context alias 15 Unclassified – Software Developer Training - SBR 2

Context Structure Table Definition of the context instances consumed by a message Each Context

Context Structure Table Definition of the context instances consumed by a message Each Context instance has: • A context alias which can be cross-referenced with the MST • Period values (whether for a duration or instant) • Dimensions and dimension values (e. g. Report Party Type and Foreign Jurisdiction) • Entity identifier information (e. g. TFN) 16 Unclassified – Software Developer Training - SBR 2

Validation Rules • Validations run by the channel before internal processing occurs • Specified

Validation Rules • Validations run by the channel before internal processing occurs • Specified using Structured English • Functions are defined in the ATO Common MIG – Rules dictionary • Implemented in Schematron (XBRL messages) • Additional validation may occur in the internal processing system which may generate additional error messages IF [CTR 77] <> NULL AND [CTR 77] <> MONETARY(U, 11, 0) RETURN VALIDATION MESSAGE ENDIF [CTR 77] = CTR: RP. JAUS: bafpr 2. 00: Expense. Operating. Lease. Amount 17 Unclassified – Software Developer Training - SBR 2

ATO Message Repository • • A central repository of the messages returned from ATO

ATO Message Repository • • A central repository of the messages returned from ATO services XML format 18 Unclassified – Software Developer Training - SBR 2

ATO Conformance Suite package CS Key Store Conformance Suite Key Store AUSkeys to be

ATO Conformance Suite package CS Key Store Conformance Suite Key Store AUSkeys to be used in EVTE CS CN Conformance Suite Cover Note Details of the changes from prior deployments and known defects Conformance ATO Conformance Suite of artefacts pertaining to the Service/Obligation CS Test Cases Conformance Test Cases Details of the test cases required for certification Test Instances Conformance Test Instances XBRL test data that can be used with test cases 19 Unclassified – Software Developer Training - SBR 2

Important Links ATO Page in SBR http: //www. sbr. gov. au/software-developers/developer-tools/ato Subscriber page (system

Important Links ATO Page in SBR http: //www. sbr. gov. au/software-developers/developer-tools/ato Subscriber page (system status and document updates) http: //www. sbr. gov. au/bulkmail/forms/subscribe-to-ato-landing-page 20 Unclassified – Software Developer Training - SBR 2

High level description of the ebms 3 SDK, C# Rules, Xml vs Xbrl and

High level description of the ebms 3 SDK, C# Rules, Xml vs Xbrl and Access Manager

Overview • The following will be covered at a high level • The purpose

Overview • The following will be covered at a high level • The purpose of the ebms 3 SDK embedded /reference client • Description of C# Rule Usage for SBR. • Operation of Access Manager 22 Unclassified – Software Developer Training - SBR 2

SBR SDK and Reference Client The Reference Client is provided as an example of

SBR SDK and Reference Client The Reference Client is provided as an example of how to connect to SBR using the ebms 3/AS 4 standards. The reference client is provided in Java, . NET and C. Both 32 Bit and 64 bit versions exist. All implementations rely on Java. 23 Unclassified – Software Developer Training - SBR 2

Context 24 Unclassified – Software Developer Training - SBR 2

Context 24 Unclassified – Software Developer Training - SBR 2

Reference Client Overview The SBR Reference Client is aimed at giving Software Developers an

Reference Client Overview The SBR Reference Client is aimed at giving Software Developers an example of how to connect to the SBR eb. MS 3 platform using the SDK components provided by SBR. It is an example only and is not intended for production use. The reference client shows how to: • Interact with an AUSkey credential store. • Use a credential from the AUSkey store to call Van. Guard. • Package bulk/batch requests. • Submit requests. • Interpret the responses received. 25 Unclassified – Software Developer Training - SBR 2

eb. MS 3 Embeddable client • • • Is an implementation of a client

eb. MS 3 Embeddable client • • • Is an implementation of a client eb. MS 3 Message Service Handler (MSH) that supports the exchanges applicable to SBR. Depends on the Java Runtime Environment (the IBM JRE is supplied). It facilitates communication between your business software and the SBR eb. MS 3 server using the eb. MS 3 protocol. 26 Unclassified – Software Developer Training - SBR 2

Recommendations • • • Use the Reference Client, eb. MS 3 SDK Developer guide

Recommendations • • • Use the Reference Client, eb. MS 3 SDK Developer guide and SBR eb. MS 3 Web Services Implementation Guide to familiarise yourself with the technologies and how they are used. Use the ebms 3 embedded client but abstract your business software from the implementation so that you are able to switch out the embedded client. Consider purchasing an eb. MS 3 message handler and adapt its implementation using the abstraction layer created above. 27 Unclassified – Software Developer Training - SBR 2

C# Rules • The ATO has recently moved from using Schematron (20102016) to using

C# Rules • The ATO has recently moved from using Schematron (20102016) to using a C# (2017 onwards) based implementation. • This decision was based upon performance and maintenance costs for the ATO. • Schematron just has not scaled from both a performance and time to market perspective. • These reasons were considered to be of more benefit to third parties than providing a platform agnostic implementation. • The C# files that the ATO provides for third parties reflects the code that the ATO currently uses at run time for both the eb. MS 3 and SBR 1 platforms. 28 Unclassified – Software Developer Training - SBR 2

C# Overview – How the ATO uses it • • • Each business rule

C# Overview – How the ATO uses it • • • Each business rule in the Business Rules Spreadsheet has a corresponding implementation in the C# rules are based on an assertion model – so each business rule checks data elements within the incoming message and will return an error message if that assertion fails. These rules are considered to be “boundary layer” rules as no calls are made to back end systems. 29 Unclassified – Software Developer Training - SBR 2

C# Rules – How you can use them The ATO provides C# to software

C# Rules – How you can use them The ATO provides C# to software developers as a reference implementation – a very unusual practise for web services. The following are some ways in which the files can be used. • Unit testing of software products – allowing you to test the output reports that your product produces to see if they will pass through ATO boundary validation checks. • Could enable you to create a mock service that may allow you to run tests without hitting the EVTE environment. • You could use third party tools to convert the C# to another programming language. • Provides some additional clarity of what a business rule means at run-time. • Note that it is not recommended to include the provided C# rules in your delivered product. 30 Unclassified – Software Developer Training - SBR 2

C# Rules – What you need to use them • The. NET runtime 4.

C# Rules – What you need to use them • The. NET runtime 4. 5+ is recommended. • If you do not use. NET then either: • Potentially use C# conversion software to allow the C# to be converted to another language. • Or create a web service/mock that allows the rules to be called from your language/run time environment. • Any editor can be used to view/edit the C# files – but visual studio is recommended. 31 Unclassified – Software Developer Training - SBR 2

C# – Generation • • • The ATO has invested heavily over the past

C# – Generation • • • The ATO has invested heavily over the past year in enabling code generation for C#. The ATO is currently migrating from manually written code to generated code. Cross form rules are currently not generated. 32 Unclassified – Software Developer Training - SBR 2

Xbrl vs Xml The ATO is still heavily invested in the SBR taxonomy –

Xbrl vs Xml The ATO is still heavily invested in the SBR taxonomy – however the over the wire format is changing from Xbrl to Xml. All data elements are still based on the SBR definitional taxonomy. The following general strategy is being used for selection the data format. Change Type Format Validation Technology Code Generated New Service Xml (mostly) or JSON. C# Y New version of existing Xbrl service (1) Xbrl - New Taxonomy Architecture C# Y 33 Unclassified – Software Developer Training - SBR 2

Access Manager enables an Administrator to assign permissions for Standard AUSkey holders and Device

Access Manager enables an Administrator to assign permissions for Standard AUSkey holders and Device AUSkeys in their business to control access to ATO online services. 34 Unclassified – Software Developer Training - SBR 2

What Access Manager allows for • • Management of employee access to tax records

What Access Manager allows for • • Management of employee access to tax records for businesses, Tax and BAS agents. Allows a business to specify another business that can act on their behalf. Allows Tax/BAS Agents to restrict employee access to particular clients. Allows businesses and agents to select and authorise online service providers who are able to security submit lodgements from the cloud. 35 Unclassified – Software Developer Training - SBR 2

Access Management - Future Services • Currently there are no services that enable management

Access Management - Future Services • Currently there are no services that enable management of end user security directly through a third party product. • The perceived benefit for the creation of AM services is the ability for users of third party products to stay within their product rather than having to go to the ATO web site to manage permissions. • The level of interest will determine the priority over building of other business value services. • Adding security maintenance features is inherently higher risk that other business services thus requiring a higher level of testing. • The use of device AUSkeys for Online Service Providers also has to be considered in the viability of creating Access Management Services. 36 Unclassified – Software Developer Training - SBR 2

Where to find further information Access Manager information can be accessed from the following

Where to find further information Access Manager information can be accessed from the following links: Link Description https: //am. ato. gov. au/amsupport/pag es/Permissions. Help. htm Provides a list of permissions and their support for SBR. https: //www. ato. gov. au/General/Onli ne-services/In-detail/Transact. Online/Using-Access-Manager/ Describes what you can do within Access Manager https: //am. ato. gov. au/amsupport/pag es/Scenarios. pdf Describes key scenarios for common usage of Access Manager. https: //abr. gov. au/AUSkey/ Reference Information for AUSkey 37 Unclassified – Software Developer Training - SBR 2

Implementation

Implementation

Business 2 Government & Business 2 Business Super. Stream eb. MS 3 Standards cover

Business 2 Government & Business 2 Business Super. Stream eb. MS 3 Standards cover each of the transaction below. Not every group will require every aspect of eb. MS 3, but should be able to handle the all features offered by eb. MS 3. B 2 B and B 2 G have mutual and exclusive patterns used, some outside the eb. MS 3/AS 4 standard, B 2 B Super. Stream eb. Ms 3/AS 4 GOVT AGENCY B 2 G G B 2 G ER Y EMPLO TAX PRACTITIONER Unclassified – Software Developer Training - SBR 2 MPC sub channels Bundling Alt Auth of Pull XML encryption security B 2 G B 2 B h G B 2 G SUPER FUND (or administrator) t Au B 2 B L One way Push One way Pull Two way Push/Push Two way Push/pull Two way Pull/Push Username & Password Auth PKI Auth Split/Join Multi Hop endpoint Reception Awareness Reliable Messaging Compression Body Duplicate detection XML Signature Security of Attachments Transport Level Security BANK M SA SUPER FUND (or administrator) Two way Synch Multi Hop Authenticate Pull Selective Pull MPC PAYROLL PROVIDE R 39

Choosing an SBR Implementation Model All parties in the SBR program must choose an

Choosing an SBR Implementation Model All parties in the SBR program must choose an implementation feature set. We have suggested three patterns in this presentation. To select a pattern: eb. MS 1. Understand your business model and Transaction volumes. Super 2. Understand SBR, Super. Stream and STP Specifications. 3. Determine what eb. MS 3 feature set and pattern is appropriate to your business. Super eb. MS Super ATO Super eb. MS Super 4. Choose eb. MS 3 Implementation approach. Should I: • Buy • Build or • Partner? Super Other eb. MS Gateways Universal Client Minimal Client

Architecture of the ATO Gateway SBR transactions are handled: 1. Software packages construct SBR

Architecture of the ATO Gateway SBR transactions are handled: 1. Software packages construct SBR payloads and transport via eb. MS. 2. Core services may route transactions to the ATO or any other SBR gateway. 3. Transactions are authenticated and authorised using Aus. Key certificates. 4. Transactions are handled in bulk or single. 5. SBR messages are validated and transformed to target system format. 6. ATO back office systems process transactions.

Testing

Testing

Systems Development Process Readiness is continuously assessed throughout the software takeup and deployment cycle

Systems Development Process Readiness is continuously assessed throughout the software takeup and deployment cycle Software Developer Take-up Cycle INFORMED ALIGNED COMMITTED PLANNED EXECUTED DEPLOYED OPERATING Expansion of ‘Executed’ and ‘Deployed’ Steps Software Developer SWD BUILD BUSINESS REQUIREMEN TS SERVICE SPECIFICATIO N BUILD INTEGRATION TEST EVTE FUNCTION TEST INTEGRATION TEST ATO BUSINESS ACCEPTANCE CONFORMAN CE TEST DEVELOPMEN T PRODUCTION WHITELIST AND PILOT 43 Unclassified – Software Developer Training - SBR 2

Multi-modal Testing e. Commerce has developed a double V Model for testing with SWD.

Multi-modal Testing e. Commerce has developed a double V Model for testing with SWD. This is largely used to explain to SWD their expectations and touchpoints with the ATO for testing. This process adapts to SWD with differing methodologies. Behind the e. CSD layer the ‘back-end’ changes can be delivered and tested in their existing practices adapting to the ATO’s multi-modal delivery approach. 44 Unclassified – Software Developer Training - SBR 2

Interoperability Process eb. MS 3/AS 4 Interoperability: Testing to done through an external organisation

Interoperability Process eb. MS 3/AS 4 Interoperability: Testing to done through an external organisation (such as the Drummond Group) to test for interoperability by simulating authentic transaction. Done by a matrix of test cases with all eb. MS 3/AS 4 enabled products. A certificate should be supplied to provide the product developer with certification there product has been tested against SBR. Similar to the heart foundation tick but applied to eb. MS 3 compliant products. Interoperability Trials Conducted by industry aligned groups to demonstrate interoperability at the business process level. Conformance Testing Conformance testing is used to ensure that defined standards are met. Testing the business message interoperability will be done through the SBR 2 conformance process. 45 Unclassified – Software Developer Training - SBR 2

ATO Production Go-Live Prod SWD Production Deployment EVTE Conformance Testing Level 4 System and

ATO Production Go-Live Prod SWD Production Deployment EVTE Conformance Testing Level 4 System and Performance Testing EVTE Waterfall EVTE Integrated Product Testing In House Unit and Product Testing e. Commerce Testing ATO Processing Testing Level 1 & 2 Agile / Iterations 46

8. Software Developer On-Boarding • Developer Registration required • through SIPO, SBR Service Desk

8. Software Developer On-Boarding • Developer Registration required • through SIPO, SBR Service Desk or existing account manager • Onboarding Team support services • Facilitate the integration of software developer partners systems to STP • Professional advocate for software developer partners within the ATO • Support, management and technical resolution of on boarding issues • Account management services to software developer partners • Testing & production release support • Limitations of the EVTE • Production Verification Test • Whitelisting and Certification • Assisting through the ATO Business process • Certifying the software and promoting via SBR Website UNCLASSIFIED

Production Service A Deploy Service A Go-Live Service C Deploy EVTE Conf Platform Deployment

Production Service A Deploy Service A Go-Live Service C Deploy EVTE Conf Platform Deployment Service B Service C Service A Level 4 Platform Service B Service C Service A Platform Service B Iteration 1 EVTE (IPT) Level 2 Service B Go-Live Service B Deploy Service A Iteration 1 Service C Iteration 1 Service A Iteration 2 Service C Iteration 3 Platform Service B Iteration 1 Service A Iteration 1 Platform Service C Iteration 1 Service A Iteration 2 Service C Iteration 3 48

Questions? UNCLASSIFIED

Questions? UNCLASSIFIED