A book template is a preformatted worksheet used to create a book of reports.
Book templates have the following features:
You can start with the empty worksheet or an existing book template, and modify it to meet the needs of the information you want to publish.
Empty sample book templates, called Template.xlt templates, are provided with the sample application set, ApShell. (They are located in \Webfolders\ApShell\<Planning or Rate>\eExcel\Books\Wizard\Template.xlt.)
You can edit the fields in the Template.xlt template to create a new book template.
The following tables describe the Book and Section fields available in the book template. If a dimension is not specified in the book's fixed or vary keys, the system takes its value (member) from the current view when the book is published.
Book fields
The Book fields allow you to specify properties for the book.
Field |
Description |
---|---|
BOOK (required) |
Enter a title to reference the book, for example, if a link to the book was added to an Interface for the Web page. |
CLEARBOOK (required) |
This field allows you to specify options for replacing an existing book, appending sections to an existing book, or using the SECTION fields to determine the contents of the book.
|
Enter Variable Time (required) |
The time member is taken from the current view, but you can hard code the time by entering the desired member in this field. |
SECTION (required) |
Denotes the beginning of a section of the book. Enter a name for the section. Note If you are creating only one section, remove any additional sections in the template by deleting the rows between the SECTION and SECTIONEND keywords. End of the note. |
CLEARSECTION |
Determines the contents of the book. |
Section fields
The SECTION fields allow you to define one or more sections to the book. Sections are marked by the SECTION and SECTIONEND fields. Each section must include values for the REPNAME, FIXKEY, and VARYKEYS fields.
Field |
Description |
---|---|
SECTION (required) |
This field denotes the beginning of a section of the book. Enter a name for the section. If only creating one section, remove any additional sections in the template by deleting the rows between the SECTION and SECTIONEND keywords. |
CLEARSECTION (optional) |
This field allows you to replace or add sections to a book based on the specified vary keys. The value in this field is used only the value of the CLEARBOOK field is Use Clearsection. Select Accumulate (previously No) to append new sections (with different member combinations) to an existing book. Select Replace (previously Yes) to replace sections of the existing book with new sections. This means that if a specified member combination is found, overwrite the existing section. |
REPNAME (required) |
Enter the following:
|
FIXKEY (optional) |
Enter the dimensions and members that you want to hard code in the reports, for example, TIME and 2008.JAN). You can also enter dimension members from another application within the application set. To specify a dimension member from another application, the syntax is APPLICATION:DIMENSIONNAME, and then the member name. |
SUPPRESSKEY (optional) |
Enter the dimensions and members you want suppressed when their value is zero. For example, Account and Revenue. |
VARYKEYS (required) |
Used to get data for multiple members of one or more dimensions.
|
SECTIONEND (required) |
Denotes the end of a section of the book |
To create a new book template, from Interface for Excel, select
To modify an existing book template, enter the required data in the fields, as defined in the table above. Make sure that you delete any sections that are not being used.