The following diagram illustrates the process flow on the My Accounts (Enrollment Summary) portal page.
User access information is implicitly refreshed upon login. For example, a business owner that opened a new business and registered it with the tax authority would be automatically given an access to this new business account.
The request is handled by a special web service, TSGetUserEnrollment.
The integration has the following steps:
The request is initiated from the self service product. The XML message contains web user ID.
The SOA Composite is querying the user access store, retrieves all enrollment records and populates them on the request; each record includes tax account identifiers line of business and enrollment ID.
The request is forwarded to the product. The processing service script finds enrollment request service task associated with each input enrollment ID. It reads service task type configuration under Enrollment Instructions, and invokes the enrollment retrievers associated with the input access type. The input list of tax accounts is compared with the retriever's response, and any new entries are added to the output. Entries that are no longer present on the list are added to the output with Inactive status.
The response is processed by the integration layer and new user's tax accounts are added to the user access store.
The results of a successful enrollment refresh may be a creation of one or more new records in user access store. Each record is stumped with the original enrollment ID/line of business combination.
Upon login the self service product displays the user enrollment summary that contains a list of all tax accounts that the user is eligible to view and manage. This is an inquiry request that defines its own web service (TSGetEnrollmentSummary). The integration has the following steps:
The request is initiated from the self service product. The XML message contains the user ID.
The SOA Composite queries the user access store and retrieves all enrollment records. Each record includes tax account identifiers (access type and access keys), line of business, and enrollment ID.
The list of enrollment records is delivered to the system. The processing service script finds the enrollment service task associated with the input enrollment ID, reads the service task type, and calls the account summary retriever. The retriever also marks one enrollment record as a default. When the web service response reaches portal application, this record is automatically pulled into a self service session context.
The self service product displays tax account highlights on the My Accounts portal page. The single tax account enrollment summary includes two components:
Title - a short description of the tax account.
Details - essentials about tax account status.
Both parts of the summary are composed using message text with the substitution parameters.
The base product is expected to supply the actual data items, including dates, numbers, and types. This information is used by the self service product as substitution parameters for the Summary messages.
The enrollment summary retriever is expected to deliver the following information:
Summary Title parameters list.
Summary Details parameters list.
Taxpayer Name (required, used internally by the self service product).
Account Name (optional, used internally by the self service product).
The enrollment summary retrievers provided with the base product return the following
Individual enrollment summary - returns a summary title parameter tax type and summary details parameters: tax role's start and end date and an outstanding balance forecasted for the current date.
Business enrollment summary - returns a summary title parameter tax type and summary details parameters: tax role's start and end date and an outstanding balance forecasted for the current date and a formatted address.
Copyright © 2007, 2016, Oracle and/or its affiliates. All rights reserved. Documentation build: 2.5.2016 10:21:45 [T1_1454696505000]