Create a report¶
A report collects text, results tables, graphs and postpro images for a set of Attitudes into one document in Bramble. You can keep it private, share it as a draft for review, and publish it to everyone in the Project.
Before you start
- Reports belong to a Project and include at least one Attitude.
- To share drafts or publish, you need Draft or Approve permission. An account admin sets these on the User Management tab. See roles and permissions.
- Tables in a report use a Results table view. See create a table view.
Who can see and change a report¶
Each report has a Status:
| Status | Who can see it | Who can set it |
|---|---|---|
| Private (the default) | Only its author | The author |
| Draft | The author, and Users with Draft or Approve permission | Users with Draft permission |
| Published | Everyone with access to the Project | Users with Approve permission only |
Reports are only shared inside Bramble: there's no PDF or print export. To share a report, publish it.
Create a report¶
- Open the report editor in one of these ways:
- On the Results page, select the Attitudes, then click the + button next to Reports. The selected Attitudes are ticked for you.
- In the sidebar, under Visualisation & Data, click Reports, then New Report. Choose the Project in Select Project and click Confirm. Or click the + button on a Project's group ("Create a new report in this project").
-
Fill in the form:
Field Required Notes Title: Yes Up to 100 characters. Must be unique in the Project ("This name is already in use") Tags: No Type a tag and click the add button. Each tag is up to 50 characters Status: Yes Private by default. You can only choose the statuses your permissions allow Attitudes: Yes At least one. Use the filter to find them -
Add content (see below).
- Click Save and Continue to save and keep editing, or Save Report to save and close.
Bramble adds a title block (Written by: <author> and the date) as the first section.
If you change the Attitudes, click Save and Continue before adding tables or plots, so they use the new Attitudes. When a saved report's Attitudes differ from your selection, Attitudes Selection asks whether to Merge Both, Keep Selected or Keep Currently Linked.
Add content¶
Open the Report Options tab and click a section type. Sections are added to the document on the left.
| Section | Does |
|---|---|
| Sub-Heading | Enter the text and click Save |
| Paragraph | Enter the text and click Save |
| Table | Under Select a table setup:, choose a table view. Adds a table of the report's Attitudes with Attitude Name, Description and the view's columns |
| Postpro | Choose from Select available postpro:, then add images from the postpro viewer (below) |
| Graph | Opens the Graphs dialog with a Table View picker. Plot, then click Add To Report |
| Force Distribution | Opens Force Distribution. Plot, then click Add to Report. Any overlaid postpro images are included. Needs Attitudes selected |
| Upload | Upload your own images (.png, .jpg, .jpeg, .gif, .svg). You can pick several |
"Table Creation Failed" or "No saved attitudes found." means the report's Attitudes haven't been saved yet.
Add postpro images. In the postpro viewer, pick the images, then open Add to Report. Selected PostPro
Data lists them as <case> - <variable> - <camera>; remove any you don't want. Then click:
- Add Directly to add them as they are, or
- Annotate & Add to mark them up first. In PostPro Annotation, click an image to annotate it, then click Confirm. See annotate an image for the drawing tools.
Add to Report only appears when you open the postpro viewer from the report editor.
Format the document. The editor toolbar has Bold, Italic, Underline, Fill Colour, Font Colour, Scale Up Sections Width and Scale Down Sections Width. Clear Content empties the document.
Edit a report¶
- On the Results page, click Reports to open the editor on the Load tab, and choose a report under Select a report to load:.
- On the Reports page, click the pencil icon on the report's row.
You can edit your own private reports, and drafts if you have Draft permission. Otherwise you'll see
** You do not have permission to edit this report **.
Comment on a report¶
- On the Reports page, click the report, then open the Comments tab.
- Type your comment, up to 500 characters.
- Tick To be resolved to start a discussion that needs resolving. Leave it unticked for a plain note.
- Click Add Comment.
Click Resolve on an open discussion to close it; it's tagged Resolved by <name>. You can delete your own
comments. Turn on Show Unresolved Only to see the open discussions. The Comments tab shows a badge while
discussions are unresolved.
You can't add comments while the report is being edited ("Can not add new comments while editing.").
Publish a report¶
You need Approve permission.
- On the Reports page, click Approve Report on a draft, or
- In the editor, set Status: to Published and save.
The Confirmation dialog asks "Do you wish to clear comments before proceeding?". Click Clear and Save to
remove the comments, or Save to keep them. The title block then reads Checked by: <approver> as well as
Written by: <author>.
Manage reports¶
The Reports page lists the Programme's reports, grouped by Project. Use Search and Filter By Tags to find them, and Show inactive projects to include inactive Projects. Click a row to open the report:
| Tab | Shows |
|---|---|
| Preview | The report. Previous and Next move between reports |
| Summary | Title, tags, status, Report Attitudes, Project, author and checker. Edit changes them, if you can edit the report |
| Comments | The report's comments |
Row actions depend on the status and your permissions:
| Action | Available for |
|---|---|
| Edit (pencil) | Your own private reports, and drafts if you have Draft permission. Otherwise View Report |
| Delete | Unpublished reports: your own private reports, and drafts if you have Draft permission |
| Revert to Private | Your own drafts, with Draft permission |
| Approve Report | Drafts, with Approve permission |
| Revert to Draft | Published reports, with Approve permission |
The Results table's Reports column lists the reports that include each Attitude.
Related: Roles and permissions · Plot graphs · Compare results in the postpro viewer · Annotate an image