A successful log in places you on the home page of OIDG portal. Click the ‘QuickView’ icon under Application tab to access the QuickView application. A new tab starts in your browser where you can use this application.
Figure 3.2.1 - QuickView Home Page
There are four tabs located at the top left and two options on the right; an About link and a Logout link. The About link displays version information when clicked.
The four available tabs include:
Batch Groups – This tab allows you to view batch groups .
Batch Transactions – This tab allows you to view batch transactions.
WebService Transactions – This tab allows you to view web service transactions.
Resubmit Requests – This tab allows you to resubmit failed outbound transactions.
Batch Groups
The Batch Groups tab is selected by default when you launch QuickView. This section will help you to learn about using and monitoring batch groups activities.
Searching for Batch Groups Transactions
To find a specific batch group use the search panel. This section filters the batch groups that you wish to view.
Figure 3.2.2 - Filters in Batch Groups Tab
Note:
By using Match values “All” or “Any”, you can control how your search criteria are matched against the result set.
Figure 3.2.3 - Matching All/ Any
Using calendar icon
Click the calendar icon to select a start and end time. Start Time and End Time search criteria fields are defaulted with current date and time.
If you select only a date, time is set by default as shown below.
StartTime: 25-Sep-2017 12:00:00 AM
EndTime: 25-Sep-2017 11:59:59 PM
Figure 3.2.4 - Using Calendar Icon
To do a search
You can search on one or more criteria. The more criteria you include, the more defined your results. Select one or more criteria. Available fields include:
Field
Description
Start Time/End Time
Select the start time and end time using the calendar icon to filter the transactions happened during between that periods.
Unique ID
A system generated GUID to identify a single batch group/ batch/ transaction/ transmission record.
Batch Group Status
Select the batch group status using the drop down. The available statuses are:
Completed: Transaction that are successfully completed.
Completed with error: Transactions that belong to batches that have at least one failed transaction.
Pending: Transactions waiting for outbound processing to complete.
Initiated: Transactions that are received and waiting for inbound processing to complete.
Failed: There are chances of getting failed transaction due to communication interference with the external system or system timeout during the transaction processing. Those failed transactions will be available for retry under Resubmit Request tab.
Error: Transactions that reported the following errors:
XMLSchemaErrror
BusinessRuleValidationError
CommunicationError
BusinessServiceError
ApplicationError
Unknown: Unknown status in the detail section is shown when the group/batch/transaction is either missing or the associated error log entries are missing.
Batch Group ID
A unique ID assigned to a batch group.
Sender Party
Select using the drop-down
Enter your criteria. For better results, be as specific as possible.
For example, if you enter duration using the Start Time / End Time field and click search button, you will see a list of transactions created within that time interval of time. Based on other search criteria such as batch status, sender party, etc., transaction row count will vary. Figure 3.2.5 - Searching Batch Groups
Click Search to search for matching transaction records based on your input criteria.
Click Reset to clear all search fields and reset the search criteria.
Note:
A batch group status of “Completed” indicates that every individual transaction in the batch completed successfully with no errors.
A batch group status of “Completed With Errors” indicates that at least one transaction in the batch resulted in an error.
Viewing Batch Group(s) Transactions
Search results are displayed in the lower portion of the tab. The Transactions table contains the actual number of transaction records to be processed with. It displays completed transactions as well as in-process transactions.
The Transactions table displays the following details:
ID: A unique ID assigned to each transaction.
Batch Group Status: Represents the status of batch group.
Completed: The batch group is successfully completed all transactions.
CompletedWithErrors: At least one transaction in the batch group failed but all transactions were processed.
Pending: At least one transaction in the batch group has not yet been processed.
Initiated: Batch processing has begun.
Failed: There are chances of getting failed transaction due to communication interference with the external system or system timeout during the transaction processing. Those failed transactions will be available for retry under Resubmit Request tab.
Error: Transactions that reported the following errors:
XMLSchemaErrror
BusinessRuleValidationError
CommunicationError
BusinessServiceError
ApplicationError
Unknown: Appears when the group/batch/transaction is either missing or the associated error log entries are missing.
Create Time: The time the request was created
Batch Count: Number of batches.
File Name: Name of the file containing the transaction request.
Sender Party: The sender party’s short name key taken from the request message.
Unique ID: A system generated GUID to identify a single batch group/ batch/ transaction/ transmission record.
Transaction details can be viewed by using the expand icon. Details vary depending on the transaction status:
If the transaction status is pending, failed, initiated or error:
You will see ‘No data to display’ after you expand the row. Figure 3.2.6 - No Data to Display
If the transaction is completed or completed with errors:
You will see the following details –
Number of batches created
Number of transaction requests, group by status
Number of outbound transactions, group by endpoint Figure 3.2.7 - Highlighted Data
Batch Transactions
Batch transactions can be viewed and monitored in Batch Transactions tab. This section will help you to learn about using and monitoring batch file activities.
Searching for Transactions
To find a specific transaction(s) use the search panel. This section filters the transactions that you wish to view.
Figure 3.2.8 - Search Filters
Batch Transaction Selection drop-down is set to ‘Valid batches and batch groups’ by default. Once you enter search criteria, set the ‘Batch Transaction Selection’ drop-down and click Search, you will see the search results. Search criteria is maintained while switching tabs.
‘Batch Transaction Selection’ drop-down allows you to filter the search results for valid or invalid batches and batch groups.
Valid batches and batch groups
Setting the drop-down to ‘Valid batches and batch groups’ will filter the search results for the transactions that are completed or completed with error.
Invalid batches and batch groups
Setting the drop-down to ‘Invalid batches and batch groups’ will filter the search results for the transactions that failed to initiate.
Start Time and End Time search criteria fields are defaulted with current date and time.
Using calendar icon
Click the calendar icon to select a start and end time. If you select only a date, time is set by default as shown below.
StartTime: 25-Sep-2017 12:00:00 AM
EndTime: 25-Sep-2017 11:59:59 PM
Figure 3.2.9 - Using Calendar Icon
Note: The time zone is set to GMT for all the Start Time/ End Time.
To do a search
You can search on one or more criteria. The more criteria you include, the more defined your results. Select one or more criteria. Available fields include: Figure 3.2.10 - Batch Status Drop-down
Field
Description
Batch Transaction Selection
Select if you want to see results of valid batch requests or invalid batch requests. A batch is invalid when none of its requests can be initiated. Default selection is valid.
Start Time/End Time
Select the start time and end time using the calendar icon to filter the transactions happened during between that periods.
Policy Number
Enter the policy number if you want to search for a specific transaction by policy number.
Batch Status
Select the batch status using the drop down. The available statuses are:
Completed: Transaction that are successfully completed.
Completed with error: Transactions that belong to batches that have at least one failed transaction.
Pending: Transactions waiting for outbound processing to complete.
Initiated: Transactions that are received and waiting for inbound processing to complete.
Failed: There are chances of getting failed transaction due to communication interference with the external system or system timeout during the transaction processing. Those failed transactions will be available for retry under Resubmit Request tab.
Error: Transactions that reported the following errors:
XMLSchemaErrror
BusinessRuleValidationError
CommunicationError
BusinessServiceError
ApplicationError
Unknown: Unknown status in the detail section is shown when the group/batch/transaction is either missing or the associated error log entries are missing.
Enter your criteria. For better results, be as specific as possible.
For example, if you enter duration using the Start Time / End Time field and click search button, you will see a list of transactions created within that time interval of time. Based on other search criteria such as batch status, policy number, etc., transaction row count and total number of rows will vary. Figure 3.2.11 - Batch Transactions
Click Search to search for matching transaction records based on your input criteria.
Click Reset to clear all search fields and reset the search criteria.
Note:
By using Match values “All” or “Any”, you can control how your search criteria are matched against the result set.
Figure 3.2.12 - Matching All/ Any
“All” specifies that only results that match all the criteria should be returned. “Any” specifies that one or more of the criteria must match each record in the result set.
Adding Fields in the Search Panel
QuickView allows you to add more fields to further filter your search results. To add more search fields follow the steps below:
Click the ‘Add Fields’ drop down. Figure 3.2.15 - Adding Fields The fields containing a blue mark in front of them are default options.
Click any of the options to add them to the search criteria. This enhances filtering capabilities for more precise control. The following search fields are supported:
Field
Description
Batch Group ID
A unique ID assigned to a batch group.
File Name
File name.
Message Type
Please see 'Transaction Messages' topic in Overview chapter for more information.
Receive Time
The time the message was received.
Receiver Party
A short abbreviated name for the party who is receiving the request.
Sender Party
A short abbreviated name for the party who is sending the request.
Note: The fields mentioned in the topic ‘Searching your transactions’ are set as default. Those fields can neither be removed nor added using the ‘Advanced’ option.
Once you’ve added fields you can use the same method described in ‘Searching your transactions’ to search for policies or transactions.
To delete search fields click the ‘X’ icon located next to the field as shown below.
Figure 3.2.16 - Deleting Fields
Note: The Search option changes are for the current session only. Changes are not preserved after logging out.
Reordering Search Fields
QuickView allows you to reorder the search fields in the search panel. To reorder search fields:
Click the ‘Advanced’ button in the search panel then click Reorder. A Reorder Search Fields dialogue box is displayed. Figure 3.2.17 - Reorder Search Fields
Select the specific field that you wish to move up/down in the search panel.
Click icon to move up or icon to move down the selected field.
Or icons move the selection to uppermost and lowermost locations respectively.
Click ‘Ok’ to save your changes.
Note: Clicking the ‘Reset’ button will undo the changes and return the search panel back to its default settings.
Viewing Transactions
Search results are displayed in the lower portion of the tab. The Batch Summary Totals at the top of the tab are updated with the actual number of transactions returned. The maximum number of transactions displayed is 900.
Remember, the batch summary is generated based upon the completed transaction set which might not be complete when you are looking at the summary. The Transactions table contains the actual number of transaction records to be processed with. It displays completed transactions as well as in-process transactions.
The Transactions table displays the following details:
Transaction ID: A unique ID assigned to each transaction.
Batch Group ID: A unique ID assigned to a group of batched transactions. A batch group can contain a zip file of other batches, XML files or GPG files.
Batch Group Status: Represents the status of batch group.
Completed: The batch group is successfully completed all transactions.
CompletedWithErrors: At least one transaction in the batch group failed but all transactions were processed.
Pending: At least one transaction in the batch group has not yet been processed.
Initiated: Batch processing has begun.
Failed: There are chances of getting failed transaction due to communication interference with the external system or system timeout during the transaction processing. Those failed transactions will be available for retry under Resubmit Request tab.
Error: Transactions that reported the following errors:
XMLSchemaErrror
BusinessRuleValidationError
CommunicationError
BusinessServiceError
ApplicationError
Unknown: Appears when the group/batch/transaction is either missing or the associated error log entries are missing.
Policy Number: The policy number taken from the request message.
Status: The overall transaction status.
Completed: The transaction successfully completed.
Error: The transaction failed schema or business rule validation.
Pending: Inbound processing and validation has completed but outbound processing is still underway.
Failed: Outbound processing has encountered an error.
Message Type: See 'Transaction Messages' topic in Overview chapter for details.
Receive Time: The time the request was received.
File Name: Name of the file containing the transaction request.
Sender Party: The sender party’s short name key taken from the request message.
Receiver Party: The receiver party’s short name key taken from the request message.
Transaction details can be viewed by using the expand icon. Details vary depending on the transaction status:
If the transaction is completed: ‘No data to display’ is shown after expanding the row.
If the transaction is Pending: ‘No data to display’ is shown after expanding the row.
If the transaction is completed with errors: You will see error details about inbound and outbound transaction processing.
Inbound and Outbound Transactions
Expand those transactions that are completed with errors to view inbound/outbound transactions.
Figure 3.2.18 - Inbound and Outbound Transactions
WebService Transactions
Web service transactions can be viewed and monitored in the WebService Transactions tab.
Figure 3.2.19 - Inbound and Outbound Transactions
Searching for WebService Transactions
To find a specific transaction use the search panel located below the transaction summary totals. This section filters the transactions that you wish to view.
When you log in to the application and click WebService Transactions tab, Start and End Time displays with current date and time by default.
Using calendar icon
Click the calendar icon to select a start and end time. If you select only a date, time is set by default as shown below.
StartTime: 25-Sep-2017 12:00:00 AM
EndTime: 25-Sep-2017 11:59:59 PM
Figure 3.2.20 - Using Calendar Icon
Note: The time zone is set to GMT for all the Start Time/ End Time.
To do a search
You can search on one or more criteria. The more criteria you include, the more defined your results. Available fields include:
Field
Description
Start Time/End Time
Select the start time and end time using the calendar icon to filter the transactions happened during between that periods.
Policy Number
Enter the policy number if you want to search for a specific transaction by policy number.
Transaction Status
Select one of the following options in the drop-down to filter the search results by transaction status:
Completed: Transaction that are successfully completed.
Pending: Transactions waiting for outbound processing to complete.
Failed: There are chances of getting failed transaction due to communication interference with the external system or system timeout during the transaction processing. Those failed transactions will be available for retry under Resubmit Request tab.
Error: Transactions that reported the following errors:
XMLSchemaErrror
BusinessRuleValidationError
CommunicationError
BusinessServiceError
ApplicationError
To know more about these, see ‘Transaction Error’ topic in Overview chapter.
Batch Group Status
The status of entire batch group.
Enter your criteria. For better results, be as specific as possible.
For example, if you enter a search time period using Start Time/End Time fields and click the search button, you will see a list of all policies created within that time interval. Summary counts by transaction status are shown at the top of the page. The corresponding results are shown in the table below the Search panel. Figure 3.2.21 - Example Search Results
Note:
By using Match values “All” or “Any”, you can control how your search criteria are matched against the result set.
Figure 3.2.22 - Matching All/ Any
“All” specifies that only results that match all the criteria should be returned. “Any” specifies that one or more of the criteria must match each record in the result set.
Adding Fields in the WebService Transactions’ Search Panel
QuickView also allows you to add more search fields to filter your search results. To add more search fields follow these steps:
Click the ‘Advanced’ button as shown below. Figure 3.2.23 - Advanced Button
The following options appear. Figure 3.2.24 - Advanced Options
Click the ‘Add Fields’ drop down. Figure 3.2.25 - Adding Fields Fields with a blue mark in front of them are default options.
Click any one of the options to add them as search criteria. The following options are provided:
Field
Description
Message Type
Message Type can be:
Policy Migration, Policy Reconciliation
Receive Time
The time the message was received.
Receiver Party
A short abbreviated name for the party who is receiving the request.
Sender Party
A short abbreviated name for the party who is sending the request.
Status
Status can be:
Completed,
Pending,
Failed, or
Error
Note: The fields mentioned in ‘Searching your web service transactions’ are displayed by default. Those fields neither can be removed nor added using the ‘Advanced’ option.
To delete search fields click the ‘X’ icon located next to the field as shown below.
Figure 3.2.26 - Deleting Fields
Reordering Search Fields
QuickView allows you to reorder the search fields in the search panel. To reorder search fields:
Click the ‘Advanced’ button in the search panel then click Reorder. A Reorder Search Fields dialogue box is displayed. Figure 3.2.27 - Reorder Search Fields
Select the specific field that you wish to move up/down in the search panel.
Click icon to move up or icon to move down the selected field.
Or icons move the selection to uppermost and lowermost locations respectively.
Click ‘Ok’ to save your changes.
Note: Clicking the ‘Reset’ button will undo the changes and return the search panel back to its default settings.
Viewing WebService Transactions
Search results are displayed in the Transactions table.
Figure 3.2.28 - Viewing Web Service Transactions
Expand the failed transactions to view error details.
Resubmit Requests
This tab allows you to resubmit requests that have passed schema and business rule validation but failed submission to external systems.
Click the ‘Resubmit Requests’ tab.
Figure 3.2.29 - Resubmit Request Tab
Upon entering this tab, you are presented with a search panel to query the list of failed transactions. By default, the fields are empty. Based upon the search criteria you enter, failed transactions will display in the table below the search area.
Searching your failed transactions
In search panel, you will find the following search fields that are available to filter your list of failed transactions:
Field
Description
Batch ID
A unique ID representing a batch request.
Batch Group ID
A unique ID representing a batch group.
Policy Number
The policy number of a specific policy you wish to match.
Message Type
Message Type can be:
Policy Migration
Policy Reconciliation
Error Type
Error Type can be:
CommunicationError
BusinessServiceError
ApplicationError
Message ID
A unique ID representing the transaction.
Enter your criteria. For better results, be as specific as possible.
Resubmitting your requests
Your search results are displayed in the ‘Submissions Available for Retry’ table.
Figure 3.2.30 - Submission Available for Retry
Each transaction in the table contains a selection box. Mark the check box for each of the records you wish to perform actions on. Some actions are only available once you select a transaction.
Select all
Clicking ‘Select All’ will select the entire list of transactions available in the table. A confirmation pop up is presented.
Figure 3.2.31 - Confirmation Dialog
Deselect
Clicking ‘Deselect’ will uncheck the check box. A confirmation pop up dialog appears as shown.
Figure 3.2.32 - Confirmation Dialog
Click ‘Ok’ to proceed and the selected transactions are deselected.
Clear
Clicking ‘Clear’ will remove the selected transactions from the resubmission list. A confirmation pop up dialog appears as shown.
Figure 3.2.33 - Confirmation Dialog
Click ‘Ok’ to proceed and the selected transaction messages are removed from the resubmission list.
Submit
Clicking ‘Submit’ will submit the selected requests for processing. A confirmation pop up dialog appears as shown.
Figure 3.2.34 - Confirmation Dialog
When you click ‘Ok’, the selected transactions are resubmitted to their respective external destinations. If a submission fails again that transaction will remain available for resubmission until you clear it.
Refresh
Click ‘Refresh’ to refresh reapply the search. This allows you to refresh the page to see the new transaction summary after having resubmitted transactions. Those that have processed successfully after resubmission will no longer appear in the list. Row counts are also updated appropriately.