How do exhibits work

This tutorial will talk you through the following:

  • What is the exhibit?
  • How exhibits work?

Exhibits

In the Budget In Brief application Enterprise Edition, we have introduced a new type of budget book section called the Exhibit. 

The Exhibit Section is different from the plain book section, in the way the exhibit document is generated every time you create the document from the specified in the book data. During book generation, data stored in the crosswalks is converted into context related tables that explain, or add, information to the related narrative documents. Different exhibits can present the same data from different perspectives, in more generic or more detailed way. 

Exhibit has all the familiar attributes of the regular document section like: CoverPage, StartOnOddPage, HeaderPath, FooterPath, NewPageNumber, MainTOCEntryName, PageBreakAfter, Margins. As well as the new attributes: TopPartPath, BottomPartPath, XSLTPath and OutputPath.

Read more about exhibit section format in the Book File Format article.

Exhibit Generation

Exhibit documents are generated from the consolidated data and consist of three following parts:

  • The top part – is any document in the supported format.
    It can contain just one line, with the table name or, it can be multi-page article that has a detailed overview of the exhibit document. The top part is optional. 
    To define the top part, specify a path to the actual document in the TopPartPath attribute;
  • The exhibit body – is the automatically generated content, and the heart of the exhibit document. 
    To produce the exhibit body, the .BOOK file should have the data and the exhibit should define the transformation script. 
    The script will extract the exhibit related information from the consolidated data file, which we have discussed in previous tutorial. 
    To specify what transformation script to use, set XSLTPath attribute. 
    The XSL transformation script should produce a document in HTML format, we call this document "Raw exhibit document". The script can produce any HTML documents, which could include any suitable content from simple tables to complex multi-page documents with paragraphs of text, multiple images and tables, bulleted and numbered lists.
  • The bottom part – is very similar to the top part and can be in any document, in the supported formats. It can be just a few lines with the footnotes, or it can be multi page article with exhibit data analysis. The Bottom part is optional.
    To define the bottom part, specify the path to the actual document in the BottomPartPath attribute;

 



Figure 1

When Budget In Brief compiles the budget book, it will generate exhibit documents; and will save exhibit documents in to specified OutputPath

Here is the general overview of all exhibit generation components.


Figure 2

Can I do it?

Yes. 

We will use the same Exhibit Generation Crosswalk tutorial as in previous part.

The book file, for our example, contains one exhibit document and uses the FundsCrosswalk.xlsx crosswalk, which you are familiar with by now.

<Book Name="Exhibit Generation Quick Steps Tutorial" 
      Value="" Version="1.0" StyleTemplate="">
  <DataFiles>
    <File Path="Data\FundsCrosswalk.xlsx"/>
  </DataFiles>
  <Section Name="Main Document Section"
           TopMargin="1" BottomMargin="1" RightMargin="1" LeftMargin="1">
    <Exhibit
      Name="Funds Exhibit Sample"
      OutputPath="Exhibits"
      TopPartPath="Exhibits\Parts\Funds Exhibit Sample - Top part.docx"
      XSLTPath="Exhibits\XSLTs\FundsExhibit.xslt" />
  </Section>
</Book>
 

Launch the Budget in Brief application, open the “ExhibitGeneration.book” file from our example, click the “Create Document” button, check the event list for messages where the “Funds Exhibit Sample” exhibit got transformed.


Figure 3

Open the folder with the final document.



Figure 4

Open the “Exhibit Generation Quick Steps Tutorial.docx” file.



Figure 5

The data from the “FundsCrosswalk.xlsx”, which we have discussed in the previous tutorials, has been transformed in to the exhibit. 

Open the crosswalk, change the data, save the crosswalk, regenerate the book, and check that your changes were incorporated.

Switch to the “Exhibit Generation” tab and check the list of all available artifact



Figure 6

Conclusion

While you are in the budget committee meeting you can, directly from your laptop, save changes in your crosswalks; click the “Create Document” button, and look at the budget book with the fresh data.


Site Map | Printable View | © 2008 - 2017 Budget In Brief | Powered by mojoPortal | HTML 5 | CSS | Design by styleshout