Dodeca Version 6.0.0

This version uses SpreadsheetGear 2010 (6.0.3.190), NetAdvantage 2011, Volume 1 (11.1.20111.1003), and Aspose.Cells 6.0.1.0.

Upgraded from NetAdvantage 2010, Volume 2 (10.2.20102.1004) to NetAdvantage 2011, Volume 1 (11.1.20111.1003)

As indicated in the PDF Support section, there was a critical issue in the previous version of Aspose.Cells, which is the third-party component that is used to generate PDF’s in Dodeca. Specifically, when a spreadsheet contained *custom number formats, instead of built-in number formats, negative numbers were being represented as zero. This would also be reflected in the numbers represented in printed PDF reports. This issue has been resolved in the updated version of the Aspose.Cells component.*

The release notes for this build contain the following sections:

Accelerator Utility

Admin Import/Export Utilities

Application

Dodeca Essbase Server Changes

Dodeca Metadata Server Changes

Dodeca Metadata Server — Relational Outline Caching

Dodeca Metadata Server and dodeca-essbase Server Logging

Essbase Ad hoc View

Essbase Excel View

Essbase Relational Caching

Essbase Selector TreeView

Excel-based Views: Excel, SQL Excel, and All Essbase Views

Relational Support

Selector ComboBox

Selector Lists

SQL Excel View

SQLPassthroughDataSet Metadata Editor

PDF Support

Print and Print Preview Tools

ViewSelectorTreeView

Workbook Script Debugger

Workbook Scripting

Accelerator Utility

_The following is an excerpt from the Dodeca Administrator’s Guide describing how to get started with the Dodeca Accelerator Utility as well as some common installation strategies for production environments. _

Below the excerpt are instructions on how to add and configure the Save Accelerator (Installation) Command File and the Save Accelerator (Uninstallation) Command File tools to an application toolbar.

The Dodeca Framework and Smart Client are shipped with a command line utility, Accelerator.exe, that dramatically reduces Dodeca’s startup time, as well as improving the overall responsiveness of its user interface. The Accelerator is packaged with every ClickOnce deployment of Dodeca and needs to be run one time per Dodeca version installed on the client machine. The Accelerator does not run as a service, but rather, performs a one-time series of environment-specific optimizations, which includes recompiling each Dodeca assembly specifically for the client machine. Our own internal benchmarks have consistently shown 50-75% decreases in application startup time, as well as 30-50% increases in UI operation performance.

As the Accelerator modifies the client machine beyond .NET Isolated Storage, it does require administrative privileges in order to run. We recommend following the steps outlined in the next section in order to familiarize yourself with the basic Accelerator installation and removal features before considering the deployment/installation strategies detailed in the subsequent sections.

Getting Started

The Dodeca Accelerator has two basic requirements that must be satisfied in order to successfully optimize a Dodeca installation. The Accelerator must be run by a user with administrative privileges, and it must have access to the Dodeca assemblies for the version to be optimized.

To run the Accelerator on a development machine where you have administrative privileges, follow these steps:

Accelerator.exe --ign

*NOTE:* Depending on the processor speed/cores and the amount of RAM installed on your system, this process may take up to 20 minutes to complete. The relatively long completion time of this installation process is due to the fact that the Accelerator recompiles each Dodeca assembly.

From this point forward, whenever you launch an instance of the Dodeca Smart Client, your system will preferentially use the natively-compiled assemblies generated by the Accelerator instead of the assemblies shipped with the Dodeca Framework. The Dodeca assemblies have also been installed into the system-wide .NET assembly library, allowing the .NET CLR to bypass hash verification of each assembly at startup. This improves startup time and reduces the amount of CPU the Dodeca Smart Client consumes at launch time.

In addition to being located in the \bin\Dodeca subdirectory of the Dodeca Framework installation, the "Accelerator.exe" file is also distributed to client machines during ClickOnce deployment. To run the Accelerator from the ClickOnce deployment directory instead (you will still need administrative privileges), start Dodeca using the ClickOnce URL for a tenant based on the Metadata Starter Kit or the Sample application and then follow these steps:

*NOTE:* If you examine the .cmd file in a text editor, you will see that the generated command line string uses the same arguments as before, but that it reflects the location of the Accelerator utility distributed via ClickOnce. The contents of the .cmd file will look something like this:

"C:\Users\Camcorder\AppData\Local\Apps\2.0\BT0NZ8GP.QOK\ADNAGC56.6MQ\appl…​app_f2a3b1b1a674c300_0006.0000_51642a3ef2cd2bce\Accelerator.exe" -ign

*NOTE:* Depending on the processor speed/cores and the amount of RAM installed on your system, this process may take up to 20 minutes to complete. The relatively long completion time of this installation process is due to the fact that the Accelerator recompiles each Dodeca assembly.

To uninstall the recompiled assemblies and reverse the system changes made by the Accelerator on a development machine where you have administrative privileges, follow either set of the following steps:

*NOTE:* This command will uninstall only the assemblies of the current Dodeca version. To uninstall all Dodeca assemblies previously installed by the Accelerator, regardless of version, use the command line arguments '-ucgn'.

or:

*NOTE:* If you examine the .cmd file in a text editor, you will see that the generated command line string uses the same arguments as before, but that it reflects the location of the Accelerator utility distributed via ClickOnce. The contents of the .cmd file will look something like this:

"C:\Users\Camcorder\AppData\Local\Apps\2.0\BT0NZ8GP.QOK\ADNAGC56.6MQ\appl…​app_f2a3b1b1a674c300_0006.0000_51642a3ef2cd2bce\Accelerator.exe" -ugn

*NOTE:* To modify the .cmd that Dodeca generates so that it uses alternate command line arguments, see the following section, 'Installation Strategies'.

Installation Strategies

Remember that the Dodeca Accelerator has two basic requirements that must be satisfied in order to successfully optimize a Dodeca installation. The Accelerator must be run by a user with administrative privileges, and it must have access to the Dodeca assemblies for the version to be optimized.

In production environments where end-users are not likely to have administrative permissions, system administrators will either have to 1) run the Accelerator utility manually from the command prompt or from a command file generated by the Dodeca Smart Client, or 2) use a Windows administration tool such as a Microsoft Management Console Snap-in to run the Accelerator automatically from a known location on the client machine or from a network location.

Both manual and automated installation procedures are similar to the techniques described in the previous section, but it should be noted that in addition to being run from the local machine, the Accelerator can be run from a network location, provided that the Dodeca assemblies are accessible to it, and that the .NET Code Access Security Policy is configured properly on the client machine. By default, the Accelerator will search for the Dodeca assemblies to optimize in the same directory where it is located. This means that as long as the version numbers of the installed Dodeca assemblies match those of the assemblies stored with the Accelerator, it can be run from any location accessible to the client machine.

*NOTE:* The Accelerator can be run (both installation and uninstallation) even while the Dodeca Smart Client is open and running on the client machine. This means that Dodeca does not have to be closed before performing a manual or automated installation.

In order to run the Accelerator from a network share, follow these steps:

*NOTE:* For this tutorial, we have mapped the network location of "Accelerator.exe" and our Dodeca assemblies to "Z:\Accelerator".

C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CasPol.exe -pp off -m -ag 1.2 -url file://Z:/Accelerator/Accelerator.exe FullTrust

*NOTE:* The preceding command-line string must be typed on a single line.

*NOTE:* For more information about "CasPol.exe" and Fully Trusted shares, see the following articles: http://msdn.microsoft.com/en-us/library/cb6t8dtz%28v=vs.80%29.aspx and http://blogs.msdn.com/b/shawnfa/archive/2004/12/30/344554.aspx

Z:\Accelerator\Accelerator.exe -ign

From this point forward, whenever an end-user launches an instance of the Dodeca Smart Client, their system will preferentially use the natively-compiled assemblies generated by the Accelerator instead of the assemblies deployed during ClickOnce deployment. The Dodeca assemblies have also been installed into the system-wide .NET assembly library, allowing the .NET CLR to bypass hash verification of each assembly at startup.

How to add the Save Accelerator (Installation) Command File and the Save Accelerator (Uninstallation) Command File tools

An Admin application that uses the default Admin toolbars configuration (i.e. the UseDefaultAdminToolbarsConfiguration setting is True) contains the tools in the Utilities menu.

A User application that was created with the metadata_starter_kit.zip installed with this version of the Dodeca Framework contains the tools in the Utilities menu, but the tools are not visible. To make the tools visible, perform the following steps:

For an existing application that was created prior to this release, perform the following steps to add the tools to the Utilities menu:

How to configure the Save Accelerator (Installation) Command File and the Save Accelerator (Uninstallation) Command File tools

By default, the tools are configured to save the command files as AcceleratorInstall.cmd and AcceleratorUninstall.cmd on the desktop, but allow the user to change the file name and location. These settings can be changed using the Configure Tools utility, which is available from the Toolbars Configuration Metadata Editor.

Admin Import/Export Utilities

Application

Resolution: When the ToolbarsConfigurationID is invalid, an error message is displayed and no toolbars configuration is used. (#1015)

NetAdvantage 2011, Volume 1, provides partial support for the Microsoft Office 2010 Look and Feel. The support is limited to the style of the toolbars, and does not include other components, such as the components used for the view and metadata editor MDI tabs, the View Selector Explorer Bar, the Selector Trees, etc.

When an application’s ApplicationStyle is set to Office2010, the toolbars reflect the Office 2010 style, but the windows tabs, view selector, etc. appear the same as when the ApplicationStyle is set to Office2007.

The screenshots below are examples of the Office2010ColorScheme setting options with the ApplicationStyle set to Office2010:

Silver Color Scheme

Blue Color Scheme

Black Color Scheme

In lieu of complete support for the Office 2010 style, NetAdvantage 2011 provides a style library that emulates the Office 2010 style using the blue color scheme. When the style library is assigned to a Dodeca application, the styles of all the components reflect the Office 2010 look and feel, as shown in the screenshot below:

To use the Office 2010 style library, perform the following steps:

Note that the ApplicationStyle, Office2007ColorScheme, and Office2010ColorScheme settings are not used when a style library is assigned to the StyleLibraryBinaryArtifact setting.

Dodeca Essbase Server Changes

The Dodeca Essbase server has been rewritten to take advantage of xml parsing efficiencies gained through use of the SAX XML parser. The SAX XML parser provides the ability for extremely large xml documents to be efficiently read on the server as it is both faster and uses significantly less memory resources. The effect of using the SAX parser is greatly improved performance, particularly in Essbase retrieval operations of 100,000 cells or more, along with greater scalability.

The server has also been updated to include optional relational caching of Essbase outline information. The benefits of caching outline information relationally include better performance and greater flexibility in creating reports and input templates. The performance gains are due to the fact that the Essbase APIs that get outline information are generally considered one of the slower portions of the Essbase technology stack. Relational technology is generally very fast, so having the most frequently used Essbase outline information available in relational format increases performance in certain situations.

Relationally cached outline information can also be used to create hybrid templates where relational techniques are used to build the structure of the Essbase retrieve range prior to the Essbase retrieve operation. When creating a retrieval range in this manner, it is possible to include additional fields of information outside of the actual range sent to Essbase. The additional fields can be used to create reports and templates in layouts that would be invalid in other Essbase interfaces.

In the example below, the parent member is displayed on the same row as the member. The member alias is also displayed on the same row and is positioned before the member name. The member name column, which is labeled SKU, has member descriptions, as defined in the Essbase outline, displayed as an Excel comment. The Product column has the related attribute dimension values displayed in the member comment (not shown). The input template is filtered by attribute value which, in most Essbase interfaces, would result in the loss of write-back capability. Finally, the template has subtotals based on the product group which are dynamically added by the Dodeca relational technology.

image::image332_dodecarelease.jpeg[Description: cid:image001_dodecarelease.jpeg@01CC72D3.FEEB2130,width=624,height=406]

Hybrid Input from the Dodeca sample application

Relational caching automatically enables full text search on Essbase members which is not possible using only the Essbase APIs.

Architecturally, the new server implements the same service lookup and instancing technology used in the Dodeca metadata server. This technology, which uses a mapping file to specify the implementation class for a given service, makes it possible for customers to override the behavior of a specific service by specifying their own implementation. For example, if a customer would like to change how the Essbase Update operation behaves, they can write their own implementation for the Update service. Looking forward, this technology makes it much easier for us to implement new Essbase-oriented innovations in the future. The new lookup and instancing technology more easily enables customers to write custom extensions to the Dodeca-Essbase server.

These changes to the server have resulted in the introduction of additional configuration files to the Dodeca-Essbase server. These files, which include the dodeca-essbase.properties, dodeca-essbase-actions.properties, essbase.properties and log4j.properties files, along with 2 resource bundle properties files used for future localization, are located to the WEB-INF\classes subdirectory structure. Here is a screenshot of the WEB-INF\classes subdirectory:

The dodeca-essbase.properties file contains a number of settings that control the behavior of the server. Many of these settings were located in the web.xml file in the classic server. This properties file is self-documenting and contains settings relating to the location of the APS server, connection caching, relational caching, clustering behavior, data audit logging and optimization. Below is a screenshot the dodeca-essbase.properties file.

It is typical for dodeca-essbase.properties file entries to be changed for a specific implementation.

The dodeca-essbase-actions.properties file contains the service mappings which map individual services to their Java implementation classes. These services include all Essbase operations which may occur within Dodeca. Although custom services may be implemented and mapped in this file, most implementations will not change the contents of this file. Here is a screenshot showing some of the contents of the dodeca-essbase-actions.properties file:

The essbase.properties file is used to configure the behavior of the Java API when Dodeca is configured to use embedded mode. When Dodeca uses a URL for Java API access, the essbase.properties in the Dodeca-Essbase service is not used, but rather, the APS server copy of the essbase.properties file is used. Here is a screenshot showing a sample essbase.properties file:

Note: The Dodeca-Essbase services are compiled for each supported version of Essbase. The essbase.properties file included in each Dodeca-Essbase service is specific to the supported Essbase version.

The most common settings modified in the essbase.properties are the service.olap.dataQuery.grid.maxRows and service.olap.dataQuery.grid.maxColumns properties. These settings are used to control the maximum number of rows and columns retrieved by the Essbase Java API. The default setting in Dodeca is 0 which indicates the size of the Essbase grid is not limited by the Essbase Java API.

The new DodecaEssbaseResourceBundle.properties and DodecaResourceBundle.properties files have been added as the first step towards localization of messages from the metadata service.

The log4j.properties file was added to enable configuration of the new logging functionality built into the server.

The META-INF subdirectory contains the persistence.xml file that configures the relational database used for outline caching and is covered in more detail in the discussion on enabling outline caching.

Dodeca Essbase Server — Relational Outline Caching

As mentioned in the previous section, optional outline caching has been implemented in Dodeca 6. The caching requires additional configuration steps and requires the use of an application server that supports the Java Persistence API 2.0, known as JPA2. Due to these requirements, the relational outline caching is disabled by default.

JPA 2.0 is the Java standard for persisting Java objects to a relational database. The JPA2 specification is based, in part, on Hibernate, the object to relational mapping technology used in all versions of Dodeca. The JPA2 specification, however, is a fairly new specification and is not fully implemented in all application servers. Based on our testing, the following application servers work with JPA2:

To enable relational outline caching, follow these steps:

As of the release of Version 6.3.0, the outline.relational.cache.enabled and outline.info.n entries have been removed. Steps 4 and 5 are no longer required.

The default persistence.xml has a number of settings that need to be adjusted for outline caching to work. Below is screenshot of the default persistence.xml. The properties highlighted in yellow are the properties that need to be adjusted in most implementations. Optionally, the other property nodes may be adjusted to tune the relational caching. The jar-file and class nodes should not be updated as changes to these values may cause significant problems with the outline caching operations.

Each of the classes defined in the persistence.xml file defines a piece of outline information stored in the database. The tables created by outline caching, and their purpose, are listed in the table below.

Here are the fields in the CACHED_OUTLINE_INFOS, CACHED_OUTLINE_VERSIONS AND CACHED_OUTLINE_ITEMS tables.

Below are sample records from the CACHED_OUTLINE_INFOS, CACHED_OUTLINE_VERSIONS, and CACHED_OUTLINE_ITEMS tables.

*CACHED_OUTLINE_INFOS*

*CACHED_OUTLINE_VERSIONS*

*CACHED_OUTLINE_ITEMS*

Below are sample records from the CACHED_OUTLINE_MEMBERS, CACHED_OUTLINE_MEMBER_ALIASES, CACHED_OUTLINE_MEMBER_ATTRIBS and CACHED_OUTLINE_MEMBER_UDAS tables.

CACHED_OUTLINE_MEMBERS

This set of tables is intended for use in designing Dodeca reports and input templates using hybrid relational/Essbase techniques. The Hybrid Input sample template, as shown above, uses these tables to create the structure for the template. The SQL used to build the above template is shown below:

SELECT 'Product' 'Sort2',

lev1.MEMBER_NUMBER 'Sort1',

lev0.MEMBER_NUMBER 'Sort0',

lev0.MEMBER_DESCRIPTION 'Description',

alias1.MEMBER_ALIAS 'ProdGroup',

SUBSTRING(attr1.ATTRIBUTE_NAME, 12, 10) 'Intro Date',

attr2.ATTRIBUTE_NAME 'Package Type',

attr3.ATTRIBUTE_NAME 'Ounces',

attr4.ATTRIBUTE_NAME 'Caffeinated',

alias0.MEMBER_ALIAS 'Alias',

lev0.MEMBER_NAME 'Member',

lev0.MEMBER_NAME 'Member2'

FROM CACHED_OUTLINE_MEMBERS lev0,

CACHED_OUTLINE_MEMBERS lev1,

CACHED_OUTLINE_MEMBER_ATTRIBS attr1,

CACHED_OUTLINE_MEMBER_ATTRIBS attr2,

CACHED_OUTLINE_MEMBER_ATTRIBS attr3,

CACHED_OUTLINE_MEMBER_ATTRIBS attr4,

CACHED_OUTLINE_MEMBER_ALIASES alias0,

CACHED_OUTLINE_MEMBER_ALIASES alias1,

CACHED_OUTLINE_VERSIONS versions,

CACHED_OUTLINE_INFOS outlines

WHERE lev0.PARENT_NAME = lev1.MEMBER_NAME

AND lev1.ID = alias1.MEMBER_ID

AND lev0.ID = attr1.MEMBER_ID

AND lev0.ID = attr2.MEMBER_ID

AND lev0.ID = attr3.MEMBER_ID

AND lev0.ID = attr4.MEMBER_ID

AND lev0.ID = alias0.MEMBER_ID

AND lev0.VERSION_ID = versions.ID

AND lev1.VERSION_ID = versions.ID

AND versions.OUTLINE_INFO_ID = outlines.ID

AND attr1.ATTRIBUTE_DIMENSION = 'Intro Date'

AND attr2.ATTRIBUTE_DIMENSION = 'Pkg Type'

AND attr3.ATTRIBUTE_DIMENSION = 'Ounces'

AND attr4.ATTRIBUTE_DIMENSION = 'Caffeinated'

AND lev0.DIMENSION_NAME = 'Product'

AND alias1.ALIAS_TABLE = 'Default'

AND alias0.ALIAS_TABLE = 'Default'

AND attr2.ATTRIBUTE_NAME IN ([T.Pkg Type])

AND attr3.ATTRIBUTE_NAME IN ([T.Ounces])

AND attr4.ATTRIBUTE_NAME IN ([T.Caffeinated])

AND outlines.ID = '[T.OutlineInfoID]'

AND versions.ID IN (SELECT MAX(v.ID)

FROM CACHED_OUTLINE_VERSIONS v

WHERE v.OUTLINE_INFO_ID = '[T.OutlineInfoID]'

AND v.ACTIVE_FLAG = 1

)

The behavior of relational caching is controlled via a number of settings in the Dodeca-essbase.properties file. These settings are:

End of Dodeca Essbase Server — Relational Outline Caching

Dodeca Metadata Server Changes

The Dodeca metadata server has been rewritten to take advantage of xml parsing efficiencies gained through use of the SAX XML parser. In addition, the previous server technology, which used the DOM parser, has been deprecated but is retained in this version. The previous server technology is now referred to as the classic server and will be phased out of the server technology in a future version.

The configuration files formerly located in the \config subdirectory have been moved to enable easier modification. These files, which include the dodeca.properties, hibernate.properties, web.xml and various hibernate xml mapping files, were formerly distributed to various locations within the dodeca-metadata.jar file or to the WEB-INF\lib directory. These files, with the exception of the web.xml file, have been relocated to the WEB-INF\classes subdirectory structure.

Here is a screenshot of the WEB-INF\classes subdirectory:

dodeca.get.method.mappings.properties File

The dodeca.get.method.mappings.properties file contains service mappings that are optionally available for use with the http GET method. These mappings, which include the user audit functionality and the Dodeca metadata database DDL display, are disabled by default for security purposes.

dodeca.properties and dodeca-actions.properties Files

The dodeca.properties file from previous versions has been split into two different files: dodeca.properties and dodeca-actions.properties. The dodeca.properties file contains miscellaneous settings that affect the behavior of the metadata server. The service implementation mappings have been moved to the dodeca-actions.properties file. Additionally, the following properties present in the previous version are now obsolete and have been removed from the dodeca.properties file:

hibernate.properties.file
dodeca.metadata.print.xml
dodeca.object.xml.export.directory
dodeca.object.xml.import.directory

The hibernate.properties.file property formerly was used to identify the file system location of the hibernate.properties file. This functionality is now provided by the configurationDirectory init-param in the web.xml file. The ability to print XML has been replaced by the XMLLogger servlet filter that will automatically print each XML request and response to a specified directory. The XML export and import functionality was removed due to the popularity of the functionality to export XML to, and import XML from, a zip file.

DodecaResourceBundle.properties File

The new DodecaResourceBundle.properties file has been included as the first step towards localization of messages from the metadata service.

log4j.properties File

The log4j.properties file was added to enable configuration of the new logging functionality built into the server.

resource Subdirectory

The resource subdirectory contains the Hibernate xml mapping files used to map Dodeca metadata classes to their underlying metadata store.

Classic Subdirectory

The classic subdirectory contains configuration files for use with the classic server. Though we expect the classic server to be removed in future versions of Dodeca, we recommend you configure the dodeca.properties and hibernate.properties files in the classic subdirectory in order to seamlessly transition to the classic version as necessary.

Dodeca Metadata Server and dodeca-essbase Server Logging

Robust, configurable logging functionality has been added to both the dodeca metadata and the dodeca-essbase servers using the industry standard log4j logging utility. Log4j is configured in the log4j.properties file. Each server has implemented both an untimed and a timed logger. The timed logger can be used to optionally display performance metrics for different segments of the operations within the respective servers. Further, log4j also provides for different levels of logging.

Below is a screenshot of the dodeca-essbase log4j.properties file:

This configures the timed logger service to run at the DEBUG level which gives the most detailed, timed performance information. The INFO level provides summary level performance information. As configured above, the timed logger uses the DailyRollingFileAppender, which creates a new log file every day. The file is placed in the directory location indicated by the dodeca.log.dir Java system property and is prefixed by the name dodeca-essbase-timed. If the dodeca.log.dir system property is not present, Dodeca will attempt to locate the appropriate directory based on application server in which it is installed. For example, if the server is running in Apache Tomcat, the logs will default to the Tomcat logs directory. If the system property is not present, and if Dodeca cannot determine the location where logging should occur, logging is disabled. To configure the dodeca.log.dir system property, add the following JVM argument to your Java application server:

-Ddodeca.log.dir=<absolute path to log file directory>

The timed logger output was designed for ease of analysis. The output is presented in pipe-delimited format, which can easily be imported into a database or into Excel for further analysis. Below is an example of the output for a single transaction:

The log entries in the screenshot above are represented below.

2011.08.27 18:18:15.004|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Servlet doPost method: pre-invoke action - ZoomIn.|0|0|0|

2011.08.27 18:18:15.005|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Pre-parse processing|0|0|0|

2011.08.27 18:18:15.018|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Parse XML|0|0|13|

2011.08.27 18:18:15.026|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Connect to Essbase and return IEssCubeView object|0|0|22|

2011.08.27 18:18:15.033|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Fill and return IEssGridView object|10488|0|7|

2011.08.27 18:18:15.284|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Perform Essbase operation ZoomIn|10488|187040|251|

2011.08.27 18:18:15.837|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Read results and serialize to output stream|10488|187040|553|

2011.08.27 18:18:16.174|49|1|6712663b-240c-44c9-a453-717327593f56|timt|ZoomIn|Servlet doPost method: post-invoke action - ZoomIn.|10488|187040|1170|

This level of detail is provided by setting the log4j log level to DEBUG. Setting the log level to INFO will print summary information only as represented by the last line in the log above.

Essbase Ad hoc View

In this screenshot, the Undo dropdown lists the previous operations, and includes the Essbase Server/Application/Database for each operation.

To include the Undo/Redo toolbar, which contains the Undo and Redo segmented popup menu buttons, in the toolbars configuration used by an Ad hoc view, do one of the following options:

OPTION 1: The easiest way is to import the Essbase View Standard All Excel AddIn toolbars configuration from the metadata_starter_kit.zip, which is installed with the Dodeca Framework in the metadata folder. (This toolbars configuration includes all the tools that are typically used with an Ad hoc view running in the Excel add-in mode.)

OPTION 2: To add the Undo/Redo toolbar to an existing toolbars configuration, perform the following steps:

Essbase Selector TreeView

Excel-based Views: Excel, SQL Excel, and All Essbase Views

The AutoCalculate feature allows a user to see the results of the following calculation functions as applied to the selected range of cells:

The results are displayed in the view’s status bar, and by default, include the Average, Count, and Sum functions. (#977)

The view metadata contains 3 settings related to the auto-calculate feature: AutoCalculateEnabled, which controls whether the auto-calculate function results are displayed in the status bar; AutoCalculateFunctions, which controls which auto-calculate functions are calculated and displayed in the status bar by default; and, AutoCalculateAllowCustomize, which controls whether the user is allowed to choose functions from the AutoCalculate menu.

When AutoCalculateAllowCustomize is True, the AutoCalculate menu can be opened by right clicking in the status bar.

When the view is covered, the auto-calculate function results are automatically cleared from the status bar and the context menu is not displayed when the user clicks the right mouse button in the status bar. When the view is uncovered, auto-calculate is automatically re-enabled.

The ability of the user to insert and delete cells, rows, and columns into and from the active worksheet is supported by the following standard tools: (#1000)

Insert and Delete Segmented Popup Menu Tools

The Insert and Delete segmented popup menu tools emulate the equivalent Excel tools that are used to insert and delete cells, rows, columns, and sheets.

Note: A segmented popup menu contains both a button and a dropdown menu.

As in Excel, when the Insert or Delete button is clicked, the active selection determines whether cells, rows, or columns are inserted or deleted.

The Insert menu contains the Insert Cells, Insert Sheet Rows, Insert Sheet Columns, and Insert Sheet tools. The Delete menu contains the Delete Cells--, Delete Sheet Rows, Delete Sheet Columns, and Delete Sheet tools.

When cells are selected and the Insert Cells or the Delete Cells button is clicked, the related options dialog is displayed.

Insert and Delete (Cells, Rows, Columns) Context Menu Tools

As in Excel, the ability to insert and delete cells, rows, and columns is supported by tools available in the context menu that is displayed when cells, rows, or columns are selected and the right mouse button is clicked on a worksheet. The active selection determines the action taken when the Insert or Delete tool is clicked. When cells are selected, the Insert or Delete options dialog is displayed. When entire rows or columns are selected, then rows or columns are inserted or deleted.

The InsertSheetCellsContextMenuButton and DeleteSheetCellsContextMenuButton can be imported into a toolbars configuration and added to a popup menu tool.

How to add the Insert and Delete segmented popup menu tools to a toolbars configuration and the Insert and Delete tools to a context menu

IMPORTANT — The following guidelines should be reviewed before adding these tools to a view’s toolbars:

To add the Insert and Delete segmented popup menu tools to an existing toolbars configuration, perform the following steps:

To add the Insert and Delete cells tools to a context menu, perform the following steps:

The Insert and Delete segmented popup menu tools described above contain the Insert Sheet and Delete Sheet tools, respectively. The ability to insert, delete, as well as rename a sheet is also supported by the sheet context menu. (#1001)

Sheet Context Menu

The sheet context menu is displayed when the tab area of the workbook is clicked with the right mouse button. The menu contains the Insert, Delete, and Rename sheet tools.

To enable the sheet context menu for a view:

Alternatively, use a toolbars configuration that already contains the SheetContextMenu.

To add the sheet context menu and related tools to an existing toolbars configuration, perform the following steps:

Relational

The screenshot below illustrates the issue. Note that the SUV SubCategory is the last child group in the Automobile Category and the Pear SubCategory is the last child group in the Fruit Category, and neither is outlined; however, the Oak SubCategory is the last child group in the Tree Category, which is the last Category, and is outlined.

The next screenshot illustrates the resolution:

This issue is related to an issue (#951) that was partially addressed, but not completely resolved, in Version 5.3.0.2646.

Selector ComboBox

The following example illustrates how this setting can be used.

The selector list AW_City is configured to escape embedded single quotes. To allow for multiple selections, the TokenValueItemFormat is set to '{0}', which encloses each selected item in single quotes. Note that the TokenValueItemFormat setting is not required when TokenValueItemEscapeSingleQuote is True, but is necessary when multiple selections are allowed and the token is used in the WHERE clause of a relational query.

In this view, one of the selected cities, Ville De’anjou, contains an embedded single quote.

The SQL statement used to query the database uses the City selector’s token, [T.City] in an IN clause within the WHERE clause:

The [T.City] token value is

'Montreal', 'Sillery', 'Ville De''anjou'

where each city is enclosed with single quotes (based on the formatting specified by the TokenValueItemFormat setting) and the embedded single quote in Ville De’anjou is escaped with another single quote (based on the TokenValueItemEscapeSingleQuote setting.)

With the token replaced, the resolved WHERE clause is

WHERE (a.City IN ('Montreal', 'Sillery', 'Ville De''anjou'))

SQLExcelView

AllowChartExplorer

AllowRangeExplorer

AllowShapeExplorer

AllowWorkbookDesigner

AllowWorkbookExplorer

And the following Behavior setting:

BackgroundThreadWorkbookCalculation (#969)

SQLPassthroughDataSet Metadata Editor

Workbook Script Tool Controller

Workbook Scripting

Two additional method arguments were added: MaxCharactersPerLine and FontStyle. The MaxCharactersPerLine indicates the maximum number of characters displayed on a comment line, and is used to calculate the size of the comment frame. The default is 40. The FontStyle can be set to Regular or Bold. The default is Regular.

These arguments make it much easier to use the SetEntry method in a procedure that is called from within a CellByCell loop. When the SetEntry Address argument is not specified and the "target" arguments are used, the @ACell(), @CRow(), @CCol() functions return the active cell, row, and column based on the CellByCell address.

_Please note that existing workbook scripts that use the SetEntry method will continue to work as before. The "target" arguments are only used if specified, and are not required. _

When the method is used by an Essbase view, the Essbase connection ID argument is optional. When no connection ID is specified, the Essbase view’s EssbaseConnectionID is used. For a non-Essbase view, the connection ID must be specified.

When the Essbase connection used by the method is stateful and the Username and Password arguments are also specified, a separate connection is opened on the server, and the connection is closed after the method executes. When the Essbase connection used by the method is stateful and the Username and Password arguments are not specified, a single instance of the connection is created on the server the first time the connection is used by either a view or a workbook script, and the connection is shared by any view and workbook script method that uses the connection. A stateful connection is closed when the Dodeca application is exited.

The Username and Password arguments will continue to be supported for the methods listed above in order to maintain backward compatibility. The recommended approach, when a workbook script method needs to use a connection with specific credentials, is to define a separate Essbase connection metadata instance that specifies the Username and Password settings, and then use this connection for the workbook script method. This approach is enforced for the following methods, which support an Essbase connection ID argument, but do not support Username and Password arguments:

In this particular customer’s case, the selector list associated with the selector is configured with the ToolVisibleInToolbar property set to False, which is advisable, in order to prevent the user from opening the docked control. The control cannot be displayed both as a docked control and a modal dialog.

The method-specific arguments include SelectorID and DialogResultPropertyName. (#1006)

The method supports the following method-specific arguments:

DefaultNetworkCredentials option - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication.

SpecifiedCredentials option - Uses the specified UserName, Password, and Domain.

The method supports the following method-specific arguments:

The method supports the following method-specific arguments:

This event link can be used to dynamically set the context menu based on the active sheet. For example, let’s say that an Excel Essbase view is configured to open a drill-through sheet in response to the user double clicking an Essbase data cell. If we want the sheet context menu to display only for a drill-through sheet, we can create a workbook script that sets or clears the view’s SheetContextMenuID based on whether or not the active sheet is a drill-through sheet.