New Solutions should match the way you work or enhance it. The SWAN UI5 Reporter is made to integrate in your existing processes and our success is defined by how easy technology smoothes your workflows. With the extensibility of SWAN UI5 Reporter you can view all reports in the built-in Reporting Viewer dialog, send mails to your service-desk with all relevant data or let the tool generate Jira tickets. Watch your efficiency increase, with this process enabler.
Jira Integration
With the Jira integration, Jira tickets can be created automatically for reporting cases. The configuration for this can be carried out via the Maintenance Dialog.
The target project and task type can be freely selected, see table. The reporting data is attached as individual JSON files. The Reporting Viewer is best suited for analyzing large amounts of data.
The data required for the Jira configuration is stored in the corresponding database table.
| Option | Description |
| base | Basic Jira address, like example.com |
| api_user | User or e-mail for the API authentication |
| api_token | Authentication token of the API user |
| project_key | key of the Jira project in which new reports are to be created |
| issuetype_name | Name of the issue type to be used for creating new Jira tasks (e.g. „Bug“) |
The creation of API tokens in Jira can be found in the support section of the Atlassian website, see: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
If an error occurs in Jira, an exception will be triggered.
Note: A current Jira Cloud environment with API token capability is required for the Jira integration. Self-hosted Jira servers that are no longer maintained are excluded.
Reporting Viewer
The Reporting Viewer is a standalone dialog delivered together with the SWAN UI5 Reporter. When the dialog is launched from the launchpad, an entry screen allows you to select reporting data, see illustration. The advantage of the Reporting Viewer is the processing of data stored in the background.
The „Today“ and „Yesterday“ buttons provide quick access to the corresponding time periods.
For more detailed selection, you can specify date, time, namespace, user, and the title of the UI5 application as search criteria.
After making a selection, the main screen appears, which is structured according to the master-detail concept, see following illustration.
On the left side, you will find the report submissions, which can be further filtered using the search function.
On the right side, in the master area, you will find the main information of the report. This area is further divided into different sections using a navigation bar; more details can be found in the following table:
| Category | Information |
| General | Reporter, Browser, UI5 application, UI5 libraries, start parameters, attachments |
| Manifest | Manifest of the UI5 application |
| Data | JSONModel with content |
| Requests | OData communication |
| Events | User interactions |
| UI5 | Logs from the UI5 framework |
| Console | Logs from the browser |
| ABAP | ABAP logs (only for On-Premise) |
At the bottom of the dialog, there is a button that allows you to jump directly to the UI5 documentation for the relevant UI5 version. The adjacent „Open Dialog“ button lets you navigate directly to the affected dialog. Finally, the „Delete“ function allows you to permanently remove the report submission from the database.
E-Mail Integration
Submitted reports can also be sent automatically via e-mail. There are two options for this:
- SMTP: Sending the e-mail via an SMTP connection.
- BCS: Using SAP’s legacy Business Communication Services (BCS) system.
SMTP
To use the SMTP option, an active SMTP connection must be set up on the SAP system and the necessary authorizations for sending must be in place. Once these prerequisites are met, an e-mail address can be entered as the recipient in the „SMTP Configuration“ section (see illustration below). Optionally, a prefix for the e-mail subject can be specified. A prefix is any text that is added at the beginning of the e-mail subject, which can be useful for e-mail rules. You can also chose whether all file attachments related to the error case should be sent by e-mail.
Business Communication Services (BCS)
To use the BCS option, an appropriate configuration must also be set up on the SAP system. Unlike the SMTP connection, a user must be specified for sending (see illustration). In addition, the recipient address and, optionally, a prefix must be provided. Here as well, you can choose whether the e-mail should be sent with or without file attachments.
