Reporting gives user the ability to record actions on a device and generate a report about them.
Create a new Manual Report
A standard report contains its name and at least 1 step. Each step contains its description, expected result, and actual result. Users can also set the status of the step to success or failure.
Any interaction with the device(swipe, click etc) has to be part of a step. Hence a step can contain a list of interactions.
Saved reports can be viewed in the reports page.
In order to create a report, use the following buttons:
- Open/Close: Click this button to open or close the report view
- Report Title: User can edit the report name by clicking on it, Insert the new text and click on the tick button next to it
- Add step: Add a new step
- Scroll lock: Lock or unlock report scrolling
- Start\Pause recording: Start or Pause the recording of the report.
- Step name: Users can edit the step name by clicking on its' name, Insert the new text and clicking on the tick button next to it
- Step Status: Change step status to Success() or Failure()
- Step Options: Additional actions that can be performed on the step
- Description Area: Write the step's description here
- Expected Result Area: Write the step's expected result here
- Actual Result Area: Write the step's actual result here
- Reset All Steps: Reset all the steps to the start of the report.
- Done: Navigate to the report summary page
A User can record the action it performs on the device. We call this user action Interaction. To start recording interaction, users can click on the Record Button. As soon as the recording starts, the button's text changes to Pause, which indicates that a user can pause it at any point in time. When user first clicks on the record button, a video report gets started recording, this video report records the screen of the device. Hence, when users see the report, in the reporter after completion, they will also see a video of the device's screen with show every action that has been performed on the device.
Pause button pauses the interaction with the device, but it doesn't stop the video report. Video report keeps on going. Since the device's screen feed is paused, the part of the video report, for which pause was in action, will show a constant frame. This frame is also the last frame before the recording was paused.
An Interaction can only be recorded to a step. One cannot add interaction outside the scope of a step. A REC icon as an indicator is displayed on the step to which the interactions are added. All other steps are disabled. An Interaction can only be added to the Last Step of the report. If users click on Add Step button, the new step will be the last step and recording shall happen to that step. One can also see the REC icon being displayed on the new step.
If need be aroused to record to any step before the last one, users have to delete the steps after that step. Thus making it the last step.
Later in QC Report we will see that an interaction can also be recorded to the first step.
Users can delete an Interaction by finding the delete button on the options icon next to the interaction.
Delete an interaction only deletes it from the UI, but not from the video report. Deleting single or a bunch of interactions disturbs the sync between the video report and the steps. However, a User can delete the whole video report by performing Reset all steps.
Save and view report
After the report is ready, click on the Done report button.
It navigates to a Report Summary View. In this view users can see the summary of the report. Apart from that, users can also set the status of the whole report.
A User cannot move to the Report Summary view until the status of all the steps are marked.
User now has 2 choices :-
- Save the Report by clicking the Save Report button
- Go back to edit view by clicking on Back to testing button
After saving a report, User can either Start a fresh new report or it can view the currently saved report.
Use a Report Template
Report Templates are very much similar to a manual report.
When using Report Template, the user starts the mobile studio session by passing it with a template of a manual report.
By using the report template feature, you can integrate with external test management tools to create a template of a report directly from your test management tool
Create a Report Template
Use Device Rest API to create a manual session of Mobile studio. Pass your template data as a payload of this request (Please check the API Doc for details).
The API returns a link to the mobile studio. Open the link in a browser. You will see manual report view is opened with the steps already added.
New Action in QC Report
You can see there are 3 new actions added to a report generated from a template:
Options with Red Dot: Red dot in the options icon indicate that the step has an attachment to it. (Please refer to the API doc for more details on attachment)
Next Step: Move recording from current step to next step.
Previous Step: Move recording from current step to the previous step. If there are interactions in the current step, users will get a popup saying that the interactions will be deleted to move the recording to the previous step.
Differences From Manual Report
Report generated from a report template shows a bit different behavior from manual report although they use the same UI design.
All the data passed via API are disabled in UI. Hence you cannot update the Report name or step name. Even expected result and description will be disabled if passed via API
User cannot add a step
User cannot delete a step.
Reset All steps will reset to the original report template.
Recording interactions works the same as one in the Manual report with only one difference - recording starts with the First Step.
In order move the recording to the next step, the user first needs to set a status of the current step and then click on the "Next Step button". Similarly, in order to move the recording to the previous step, user needs to click the Previous Step button. Apart from that everything is same as manual report.
Next and Previous buttons are only enabled when recording is on.
For More details read Manual Report: Record Interactions
Save and View QC Report
You can also get reports in JSON format by calling the Reporter API: Get Test By the manual report identifier (report_api_id). The API needs report_api_id which users will get in response of Device Rest API.