After opening a project in Central, you can click Reports at the top of the interface to see various types of reports and statistics. When you select a report or statistical category on the left, a chart and grid are populated on the right with details. It is a good idea to look at the reports before you publish output so that you are assured the project does not contain issues that need to be fixed.
No special permission is required for this activity. Any user associated with a project has permission to view the Reports page.
There are multiple ways to open the Reports page to view it:
Reports Option on Projects Page After opening a project in Central, you can click Reports at the top.
Project Grid Context Menu On the Projects page, you can right-click a project and select Reports.
Report Widgets If you have added Report widgets to a dashboard
(see Report Widgets), you can click any of the square objects related to a specific type of report.
The following reports are provided. These are all reports that are considered “critical,” in that your output will contain missing or incorrect information if you do not fix the issues.
- Broken Bookmarks These are links to bookmarks that are broken. In Flare, you need to fix the issue (e.g., remove or replace the bookmark link).
- Broken Links These are links—such as cross-references—that are broken. In Flare, you need to fix the issue (e.g., remove or replace the link).
- Broken Snippet Links These are links to snippets that are broken. In Flare, you need to fix the issue (e.g., remove or replace the snippet).
- Undefined Condition Tags These are conditions that have been applied in the project, but the name or location of those conditions cannot be found. This might occur, for example, if you have applied a condition in a topic and then later change the name of the tag or condition tag set. The old tag or set name is still used at the location where it was previously applied in the topic. In Flare, you need to fix the issue (e.g., rename the condition tag or set, remove the tag where it was applied).
- Undefined File Tags These are file tags that have been applied in the project, but the name or location of those file tags cannot be found. This might occur, for example, if you have associated a file tag with a topic and then later change the name of the tag or file tag set. The old tag or set name is still used for the topic. In Flare, you need to fix the issue (e.g., rename the file tag or set, remove the tag where it was applied).
- Undefined Glossary Term Links These are glossary term links in your content that are broken. This might occur, for example, if you have created a new term in a glossary and then inserted that term into a topic as a glossary term link. Later, you remove that term from the glossary. You now have a glossary term link in a topic, but the term no longer exists in the glossary. In Flare, you need to either remove the glossary term link from the content, or you need to add the term to the glossary again.
- Undefined Variables These are variables that have been inserted in the project, but the name or location of those variables cannot be found. This might occur, for example, if you have inserted a variable in a topic and then later change the name of the variable or variable set. The old variable or set name is still used at the location where it was previously inserted in the topic. In Flare, you need to fix the issue (e.g., rename the variable or set, remove the variable where it was applied).
In addition, you can view statistics (i.e., the count) for the following in each project:
- Segments (i.e., phrases or sentences)
Whenever you push changes for a project to Central, a new scan will be automatically initiated. While the scan is in process, a green progress bar will move across the top.
When you no longer see the green bar, the scan is finished. Larger projects will take longer to scan.
The last time the project was scanned is indicated in the upper-left part of the page, next to the Reports pane heading.
You can also click in the toolbar to initiate a scan manually whenever you like.
Note: This feature is currently limited to projects smaller than 1 GB. Projects larger than that will not be scanned for reports or statistics.
Note: If you already had a Flare project uploaded before this feature was introduced, you will not initially see data on the Reports page. You must either perform a manual scan or push changes for that project to Central first. After that, the Reports page will populate.
The various types of reports and statistics are listed on the left side of the page.
To see data for a particular report or statistical category, click it. The area to the right is then populated with a chart and grid.
The chart shows a count history of the item, with each bar representing a different push of changes to Central. You might see many bars with the same date, because you might have pushed changes to Central multiple times throughout the day.
A drop-down lets you choose how many of the most recent scans to show in the chart (default is 10). If you hover over a bar, you will see the date, time, and count for a particular scan of the selected item.
Unlike the chart, the grid below it does not show a history of pushes. Instead, it shows results for the most recent scan and displays all of the instances of the selected item in the project. For example, if you selected the Broken Links report, each row of the grid will show a broken link that was found in the latest scan of the project. The Folder and File columns on the left tell you where the issue was found. The rest of the columns are different for each type of report and provide information to track down the problem.
You can click the arrow in any column heading to sort the information according to that column.
When you select a statistical category, the grid will show a count history for all of the categories. However, the chart above represents the count history for only the selected item.
When you view a report and notice critical issues, you should do the following:
- Use the report to identify the location in Flare where the issue exists.
- Open Flare and fix the problem.
- Commit and push your changes to Central.
- Open the Reports page again and ensure that no more critical issues are present. (Alternatively, you can use the Analysis ribbon in Flare to see the updated reports.)
You can add Report widgets to your Home or Project dashboards, based on any of the critical reports. Each widget is a small square with a number that indicates the number of issues found in the project.
Open the Reports view, and in the toolbar click .
Alternatively, you can click this same button in the toolbar of the Home or Projects dashboard.
Tip: It is recommended that you use the option in the Reports view because it lets you add widgets for multiple kinds of critical reports at the same time. On the other hand, if you are on a dashboard, you will need to repeat the steps for adding each type of report, plus you will need to filter each blank widget afterward to choose a report for it.
Do one of the following in the dialog that displays, depending on the method you are using:
Method 1: Reports View (Recommended)
If you clicked the button in the Reports view, select Home Dashboard, Project Dashboard, or both, depending on where you want to see the widgets.
Then, below those selections, choose which types of reports you want to include in widgets.
After that, click Add.
Method 2: Home or Project Dashboard
If you clicked the button on a dashboard, select Reports and click Add.
Repeat these steps for each type of report widget you want to add to a dashboard.
If you used the Reports view method, you can go to the dashboard, then click and drag the widgets to move them where you want them.
If you used the Dashboard method, the new widgets will initially be empty. So you will need to filter them (see How to Filter Report Widgets) in order to choose report types. After this, you can click and drag the widgets to move them where you want them on the dashboard.
Regardless of the method you used, keep in mind that you might need to scroll down to see your new widgets if existing widgets are already taking up all the space toward the top of the dashboard.
If you added a widget from the Reports view, it should be populated already. But if you have an empty reports widget, use the following steps to choose a report type in order to populate it.
- On the left side of the interface, select either Home or Projects, depending on the dashboard where you've added the report widgets. If you selected Projects, you might also need to choose Dashboard at the top of the interface.
In the empty widget container, click in the upper-right corner.
In the menu, expand Project (if necessary) to choose an uploaded Flare project. Then expand Report and select a report type.
- Click away from the dialog. The widget is now populated with data for that report type.
Tip: If you click the number on a report widget, the Reports page automatically opens with that report selected.
In your account settings, you can choose when to be notified for specific activities. The user who is notified depends on the activity.
Note: A refresh button is available in the toolbar on the Reports page. This option is not necessary to populate the chart and grid. However, the project activity sometimes does not automatically refresh after a scan; therefore, you can click the refresh button to update it.