Custom report syntax
Joined: Jan 2022 Posts: 19 Location: United StatesNewcomer
Would like to get more involved with reports. There’s not a ton of examples in the blue prints. Also There’s some math functions I’m trying to write out, like summing totals , where can I find more resources ?DrewFinale
Joined: Dec 2019 Posts: 401 Location: United StatesSilver
Thanks for posting! Here are the current reports/labels resources from the Finale 3D Help Center:
Documentation articles: https://finale3d.com/software-documentation/toc/#reports
Video tutorials: https://finale3d.com/video-gallery/reports-labels-and-diagrams
To be fair, the current set of articles and videos is by no means all-inclusive, but it’s a great starting point. If you’re stuck on something specific, don’t hesitate to post the details here so I can give you more tailored instructions.
As a starting point, it’s worth mentioning that the report and label customization features are only available in Finale 3D Pro. It is possible to make a few tweaks in Hobbyist, but nothing compared to the functionality of Pro. You mentioned a few things that make me think you’re trying to edit blueprints directly. For the most part, we don’t have documentation on the syntax for the raw blueprint data because it’s really not meant to be human-readable or edited. You also mentioned the need to create sums. At the moment, you get sums or totals by combining rows on reports. For example, a product list report combines all rows of script that have the same part number in order to provide the total quantity needed of each item. Combining rows is currently the only way to display a sum, in the future it will be possible to have a separate line on a report for totals or subtotals.
Here’s an overview of creating/customizing reports in Finale 3D Pro:
Part 1 – Select a window
In Finale 3D Pro, custom reports are created using the window that contains the data you want in your report. For example, if you want a report that includes information like event times and firing system addresses, then you would create the report in the Script window, because this is the window containing the data. Similarly, if you wanted a report that lists rack quantities, you would create the report in the Racks window. Most reports come from the Script or Racks windows, although there are times when you may need a report from other windows, such as the Effects window or Positions window. As a general rule, always make reports from the Script and Racks windows, unless another window is the only place that has what you need. For example, if you want to create a product list for a show, always use the script window unless you need a specific column on the report that is only available in the Effects window.
Part 2 – Format the column layout
Once you’ve identified which window has the data you want on your report, the next step is to create the column layout. This is accomplished using the blue gear menu to hide or unhide columns, move columns left or right, and adjust the relative column widths. Think of the window you’re working in as a kind of report preview. Your final PDF report will have the same columns, column order, and relative column widths that you see in the window. For example, if you’re making a report using the Script window and the Event Time column is visible, then the Event Time column will appear on your report. If you don’t want Event Time, hide it using the blue gear menu.
Part 3 – Configure and save
After configuring the column layout, go to the blue gear and find the menu item titled, ‘Save current table layout to report template’. Then, either select ‘New report template’ or select an existing report. Selecting an existing report is handy because it allows you to use that report as a starting point. Regardless of which option you choose, the Report Configuration dialog will be opened. This is where all report customizations are made (except for the column layout). Here you will find 6 sections that allow you to customize the sort order, combine of rows, add page breaks, add subtitles, set page formatting and add conditional formatting. When you open the dialog, some of these sections will be out of view. Use the scroll wheel on your mouse or the scroll function on your touchpad to scroll down in the dialog. To become familiar with the configuration options, experiment and also look at the configurations for existing reports. When you’re done editing, click Enter in the dialog to save. To generate your report, go to ‘File > Reports’. To make changes go back to the blue gear in the appropriate window and find ‘Edit report template’. You can also ‘Select table layout from report template’ in the blue gear menu to display the column layout for any existing report. This is very handy when you want to tweak the column layout of an existing report or use the column layout of an existing report as the starting point for a new report.
Please login to reply to this topic.