Show TOC

EPMBookLocate this document in the navigation structure

Applies to: Planning and Consolidation connections.

This function retrieves a specified text you can double-click to open a book published in Planning and Consolidation web client.
  • If the books you want to view have been published in several PDFs, do not use the locationType or teamID parameters.
  • If the books you want to view have been published in one single PDF, you must specify the locationType parameter, that is the location type that has been specified in the book publication template:
    • 2=Public
    • 3=Private
    • 4=Team. If you specify the team location type, you must then specify the teamID parameter.

When you double-click the cell, a web browser opens, displaying the book specified. All the variable members that have been specified in the book publication template can be selected, using the dropdown lists to the left part of the window. The data on the right part of the window is updated accordingly.

Note
  • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in Start of the navigation path EPM Next navigation step Options Next navigation step User Options End of the navigation path).
  • If the cell on which you double-click is merged with other cells, the double-click will not function.
Parameter Description
modelName Name of the model. If not specified, the model for the active connection is taken into account.
templateName Name of the book publication template.
sectionName Name of the section.
locationType (only for single PDF) Specify the location where the PDF has been published. 2=Public; 3=Private; 4=Team
teamID (only for single PDF and for Team location) Specify the ID of the team for which the PDF has been published.
displayedText Text in the cell on which to double-click. Optional. If not specified, the following text appears: "View [template name]".
member1... to member19 Specify the name of the variable member. Optional.
  • Name of the member.
  • Or name of the context favorite. If you enter a context favorite in Member1, leave the other member parameters blank.
Note
  • If the description of a member exists in several dimensions, once you have entered the function, a message appears, stating that the description is ambiguous and recommending that you use the ID of the member instead.
  • If the ID of a member exists in several dimensions, once you have entered the function, a message appears, stating that the ID is ambiguous and recommending that you use the full unique name of the member instead.