canvasplanning:userguide:bookpublisher

Book Publisher

From the Book Publisher you can print reports in bulk or create report files in bulk.

  • Publish – publish the book to print reports or create files
  • Save – save the current book definition into the currently selected workbook. (Note: This does not automatically save the book definition to physical storage on disk. To save to disk, you must save the Excel workbook after closing the Book Publisher dialog box! The book definition is saved inside the workbook.)
  • Close – close the Book Publisher dialog box.

(Note: To schedule a book to publish automatically a preset times, see the Schedule Actions section later in this documentation.)


Book properties are displayed when the Book node is selected at the top of the tree

  • Print – option to print reports when the book is published.
  • Create Files – option to create report files when the book is published.
  • Create PDF Files – option to create reports as pdf files when the book is published. (Note: This option is only available in Excel 2010 or later.) When emailing reports, it is good to remember that pdf files are much larger than Excel xlsx files.
  • Display book outline report – option to create a visual outline of the book definition in the workbook when the book definition is saved. The outline is created on a workbook tab named Callisto_Book
  • Create index when publish – option to create an index to published reports when the book is published.
    • The index is create on a workbook tab named Callisto_BookFileIndex when the Create Files option is selected, and on a workbook tab named Callisto_BookPrintIndex when the Print option is selected.
    • When “Publish to tabs” is checked, there will also be an index tab of reports included in the workbook published for each section.
  • Clear all reports from folder before publishing – clear report files from the publishing path before publishing new reports.
  • Publish To tabs – Option for each Report in a Section to be published as a tab within one workbook for the Section. Each Section within a Book publishes a separate workbook, containing all the reports for that Section. See Section Properties to configure workbook name, and tab names, and report descriptions.
    • Note: The maximum number of Reports that can be published within a Section is 255, and any reports beyond that are ignored.
    • Caution: Merged cells in a worksheet to be published will cause Publish to tabs to fail. Use Format / Center across instead.
    • Caution: Only worksheets containing defined reports are published. All worksheets published are published as values with formulas converted to values to preserve published values and prevent formula errors. To publish worksheets containing only CL function reports “Publish CLValue reports to tabs” section near the end.
  • Publish To Path – Folder that reports should be published to. This can be folder on the local PC or it can be network share on a server. When the folder is a network share, the folder must already exist. When selecting a folder with the lookup button, the folder can be created. If no folder is supplied, the book will be published to a folder, within the My Documents folder, with the same name as the book workbook.
  • Email reports when publishing – enable emailing reports. When selected the email entries for each Section of the book are enabled to supply email information.
  • Add Section – Add another section to the book definition.


The fixed member properties are used to fix the member selection on various dimensions to control the portion of the database a section of the book will be published for.

  • Model / Dimension – select the model or dimension from the drop down list that a member will be selected for.
  • Member – select one model or one member in the dimension to fix for this section of the book.
  • Insert – insert a new item to the Fixed selections.
  • Delete – delete an item from the Fixed selections.


The workbook properties are used to select the workbooks containing reports that are to be published.

  • Source
    1. Shared Library – workbook is located in the Shared Library.
    2. Local File – workbook is located on the users local PC.
  • Workbook name – name of the workbook file containing reports to be published.
  • Insert – insert a workbook in the list of workbooks to be published.
  • Delete – delete a workbook from the list of workbooks to be published.


Request: User wants the index to be indented to show the parent/child relationship, (hierarchy).

Answer: There is some capability to customize the Reports and Description columns in the report index for “Publish to tabs” books, but that capability will not accommodate exactly what the user is asking for. However, here is a description of the capability we do have.

When the “Publish to tabs” option is selected, for each Section of the book we use the “Template for tab names” and the “Template for tab descriptions” to generate tab names and the index table in the published workbook. These two entries support the same dynamic capabilities as report headings, so the entries can consist of any member properties with the property syntax.

See the images below for an example against Sample. This example is not meant to make sense but only to illustrate how to specify dynamic values based on member properties.

In addition, you can also get more creative with the “Template for tab descriptions” by specifying an Excel formula combined with member property values. Here is an example of indenting Entity names by blank spaces based on the member level number.

(Note: This same trick will not work for “Template for tab names” because that value must be valid tab name in Excel.)


When checked in the Book Properties the following properties are enabled. Each report defined within the Section Workbooks will create a report tab in a workbook. (Note: When a source workbook contains multiple report tabs then multiple report tabs are also published.) Tab Names in Excel are limited to 31 characters and each must be unique. We make sure all Tab names meet this limitation, and we create an index of Tab names with a longer Description. The maximum number of report tabs is 255, and any reports beyond that are ignored. Application Variables can be used to define Tab Names and Descriptions. (Note: The additional Application Variable @SRCTABNAME is available for these properties. It will return the name of the Workbook Tab containing the source report.)

  • Publish to Workbook – Name of workbook created for all reports in this Section.
  • Template for tab names – A naming template to create a uique dynamic name for each report tab. The value can contain text as well as any Application Variables.
  • Template for tab descriptions – A naming template to create a unique dynamic description for each report. The value can contain text as well as any Application Variables.

When checked in the Book Properties the following properties are enabled.

  • Email send to addresses – email addresses of people the reports should emailed to. The email sent to these people will have files attached for all reports published by this Section of the book. If no email addresses are entered, no email will be sent.
  • Email subject – subject of email message to be sent.
  • Email contents – content of email message to be sent.


The vary member properties are used to select multiple members on dimensions that reports should be published for in this section of the book.

  • Dimension – select the dimension that members will be selected from.
  • Member Selection Types
    1. Expand – define expansion properties that will be used to create a dynamic list of members to publish reports for. This dynamic list automatically changes based on dimension changes.
    2. List – select the list of members to publish reports for.
    3. Range Name – a named range in the Excel workbook that contains a member list.
  • canvasplanning/userguide/bookpublisher.txt
  • Last modified: 2022/06/13 07:36
  • by pcevli