adminguidecs clarity server - ibm.com

Clarity ServerAdministration Guide Version 6.2

C L A R I T Y s y s t e m s

. . .

. .

Clarity

Administration Guide

Version 6.2

1st Edition

Microsoft is a registered trademark. Microsoft SQL Server, Office, Excel, Word, Internet Explorer, FrontPage, Query, Windows and Windows NT are trademarks of Microsoft Corporation. Adobe Acrobat and Adobe Acrobat Reader are registered trademarks of Adobe Systems Incorporated. All other brand and product names are registered trademarks of their respective holders.

No portion of this manual may be reproduced or transmitted in any form by any means, electronic or mechanical, including photocopying, recording, or using within information storage and retrieval systems, for any purpose other than the purchaser’s personal use without express written permission of Clarity Systems.

Notice: The information contained in this document is subject to change without notice. Clarity Systems shall not be liable for errors contained herein or consequential damages in connection with the furnishing, performance or use of this material.

Clarity Systems Limited 2 Sheppard Avenue East Suite 800 Toronto, ON CanadaM2N 5Y7 1-877-410-5070 1-416-250-5500 www.claritysystems.comPrinted in Canada 2/2008

Copyright © 2008 Clarity Systems Limited. All rights reserved.

. . .

. .

TABLE OF CONTENTS

Clarity Overview..................................................................................................... 1About Clarity................................................................................................................................. 1Clarity Budgeting and Planning .................................................................................................... 2Clarity Forecasting ....................................................................................................................... 2Clarity Reporting........................................................................................................................... 3Clarity Consolidations................................................................................................................... 3Clarity Scorecards ........................................................................................................................ 3Clarity Analysis............................................................................................................................. 4Clarity Modeling............................................................................................................................ 4

About This Documentation ................................................................................... 5About this Guide........................................................................................................................... 5Conventions and Terminology ...................................................................................................... 5Shortened Names and Acronyms ................................................................................................ 5Naming Conventions .................................................................................................................... 6Additional Reading ....................................................................................................................... 6

Technical Architecture .......................................................................................... 9How Clarity Performance Management Works ............................................................. 11

Clarity Server Process Overview - Step 1 .................................................................................. 12Clarity Server Process Overview - Step 2 .................................................................................. 13Clarity Server Process Overview - Step 3 .................................................................................. 14Clarity Server Process Overview - Step 4 .................................................................................. 15Clarity Server Process Overview - Step 5 .................................................................................. 16Clarity Server Process Overview - Step 6 .................................................................................. 17Clarity Technology - Terms and Definitions ................................................................................ 18

Web-Based Applications .................................................................................................. 18Active Server Pages (ASP) .............................................................................................. 18Extensible Markup Language (XML)................................................................................ 18Internet Information Services (IIS) ................................................................................... 18COM+ Technology ........................................................................................................... 19

Relational Connections ....................................................................................... 21Configuring Relational Connections.............................................................................. 23Encryption Tool ................................................................................................................ 25

Customizing the Web Interface........................................................................................................ 27

Customizing the Login Page........................................................................................... 29

1

Language Option (Localization) ....................................................................................... 29Remember Password....................................................................................................... 30Change Password............................................................................................................ 30Encryption ........................................................................................................................ 30Hot Links .......................................................................................................................... 30Other Changes................................................................................................................. 31

Customizing the Main Page ............................................................................................ 33Logo ................................................................................................................................. 33Instance Description......................................................................................................... 34Static Comments.............................................................................................................. 34Hot Links .......................................................................................................................... 34Assigning a Home Page by Role ..................................................................................... 34

Customizing OWC Deployment ...................................................................................... 35Customizing ActiveX Compression Level ..................................................................... 37

Other Configurations........................................................................................... 39Application Server Configuration................................................................................................ 40

Proxy User Setup (Essbase Only) ................................................................................... 41Calc User Setup (Essbase Only) ..................................................................................... 41SMTP Mail Setup ............................................................................................................. 41

Security Services ................................................................................................. 43Administrating Security Services................................................................................... 45

Configuring Security Services .................................................................................................... 45OLAP Manager ................................................................................................................. 47Administrating Users and Roles..................................................................................... 49

Reserved Roles.......................................................................................................................... 49Users & Roles ............................................................................................................................ 51

Hierarchy Security Profiles ............................................................................................. 65Hierarchy Security Configuration................................................................................... 71Administrating Hierarchy Security ................................................................................. 73Menu Administration ....................................................................................................... 81

Security Services XML Configuration......................................................................................... 99Virtual Directory XML Configuration ......................................................................................... 102

Workflow............................................................................................................. 103Workflow XML Configuration........................................................................................ 105

Define Global Settings.............................................................................................................. 106Define Scenarios ...................................................................................................................... 107Workflow Administration Configuration ..................................................................................... 110Manage Workflow Configuration ............................................................................................... 114Workflow Audit Trail Configuration ............................................................................................ 116

Administrating Workflow............................................................................................... 117

2

. . .

. .

Workflow Administration............................................................................................................ 117Defining a Workflow Entity ............................................................................................. 117Workflow Administration Toolbox Commands................................................................ 121

Manage Workflow..................................................................................................................... 123Using Manage Workflow ................................................................................................ 123Changing Workflow Status............................................................................................. 124Notes in Manage Workflow ............................................................................................ 125Email in Manage Workflow............................................................................................. 126Sample Scenario of Collective Email Notification........................................................... 127Filter in Manage Workflow.............................................................................................. 128Manage Workflow Toolbox Commands ......................................................................... 128

Template Status........................................................................................................................ 129Workflow Audit Trail.................................................................................................................. 133

Workflow Audit Trail Toolbox Command........................................................................ 135

Audit Trail ........................................................................................................... 137Audit Trail Overview....................................................................................................... 139

Audit Trail - by Template........................................................................................................... 139Viewing Audit Trail Entries ............................................................................................. 140

Audit Trail Reporting................................................................................................................. 142Purge Log................................................................................................................................. 144

Using Purge Log for Audit Trail - by Template ............................................................... 145Using Purge Log for Audit Trail - Report ........................................................................ 146Using Select All / Deselect All ........................................................................................ 146

XML Configuration and Optimization........................................................................... 147Audit Trail XML Configuration .................................................................................................. 147Audit Trail XML Configuration - Directory Path and Query Optimization.................................. 148Optimizing XML Parameters for Performance.......................................................................... 149

Queued vs. Non-Queued ............................................................................................... 149

Activity Tracking ................................................................................................ 151Administrating Activity Tracking .................................................................................. 153

Activity Tracking XML Configuration ........................................................................................ 154Configuring Activity Tracking.................................................................................................... 155

Activity Tracking Log..................................................................................................... 157View Log................................................................................................................................... 158Purge Log................................................................................................................................. 158Export to CSV........................................................................................................................... 159

Report Books ..................................................................................................... 161Report Books Configuration ......................................................................................... 163

Report Books Server - XML Configuration ............................................................................... 163Application Server .......................................................................................................... 163Web Server .................................................................................................................... 165

3

Report Books.................................................................................................................. 167Manage Report Books ................................................................................................... 169

Add/Edit Report Book............................................................................................................... 170Delete Report Book .................................................................................................................. 171Select Page Options................................................................................................................. 172Global Options.......................................................................................................................... 173

Run Report Books.......................................................................................................... 175Generating a Report Book........................................................................................................ 175

View My Reports............................................................................................................. 177Refresh List of Reports............................................................................................................. 177Purge Reports .......................................................................................................................... 178Print .......................................................................................................................................... 178Save As.................................................................................................................................... 178Select All .................................................................................................................................. 179Deselect All .............................................................................................................................. 179

Schedule Report Books................................................................................................. 181Add Schedule ........................................................................................................................... 182Edit Schedule ........................................................................................................................... 183Delete Schedule ....................................................................................................................... 183

Business Rules .................................................................................................. 185Business Rules Configuration...................................................................................... 187

Business Rules XML Configuration.......................................................................................... 187Report Books XML Configuration............................................................................................. 187

Clarity Web Interface URL ............................................................................................. 189Business Rules .............................................................................................................. 191

Manage Business Rules........................................................................................................... 191Add/Edit Business Rule.................................................................................................. 192Run Business Rule......................................................................................................... 193Delete Business Rule..................................................................................................... 193

Schedule Business Rules......................................................................................................... 194Add/Edit Schedule.......................................................................................................... 194Delete Schedule............................................................................................................. 194

Modeling ............................................................................................................. 195Understanding Modeling ............................................................................................... 197Calculations.................................................................................................................... 199

Calculation Scripts.................................................................................................................... 199What-If ............................................................................................................................. 203

OLAP Connection and Formatting ........................................................................................... 204Dimension Selection Fields ...................................................................................................... 204Calculation Methods................................................................................................................. 205Member list for custom allocation............................................................................................. 206Calculation scripts .................................................................................................................... 206

4

. . .

. .

Versioning....................................................................................................................... 209OLAP Connection and Formatting ........................................................................................... 210Dimension Selection Fields ...................................................................................................... 210Calculation Scripts..................................................................................................................... 211Creating Menu Items................................................................................................................ 213Calculation Example................................................................................................................. 213Running Batch Files from Menu Items ..................................................................................... 214

Detect and Alert ................................................................................................. 215Detect and Alert.............................................................................................................. 217

Creating an Alert Definition ...................................................................................................... 218Alert Definition XML Configuration ........................................................................................... 218

Example of ClarityDemo.xml .......................................................................................... 218Creating a New Alert ................................................................................................................ 221Edit an Existing Alert Definition ................................................................................................ 223Delete an Existing Alert Definition ............................................................................................ 224Detect and Alert XML Configuration - Folder Path ................................................................... 224

ActiveX Control .................................................................................................. 225The ActiveX Control....................................................................................................... 227

1. Installation ............................................................................................................................ 2271.1 Automatic Download ................................................................................................ 2271.2 Manual Download .................................................................................................... 227

2. Applying Updates to the ActiveX Control ............................................................................. 2282.1 Automatic Download ................................................................................................ 2282.2 Manual Download .................................................................................................... 2282.3 Testing an Update on a Single Workstation............................................................. 228ActiveX XML Configuration ............................................................................................ 229

License Keys ...................................................................................................... 231Administrating License Keys........................................................................................ 233

Installing the License Key......................................................................................................... 233Server License - XML Configuration .............................................................................. 233

Replacing the License Key to Accommodate More End Users................................................ 234Updating the Clarity License Key ................................................................................... 234

Language Localization ...................................................................................... 237Understanding Localization .......................................................................................... 239

Clarity Environment .................................................................................................................. 239Essbase Environment .............................................................................................................. 240Windows Environment.............................................................................................................. 240

Configuring Language Localization ............................................................................. 241Localization XML Configuration................................................................................................ 241

5

Menu Security Configuration for Localization........................................................................... 242Create or Update Templates and Reports................................................................................ 246

XML File Overview ............................................................................................. 247Working with XML Configuration Files ........................................................................ 249

XML Files Used by Clarity ........................................................................................................ 249XML Structure........................................................................................................................... 249Modifying XML Files ................................................................................................................. 250

Server Configuration Files (Web and Application Config)......................................... 251Web Server Configuration File ................................................................................................. 251Application Server Configuration File ....................................................................................... 252

ER Diagrams....................................................................................................... 253

6

About Clar i ty

Clarity is a single-integrated application that offers the flexibility, security, and control needed to make more informed business decisions, meet compliance requirements and ensure better corporate responsibility through its highly feature-rich environment.

With Clarity, there are no modules or add-ons required to perform the necessary performance management processes and functions. Budgeting, forecasting, planning, reporting, consolidations, scorecards, analysis, modeling and more – all in a single, web-based and Excel-compatible application that utilizes existing databases and financial models.

Clarity Overview 0

1

C L A R I T Y O V E R V I E W

Clarity is the only performance management application that supports multiple industry standard OLAP databases, and it supports multiple industry-standard relational databases as well. This ability to simultaneously interact with both relational and multi-dimensional OLAP databases means that Clarity leverages your existing investment in database technology, and connects directly to those databases currently in your environment.

As a web-based application, Clarity provides accessibility and visibility across the organization while easing deployment and maintenance tasks.

Clar i ty Budget ing and PlanningBudgeting and Planning with Clarity allows for control over the accuracy, completeness, and timeliness of an enterprise-wide budgeting process. Clarity easily facilitates budget preparation at any level of granularity.

Features include:

• Excel look and feel on the web.

• Secure centralized database.

• Collaboration with several or thousands of planners contributing numbers.

• Ease of use allows for input of data via a template online or uploading a spreadsheet; allocation of data across periods and adjusting of data by a percentage.

• Top-down or bottom-up planning.

• Human Resource and Capital planning is built-in.

• Quick access to line item details.

• Ease of deployment.

• Workflow allows for close monitoring of the budget cycle.

Clar i ty Forecast ingForecasting with Clarity allows for quick reactions to the rapidly changing competitive landscape. As drivers change, the impact on financial results can be obtained very quickly with Clarity.

Features include:

• Excel look and feel on the web.

• Secure centralized database.

• Multiple versions.

• Rolling forecasts.

2

. . .

. .C L A R I T Y O V E R V I E W

• Spreading patterns.

• Advanced business rules and modeling capabilities.

Clar i ty Repor t ingReporting with Clarity allows for the distribution of reports to management on a scheduled basis with a choice of output format.

Features include:

• Choice of output format.

• Books of reports.

• Ad-hoc reporting.

• Advanced hierarchy and template/report security controls access to data.

• Ease of distribution.

Clar i ty Consol idat ionsFinancial consolidations with Clarity allows for the consolidation of financial results quickly and accurately while keeping in compliance with international accounting and regulatory standards.

Features include:

• Import of data from multiple source systems.

• Foreign currency translation.

• Inter-company eliminations.

• Journal entries.

• Consolidation methods.

• Alternate hierarchies.

Clar i ty ScorecardsClarity Scorecards help align tactics with corporate strategies; communicate company objectives, and monitor performance against targets.

Features include:

• Focusing on priorities.

• Insight into your organization.

3

C L A R I T Y O V E R V I E W

• Multiple indicators at a glance.

• Access to detail.

Clar i ty Analys isAnalysis with Clarity helps make accurate, meaningful, and timely decisions. The intuitive web interface provides information in a clear, presentable and highly graphical format.

Features include:

• Easy to use template building wizard.

• Powerful graphics with Clarity Visualizer.

• Drill down to underlying transactions or into more detailed reports.

• Zooming-in and zooming-out.

• Traffic lighting to identify values that exceed, meet or fall below a specified threshold.

• Cell notes and row notes to embed explanations.

• Point of view selection to quickly slice and dice data.

Clar i ty Model ingModeling with Clarity provides the ability to adjust various financial and non-financial parameters to determine the impact of these changes on the overall financial results of the organization.

Features include:

• Flexible business rules.

• Parameter based calculations.

• Multiple versions.

• Alternate scenarios to compare the results.

• Goal seeking.

4

About th is GuideThis guide provides all the information needed to configure and administer the Clarity web-based integrated applications.

Convent ions and TerminologyThis guide uses standard Microsoft naming conventions and terminology to describe the Clarity web-based graphical user interface.

Shor tened Names and AcronymsThe following table lists the shortened names or acronyms commonly used in this guide.

Full Name Shortened Name or Acronym

Clarity Clarity

Clarity Application Server Application Server

Clarity Consolidations Consolidations

Clarity Cube Manager Cube Manager or CM

Clarity Security Services CSS

Clarity Template Builder Template Builder

Clarity Visualizer Visualizer

Clarity Visualizer Report Builder Visualizer Builder

Clarity Web Interface Web Interface

Clarity Web Server Web Server

Database Administrator DBA

Essbase Spreadsheet Add-In Spreadsheet Add-In

Graphical User Interface GUI

Hyperion Essbase Essbase

About This Documentation 1

5

A B O U T T H I S D O C U M E N TA T I O N

Naming Convent ionsThe following naming conventions are used throughout this guide:

• Bold text indicates items such as keys, buttons and menu commands that require you to press, click or select. For example, click OK means to click the left-mouse button once on the OK button.

• Bold text is also used to highlight the names of dialog boxes, tabs, fields, and other interface elements.

• Notes provide important information such as warnings, tips, or consequences of an action.

• Generally Clarity Reports are referred to as ‘templates’ as there is no structural difference when building a Clarity Template or Clarity Report. When exceptions occur, references will be made to ‘reports’.

Addi t ional ReadingThe following guides are available for Clarity:

• Clarity Administration Guide (including Template Builder)

Hyperion Essbase Integration Services Hyperion EIS or EIS

IBM DB2 OLAP OLAP

Inter-company I/C

Internet Information Services IIS

Microsoft MS

Microsoft Analysis Services MSAS

Microsoft Excel Excel

Microsoft Internet Explorer Internet Explorer or IE

Microsoft SQL Server 2000 SQL Server 2000

Microsoft SQL Server 2005 SQL Server 2005

On-line Analytical Processing OLAP

Single Sign-On SSO

Structured Query Language SQL

Uniform Resource Locator URL

Visual Basic VB

Visual Basic Script VBS

6

. . .

. .A B O U T T H I S D O C U M E N TA T I O N

• Clarity Installation Guide (including Template Builder)

• Clarity Administration Guide for Consolidations

• Clarity Installation Guide for Consolidations

• Clarity Administration Guide for Cube Manager

• Clarity Installation Guide for Cube Manager

• Clarity Administration Guide for Visualizer

• Clarity Installation Guide for Visualizer

• Clarity System Guide

7

A B O U T T H I S D O C U M E N TA T I O N

8

Clarity© is a corporate performance management solution that enables you to create corporate standardized reports and data entry templates based on existing company data. These templates and reports are then distributed to a user community for enterprise-wide financial processes, such as budgeting, planning, forecasting, and corporate reporting.

Clarity allows users to report and analyze company data using their web browser over a corporate Intranet or Internet. It leverages the power of both OLAP (IBM DB2 OLAP, Hyperion Essbase, and MS Analysis Services) and relational (MS-SQL Server, Oracle, and DB2) databases.

This section contains information about Clarity and how it can be used to view, modify, and otherwise manipulate summary data to create a budgeting and planning solution for your organization. Also included in this section is a high-level architectural overview, and information about the mechanics of Clarity’s software and server processes.

Technical Architecture 2

9

TE C H N I C A L A R C H I T E C T U R E

10

. . .

. .TE C H N I C A L A R C H I T E C T U R EHow Clarity Performance Management Works

H O W C L A R I T Y P E R F O R M A N C E M A N A G E M E N T W O R K S

Because Clarity is a web-based application, it has certain advantages over traditional software, which include ease of deployment and accessibility.

Web-based applications do not require software to be installed on a PC in order to run them. To run Clarity, all you need is Internet Explorer and the URL of the Web Server which hosts Clarity.

Clarity uses a series of server processes in order to coordinate communication from your web browser to the database environment.

Clarity is comprised of the following server processes:

• The Clarity Web Server

• The Clarity Application Server

• The OLAP Database Server

• The Relational Database Server

Other important components in the Clarity solution include both administrator and end user client machines (used to communicate with Clarity), and any existing company ERP systems such as general ledgers and human resource systems (from which existing data is extracted).

The following pages illustrate a series of steps to show how data is transferred from your organization’s existing ERP systems into the Clarity database environment, and how you can use Clarity to view and modify that data.

11

TE C H N I C A L A R C H I T E C T U R EHow Clarity Performance Management Works

Clar i ty Server Process Overview - Step 1Existing data sources encompass all existing company ERP systems (human resource systems, general ledgers, etc.) This includes data regarding business transactions, employee salaries, etc.

Information is extracted from these sources and transferred into the Clarity database environment (which consists of the OLAP and Relational Database Servers).

Data is typically extracted via the extraction tool native to the ERP system. It is then imported into the Clarity database environment via load rules for the OLAP Database Server, and DTS packages for SQL Server, or their relational database equivalent.

12

. . .

.TE C H N I C A L A R C H I T E C T U R EHow Clarity Performance Management Works

.

Clar i ty Server Process Overv iew - Step 2The Clarity database environment consists of the OLAP and relational database servers. Information is extracted from existing data sources and allocated between the two databases.

In most cases, transaction and salary-type data is stored in the relational database (tabular data structure), while account-level data is stored in the OLAP database (cube data structure). The relational database also stores some Clarity-specific data such as template and hierarchy security permissions.

13


Clar i ty Server Process Overview - Step 3The Clarity Application Server communicates with the Clarity Web Server as well as both servers in the Clarity database environment. It relays Web Server requests for data to both databases for information retrieval, and requests updates to the same information.

14

. . .


Clar i ty Server Process Overview - Step 4From a client machine, you can access the Clarity web interface by entering the URL of the Clarity Web Server in your browser’s address bar. Any changes or requests you make will be relayed back to the Clarity database environment via the Clarity Application Server.

15


Clar i ty Server Process Overview - Step 5Administrator client machines not only communicate with the Clarity Web Server in the same way end user clients do (accessing the Clarity web interface), but they also communicate directly with both the OLAP and relational database servers. This is so administrators can design and create templates and reports, as well as establish database security parameters and other administrative tasks.

In addition to having access to the web interface on the Web Server, administrator client machines also have network access to template and report files.

16

. . .


Clar i ty Server Process Overview - Step 6At the end of a budgeting and planning cycle, the new data stored in the Clarity database environment can be transferred back into the company’s ERP systems, if required.

Data is loaded back into the ERP system via the utility extraction tool of the specified ERP system.

17


Clar i ty Technology - Terms and Def in i t ionsThe following terms and definitions will help you better understand the technological elements that compose the Clarity solution. Understanding these technical terms will give you a better understanding of how Clarity works.

W e b - B a s e d A p p l i c a t i o n sClarity is a web-based application. This gives it certain advantages over traditional client-based applications, including ease of deployment and accessibility.

Web-based applications do not require software to be installed on your PC. All you need is a compatible web browser such as Internet Explorer and the URL of the Web Server, which hosts the Clarity web interface.

A c t i v e S e r v e r P a g e s ( A S P )Active Server Pages (ASP) are used by Clarity to display its content. This enables the Web Server to interpret and display contents of ASP files in your web browser. This process is transparent to the user.

For example, the URL http://budgeting/Clarity/login.asp tells the web browser to contact the Web Server named budgeting and open the ASP page login.asp. This is the Clarity log on screen, which will be discussed shortly.

E x t e n s i b l e M a r k u p L a n g u a g e ( X M L )Extensible Markup Language (XML) is used to send and receive data to and from the OLAP Database Server. XML allows a server to format data in a specific way that is easy for a client PC to parse and render.

Although XML is used to transfer data to and from the server, end users will never see XML, and therefore do not need to understand it to use the web interface.

I n t e r n e t I n f o r m a t i o n S e r v i c e s ( I I S )Internet Information Services (IIS) is Microsoft’s web server software. It allows your web browser to connect to the Clarity Web Server using a URL and access the ASP pages residing there (and thus the Clarity user interface).

18

. . .


C O M + T e c h n o l o g yCOM is an acronym for Component Object Model and is part of Microsoft’s multi-tiered application strategy. COM+ allows developers to create components or modules that can be reused in different applications. Clarity uses several COM components in its core functionality. (Templates, connectivity to the OLAP database, etc.)

The COM+ components reside on the Application Server.

19


20

In order for Clarity to communicate to a relational database management system (RDBMS), connection information must be configured. To encode and protect this sensitive information, the Encryption Tool is used.

This section contains the following topics:

• Configuring Relational Connections

• Encryption Tool

Relational Connections 3

21

R E L A T I O N A L C O N N E C T I O N S

22

. . .

. .R E L A T I O N A L C O N N E C T I O N SConfiguring Relational Connections

C O N F I G U R I N G R E L A T I O N A L C O N N E C T I O N S

Each relational database that Clarity needs to access must have at least one configured connection string. These strings are found in the config.xml file, which is located in the ...Clarity Systems\ClarityServer\com\bin folder.

The following attributes are found in the config.xml file, and control the aspects of the OLAP and Relational Database Server connections:

<databases defaultalias=“CPM_MSSQL_ENC”> <database alias=“CPM_MSSQL” type=“MSSQL” isencrypted=“false” connectionString=“Provider=SQLOLEDB; Data Source=(local) ; Initial Catalog=Clarity6; User id=sa; password=clarity;”/><database alias=“CPM_MSSQL_ENC” type=“MSSQL” isencrypted=“true” connectionString=“9434nxxx...”/>

</databases>

Node Attribute Description Possible Values Example

<databases> defaultalias The default alias of the Rela-tional Database Server.

defaultalias= “CPM_MSSQL_ENC”

<database> alias alias=“CPM_MSSQL”

type The type of database specified by the database alias attribute. Enter MSSQL, Oracle, or DB2, depending on the Rela-tional Database Server plat-form.

MSSQLOracleDB2

type=“MSSQL”

isencrypted Indicates if the Relational Database Server string is encrypted or not. Enter true if the Relational Database Server string is encrypted, or false if it is not.

truefalse

isencrypted= “false”

connectionString The Relational Database Server connection string.

connectionString=“Pro-vider=SQLOLEDB; Data Source=(local) ; Initial Catalog=Clarity6; User id=sa; password=clarity;”

provider This attribute is used to deter-mine what type of provider to use. Note: OLEDB value is only supported for DB2 databases.

managed OLEDB (aka unmanaged)

provider=“managed”

23

R E L A T I O N A L C O N N E C T I O N SConfiguring Relational Connections

24

. . .

.R E L A T I O N A L C O N N E C T I O N SEncryption Tool

.

E N C R Y P T I O N T O O L

The encryption tool allows administrators to encrypt and decrypt data. The main use for this tool is to encrypt the relational connection string stored in the COM\bin\config.xml file, since it includes sensitive information like usernames and passwords:

• Type the complete connection string into the UnEncrypted Data area and click on the Encrypt button.

• Select the results from the Encrypted Data area and copy to the clipboard (right-click and select Copy or press Ctrl+C).

• Paste into the appropriate location within the ...com\bin\config.xml file.

25

R E L A T I O N A L C O N N E C T I O N SEncryption Tool

26

The login page of Clarity can be customized to remember, change and encrypt passwords, add HotLinks, change images, colors and placement of text, or choice of language.

The main page of Clarity can be customized for logos, instance description, add static comments and HotLinks.

Note: The login page cannot be customized for the MSAS enviroment or when Single Sign On is used in the Essbase environment.


• Customizing the Login page

• Customizing the Main page

• Customizing Office Web Component (OWC) deployment

• Customizing ActiveX Compression Level

Customizing the Web Interface

4

27

C U S T O M I Z I N G T H E WE B I N T E R F A C E

28

. . .

. .C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Login Page

C U S T O M I Z I N G T H E L O G I N P A G E

The following features of the Clarity Login page are configurable:

L a n g u a g e O p t i o n ( L o c a l i z a t i o n )If enabled, this feature displays a drop down menu that allows the user to select a language option. If option is set to true, then the language option does not display on the login page. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<localization>

<hide_language_selection>false</hide_language_selection>

<force_default_culturecode>false</force_default_culturecode>

<default_culturecode>en-US</default_culturecode>

</localization>

29

C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Login Page

R e m e m b e r P a s s w o r dIf enabled, this feature displays a checkbox which allows users to store their password on their machines, instead of retyping it every time they log in. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<allow_remember_password_at_login>yes</allow_remember_password_at_login>

C h a n g e P a s s w o r dIf enabled, this feature displays a link which allows Essbase users to show or hide a section to change their password directly from the login screen. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<allow_set_password>yes</allow_set_password>

E n c r y p t i o nIf enabled, this feature will store the current password and the remembered password in encrypted format rather than plain text. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<cbwactivexhelper encryption="true">

H o t L i n k sAny number of optional links to static documents, “mailto” addresses or other URLs may be displayed. These Hot Links are controlled by the default.xml file that resides in the ...\Clarity Systems\ClarityServer\Web folder on the Web Server:

<hotlinks><url text="Suggestion Box" href="mailto:[email protected]"

tooltip="Send us your product enhancement ideas"/><url text="Planning Guidelines" href="../docs/planning_guidelines.doc"

tooltip= "What you need to know when planning"/></hotlinks>

Each <url> tag represents one Hot Link on the Login screen:

• The text attribute represents the caption displayed on the page

• The href attribute contains the URL address to call the new browser window

• The tooltip attribute contains text that is displayed when a user hovers their pointer over the caption in the web interface

To add or remove a Hot Link from the page, add a new <url> node to the XML file, or remove the corresponding <url> node.

30

. . .

.C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Login Page

.

O t h e r C h a n g e sAdditional customizations to images, colors, and placement of text may be added by an administrator familiar with HTML and CSS, by modifying the following files:

<clarity install folder>\Web\default.xsl

<clarity install folder>\Web\css\LoginPage.css

31

C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Login Page

32

. . .

. .C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Main Page

C U S T O M I Z I N G T H E M A I N P A G E

After logging into Clarity, the user is presented with the Clarity main page, which includes the main menu and the home tab (My Home by default.)

The following features of the Clarity main page are configurable:

L o g oBy default, the Clarity Systems logo appears in the upper left corner. Any image can be substituted by placing it in the Images folder (or another folder under the Web folder) and changing the path accordingly. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<config menulogo="images/company_logo2.gif" >

33

C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing the Main Page

I n s t a n c e D e s c r i p t i o nAn optional title may be added to distinguish multiple instances of Clarity. The title appears above the main menu. This is controlled by the following setting in the ...\Clarity Systems\ClarityServer\Web\config.xml file:

<config instancedescription ="Budgeting - Production" >

S t a t i c C o m m e n t sThe middle column of the My Home tab displays the Comments section. Comments related to the current date will display here. Global comments not related to a specific date are also displayed. These static comments may contain any html tags, and are controlled by the hotlinks.xml file that resides in the ...\Clarity Systems\ClarityServer\Web\MyHome folder on the Web Server:

<comments><comment>This is a test.</comment><comment><![CDATA[<font color="red" size="12">Testing...</font>]]></comment><comment><![CDATA[<img src="../images/whatifbackground.gif" height="250"/>]]></comment>

</comments>

H o t L i n k sThe rightmost column of the My Home tab may display any number of optional links to static documents, “mailto” addresses or other URLs. These Hot Links are controlled by the hotlinks.xml file that resides in the ...\Clarity Systems\ClarityServer\Web\MyHome folder on the Web Server:

<hotlinks><url text="Suggestion Box" href="mailto:[email protected]"

tooltip=Send suggestions for product enhancements to [email protected]"/><url text="Planning Guidelines" href="../docs/planning_guidelines.doc"

tooltip= "Tips for entering data to the budget templates."/></hotlinks>

Each <url> tag represents one Hot Link on the Login screen:

• The text attribute represents the caption displayed on the page.

• The href attribute contains the URL address to call the new browser window.

• The tooltip attribute contains text that is displayed when a user hovers the pointer over the caption in the web interface

To add or remove a Hot Link from the page, add a new <url> node to the XML file, or remove the corresponding <url> node.

A s s i g n i n g a H o m e P a g e b y R o l eFor information on using Clarity to assign a home page to a specific role or end user, see the topic, “Users & Roles” on page -51.

34

. . .

. .C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing OWC Deployment

C U S T O M I Z I N G O W C D E P L O Y M E N T

In order to use Clarity templates and reports, the client machine needs to have the Office Web Components (OWC) installed. These may be installed ahead of time, or Clarity may be configured for automatic deployment. Refer to the Microsoft documentation for more information on creating an administrative installation point for the version of Office in use. Once this is done, the information may be entered in the following settings in the...\Clarity Systems\ClarityServer\Web\config.xml file:

<owc><spreadsheet version="9.0" >

...<codebase>file:\\server1\Software\Office 2000\msowc.cab</codebase>

</spreadsheet>

<spreadsheet version="10.0" >...<installbase>file:\\server1\Software\Office XP\files\owc\setup.exe</installbase>

</spreadsheet>

<spreadsheet version="11.0" >...<installbase>file:\\server1\Software\Office 2003\owc\setup.exe</installbase>

</spreadsheet></owc>

If automatic deployment is not being used, these settings should be cleared as follows, in order to minimize processing time when loading the page:

<owc><spreadsheet version="9.0" >

...<codebase></codebase>

</spreadsheet>

<spreadsheet version="10.0" >...<installbase></installbase>

</spreadsheet>

<spreadsheet version="11.0" >...<installbase></installbase>

</spreadsheet></owc>

35

C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing OWC Deployment

36

. . .

. .C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing ActiveX Compression Level

C U S T O M I Z I N G A C T I V E X C O M P R E S S I O N L E V E L

To customize the level of compression used when sending or receiving certain calls to the server, perform the following steps:

1. Open the...\Clarity Systems\ClarityServer\Web\config.xml file.

2. Locate the compression attribute of the cbwactivexhelper node:

<cbwactivexhelper enabled=“true” encryption=“true”

compression=“none”>

3. Modify the compression attribute to set the level of compression:

• By default, the value is set to “none”. No compression will be used.

• The level can be set to any integer from “1” to “9” inclusive. “1” indicates the lowest level of compression and overhead, while “9” indicates the highest level of compression and overhead.

Note: A high level of compression may increase performance on server calls.

4. Save the changes to the config.xml file.

37

C U S T O M I Z I N G T H E WE B I N T E R F A C ECustomizing ActiveX Compression Level

38

The Application Server Configuration page allows an administrator to configure proxy user, calc user and SMTP options through an interface instead of editing the relevant XML file.


• Proxy user(s) configuration

• Calc user(s) configuration

• SMTP configuration

Other Configurations 5

39

O T H E R C O N F I G U R A T I O N S

Appl icat ion Server Conf igurat ionThe Application Server Configuration page is accessed from the Administration > Application Server Configuration menu.

This page enables administrators to set configuration parameters for the Clarity Application Server. For Essbase installations, the pane appears as follows:

Note: The Proxy User and Calc User Setup parameters are not applicable for MSAS installations.

40

. . .

. .O T H E R C O N F I G U R A T I O N S

The Application Server Configuration page is split into three sections:

• Proxy User Setup (Essbase Only)

• Calc User Setup (Essbase Only)

• SMTP Mail Setup

P r o x y U s e r S e t u p ( E s s b a s e O n l y )Enables an administrator to specify a proxy user on the application server to be used when sending data to Essbase from Clarity Templates. Click the check box to enable the User ID and Password fields, enter valid information in the fields provided and click Save Config Settings toolbox command. The system is updated to include the proxy user that you specified.

This setup can be used in situations where individual users are restricted from sending data through their individual accounts.

C a l c U s e r S e t u p ( E s s b a s e O n l y )Enables an administrator to specify a user who has permissions to run calculation scripts in the OLAP database environment to be used when running calculations either from a template or via the Calculate menu. Click the check box to enable the User ID and Password fields, enter valid information in the fields provided, and click Save Config Settings toolbox command. The system is updated to include the calc user that you specified.

S M T P M a i l S e t u pMany features in the web interface use SMTP Mail to send notifications and generated reports.

To use these features, Clarity must be configured to match the SMTP configuration used:

• If SMTP is installed locally, uncheck the Remote checkbox. None of the other fields are required.

• If SMTP is installed remotely, select the Remote checkbox -

Enter the name or IP address of the SMTP mail server.

Select the authentication method that this server uses.

If necessary, enter the port, userID and password needed for the SMTP service on this server.

41

O T H E R C O N F I G U R A T I O N S

42

Security Services enables organizations to manage end user access to various elements of the Clarity web interface. Administrators are able to define security permissions for templates and reports, menus and menu commands, as well as access to members within dimension hierarchies.

Administrators can use Security Services to assign access privileges to other users and roles, thus providing distributed security management.

This section describes the features and functionality of Security Services including:

• Setup

• OLAP Manager

• Hierarchy Security Configuration

• Hierarchy Security Profiles

• Users & Roles

• Hierarchy Security

• Menu Administration

• Security Services - XML Configuration

Security Services 6

43

S E C U R I T Y S E R V I C E S

44

. . .

. .S E C U R I T Y S E R V I C E SAdministrating Security Services

A D M I N I S T R A T I N G S E C U R I T Y S E R V I C E S

The Security Services folder contains commands that enable an administrator to set up and modify security permissions:

• The Setup folder contains commands relating to the initial security configurations and setup.

• Users & Roles enables administrators to add, delete, and modify users and roles within the system.

• Menu Administration enables administrators to control security permissions to menus and menu commands, including folders, sub-folders, and templates and reports.

• Hierarchy Security enables administrators to control security permissions to the dimension hierarchies of the OLAP database environment.

Conf igur ing Secur i ty Serv icesThe following order is recommended for Security Services setup:

1. OLAP Manager

2. Administrating Users & Roles

3. Hierarchy Security Profiles

4. Hierarchy Security Configuration

5. Hierarchy Security

6. Menu Administration

45

S E C U R I T Y S E R V I C E SAdministrating Security Services

46

. . .

.S E C U R I T Y S E R V I C E SOLAP Manager

.

O L A P M A N A G E R

The OLAP Manager is used to define the OLAP cubes on the OLAP Database Server that will be used by Clarity:

New cubes can be added by clicking on the Add OLAP Server toolbox command.

The fields defining a specific cube (Server, Provider, Application and Database) can be changed by clicking on the Edit OLAP Path icon alongside the relevant cube. While editing, the icons under the Options column switch to Accept and Cancel which are used to save or discard changes.

The cube can be deleted from the list by clicking on the Remove OLAP icon.

47

S E C U R I T Y S E R V I C E SOLAP Manager

To display the Dimensions within a cube, click on the View Dimensions icon alongside the relevant cube. The Dimension Details dialog box displays:

The Dimension Details dialog box will display any inconsistencies between the current structure of the OLAP database and what has been stored within Clarity. If there are inconsistencies (e.g. a dimension was renamed in OLAP), the Clarity tables can be updated from this page to ensure they are in sync with the current OLAP structure.

48

. . .

. .S E C U R I T Y S E R V I C E SAdministrating Users and Roles

A D M I N I S T R A T I N G U S E R S A N D R O L E S

Reserved RolesA reserved role is used to organize users and facilitate Clarity functionality, and cannot be deleted. In Clarity there are ten reserved roles:

• Clarity Administrators

• Clarity Users

• Clarity Calculators

• Clarity Modelers

• Clarity Report Book Administrators

• Clarity Report Book Users

• Clarity Workflow Users

• Journal Entry

• Consolidations Journal Post

• Consolidations Post Unbalanced

In order to access specific Clarity features such as consolidations or report books, a user must be included within the reserved role(s) for that feature. Users that are not included within a reserved role will not have menu access to use the functionality.

Reserved RolesAccess Provided with

Configuration DescriptionClarity Administrators Access to all default menu items and

RolesThis role is automatically added to all other roles; therefore, users within this role inherit the menu and hierarchy security for all other roles. Users within this role have administrative rights over all users. Membership in this role does not grant access to hierarchies.

Clarity Calculators Access to the Calculate menu items:Calculate AllCalculate RevenueClear What-If

Note: Available for Essbase environ-ments only

Users within this role have access to the menu items under Calculate.

Note: Membership in this role does not grant permission to run calculations in Essbase.

Refer to the Modeling section of the Clarity Administration Guide.

Clarity Modelers Access to the Modeling menu items:VersioningGoal SeekingWhat-If

Users within this role have access to the menu items under Modeling.

Note: Membership in this role does not grant permission to run calculations in Essbase.

Refer to the Modeling section of the Clarity Administration Guide.

49

S E C U R I T Y S E R V I C E SAdministrating Users and Roles

Clarity Report Book Administrators

Access to all Report Books menu items:

Manage Report BooksRun Report BooksView My ReportsSchedule Report Books

Users within this role are able to create and maintain Report Books, run Report Books, view Reports generated by Report Books, and schedule Report Books to be run as specific times.

Refer to the Report Books section of the Clarity Administra-tion Guide.

Clarity Report Book Users

Access to the following Report Books menu items:

Run Report BooksView My Reports

Users within this role are able to run Report Books that were created by the 'Clarity Report Book Administrators' role, and view Reports generated by Report Books.

Refer to the Report Books section of the Clarity Administra-tion Guide.

Clarity Users Access to Workflow menu items and sample Templates/Reports

All registered Clarity users are contained in this role.

Clarity Workflow Users This role is set up as the configured role containing Workflow users.

Users within this role can be defined as Owners, Watchers or Approvers on workflow entities.

Refer to the Workflow section of the Clarity Administration Guide.

Reserved RolesAccess Provided with

Configuration Description

50

. . .


Users & Roles

Users and Roles are maintained in Clarity via the Users & Roles menu command:

Search BarAdministrators can filter the view of existing users and roles by clicking on the alpha characters in the Search Bar, located above the list of users or roles:

• Clicking an alpha character will filter users and roles in the system based on the first letter of the Login ID or Role name. For example, selecting F will filter out all users and roles that do not begin with the letter F.

• Clicking All returns all users and roles in the system on the Users tab and the Roles tab.

• Search navigates to the Search tab, which enables administrators to filter users and roles based on a text string.

• The Retrieve All On Load check box toggles if the Users & Roles page populates with a full list of users and roles each time the menu command is issued. If the check box is unselected, the page will open without any users or roles displaying.

51


Users TabThe Users tab displays the list of existing user profiles to which the current logged in user has access:

Each record is composed of Login ID, First Name, Last Name, Email Address, Last Login Date. Additionally, each row contains an Enabled check box and Options command icons.

• The Login ID column contains the ID that an end user must type (along with their password) in order to log into Clarity successfully.

• The First Name column is a mandatory field that is typically used to associate the user profile with an existing employee/end user.

• The Last Name column is a mandatory field typically used to associate the user profile with an existing employee/end user.

• The Email Address column is a mandatory field typically used to associate the user profile with an existing employee/end user.

• The Last Login Date column displays the last time the specified user profile logged into the web interface.

• The Enabled column contains a check box that determines if the specified user profile is valid in the system or not. If a user attempts to log in via a disabled user profile, the system will not recognize it.

By default, new users are enabled in Clarity; if an administrator disables a user, that user cannot access Clarity, but the information and permissions associated with the user are retained in the system.

Note: The user profile defined during the Clarity Server installation cannot be disabled in the system, and the Enabled check box is therefore grayed-out.

52

. . .


• The Options column contains command icons that affect the relevant user profile:

• Delete User: Deletes the user profile from the system.

Note: The user profile defined during the Clarity Server installation cannot be deleted in the system, and the Deleted icon is therefore grayed-out.

• Edit User Details: Enables an administrator to modify the parameters associated with the user profile via the Edit User Details dialog box:

Modify the values in the First Name, Last Name, and Email Address fields. The Enabled check box determines if the specified user profile is valid in the system or not. If a user attempts to log on via a disabled user profile, the system will not recognize it.

The Super User check box is used to identify if the user profile is a super user or not. A profile that has been identified as a super user has the following properties:

- Cannot be locked out of Clarity, even if the profile is disabled.

- Administrate all users and roles.

- Automatic access to all menu items.

- Restricted by Hierarchy Security.

Note: Both the Enabled and Super User check boxes will be grayed-out if the user profile is the profile created via the Clarity Server installation program.

Click OK to save any changes, or click Cancel to return to the Users & Roles page without applying any of the changes.

53


• Assign User to Role: Enables an administrator to associate the user profile with a role or roles via the Assign Roles dialog box:

The Available Roles pane displays all roles in the system to which the user is not assigned, while the Assigned Roles pane indicates which roles the user is assigned. Use the arrows between the two panes to select or unselect roles from both panes, as needed.

54

. . .


When a role is moved to the Assigned Roles pane, the user’s security parameters can then be further defined by selecting the relevant check box:


Note: A user must belong to Clarity Users role and one other role in order to work in Clarity.

Command DescriptionThe user inherits the role permissions if the ‘Belongs to this role’ checkbox is selected.

Note: If the user is assigned to a role that is disabled, the user will not have the permis-sions granted by that role.Reserved roles such as Clarity Users cannot be disabled.

If the ‘Manage users that belong to the selected roles’ checkbox is selected, the user can administer the users within the selected role.

If the ‘Ability to assign the selected roles to users’ checkbox is selected, the user can assign the role to users.

55


• Set Home Page: Enables an administrator to set the default page to appear when the user logs on to Clarity. The default home page can be set to any available static template, report or menu command via the Set Home Page dialog.

A home page can be set explicitly for a user, or for a particular role:

Note: When setting a home page for a role, the Inherit homepage from... option does not appear.

The page displays a tree view of the menu bar, including all menus and sub-folders.

When setting a home page for a user, menu item selections pertain to the user’s access - only items that the user has access to are displayed. For a role, menu items are only displayed if the role has access to the items. If a menu or subfolder is missing, the user or role does not have access to it.

When assigning a user or role to a home page other than "My Home", the administrator will need to enable the My Home menu item and grant the desired users access to the menu item, so that users can select it from the menu.

56

. . .


Each menu that is selectable has a radio button alongside the menu item. The user’s default page is determined by the selected radio button. For example, if an administrator selected the Administrate Workflow radio button, the specified user would always view the Administrate Workflow page immediately upon logging in.

Select a default page for the user and click OK to save the changes. Clicking Cancel exits the Set Home Page dialog without saving the changes.

When assigning Home Pages to a user or role, there is a chance that the user may have two home pages assigned. To manage any possible conflicts, use the Home Page Manager, which is accessible from the Set Home Page dialog under the roles tab:

Roles TabThe Roles tab displays the list of existing roles to which the current logged in user has access:

Each role record is composed of Role Name and Description. Additionally, each record contains an Enabled check box and Options command icons.

• The Roles column contains the name of the role.

• The Description column is a mandatory field typically used to describe how the role is applied.

57


• The Enabled column contains a check box that determines if the specified role is valid in the system or not.

• The Options column contains command icons that affects the record of the relevant role:

• Delete Role: Deletes the role from the system.

Note: Reserved roles cannot be deleted from the system, and the Deleted icons are therefore grayed-out.

• Edit Role Details: Enables an administrator to modify the parameters associated with the role profile via the Edit Role Details dialog:

Modify the values in the Role Name and Description fields, as needed.

The Enabled check box is used to identify if the specified role is valid in the system or not. Disabled roles do not share their assigned permissions with associated users, and new users cannot be added to them.


58

. . .


Assign User(s) & Role(s): Enables an administrator to associate the role profile with user(s) and/or role(s) via the Assign Users/Roles dialog:

The Available Users and Available Roles panes display all users and roles in the system that a role is not assigned to, while the Assigned Users and Assigned Roles panes indicate which users and roles are associated with the role. Use the navigation arrows between the panes to select or unselect users and roles, as needed.

Administrators can only view the users and roles that they have access to.

Note: The Roles listed in the Assigned Roles pane inherit the permissions of the Role displayed in the title of the dialog. Roles cannot be assigned to the “Clarity Administrators” reserved role.

59


Search TabThe Search tab provides the ability to search the users and roles, to which the current logged in user has access to, based on a text string. All user and role names that match the search criteria are returned in a list:

Select a search criteria value in the drop down list that follows View records that (Contain, Do Not Contain, Starts With, and Ends With) and type a search string into the field that follows the string. When the Search button is clicked, Clarity returns a list of users and roles that match the search criteria:

60

. . .


Add User(s)

The Add User(s) command is used to add user profiles to Clarity via the Add User(s) dialog window:

New users are added to the system by entering information in the fields provided. All fields are mandatory and the Login ID must match the user ID that has been predefined in the OLAP database environment.

Note: The Login ID must contain at least one alpha character and CANNOT contain all spaces, nor any of the following characters: \ / “ ” [ ] | < > + = : ; , ? * @ $

• Click on the roles to associate the new user with roles in the Assign Roles pane. To unselect a role, click on it again.

• To copy permissions from one user to another, select the check box alongside Copy permissions from another User. From the drop down list, Select a User to copy from, and apply to the newly defined user, then select the Hierarchy

61


Security, Roles, and/or Menu Security check boxes to specify which permissions from the specified user will be copied to the new user.

Note: If Copy Permissions from another User is selected, the Assign Roles pane is unavailable.

• Click the Add User(s) command in the panel located on the left-hand side of the page to add an additional user definition to the Add User(s) dialog box. This button can be clicked multiple times to create many users at once.

• Click OK to write the new user definitions to the system, or Cancel to exit the Add User(s) dialog box without creating the new definitions.

62

. . .


Add Role(s)

The Add Role(s) command is used to add roles to Clarity via the Add Role(s) dialog window:

New roles are added to the system by entering information in the fields provided.

Note: The Role Name CANNOT contain all spaces, nor any of the following characters: \ / “ ” [ ] | < > + = : ; , ? * @ $

• Unselect the Enabled check box to disable the role immediately upon creation.

• Click the Delete icon in the Options column to remove the role definition from the dialog window.

• To copy permissions from an existing role to another role, select the check box alongside Copy permissions from. From the drop down list, Select a Role to copy from, and apply to the newly defined role, then select the Hierarchy Security, Roles, and/or Menu Security check boxes to specify which permissions from the specified role will be copied to the new role.

63


• Click the Add Role(s) command in the panel located on the left-hand side of the page to add an additional user definition to the Add User(s) dialog box. This button can be clicked multiple times to create many roles at once.

• Click OK to write the new role definitions to the system, or Cancel to exit the Add Role(s) dialog box without creating the new definitions.

Notes: By default, all new Roles belong to the “Clarity Administrators” reserved role.

64

. . .

. .S E C U R I T Y S E R V I C E SHierarchy Security Profiles

H I E R A R C H Y S E C U R I T Y P R O F I L E S

Security Profiles are used to associate Hierarchy Security to a template or report.

Security Profiles are maintained in Clarity via the Security Profiles menu command. The Security Profiles page displays a list of existing profiles:

Each security profile is composed of Profile Name and Description. Additionally, each profile contains an Enabled check box and Options command icons.

• The Profile Name column contains the name of the security profile.

• The Description column is an optional field typically used to describe how the profile is applied.

• The Enabled column contains a check box that determines if the specified profile is available for setting up Hierarchy Security.

65

S E C U R I T Y S E R V I C E SHierarchy Security Profiles

• The Options column contains command icons that affects the record of the relevant profile:

• Delete Security Profile: Deletes the profile from the system.

Note: The Default security profile cannot be deleted from the system, and the Deleted icon is therefore grayed-out.

• Edit Security Profile: Enables an administrator to modify the parameters associated with the security profile via the Edit Security Profile dialog box:

Modify the values in the Profile Name and Description fields, as needed.

The Enabled check box is used to identify if the specified profile is valid in the system or not.

Click OK to save any changes, or click Cancel to return the Security Profiles page without applying any of the changes.

66

. . .


• Assign User(s) & Role(s): Enables an administrator to associate the security profile with user(s) and role(s) via the Assign Users & Roles to Security Profiles dialog box:

The Available Users and Available Roles panes display all users and roles in the system that the security profile is not assigned to, while the Assigned Users and Assigned Roles panes indicate which users and roles are associated with the security profile. Use the navigation arrows between the panes to select or de-select users and roles, as needed.

Note: Only the users and roles that the current user has access to will be displayed.

67


Add Security Profile(s)

The Add Security Profile(s) command is used to add profiles to Clarity via the Add Security Profile(s) dialog window:

New profiles are added to the system by entering information in the fields provided. The description field is optional and new security profiles are Enabled by default.

• De-select the Enabled check box to disable the profile immediately upon creation.

• Click OK to write the new security profile definitions to the system, or Cancel to exit the Add Security Profile(s) dialog box without creating the new definition.

Select All and Deselect All

The Select All toolbox command is used when applying options to all profiles listed. When this command is used, the singular Options command icons are no longer available and the administrator must use the toolbox commands.

The Deselect All toolbox command removes the selections from the check boxes to the left of the security profiles.

68

. . .


Assign User(s) & Roles(s)

The Assign User(s) & Role(s) toolbox command is used to assign users and roles to one or more security profiles at the same time. Select multiple security profiles by clicking on the check box to the left of the profile name, or click on the Select All toolbox command. The Assign Users & Roles to Security Profiles dialog appears:

The Available Users and Available Roles panes display all users and roles in the system that the security profile is not assigned to, while the Assigned Users and Assigned Roles panes indicate which users and roles are associated with the security profile. Use the navigation arrows between the panes to select or de-select users and roles, as needed.

Note: Only the users and roles that the current user has access to will be displayed.

Delete Security Profiles

The Delete Security Profiles toolbox command is used to delete one or many security profiles at a time. Select multiple security profiles by clicking on the check box to the left of the profile name.

69


70

. . .

. .S E C U R I T Y S E R V I C E SHierarchy Security Configuration

H I E R A R C H Y S E C U R I T Y C O N F I G U R A T I O N

The Hierarchy Security Configuration menu command enables administrators to configure hierarchy security parameters via the Hierarchy Security Configuration page:

Hierarchy Security Tree ControlThe Hierarchy Security Tree Control section of the Hierarchy Security Configuration page allows administrators to specify whether Hierarchy Security will be applied when adding permissions on the Hierarchy Security page. This will allow for the task of adding permissions to be distributed, as each administrator will only be able to add permissions within the section of the cube to which an administrator has access. To enable this feature:

• Select the Yes radio button alongside Enable distributed configuration of Hierarchy Security.

• Use the drop down list to select the security profile that will be applied when adding permissions on the Hierarchy Security page.

71

S E C U R I T Y S E R V I C E SHierarchy Security Configuration

If this menu command is not enabled, any user with access to the Hierarchy Security page will be able to access the entire dimension tree when adding permissions.

Dimension SecurityThe Dimension Security section of the Hierarchy Security Configuration page initially contains a set of server specification fields:

Use the drop down lists to specify an OLAP server, application, and database in order to configure dimensions for hierarchy security. Click on the Retrieve toolbox command to display a list of cube dimensions:

• The Dimension Name column contains the name of the dimension as it appears in the OLAP database.

• The Default Start Member specifies the level within the dimension hierarchy that users can access. For example, if the Default Start Member is set to Office Products Division, for the Office Products Inc. dimension, only the Office Products Division and descendents are available when viewing the dimension in a tree.

Note: The Default Start Member limits the selection of members within a hierarchy. For example, an administrator may want to exclude statistical members or ‘No_xxxxx’ type members, and therefore would not set the start member as the top member of the dimension. If the Default Start Member is not set, the entire dimension is available.

• The selected check boxes in the Hierarchy Security Enabled column indicate which dimensions have hierarchy security permissions applied. By default, all dimensions are Enabled.

72

. . .

. .S E C U R I T Y S E R V I C E SAdministrating Hierarchy Security

A D M I N I S T R A T I N G H I E R A R C H Y S E C U R I T Y

The Hierarchy Security menu command enables an administrator to specify which members, by dimension, users and roles can choose to access via the template or report page options:

Permissions are listed by user or role under the respective tab. Click the check box or check boxes beside the user or role to process multiple deletions at a time, using the toolbox command. The icons in the Options column allow for a singular record to be deleted or edited.

Selection BarThe Selection bar indicates the server, application, database, dimension, and security profile to which the hierarchy security permissions will be applied:

Use the drop down lists to specify a Server, Application, Database, Dimension, and Security Profile as required.

73

S E C U R I T Y S E R V I C E SAdministrating Hierarchy Security

Search BarAdministrators can filter the view of existing hierarchy security permissions by clicking on the alpha characters in the Search Bar, located above the list of users or roles:

• Clicking an alpha character will filter users and roles in the system based on the first letter of the Login ID or Role name. For example, selecting F will filter out all users and roles that do not begin with the letter F.

• Clicking All returns all users and roles in the system on the All tab.

• Search navigates to the Search tab, which enables administrators to filter users and roles based on a text string.

• The Retrieve All On Load check box toggles if the Users & Roles page populates with a full list of users and roles each time the menu command is issued. If the check box is de-selected, the page will open without any users or roles displaying.

Users TabThe Users tab displays a list of existing hierarchy security permissions applied to each user:

Each permission is composed of a User Name, First Name, and Last Name. Additionally, each record contains a Permission(s) column and Options command icons.

• The Login ID, First Name and Last Name fields contain the information as defined when the user was first created.

• The Permission(s) column displays all hierarchy security permissions associated with the user. The permission will be in the form of a single-member, descendants or children of a member, including the parent member, or bottom level descendants.

• The Options column contains command icons that affects the record of the relevant permission:

74

. . .


• Delete Permission: Deletes the permission from the system.

Note: The permissions for the user profile defined during the Clarity Server installation cannot be deleted in the system, and is therefore grayed-out.

•Edit Permission: Enables an administrator to modify the parameters associated with the permission via the Edit Permission dialog box:

In the Select a Member field, click the ellipsis button and select a new member from the specified dimension to change it.

In the Select a Specification field, use the drop down list to specify the retrieval command that determines what members the permission affects. Choose Single Member, Descendants, iDescendants, Children, iChildren, or Bottom Level Descendants.


Roles TabThe Roles tab displays a list of existing hierarchy security permissions applied to each role:

Each permission is composed of a Role Name and Description. Additionally, each record contains a Permission(s) column and Options command icons.

• The Role Name column contains the role name as defined when the role was first created.

• The Description column contains the description of the role as defined when the role was first created.

75


• The Permission(s) column displays all hierarchy security permissions associated with the role. The permission will be in the form of a single-member, descendents or children of a member, including or excluding the parent member, or bottom level descendents.

• The Options column contains command icons that affects the record of the relevant permission:

• Delete Permission: Deletes the permission from the system.

Note: The permissions for the user profile defined during the Clarity Server installation cannot be deleted in the system, and is therefore grayed-out.

• Edit Permission: Enables an administrator to modify the parameters associated with the permission via the Edit Permission dialog box:

In the Select a Member field, click the ellipsis button and select a new member from the specified dimension to change it.

In the Select a Specification field, use the drop down list to specify the retrieval command that determines what members the permission affects. Choose Single Member, Descendants, iDescendants, Children, iChildren, or Bottom Level Descendants.


76

. . .


All TabThe All tab provides the ability to search the users and roles in the system based on a text string. All user and role names that match the search criteria are returned in a list:

Select a search criteria value in the drop down list that follows View records that (Contain, Do Not Contain, Starts With, and Ends With) and type a search string into the field that follows the string. When the Search button is clicked, a list of users and roles is returned that match the search criteria:

77


The panel on the left-hand side of the page contains all Hierarchy Security commands:

Select AllSelects all check boxes (including user/role check boxes and individual permission check boxes) in the display view. Use when applying changes to multiple entries and/or permissions.

Deselect AllDe-selects all check boxes (including user/role check boxes and individual permission check boxes) in the display view.

Delete Permission(s)Deletes the selected permission(s) from the system.

78

. . .


Create Permission(s)Enables administrators to create new permission definitions via the Create Permission(s) page:

The Dimension panel displays a tree view of the dimension hierarchy selected from the drop down list on the main page. An administrator chooses a member and clicks the navigation arrow. The member name and a Specification displays in the columns on the right-hand side of the page:

• The Member column displays the name of the selected member.

• The Specification column defines the permission for members that will be affected within the dimension hierarchy. Use the drop down list to select Single Member, Descendants, iDescendants, Children, iChildren, or Bottom Level Descendants.

79


• The Options column contains the Delete icon. Click the icon to remove the permission from the page.

Multiple permissions can be added by selecting another member from the tree view and clicking the navigation arrow again. Another member hierarchy specification definition displays:

The Users and Roles panes are used to select the users and roles to be applied to the permission(s). Use the Shift or Control keys to select multiple users or roles at the same time:

Click on the Add Permission(s) toolbox command to add to the permission list:

Expand the user and role lists to view all hierarchy member permissions associated with the user or role. To delete a definition, click the Delete icon located in the Options column of the list.

Click OK in the toolbox panel located on the left-hand side of the page to write the permissions to the system. Click Cancel to exit the page without writing any of the hierarchy security permissions to the system.

80

. . .

. .S E C U R I T Y S E R V I C E SMenu Administration

M E N U A D M I N I S T R A T I O N

The Menu Administration command enables an administrator to add new menus and menu commands to the web interface, as well as modify the properties of existing web interface menus, sub-folders, and menu commands. Specifically, an administrator can designate the names of menus, the names of commands and sub-folders, and select icon graphics.

Additionally, the Menu Administration command sets menu and menu command permissions for users and roles in the system:

The tree view displays all menus, submenus, and menu commands in the system (including the menu commands that launch templates and reports) that the administrator has access to. Expand the tree view as required, and click the check box or check boxes beside the menus, menu folders, and commands to which the user and/or role permissions apply:

• The Menu Item column contains the name of the folder, command, or file, as indicated by the icon beside the name of the menu item.

81

S E C U R I T Y S E R V I C E SMenu Administration

• The Options column contains command icons that affect the record of the relevant menu item:

• Delete Menu Item: Deletes the menu item from the system.

Note: The My Templates and My Reports menu folders cannot be deleted, and therefore the Delete Menu Item icons are grayed-out and disabled.

82

. . .


• Edit Menu Item: Enables an administrator to modify the properties of the menu item (file or folder) via the Edit Menu Item dialog box:

Note: Folders contain less menu property fields, as some properties (such as Windows Action) are not applicable to the functionality. See Add Menu Item for Folder.

• Menu ID is an automatically generated system ID.

• Document Type indicates the type of file that will execute when this menu item is selected. Select Clarity Document, Reporting Services Document, Visualizer Document, Website or Other, as appropriate.

83


Note: A Clarity Document is a template or report created with Clarity Template Builder (.XML). A Visualizer Document is a report created with Clarity Visualizer. Website is used to display a report that is directly available through a website URL. Use Reporting Services Documents to display Microsoft Reporting Service reports within Clarity. Other represents any other type of file attached to a menu item.

• Caption defines the text that displays for the Menu or Menu Item. For example, enter Budget Templates into the Caption field when creating a sub-folder named Budget Templates. The Enter Country/Regional Caption icon allows an administrator to define the language displayed for the menu or menu item.

• Parent Folder indicates where the menu item will be located in the web interface. Click on the ellipsis button to browse to a parent folder for selection. For example, a menu item that opens a template named Budget would have a parent folder of My Templates and display as a command in the My Templates menu.

• Enabled defines whether the command will display on the menu or not in the web interface. True indicates that the command is enabled, while False indicates that the command disabled.

• Window Action defines if users will be able to open this page in multiple windows or not. Select Single to restrict this command to a single page, Multiple to enable multiple instances of this command to exist in the web interface at the same time, or Prompt to warn users when an instance already exists in the web browser.

• Document Location, URL or Report URL indicates the location of the file that launches when the user selects the command. The name for this field will vary, dependent upon the document type selected.

• Image defines the folder path and file name of the image to be used for the icon of the menu item. For example: images/document.gif.

• Toolbar Location (optional) defines the folder path and name of the .xml file for the menu item. For Clarity documents, the template.xml file is used.

Note: When defining the location path, ensure that forward slashes (/) only are used in the syntax.

• Tool Tip defines the text that is displayed when the mouse pointer hovers over a menu item in the web interface. The Enter Country/Regional Tooltips icon allows an administrator to define the language displayed when a user drags the mouse over the menu item.

• Position Value of Menu Item indicates where in the menu tree the command will display. Specify a numeric value, where 0 will place the command at the top of

84

. . .


the menu drop down list. For example, if two menu items are created, and assigned a value of 9 for one, and 54 for the other, the item with the value of 9 will appear first in the menu list. If a third menu item is created and assigned a value of 3, it would appear in the menu above the other two commands.

Note: Folders and sub-folders will always appear first as menu items for folders and files are sorted independently.

Click OK to write the menu item definition to the system or click Cancel to exit the Edit Menu Item page without applying any changes.

• Assign Users & Roles: Enables an administrator to assign users and/or roles access permissions for the selected menu item via the Assign Users & Roles dialog window:

Use the navigation arrows located between the Available Users/Available Roles panes and Assigned Users/Assigned Roles panes to move existing users and roles from the available panes to the assigned panes. The users and roles in the assigned panes have access to the folders or menu commands selected in the Menu Administration page.

85


Note: If permissions are assigned to a folder, the menu items below this folder do not inherit the permissions of the folder. If permissions are assigned to a sub-folder or menu item, then the permissions are applied to all folders above the sub-folder or menu item. Security should therefore be added at the lowest level.

Click OK to save your changes in the system. All users and roles in the Assigned panes can now access the specified menus and/or menu commands. Click Cancel to return to the Menu Administration page without applying any changes.

The panel on the left-hand side of the page contains all Menu Administration commands:

86

. . .


Add Menu Item

The Add Menu Item command adds a new menu item to the folder tree view of the Menu Administration page via the Add Menu Item dialog window:

Add File:

• File/Folder defines the menu item as a menu command or folder. To define the menu item as a command, select File.

• Document Type indicates the type of file that will execute when this menu item is selected. Select Clarity Document, Visualizer Document, Reporting Services, Website or Other, as appropriate.

Note: A Clarity Document is a template or report created with Clarity Template Builder (.XML). A Visualizer Document is a report created with Clarity Visualizer. Website is used to display a report that is directly available through a website URL. Use Reporting Services Documents to display Microsoft Reporting Service reports within Clarity. Other represents any other type of file attached to a menu item.

87


• Caption defines the text that displays for the Menu or Menu Item. For example, enter Budget Templates into the Caption field when creating a sub-folder named Budget Templates. The Enter Country/Regional Caption icon allows an administrator to define the language displayed for the menu or menu item.

• Parent Folder indicates where the menu item will be located in the web interface. Click on the ellipsis button to browse to a parent folder for selection. For example, a menu item that opens a template named Budget would have a parent folder of My Templates and display as a command in the My Templates menu.

• Enabled defines whether the command will display on the menu or not in the web interface. True indicates that the command is enabled, while False indicates that the command disabled.

• Window Action defines if users will be able to open this page in multiple windows or not. Select Single to restrict this command to a single page, Multiple to enable multiple instances of this command to exist in the web interface at the same time, or Prompt to warn users when an instance already exists in the web browser.

• Document Location indicates the location of the file that launches when the user selects the command, if applicable.


• Toolbox Location (optional) defines the folder path and name of the .xml file for the menu item. For Clarity documents, the template .xml is used.

Note: When defining the location path, ensure that forward slashes (/) only are used in the syntax.

• Tool Tip defines the text that is displayed when the mouse pointer hovers over a menu item in the web interface. The Enter Country/Regional Tooltips icon allows an administrator to define the language displayed when a user drags the mouse over the menu item.

• Position of Value of Menu Item indicates where in the menu tree the command will display. Specify a positive numeric value, where 0 will place the command at the top of the menu drop down list. For example, if two menu items are created, and assigned a value of 30 for one, and 50 for the other, the item with the value of 9 will appear first in the menu list. If a third menu item is created and assigned a value of 10, it would appear in the menu above the other two commands.

Note: Folders will always appear first as menu items for folders and files are sorted independently.

88

. . .


• Click OK to write the menu item definition to the system or click Cancel to exit the Edit Menu Item page without applying any changes.

Add Folder:

• File/Folder defines the menu item as a menu command or folder. To define the menu item as a folder, select Folder.

• Parent Folder indicates where the sub-folder will be located in the web interface. Click on the ellipsis button to browse to a parent folder for selection.

• Caption defines the text that displays for the sub-folder. For example, enter Budget Templates into the Caption field when creating a sub-folder named Budget Templates.

• Dynamic Build indicates whether the items below this folder will be dynamically built at run-time using the contents of the specified folder. If set to True, the security defined for the folder is applied to all dynamically created menu items below this folder. If set to False, the menu becomes static, menu items must be explicitly defined and security permissions must be set per menu item.

Note: Templates/Reports within a Dynamic Build folder cannot be used with Report Books.

• Enabled defines whether the sub-folder will display on the menu or not in the web interface. True indicates that the sub-folder is enabled, while False indicates that the sub-folder is disabled.


• Position Value of Menu Item indicates where in the menu tree the sub-folder will display.

89


Note: Folders and sub-folders will always appear first as menu items for folders and files are sorted independently.

• Click OK to write the menu item definition to the system or click Cancel to exit the Edit Menu Item page without applying any changes.

Menu Import

The Menu Import command enables an administrator to upload file(s) to the menu command tree from files existing in a folder on the Web Server. All files specified will be added to the Clarity menu:

Note: Before using Menu Import, ensure that the folder already exists as this command will not create the Parent Folder. Use Add New Menu Item to create the parent folder or create a parent folder manually on the Web Server.

• Specify a Parent Folder where the new menu objects will be added by clicking the ellipsis button and selecting a folder from the list provided:

Click OK to populate the Parent Folder field with the selection.

90

. . .


• The Folder to Import field specifies the folder that contains the files to be added to the parent folder. Specify the files to add by clicking the ellipsis button and selecting a folder from the list provided:

Use the Current folder window to select the folder that contains the files that are required to populate the menu with and click OK.

91


• In the Files to Load drop down list, select either All Files to load all files contained in the specified folder, or Clarity Documents to load template and report files, created with Clarity Template Builder, to appear in the menu.

• Click Import to add the specified files to the Clarity menu bar. Security permissions must then be assigned for the appropriate users and roles for these new menu commands to appear on client machines.

92

. . .


Upload Manager

The Upload Manager command enables an administrator to upload a file to the menu command tree, that is located in a local or network folder, to the Web folder of the Clarity Web Server:

Note: The maximum file size for upload to the Web folder is 5Mb.

93


• Specify a Source where the new menu objects currently reside by clicking the Browse button and selecting a folder from the list provided:

Click OK to populate the Source field with the selection.

• The Destination field specifies what folder in the Web folder the file will be uploaded into. Click the Browse button and select a folder from the list provided:

Use the Current folder window to select a folder where the uploaded file will be placed and click OK.

94

. . .


Additionally, the Upload Manager page contains a number of commands in the panel located on the left-hand side of the page:

• Click Add File(s) to Upload command to add multiple instances of the Source and Destination fields. This command enables you to upload multiple files at once via Upload Manager.

• Click Create Folder command to create a folder within the Web folder structure. The Create Folder dialog box displays:

Specify the parent folder for the new folder in the Select Parent Folder field by clicking the Browse button, to open the Web folder view, and selecting a folder from the list provided.

Type the name of the new folder in the Folder Name field, and then click the Create button to add the folder to the Web folder. Click the Close button to return to the File Upload Manager dialog box.

• Click Upload File(s) command to upload all specified files in the Upload Manager page to the folder(s) specified in the Web folder of the Web server.

95


• Click Close to exit Upload Manager. Any file specifications currently defined will not be uploaded to the Web Server.

Expand/Collapse Menus

The Expand/Collapse Menus command expands all nodes in the folder tree view in the Menu Administration page, or collapses all nodes in the folder tree view, respectively. If a folder or sub-folder node has been expanded manually, Expand/Collapse Menus toggles the selections ‘as is’.

Refresh Main Menu

The Refresh Main Menu command refreshes the menu items on the main Menu bar and remains on the Menu Administration page. Use this command when changes to the view have been made by adding or deleting folders/commands.

Select All and Deselect All

The Select All and Deselect All commands select and deselect all folders and menu commands in the folder tree view of the Menu Administration page, respectively. The Select All command allows for all menu items to be assigned user(s) and/role(s).

Assign User(s) & Role(s)

The Assign User(s) & Role(s) command is used to apply user and/or role access rights to multiple menu items at a time.

96

. . .


Use the check boxes alongside each menu item listed in the folder tree view and issue the command. The Assign User(s) & Role(s) dialog window displays:

Use the navigation arrows located between the Available Users/Available Roles panes and Assigned Users/Assigned Roles panes to move existing users and roles from the available panes to the assigned panes. The users and roles in the assigned panes have access to the folders or menu commands selected in the Menu Administration page.

Note: If permissions are assigned to a folder, the menu items below this folder do not inherit the permissions of the folder. If permissions are assigned to a sub-folder or menu item, then the permissions are applied to all folders above the sub-folder or menu item. Security should therefore be added at the lowest level.

• Click OK to save your changes in the system. All users and roles in the Assigned panes can now access the specified menus and/or menu commands. Click Cancel to return to the Menu Administration page without applying any changes.

97


Delete Menu Items

The Delete Menu Items command removes all selected menus items from the folder tree view of the Menu Administration page.

Select the folders and commands you want to remove, and click Delete Menu Items. The items no longer appear in the Clarity menu bar once the Refresh Main Menu command has been executed.

Note: You cannot delete the My Templates or My Reports folder using this command.

98

. . .


Secur i ty Serv ices XML Conf igurat ionThe following attributes in the XML file ...\ClarityServer\Web\config.xml control aspects of security:

<hierarchysecurityoptions> <defaultpermission>Write</defaultpermission> <securityprofile>Default</securityprofile> <hidepermission>True</hidepermission> <hideRoles>False</hideRoles> <hideUsers>False</hideUsers> <autoload>true</autoload>

</hierarchysecurityoptions> <hierarchysecurity displaynameorlias=“name” allowedit= “false”>

<server provider=“Essbase” name=“localhost”> <application name=“Clarity”>

<database name=“Demo61”> <dimension name=“Office Products Inc”/>

</database> </application>

</server> </hierarchysecurity> <UserrolesOptions>

<autoload>true</autoload> </UserrolesOptions> <ProfileTools>

<CopyTool> <OLAP display=“show” OLAPOptions=“show” ProfileOptions=“show”>

<defaultdestinationprofileText>defaultdestionationprofileText From Config.xml</defaultdestinationprofileText> <defaultserver></defaultserver> <defaultapplication></defaultapplication> <defaultdatabase></defaultdatabase> <defaultdimension></defaultdimension> <defaultsourceprofile></defaultsourceprofile>

<defaultdestinationprofile></defaultdestinationprofile> </OLAP>

</CopyTools> </ProfileTools>

...

<globalmenulist menutype=“advanced”/> <templatesecurity enabled=“true”/> <autologincredentials validateuser=“olap” generatessotoken=“false” source=“loginpage”>

<provider>Essbase</provider> <server>localhost</server> <userid>clarity_admin</userid> <password>clarity</password> <application></application> <database></database>

<ssotokenwebservice>http://localhost/ClarityWebService/SingleSignOnService.asmx</ssotokenwebservice> </autologincredentials>

Node Attribute DescriptionPossible Values Example

<defaultper-mission>

N/A - not currently used. Write <defaultpermis-sion>Write</default-permission>

<securitypro-file>

The name of the default security profile. Default <securitypro-file>Default</securi-typrofile>

<hidepermis-sion>

N/A - not currently used.The default value should always be set to true.

TrueFalse

<hidepermis-sion>True</hidepermis-sion>

99


<hideRoles> Indicates if all roles are hidden on the Cre-ate Permissions screen in the web inter-face or not.

TrueFalse

<hide-Roles>False</hide-Roles>

<hideUsers> Indicates if all users are hidden on the Cre-ate Permissions screen in the web inter-face or not.

TrueFalse

<hideUs-ers>False</hideUsers>

<autoload> Autoloads all hierarchy security permis-sions when the screen is opened in the web interface.

truefalse

<autoload>true</auto-load>

<hierarchyse-curity>

displayname-oralias

Indicates if members are displayed by name or alias on the Hierarchy Security screen. Enter a value of name if members are to be displayed by member name in the web interface, or alias if members are to be displayed by member alias.

namealias

displaynameora-lias=“name”

allowedit Indicates if edit is allowed. truefalse

allowedit= “false”

<server> provider The type of OLAP Database Server to which hierarchy security applies. Enter Essbase for Essbase/DB2 OLAP plat-forms, or MSAS for Microsoft Analysis Services platforms.

EssbaseMSAS

server provider=“Ess-base”

name The name of the OLAP Database Server to which hierarchy security applies.

localhost name=“localhost”

<application> name The name of the application to which hier-archy security applies.

Clarity <application name=“Clarity”> <database name=“Demo61”>

<database> name The name of the database to which hierar-chy security applies.

Demo <database name=“Demo61”>

<dimension> name The name of the dimension to which hierar-chy security applies.

Account <dimension name=“Office Products Inc”/>

<OLAP> display Indicates if drop down items are shown, hidden, or read only in the OLAP Path menu. The value can be show, hide, or rea-donly, respectively.

showhidereadonly

<OLAP display=“show”

OLAPOptions Indicates if drop down items are shown, hidden, or read only in the OLAP Options menu. The value can be show, hide, or rea-donly, respectively.

showhidereadonly

OLAPOptions=“show”

ProfileOptions Indicates if drop down items are shown, hidden, or read only in the Profile Options menu. The value can be show, hide, or rea-donly, respectively.

showhidereadonly

ProfileOptions=“show”

<defaultdesti-nationprofile-Text>

The value of the label above the destination profile drop down menu.

<defaultdestination-profileText>default-destionationprofileText From Con-fig.xml</defaultdesti-nationprofileText>

<defaultsour-ceprofile-Text>

The value of the label above the source pro-file drop down menu.

<defaultsourcepro-file></defaultsour-ceprofile>


100

. . .


<default-server>

The name of the OLAP Database Server that appears by default in the web interface. Leave this value blank to keep the server name default non-specific.

<default-server></default-server>

<defaultappli-cation>

The application of the OLAP Database Server that appears by default in the web interface. Leave this value blank to keep the application name default non-specific.

<defaultapplica-tion></defaultapplica-tion>

<defaultdata-base>

The database of the OLAP Database Server that appears by default in the web interface. Leave this value blank to keep the database name default non-specific.

<defaultdata-base></defaultdata-base>

<defaultdi-mension>

The dimension of the OLAP Database Server that appears by default in the web interface. Leave this value blank to keep the dimension name default non-specific.

<defaultdimen-sion></defaultdimen-sion>

<defaultsour-ceprofile>

The source profile that appears by default in the web interface. Leave this value blank to keep the profile default non-specific.

<defaultsourcepro-file></defaultsour-ceprofile>

<defaultdesti-nationpro-file>

The destination profile that appears by default in the web interface. Leave this value blank to keep the profile default non-specific.

<defaultdestination-profile></defaultdes-tinationprofile>

<templatese-curity>

enabled Indicates if template security is enabled or disabled in Clarity. Enter a value of enabled or disabled as the attribute value, respectively.

enableddisabled

<templatesecurity enabled=“true”/>

<autologin-credentials>

validateuser Indicates if it checks login credentials against OLAP server.

olapnone

autologincredentials validateuser=“olap”

generatessoto-ken

Indicates if it generates SSO token. truefalse

generatessoto-ken=“false”

source Indicates the source of the login credien-tials.

loginpagewindowsheader

source=“loginpage”

<ssotoken-webservice>

The address of the SSO Token web service. http://.../Clarit-yWebServ-ice/SingleSignOnServ-ice.asmx

ssotokenwebser-vice>http://local-host/ClarityWebService/SingleSignOnSer-vice.asmx</ssotoken-webservice>


101


Vir tual D i rectory XML Conf igurat ionThe following attributes in the XML file ...\ClarityServer\Web\config.xml control aspects of Clarity:

<virtualdirectories>

<virtualdirectory name="Templates"/> - (Directory Name)

<virtualdirectory name="Reports"/> - (Directory Name)

</virtualdirectories>


<virtualdi-rectories>

<virtualdirectory name>

Indicates the name of one or more virtual directories in use.

Any name <virtualdirectory name="Templates_1"/>

<virtualdirectory name="Templates_2"/>

102

The Clarity Workflow Administration feature allows administrators to define levels of approval for validating and submitting budget, forecast and plan data.

Administrators can assign owners, approvers and watchers to entities in the workflow chain.

Workflow provides a controlled and accurate environment for tracking the status changes across the input process.

This section contains the following:

• Workflow XML Configuration

• Administrating Workflow

Workflow 7

103

WO R K F L O W

104

. . .

. .W O R K F L O WWorkflow XML Configuration

W O R K F L O W X M L C O N F I G U R A T I O N

The file used to configure Workflow is called workflow.xml. Workflow features are defined by attributes set in the XML file.

In both the Essbase/DB2 OLAP or MSAS environments, the XML file resides in the ...\Clarity Systems\ClarityServer\Web folder on the Web Server.

Note: The Workflow XML configuration examples shown in the following tables are for Essbase/DB2 OLAP.

105

WO R K F L O WWorkflow XML Configuration

Def ine Global Set t ingsThe following section of the workflow.xml file defines the global settings for workflow:

<workflow createemail=“true” displaynameoralias=“Alias” applyworkflowtocellnotes=“true” applyworkflowtotemplatenotes=“true” numberofentities=“50” paging=“entity count”>

The attributes that control how workflow is displayed are:

The attributes that control workflow functionality are:


<workflow> displayname-oralias

Indicates if Workflow entities (OLAP members) are displayed by member name or alias in the web interface. A value of Alias indicates that the enti-ties will be displayed by member alias. A value of Name indicates that entities are displayed by member name.

NameAlias

displayname-oralias=“Alias”

numberofentities Indicates the maximum number of workflow enti-ties per page.

50 numberofenti-ties=“50”

paging Controls how the page links are displayed in the Workflow Page, for Manage Workflow or Work-flow Administration features:

entitycount - the page links group the entities into numeric ranges (ex. 1-50 51-100), based on the numberofentities attribute and the number of entities returned.

pagecount - the page links group the entities into pages (ex. Page 1 Page 2), based on the numbero-fentities attribute and the number of entities returned.

entitycountpagecount

paging=“entitycount”


<workflow> createemail Indicates if Clarity will create notification email when Workflow is submitted, approved, or other-wise modified. A value of true indicates that email notifications will be issued, while a value of false indicates that emails are disabled.

truefalse

createemail= “true”

applyworkflowto-cellnotes

A value of true indicates that template cell notes are subject to the workflow feature. A value of false indicates that cell notes are not considered in the submittal and approval process.

truefalse

applyworkflow-tocell-notes=“true”

applyworkflowto-templatenotes

A value of true indicates that template notes are subject to the workflow feature. A value of false indicates that template notes are not considered in the submittal and approval process.

truefalse

applyworkflow-totemplaten-otes=“true”

106

. . .

.W O R K F L O WWorkflow XML Configuration

.

Def ine Scenar iosCreate a <scenario> node for each unique combination of OLAP server, application and database that requires workflow configuration. For each scenario, set appropriate values for the attributes. For example:

<scenario enabled="true" alias="qcs610_u" provider="Essbase" server="pdgessbase7x" application="qcs610_u" database="clarity" userrole="Clarity Workflow Users" allowapprover="next" sendcollectiveemail="false" sendemailperentity="false" statusreset="single" statusapprover="" usecomplianceform="false">

</scenario>

Note: The <scenario> node is a unique combination of OLAP server, application and database. Using the same server, application and database names across multiple workflow scenarios is not supported.

The attributes that define which OLAP database the scenario uses are:

The attribute to define which user(s) will be using the scenario is:

Node Attribute Description Possible Values Example<scenario> provider The type of OLAP database. Enter Essbase for

Essbase/DB2 OLAP platforms, Analysis Serv-ices 2K for MSAS 2000, or Analysis Services 2K5 for MSAS 2005.

EssbaseAnalysis Services 2KAnalysis Services 2K5

provider=“Essbase”

server The name of the server that hosts the OLAP database environment.

server= “localhost”

application The name of the Essbase application or MSAS database.

application= “clar-ity”

database The name of the Essbase database or MSAS cube.

database= “demo61”

Node Attribute Description Possible Values Example<scenario> userrole Indicates the name of the Security Services role

to which users must belong, so workflow entities can be assigned to them (as owners, approvers and /or watchers).

Note: Only users explicitly added to this role appear in Workflow Administration.

Clarity Workflow Users

userrole=“Clarity Workflow Users”

107


To define behavior of approvers in the scenario:

Node Attribute Description Possible Values Example<scenario> allowapprover current - When a user loads a template in Clar-

ity, if the template uses workflow and the user is one of the approvers for the page options selected and workflow has been submitted, then only allow user to edit data if he is next person in the workflow chain that needs to take action.all - Allow all approvers to make changes to a template whether or not workflow is submitted.next - Allow next level and above approvers to make changes after workflow is submitted.none - Allow no approvers to make changes after workflow is submitted.

currentallnextnone

allowapprover= “all”

statusreset Define behaviour of approvers for the scenario:

single - When an approver rejects, only the pre-vious approver's status is reset. Exception: If multiple approvers before this user had been skipped then they will all be reset.all (or blank) - When an approver rejects, all users' statuses (owner and approvers) below the user will be reset.

singleall(blank)

statusreset= “single”

statusapprover any - Upper level approvers are allowed to skip lower level approvers.(blank) - No skipping is allowed

any(blank)

statusapprover=“”

108

. . .


To define email behavior for the scenario:

Configure the following attributes to define if compliance forms will be used, and which one(s) to use:

Node Attribute Description Possible Values Example<scenario> sendcollectivee-

mailDetermines if the approver will receive a notifi-cation email once all the entities he/she is responsible for have been submitted or approved.

The same is true when approval chains are in place - the top approver will not receive an email until the other approvers have submitted for that entity.

If true, Clarity will only send an email to next level when all entities for that approver have been submitted or approved, and will also disa-ble Send Email checkbox on the Manage work-flow page in Clarity. If false, no emails are sent.

Note: sendcollectiveemail and sendemailperen-tity are mutually exclusive. If one is set to true, the other must be set to false.

See “Sample Scenario of Collective Email Noti-fication” on page 127 for more information.

truefalse

sendcollectivee-mail= “true”

sendemailperen-tity

Determines if a notification email is sent to all users for every status change for a workflow item.

A value of true indicates that Clarity issues indi-vidual emails per entity. A value of false indi-cates that Clarity does not.

Note: sendcollectiveemail and sendemailperen-tity are mutually exclusive. If one is set to true, the other must be set to false.

truefalse

sendemailperen-tity= “false”

Node Attribute Description Possible Values Example<scenario> usecompliance-

formIndicates if compliance forms are used with the workflow feature. A value of true indicates that compliance forms appear whenever an end user attempts to submit or approve workflow. A value of false indicates that compliance forms are disa-bled.

truefalse

usecompliance-form=“false”

ownercompli-anceform

Indicates the system name of the compliance form used when an owner submits workflow.

wfcompliance ownercompliance-form= “wfcompli-ance”

approvercompli-anceform

Indicates the system name of the compliance form used when an approver approves or rejects a workflow submission.

wfcompliance approvercompli-anceform= “wfcom-pliance”

109


Note: Form details are stored in relational tables and currently there is no interface to set them up.

Workf low Administrat ion Conf igurat ionFor each scenario, perform the following tasks:

1. Create a <module> node for Workflow Administration:

<module name=“workflowadministration” sort=“true”> <pages>

... </pages>

</module>

2.

3. Define which combination of dimensions correspond to a “Workflow Entity”. Each workflow entity will later be assigned a workflow chain (an owner, approver(s), and optionally a watcher) via the Workflow Administration page.

Within the <pages> node in the “workflowadministration” section of workflow.xml, create a <page> node for each of the dimensions that define the workflow entity. This node will identify the dimension, which members from the dimension will be used to create workflow entities, and whether the Administrator will have the option of filtering the entity list on the Workflow Administration page.

Each dimension can be defined as one of the following:

a) A Tree, where the user can select a member or use all members. Specify bottomonly, display (name or alias), spec (the startmember), caption, filter(=true), and alternate spec.

<page show="true" view="tree" bottomonly="true" displaynamealiasoption="alias" filter="true">

<name><![CDATA[Office Products Inc]]></name>


<module> name The system name of the Workflow Administration fea-ture.

workflowadmin-istration

name=“workflow-administration”

sort Defines if entities displayed on the Workflow Adminis-tration page are sorted alphanumerically or not.

A value of true will sort alphabetically (by concatenation of dimension member aliases, in the order they are listed in the <page> nodes).

A value of false will provide an unsorted list of members, in the order returned by the specifications for each config-ured dimension.

Pages listed here are used to generate workflow entities.

truefalse

sort=“true”

110

. . .


<caption><![CDATA[Division(s)]]></caption>

<spec><![CDATA["All Companies - Operating Divisions"]]></spec>

<alternatespec><![CDATA[<LINK (<DIMBOT ("Office Products Inc") AND <DESC

("All Companies - Operating Divisions"))]]></alternatespec>

<selected><![CDATA[]]></selected>

</page>

b) A List, where the user must select a member. Specify the display (name or alias), caption, spec, filter(=true).

<page show="true" view="list" displaynamealiasoption="name" filter="true">

<name><![CDATA[Scenario]]></name>

<caption><![CDATA[Scenario]]></caption>

<spec><![CDATA[<CHILD "Planning Scenarios"]]></spec>


</page>

c) A Hidden Page defining a list of members that will always be used. Specify spec, filter(=false), view(=list).

<page show="true" view="list" displaynamealiasoption="name" filter="false">



<spec><![CDATA[<CHILD "Planning Scenarios"]]></spec>


</page>

Node Attribute Description Possible Values Example<pages> displaynamealia-

soptionIndicates if Workflow entities (OLAP members) are displayed by member name or alias in the web interface. A value of alias indicates that the entities are displayed by member alias. A value of name indicates that entities aredis-played by member name.

namealias

displaynamealia-soption=“Alias”

111


<page> show Indicates if the page option selection appears in the dialog when a user opens the Workflow Administration page or not.

truefalse

show=“true”

view A page selection field attribute. Indicates the page option selection type. A value of tree indicates that users select the page option via a tree view menu, while a value of list indicates that users select a page option via a drop down list.

treelist

view=“tree”

bottomonly A page selection field attribute. Specifies if only the bottom level members can be selected via the field’s tree view or drop down menu. A value of true indicates that only the bottom level members of the specified dimension will be dis-played, while a value of false indicates that all members will be displayed, regardless of where they sit in the dimen-sion hierarchy.

truefalse

bottomonly= “true”

displaynamealia-soption

Indicates if Workflow entities (OLAP members) are displayed by member name or alias in the entity selection dia-log for the Workflow page.

A value of alias indicates that the entities are displayed by member alias. A value of name indicates that entities aredis-played by member name.

namealias


filter true - Will show this page option on the Select Options dialog to make a filter available to the user.false - Will not show this page option on the Select Options dialog. Will just use the script provided in the <spec> tag to generate the workflow entities.

truefalse

filter=“true”

<name> A page selection field attribute. Indicates the name of the dimension that the field selection members belong.

<![CDATA[...]]> <![CDATA[Office Products Inc]]>

<caption> A page selection field attribute. The text that appears in the corresponding field selection of the Workflow Administra-tion page selection dialog.

<![CDATA[...]]> <![CDATA[Cost Centers]]>

<spec> A page selection field attribute. Indicates the query made to the OLAP database that retrieves the member selections of the specified dimension. Enter a valid report script or MDX statement specific to the dimension as indicated in the <name> attribute.

Note: When view is set to tree, enter a top level member for this attribute.

<![CDATA[...]]> <![CDATA[Get-FromPageSecurity “Default”]]>


112

. . .


<alternatespec> The spec/mdx script that will be used when you check the No Filter Checkbox, and view is set to tree.

<![CDATA[...]]> <![CDATA[]]>

<selected> Used for backend processes only. Users are not to fill this in.

<![CDATA[]]> <![CDATA[]]>


113


Manage Workf low Conf igurat ionThis section in the workflow.xml file defines Manage Workflow:

<module name=“manageworkflow”> <pages>

... </pages>

</module>

For each scenario, perform the following tasks:

1. Create a <module> node for Manage Workflow.

2. Define which additional dimensions will be used to subdivide the workflow entity. (Ex. Workflow entity of "The SupplyDepot || Base Plan" may be subdivided by year.) The same workflow chain would apply to this entity for each year, but each year may have a different workflow status at any given time.

When using the Manage Workflow page, the user will need to select a member from each additional dimension to filter the list, as each entity will only appear once in the list. In addition, any dimensions that make up the workflow entity can be added to the Manage Workflow section in the workflow.xml file to provide further filtering.

3. Within the <pages> node under the "manageworkflow" section of workflow.xml, create a <page> node for each additional dimension. Also create a <page> node for each workflow entity dimension that can be used to filter this page. (Workflow entity dimensions that will not be filtered do not need to be defined in this section.)

Each dimension can be defined as one of the following:

a) A Tree where user must select a member. Specify bottomonly, display (name or alias), spec (the startmember), caption.

<page show="true" view="tree" bottomonly="true"displaynamealiasoption="alias">


<caption><![CDATA[Division(s)]]></caption>

<spec><![CDATA["All Companies - Operating Divisions"]]></spec>


</page>

b) A List where user must select a member. Specify display (name or alias), caption, and spec.

<page show="true" view="list" displaynamealiasoption="name">

<name><![CDATA[Year]]></name>

Node Attribute Description Possible Values Example<module> name The system name of the Manage Workflow

feature.manageworkflow name=“manage-

workflow”

114

. . .


<caption><![CDATA[Year]]></caption>

<spec><![CDATA[<CHILD "Planning Years"]]></spec>


</page>

c) A Hidden Page defining a single member that will always be used. Specify spec, and show(=false).

<page show="false" view="list" displaynamealiasoption="name">



<spec><![CDATA[&CurrYear]]></spec>


</page>

Node Attribute Description Possible Values Example<page> show A page selection field attribute. Indicates if

the page selection definition is displayed in the page option dialog that appears when a user opens the Manage Workflow page. A value of true indicates that the page selec-tion appears in the dialog, while a value of false indicates the page selection is ‘hidden’ from the end user. Note: At least one of the pages must be set to true.

truefalse

show=“true”

view A page selection field attribute. Indicates the page option selection type. A value of tree indicates that users select a page option via a tree view menu, while a value of list indicates that users select a page option via a drop down list.

treelist

view=“list”

bottomonly A page selection field attribute. Specifies if only the bottom level members can be selected via the field’s tree view or drop down menu. A value of true indicates that only the bottom level members of the speci-fied dimension will be displayed, while a value of false indicates that all members will be displayed, regardless of where they sit in the dimension hierarchy.

truefalse

bottomonly= “true”


Indicates if Workflow entities (OLAP mem-bers) are displayed by member name or alias in the entity selection dialog for the Work-flow page.

A value of alias indicates that the entities are displayed by member alias. A value of name indicates that entities aredisplayed by member name.

aliasname


<name> A page selection field attribute. Indicates the name of the dimension to which the field selection members belong.

<![CDATA[...]]> <!CDATA[[Year]]>

115


Workf low Audi t Tra i l Conf igurat ionThis section in the workflow.xml file defines the audit trail configuration:

<module name=“workflowaudittrail” displaynamealiasoption=“alias”/>

For each scenario, perform the following tasks:

1. Create a <module> node for Workflow Audit Trail:

2. Set the following attribute to define behavior of the Workflow Audit Trail page for the scenario:

<caption> A page selection field attribute. The text that appears in the corresponding field selection of the Manage Workflow page selection dialog.

<![CDATA[...]]> <!CDATA[[Year]]>

<spec> A page selection field attribute. Indicates the query made to the OLAP database that retrieves the member selections of the speci-fied dimension.

Enter one of the following values:

• Enter a valid report script or MDX statement specific to the dimension as indicated in the <name> attribute.

• Use hierarchy security.

<![CDATA[...]]> <![CDATA [<CHILD "Plan-ning Years"]]>

<![CDATA [GetFromPageS-ecurity “Default”]]>

<selected> Used for backend processes only. Users are not to fill this in.

<![CDATA[]]> <![CDATA[]]>

Node Attribute Description Possible Values Example<module> name The system name of the Workflow Audit

Trail feature.workflowaudit-trail

name=“work-flowaudittrail”


Defines if Workflow entities (OLAP members) are displayed by member name or alias in the web interface.

A value of alias indicates that the entities are displayed by member alias. A value of name indicates that entities are displayed by member name.

aliasname

displaynamealia-soption= “alias”


116

. . .

. .W O R K F L O WAdministrating Workflow

A D M I N I S T R A T I N G W O R K F L O W

A Clarity Workflow entity is defined through dimensions based one or more members in the OLAP cube. A Clarity Workflow chain traces the data entry and validation on a template.

The chain is created by assigning an owner (inputs data values), one or more approvers (ensure that those values are valid and comply with the overall budgeting process) and an optional watcher (like a super-user that can simulate an approver or an owner).

Clarity Workflow consists of four main features:

1. Workflow Administration

2. Manage Workflow

3. Template Status

4. Workflow Audit Trail

Workf low Administrat ionThe Workflow Administration page enables an administrator to define and modify workflow entities and assign end users as owners, watchers and/or approvers.

D e f i n i n g a W o r k f l o w E n t i t yA Workflow entity consists of members from the OLAP dimension selected by an administrator that is to be used for data validation purposes. The entity may be comprised of one dimension or multiple dimensions, as configured in workflow.xml.

Cost centers are most commonly used as workflow entities to track data entry within templates across year and scenario dimensions.

117

WO R K F L O WAdministrating Workflow

To create a Workflow entity, select a member from each dimension in the Options - Web Page dialog. To create multiple Workflow entities, check the No Filter checkbox available for Cost Centers.

Note: To include a page option on this dialog the administrator must first edit the workflow.xml to enable filter option. (filter="true") If filter="false", the page option does not appear on the dialog and the spec is used to generate a list of entities on the page.

118

. . .


Based on the members selected, Workflow Entities will be generated:

Note: The No filter checkbox does not appear for a list. If the dimension displayed on the dialog is a tree view, then the spec element must contain the top level member to be displayed for the tree and the alternate spec element in the workflow.xml should contain the script to be used to generate list of members to be used to create workflow entities.

119


One owner and at least one approver are mandatory for a Workflow entity. A watcher or several approvers are optional.

The Edit button beside a chain allows you to edit the Owner, Watcher and Approvers assigned. The Remove button removes the Owner, Watcher and Approvers assigned.

120

. . .


W o r k f l o w A d m i n i s t r a t i o n T o o l b o x C o m m a n d sToolbox commands that appear on the Workflow Administration page may be removed (or new ones added) by editing the workflowadmintools.xml file found in the ...\Clarity Systems\ClarityServer\Web\workflow folder.

Change Options toolbox command displays the Options dialog to change page option selections.

Reset Status toolbox command allows the administrator to reset selected workflow entities back to the "Not Started" status at the end of a business cycle

The Find Entity toolbox command allows the administrator to quickly find an entity instead of scrolling through the page(s).

The Entity Wizard toolbox command allows the administrator to set up workflow chains for larger sets of entities at a time.

121


Select the "Descendants of Member" option for "Furniture Division" and select an owner and approver and click Apply. Click on Save Changes to save changes to the database.

Note: The Entity Wizard only updates entities that are showing on the Administration page.

122

. . .


Select All enables the user to select all of the workflow entities that are listed on the page.

Deselect All enables the user to uncheck all of the workflow entities that are listed on the page.

Multiple entities may also be edited by checking the checkbox on left of each item and then clicking on Edit Selected toolbox command. The owner, watcher, and approver(s) are reset to the new selection.

Clear Selected toolbox command will remove the owner, watcher, and approver(s) for the selected entities.

Manage Workf lowChanges to the Workflow status are made through the Manage Workflow feature.

Manage Workflow can be accessed via the Workflow menu item. The Manage Workflow page will show the Workflow entities that the user is currently assigned to.

Note: Only users belonging to the configured role (ex. “Clarity Workflow Users”) can be assigned to Workflow entities. The role can be changed in workflow.xml by setting the usergroup attribute of scenario node.

U s i n g M a n a g e W o r k f l o wThe Page options dialog displays members from the configured dimensions, set by the Administrator in workflow.xml.

The page options defined in Manage Workflow are used to track workflow status, based on one or more dimensions, as defined in the workflow.xml file.

123


The Manage Workflow page displays all the entities where the logged-in user is part of the workflow chain (i.e. an owner, watcher or an approver).

C h a n g i n g W o r k f l o w S t a t u sThe following image illustrates the possible stages of a business cycle in Clarity Workflow:

Changing the Workflow Status can be done by clicking on the icon in front of the user name:

Depending on whether the user is owner or approver, continuously clicking on the icon toggles the status from one to the other:

The owner has three possible statuses: Not Started, Work In Progress and Submitted.

The approver has four possible statuses: Needs to Approve, Approved, Reject and Skipped.

124

. . .


Skipped status can be enabled or disabled in the workflow.xml configuration by changing the attribute to statusapprover="any". When the attribute is set to any, skipped status is allowed.

Note: A final approver can always approve or reject even if owner's status is set to “Work in Progress” and/or other approvers have not yet approved.

N o t e s i n M a n a g e W o r k f l o wTo Add/Edit a note, click on the user name.

An asterisk (*) appears next to the name of the user in the chain if a note exists.

Note: Notes are saved only when making a status change.

125


E m a i l i n M a n a g e W o r k f l o wEmail status can be configured in workflow.xml by changing the attributes to:

1. createemail= “true” or “false”

A value of true enables email notification.

If false, no email notifications will be sent out.

2. sendemailperentity= “true” or “false”

Determines if a notification email is sent to all users in the chain for every time a status change occurs.

A value of true indicates that Clarity issues individual emails per entity.

If false, no emails are sent.

3. sendcollectiveemail=“true” or “false”

Determines if the approver will receive a notification email once all the entities he/she is responsible for have been submitted or approved. The same is true when approval chains are in place - the top approver will not receive an email until the other approvers have submitted for that entity.

If true, Clarity will only send an email to next level when all entities for that approver have been submitted or approved, and will also disable Send Email checkbox on the Manage workflow page in Clarity. On rejection, the previous user (owner or approver) gets an email notifying him that the data has been reviewed and rejected.

If false, no emails are sent.

Note: sendcollectiveemail and sendemailperentity are mutually exclusive. If one is set to true, the other must be set to false.

126

. . .


S a m p l e S c e n a r i o o f C o l l e c t i v e E m a i l N o t i f i c a t i o n

In this scenario, John is the final approver of all Base Plan data. Bob is also an approver, but only for IT entity.

Mary is the owner of IT entity Base Plan data, and is responsible for working with this data only. Bob audits and approves or rejects her work.

Jim is the owner of the Manufacturing and Home Office Decor entities, but he submits his plan data directly to John for final approval.

Clarity has been configured to send a collective notification email. (sendcollectiveemail= “true”).

Note: Watchers do not receive notification emails.

Task Resulting Email ExplanationMary completes her work and submits all of the Base Plan data for IT entity.

Notification email to Bob. A notification email is sent to Bob that all IT entities have been submitted for his approval.

Bob reviews the data, notices there is an error. Bob rejects Mary’s submission.

Rejection notification email to Mary.

A rejection notification email is only sent to the user that last submitted the data (Mary) - not to any other users in the workflow chain.

Mary corrects the error, and resubmits for IT entity.

Notification email to Bob. A notification email is sent to the next person in the approval chain every time all entities they are responsible for have been submitted. Bob is only responsible for Mary’s entity, so he receives an email.

Bob confirms that the data is accurate, and approves Mary’s work.

Notification email to John. A notification email is sent once all entities that a user is responsible for have been received for approval. In this case, John receives an email because as a 2nd level approver, he is responsible for IT entity only. Mary and Bob have submitted their work, so John receives notification.

Jim completes his work and submits data for Home Office Decor entity to John.

None. As a 1st level approver, John has 2 entities that he is respon-sible for. Until Jim submits data for both Home Office Decor and the Manufacturing entities, no notification email will be sent.

127


F i l t e r i n M a n a g e W o r k f l o wAllows the user to filter workflow entities by the workflow status by selecting one of the possible stages of a business cycle:

M a n a g e W o r k f l o w T o o l b o x C o m m a n d sToolbox commands that appear on the Manage Workflow page may be removed (or new ones added) by editing the workflowmanagetools.xml file found in the ...\Clarity Systems\Clarity\Web\workflow folder.

Change Options toolbox command displays the Options dialog to change page option selections.

128

. . .


Find Entity toolbox command enables user to find an entity on the page(s).

Cancel Changes toolbox command discards any status changes that user may have made on the page and not yet saved to the database.

Save Changes toolbox command will save changes to the database.

Multiple Entity Update toolbox command updates the status for any selected member for any given user.

With the settings shown in the dialog above, the wizard will reject all combinations of children of Head Office for the Base Plan scenario.

Note: It is not required to click Save Changes after using the Multiple Entity Update Wizard.

Template StatusClarity can be configured to allow users to update the workflow process from within a template.

129


The Manage Workflow command can be added in the Template Builder Options menu when designing the template. This allows users to pull up the workflow entities related to Page options on the template and change the status directly, instead of navigating to Manage Workflow from the menu option.

To use Manage Workflow from within a template, three configurations have to be done:

1. The user must be set up as part of the workflow chain, and belong to the reserved role “Clarity Workflow Users”.

2. The template locking status must be configured within workflow.xml

3. The template must be configured to use workflow.

Template Locking status can be enabled or disabled in the workflow.xml configuration by changing the attribute allowapprover to:

• allowapprover="all" - As a result, all approvers are allowed to edit data even after the entity is submitted and/or approved.

• allowapprover="none" - As a result, no approvers are allowed to edit data.

• allowapprover="next" - As a result, the next approver in line is allowed to edit data.

When a template is locked for editing, a user will receive an alert when trying to retrieve or save data from the template:

Note: An owner or other users not part of the chain are always locked out for editing after workflow status has been set to submitted and/or approved.

130

. . .


Setting the Use with Workflow attribute in Template Builder, for all the dimensions involved in the workflow process, allows the template to be implicated in the workflow.

The Manage Workflow command allows the user to access workflow from within the Clarity template. The status of the workflow can be changed directly within the template by the user:

131


The following image shows Expense Template - Budget as being submitted:

Clicking on the Manage Workflow command will open the Template Workflow dialog. The following image shows how the status can be changed from within a template. In this example, John approves Mary’s submission, skipping Bob in the approval process:

132

. . .


Workf low Audi t Tra i lThe Workflow Audit Trail feature is used to view all status changes that have occurred.

133


The following image shows the options to filter the data returned by the Workflow Audit Trail:

Based on the selections made, a particular Workflow status can be viewed on the page:

134

. . .


W o r k f l o w A u d i t T r a i l T o o l b o x C o m m a n dToolbox items that appear on the workflow audit trail page may be removed (or new ones added) by editing the workflowaudittrail.xml file, found in the ...\Clarity Systems\Clarity\Web\workflow folder.

View Log toolbox command allows the user to see a list of Workflow changes based on the filter selection.

Purge Log toolbox command allows the user to delete all Audit Trail entries from the database.

135


136

The Audit Trail feature provides administrators with a record of all changes made to data via templates. The audit trail can be used to track every instance of data input by users. There are two levels of detail to provide enhanced searching and reporting capabilities:

Template Audit Trail contains a record of all instances of templates saved by users.

Enhanced Audit Trail contains a record of all OLAP data intersections that were updated via templates, and provides more detailed reporting capabilities.


• Audit Trail Overview

• Audit Trail XML Configuration

Audit Trail 8

137

A U D I T TR A I L

138

. . .

. .A U D I T TR A I LAudit Trail Overview

A U D I T T R A I L O V E R V I E W

The Audit Trail tracks every instance of data input modification, based on when it was written back to the database environment via the Save command.

There are two different audit trail reporting options:

Audit Trail - by Template can be used to report on all instances of templates saved by users. This feature is enabled for each template, and may contain a full snapshot of the template at the time of the save, or a simple view of only the changes to OLAP data. This data can be searched by template name, page options, user or time period.

Note: In addition to enabling and configuring Template Audit Trail for the application, the Template Audit Trail option must also be enabled on each template, within Template Builder.

Audit Trail Reporting retains a record of all OLAP data intersections that were updated via templates. This feature is enabled globally, independent of the Template Audit Trail settings. This data can be searched by user, time period, or any OLAP member(s).

Audi t Tra i l - by TemplateThe Audit Trail - by Template page is available from the Administration menu:

139

A U D I T TR A I LAudit Trail Overview

It contains search parameters that enable administrators to select the audit trail entries that are returned:

• The Login ID drop down list filters the audit trail entries by user ID. Only users that the administrator has access to will appear in the drop down list.

• The Template drop down list filters the audit trail entries by template name.

• The All Dates, Today Only, and From and To fields drop down list filters the audit log entries by calendar date. Administrators can select all dates, the current day, or start and end date ranges. Clarity returns all audit log entries made for the date(s) specified.

• The Case sensitive text search on Page Options field enables administrators to search audit log entries by specific page option selections made by end users. Enter the full or partial name of a valid page option member in the field provided. Clarity returns all audit log entries where the specified text is found in the selected page options.

V i e w i n g A u d i t T r a i l E n t r i e sAfter specifying search criteria, click the View Log command to view all audit trail entries that match the criteria. The default criteria will display all entries in the system.

Audit trail entries are displayed by login ID, template, and the date/time of the database write. For each column, the arrow buttons can be used to sort the list of audit trail entries. Click on the Show/Hide Page Options command to view or hide the Page Options column:

140

. . .

.A U D I T TR A I LAudit Trail Overview

.

Note: The Page Options column does not appear initially if you are not searching on Page Options.

When an administrator clicks the View icon beside an audit trail entry, the data that was captured by audit trail when the user saved the changes to the template will be displayed on a new page within Clarity:

Note: If the file has been purged, the user cannot view the details.

When viewing the audit trail details, the following options are available to the administrator:

Option Description

Prints the audit trail entry details from Excel.

Allows a preview of the audit trail entry details from Excel.

Opens the audit trail entry details in Excel.

141


Audi t Tra i l Report ingThe Audit Trail - Report page is available from either the View History command, or the Administration menu:

Highlights the values changed by the user at the time the audit trail item was logged.

The Highlight Changes command is based on the last known write to the template with these page options. If the audit trail entry is the first of its kind in Clarity, the Highlight Changes command will not highlight the modifications. This feature will only work with subsequent writes to the database environment.

The Highlight Changes command is not available if the template is set up to save only changed rows to the audit trail.

Opens the history of changes to the audit trail item within Clarity.

Sets the decimal precision for the values displayed in the audit trail entry.

Option Description

142

. . .


To generate an audit trail report:

1. Click on the Search Options command. The Select Search Options dialog will appear:

• Choose the date range to display in the report.

• Select the Login ID(s) of the users to be queried.

• Choose the Server and Database for which you want to see details.

2. Once a server and source database have been chosen, the Select Search Options dialog will update to allow dimension selections:

• Select the dimensions you want to filter on. Leaving defaults at --ALL-- will return all audit trail entries in the database for the dates and user specified.

143


3. Click OK. The audit trail report results are displayed in Clarity:

4. At any time, you can optionally:

• Select the Records per Page displayed in the Report, in increments of 100, 250, or 500.

• Sort the list of audit trail entries by using the arrow buttons for each column.

• Use the buttons to move forward and backward through the pages of records. Where a large number of records occur, the Go To button allows the user to navigate to a new set of pages.

Purge Log

The Purge Log command is available in the Audit Trail - by Template and Audit Trail - Report panes. It can be used to delete specific audit trail log entries and/or details.

Note: Purged logs CANNOT be recovered.

The Purge Log command is only available to members of the group identified in the config.xml file as being permitted to purge the audit trail log.

144

. . .


U s i n g P u r g e L o g f o r A u d i t T r a i l - b y T e m p l a t eThe Purge Template Audit Trail dialog is available from the Audit Trail - by Template pane:

• The dialog allows the user to delete files only, records and files, or all details for entries being targeted:

• Files Only - deletes detail snapshot/changes.

• Records and Files - deletes Template Audit Trail and snapshot/changes.

• All Details - deletes Template Audit Trail, snapshot/changes, and OLAP entries.

• The entries to be deleted can be further specified:

• Select the all displayed entries radio button to delete all the entries shown in the Purge Template Audit Trail pane.

• Select the all selected entries radio button to delete only the entries that are selected in the Purge Template Audit Trail pane.

Note: The entries to be deleted must be selected by clicking on the the checkbox next to the audit trail entry prior to running the Purge Log command.

• Select the all entries selected on or before... radio button, and choose the date to be used.

145


U s i n g P u r g e L o g f o r A u d i t T r a i l - R e p o r tThe Purge Audit Trail dialog is available from the Audit Trail - Report pane:

• The audit trail entries to be deleted can be specified:

• Select the Purge all entries that meet the current search criteria radio button to delete all audit trail entries shown in the Audit Trail - Report pane.

• Select the Purge all selected entries radio button to delete only the entries that are selected in the Audit Trail - Report pane.

Note: The entries to be deleted must be selected by clicking on the the checkbox next to the audit trail entry prior to running the Purge Log command.

• Select the all entries selected on or before... radio button, and choose the date to be used.

U s i n g S e l e c t A l l / D e s e l e c t A l l

The items to be purged from the audit trail log are identified by clicking on the checkbox. Click on the checkbox next to the item to be deleted, or use the Select All / Deselect All checkboxes to select or unselect all of the items in the audit trail log.

The Select All/Deselect All command is only available to members of the group identified in the config.xml file as being permitted to purge the audit trail log.

146

. . .

. .A U D I T TR A I LXML Configuration and Optimization

X M L C O N F I G U R A T I O N A N D O P T I M I Z A T I O N

There are two XML files that can be configured to control how Audit Trail functionality works. The files have default settings that can be modified - refer to XML File Overview section for details on how to modify XML settings.

Audi t Tra i l XML Conf igurat ionThe following parameters are configured in the ...Web\config.xml file:


<audittrail> enabled If true, template audit trail entries will be cre-ated when sending templates that are config-ured for audit trail. If false, no template audit trail entries will be created.

truefalse

enabled=“true”

queued Default value is false. If true, audit trail entries will be created using a background process. If false, Clarity will wait for the audit trail entry to be created before returning control to the user.

truefalse

queued=“false”

enhanced Default value is true. If true, enhanced audit trail entries are recorded. If false, enhanced audit trail entries are not recorded.

truefalse

enhanced= "true"

viewdetails This attribute controls how the audit trail details will be displayed in Clarity.tab - Default setting. Results in details being displayed in new tab in web interface.window - Opens the details in a separate dia-log.popup - Opens the details in a modal dialog.

Note: for popup, the dialog must be closed again before any other user activity can be per-formed.

tabwindowpopup

viewdetails= "tab"

purge-group

This attribute identifies the user group that is permitted to purge the Audit Trail log.

Any reserved role or group with Audit Trail menu access

purgegroup= "Clarity Administra-tors"

147

A U D I T TR A I LXML Configuration and Optimization

Example:

<audittrail enabled="true" queued="false" checkbeforesend="false" timelimit="1" enhanced="true" viewdetails="tab" purgegroup="Clarity Administrators"/>

Audi t Tra i l XML Conf igurat ion - D i rectory Path and Query Opt imizat ionThe following attributes are configured in the ...COM\bin\application.config file:

checkbe-foresend

If true, when the user saves a template, Clarity will check for previously created audit trail entries for this template within the timelimit specified, and if any are found, will notify the user and prompt to cancel the send. If false, this check is not done.

truefalse

checkbefore-send=“false”

timelimit When checkbeforesend = “true”, the time-limit attribute specifies the number of minutes within which previously created audit trails will cause notifications as described.

1 timelimit=“1”


<add key> AuditTrailPath The directory path where files associated with Audit Trail entries are stored.

<add key="AuditTrail-Path" value="C:\Clarity Systems\ClarityServer \COM\AuditTrailLogs\"/>

MaximumOlapAudi-tRecordsPerQuery

When the administrator runs an audit trail report from the Administrator menu, this value limits the total number of records retrieved. This attribute can be used to limit the size of a query and optimize perform-ance.

any number value

<add key="MaximumO-lapAuditRecordsPerQu-ery" value="4000"/>

OlapThreadWaitTime This attribute is used to prevent unnecessary wait times for retrieval. OLAP data will be displayed after the wait time has expired.

Time is measured in seconds, and can be any number.

any number value

<add key="OlapThread-WaitTime" value="500"/>

MaximumRowPer-Thread

This attribute determines how many lines to run per thread. It is used for run time optimiza-tion.

any number value

<add key="Maximum-RowPerThread" value="100"/>


148

. . .

. .A U D I T TR A I LXML Configuration and Optimization

Example:

 <add key="AuditTrailPath" value="C:\Clarity Systems\ClarityServer\COM\AuditTrailLogs\"/> <add key="MaximumOlapAuditRecordsPerQuery" value="4000"/> <add key="OlapThreadWaitTime" value="300"/> <add key="MaximumRowPerThread" value="20"/>

Opt imiz ing XML Parameters for Per formanceSettings in the XML files and template determine overall performance of enhanced audit trail:

Q u e u e d v s . N o n - Q u e u e dIf queued attribute is set to false in config.xml, the user’s data submission is saved directly to the relational database. The user is unable to continue working until the audit trail entry is created synchronously.

Config.xml Attribute Settings

Template Settings Effect

queued = “true” template data ranges = [changed only]

Best performance.

Only the changes to template data are submitted, and audit trail entries are created by the background process.

The user does not have to wait to continue working.

queued = “true” template data ranges = [full]

Better performance.

All data is submitted when the user saves changes to template data.

The user does not have to wait to continue working.

queued = “false” template data ranges = [changed only]

Good performance.

Only the changes to template data are submitted.

The user will have to wait while Clarity creates the audit trail entry and submits data.

queued = “false” template data ranges = [full]

OK performance.

All data is submitted when the user saves changes to template data.

The user will have to wait while Clarity creates the audit trail entry and submits data.

149

A U D I T TR A I LXML Configuration and Optimization

If queued attribute is set to true in config.xml, the user can continue to work while the data is being submitted and audit trail entries are being created asynchronously. In this case, the data is saved into an XML file first, and is then submitted to the queued (asynchronous) process. The XML file remains (stored in the specified audittrailpath location) until the audit trail/enhanced audit trail entry is saved successfully.

150

The Clarity Activity Tracking feature captures end user activity. When enabled, it continually monitors the submissions and retrievals of a user from the OLAP database, and the use of any Clarity functionality.

Administrators can select which Clarity features to monitor, and can also view, audit and report on user activities.


• Administrating Activity Tracking

• Activity Tracking Log

Activity Tracking 9

151

A C T I V I T Y TR A C K I N G

152

. . .

. .A C T I V I T Y TR A C K I N GAdministrating Activity Tracking

A D M I N I S T R A T I N G A C T I V I T Y T R A C K I N G

Activity Tracking is accessible from the Administration menu.

Activity Tracking can be used to track typical user activities such as:

• Login/Out activities

• Failed login attempts

• Templates or reports used

• Data submissions, changes to cell notes or row notes

• Line item details

• Security changes (users, roles, hierarchy security, menu permissions)

The user information captured for these activities is saved in the relational database.

153

A C T I V I T Y TR A C K I N GAdministrating Activity Tracking

Act iv i ty Tracking XML Conf igurat ionThe config.xml located in the ...\Clarity Systems\ClarityServer\COM\bin folder contains the following attributes to set the Activity Tracking feature:

<ActivityTracking MaximumRecordsPerSearch="2500" databaseAlias="CPM_MSSQL"></ActivityTracking>


<ActivityTrack-ing>

Maximum-RecordsPer-Search

The number of records returned when querying the database. It is recommended that the value be kept between 2000 and 6000 for optimal performance.

any “Maximum-RecordsPer-Search=“2500”

databaseAlias The name of the database where the activity tracker relational database exists. The activity tracker database can be configured on any database server other than the main Clarity database server, or it can exist in the main Clarity Server relational database.

any alias name databaseAlias= “CPM_MSSQL”

154

. . .

.A C T I V I T Y TR A C K I N GAdministrating Activity Tracking

.

Conf igur ing Act iv i ty TrackingTo select what user activities will be tracked in Clarity, from the Administration menu choose Activity Tracking > Activity Tracking Administration.

The Activity Tracking Administration page allows the administrator to enable tracking for various Clarity features.

Select the features to be tracked in Clarity, and click OK. The settings are saved, and any user activities that occur for the selected Clarity features will be logged.

155

A C T I V I T Y TR A C K I N GAdministrating Activity Tracking

156

. . .

. .A C T I V I T Y TR A C K I N GActivity Tracking Log

A C T I V I T Y T R A C K I N G L O G

To select data logged by Activity Tracking in Clarity, from Administration menu choose Administration > Activity Tracking Log.

The Activity Tracking Log page allows the administrator to view or report on any user activities that are enabled in Clarity. The search parameters available are:

Parameter Description

Login ID Provides a list of users to select for Activity Tracking purposes. All users is the default setting.

Application This can be either Clarity or Unknown. All applications is the default setting.

Module This setting determines what Clarity features will be included when generating a report from the Activity Tracking log. All modules is the default setting.

Feature Provides a list of Clarity features to select for reporting on Activity Tracking. All fea-tures is the default setting.

Action The administrator can select a particular user action to report on. All actions is the default setting.

Starting DateEnding Date

By choosing a start and end date, these selections allow an administrator to limit the date range being viewed in the Activity Tracking log.

Case Sensitive Text Search on ‘Action Detail’ Column

When an Activity Tracking log is generated, the details of the transaction are logged. This field allows the administrator to search the Activity Log for a particular item (ex. word, phrase, number) and retrieve any logged activity that matches.

Records per Page This number allows selection of how many records to display per page based on search criteria. The administrator can choose 25, 50 or 100 records per page.

157

A C T I V I T Y TR A C K I N GActivity Tracking Log

View LogOnce reporting parameters have been selected, click on View Log. Clarity will filter and display the Activity Tracking log according to chosen parameters:

Purge LogTo clear the Activity Tracking log, click on Purge Log. The Purge Activity Tracking Log dialog will appear:

158

. . .

. .A C T I V I T Y TR A C K I N GActivity Tracking Log

Choose the start and end dates for the information to be cleared from the log.

Click OK to delete the information in that date range, or Cancel to exit without deleting.

Export to CSVWhen exporting the Activity Log to a CSV file format, only data records returned by search selection criteria are exported. The fields that are provided in the file are:

• ActivityDate

• username

• applicationName

• ModuleName

• FunctionalityName

• program

• action

• actiondetails

• serverIPAddress

• clientIPAddress

To create a log file in CSV format, click on Export to CSV. The File Download dialog will appear:

159

A C T I V I T Y TR A C K I N GActivity Tracking Log

Click on Open to view the CSV file in Microsoft Excel:

Click on Save to save the CSV file in a physical location on your machine:

Or click on Cancel to exit without saving the CSV file.

160

Report Books are used to consolidate and schedule the processing of individual Clarity reports, and are fully customizable by an administrator.

Once a report book has been generated, the reports are then distributed to end users via email, in a file format of the administrator’s choosing (Excel spreadsheet, PDF, HTML, etc.)


• Report Books Configuration

• Manage Report Books

• Run Report Books

• View My Reports

• Schedule Report Books

Report Books 10

161

R E P O R T B O O K S

162

. . .

. .R E P O R T B O O K SReport Books Configuration

R E P O R T B O O K S C O N F I G U R A T I O N

After initial installation of the Report Books feature, refer to the topic, “Report Books Configuration” on page -205 of the Clarity Installation Guide for detailed configuration steps.

For Report Books to function correctly, there are required configuration steps for the Clarity application and web servers, as well as each client machine.

Note: Report Books is a scheduled feature, which relies on the Clarity Scheduler. If the Clarity Scheduler is not installed or is disabled, the Report Books feature will not work. Refer to the topic, “Clarity Scheduler Configuration” in the Clarity Installation Guide.

Report Books Server - XML Conf igurat ion

Note: There are similarities between Business Rules and Report Books XML configuration. If your organization already uses the Business Rules XML feature, some of the Report Books XML configuration will already be completed.

A p p l i c a t i o n S e r v e rSettings for the Report Book application server are controlled by the following attributes in the config.xml file, which resides in the ...Clarity Systems\ClarityServer\COM\bin folder:

<reportbook loglevel=“3” rbemailfrom=“[email protected]” bremailfrom=“[email protected]” keepattachments=“false” zipdattachments=“false” hidehiddenrowscols=“false” path=“C:\ClaritySystems\Clarity6\ReportBooks\” notificationemaildisplaylink=“true” distributionemaildisplaylink=“false” reportbooksdummyemailfrom=“[email protected]” allocationsdummyemailfrom=“[email protected]” sendwarnings=“true”> <customvbsfunctions timeoutseconds=“180”></customvbsfunctions> </reportbook>

<cbwwebsite url="http://applicationservername/Clarity">

... <reportbookviewer ancestorlist=“essbase”/>

163

R E P O R T B O O K SReport Books Configuration


<reportbook> loglevel Determines the detail level of the report book generation log files. Enter a value from 0 (no logging) to 3 (very detailed).

0, 1, 2, 3 loglevel=“3”

rbemailfrom The address that Clarity uses to gener-ate report book notification emails.

(a valid email address)

rbemailfrom= “[email protected]”

bremailfrom The address that Clarity uses to gener-ate business rules notification emails.


bremail-from=“[email protected]”

keepattachments Indicates if attachments issued with Report Book emails will be stored on the Web Server or not. A value of true indicates that attachment files are stored on the Web Server. A value of false indicates that they are not.

truefalse

keepattachments= “false”

zipattachments Indicates if zipped attachments issued with Report Book emails will be stored on the Web Server or not. A value of true indicates that attachment files are stored on the Web Server. A value of false indicates that they are not.

truefalse

zipattachments= “false”

hidehiddenrows-cols

Indicates if rows and columns desig-nated as hidden rows and columns in the web interface are hidden when a Report Book is generated. A value of true indicates that rows and columns are automatically hidden, while a value of false indicates that they are not.

truefalse

hidehiddenrows-cols=“false”

path The folder path where generated report books reside.

path=“C:\Clarity Systems\Clarit-yServer\Report-Books\”

notificatione-maildisplaylink

Indicates if a hyperlink to the View My Reports screen is inlcuded in the notifi-cation email. A value of true indicates that the hyperlink is included, a value of false indicates that it is not included.

truefalse

notificatione-maildisplaylink= “true”

distributione-maildisplaylink

Indicates if a hyperlink to the View My Reports screen is inlcuded in the dis-tribution email. A value of true indi-cates that the hyperlink is included, a value of false indicates that it is not included.

truefalse

distributione-maildisplaylink= “false”

164

. . .

.R E P O R T B O O K SReport Books Configuration

.

W e b S e r v e rSettings for the Report Book web server are controlled by the following attributes in the config.xml file, which resides in the ...Clarity Systems\ClarityServer\Web folder:

<ReportBookServer>http://localhost/ReportBooks/</ReportBookServer>

<reportbookviewer filterbyuser="selectable">

reportbooks-dummyemail-from

This value will appear as the email address in the From field of notifica-tion and distribution emails generated by the Report Book module.


reportbooksdum-myemailfrom= “[email protected]”

allocationsdum-myemailfrom

This value will appear as the email address in the From field of notifica-tion and distribution emails generated by the Allocation part of the Report Book module.


allocationsdum-myemailfrom= “[email protected]”

sendwarnings Indicates if warning messages will be included in notification, distribution and error messages.

truefalse

sendwarnings

<customvbs-functions>

timeoutseconds This function is not supported in Clar-ity.

180 customvbsfunc-tions timeoutsec-onds=“180”

<report-bookviewer>

ancestorlist Determines how ancestor members are retrieved by the feature. Enter a value of essbase if ancestors of members are to be retrieved directly from Essbase, or a value of relational to retrieve ancestors from the pre-populated MemberAncestors Clarity relational table.

essbaserelational

reportbookviewer ancestorlist=“ess-base”

<cbwweb-site>

url Address of the Clarity website. If miss-ing or not correct, Report Books will not function correctly.

http://local-host/Clarity6/

<cbwwebsite url= “http://local-host/Clarity6/”/>


165

R E P O R T B O O K SReport Books Configuration

Node Attribute Description Possible Value Example

<ReportBook-Server>

Used by the View My Report function to retrieve generated reports for display and printing purposes.

Must contain the URL of the ReportBooks folder on the application server.

http://local-host/Report-Books/

<report-bookviewer>

filterbyuser Enables security filters on the View My Report screen in the web interface.

true: report list is filtered by user ID. It will only display the user's reports.false: report list is not filtered. All reports in the system will be displayed.selectable: Enables the user to select whether or not the result-ing list is filtered by their user ID or not.

truefalseselectable

filterbyuser= “selectable”

enablefilters If true, My Report dropdown list will be filtered by the <pages> node. If false, all reports will be displayed on the list.

truefalse

enablefil-ters="false"

deletepermission Specify the user group that has permissions to delete reports

(a valid user group)

deletepermis-sion="CBWAdministrators"

166

. . .

. .R E P O R T B O O K SReport Books

R E P O R T B O O K S

Report Book features are located in the My Reports menu available to users belonging to the reserved roles of "Clarity Report Book Users" and "Clarity Report Book Administrators":

167

R E P O R T B O O K SReport Books

168

. . .

. .R E P O R T B O O K SManage Report Books

M A N A G E R E P O R T B O O K S

Report books are defined via the Manage Report Books page, available to users belonging to "Clarity Report Book Administrators" role:

169

R E P O R T B O O K SManage Report Books

Add/Edi t Report BookClick the Add Report Book toolbox command to create a new Report Book or select the Edit Report Book icon to edit an existing Report Book. The Add/Edit Report Book screen appears:

Enter a valid name in the Report Book Name field for the new Report Book. When changing the name of an existing Report Book, the following confirmation message displays with selections to rename, copy or cancel:

170

. . .


The Available Templates list contains all templates and reports stored in static folders that the end user has access to. Dynamic templates and reports will not appear in this list. The navigation arrows are used to move reports between the Available and Selected panes.

Note: If the definition of a template/report changes, the template/report must be added into the Report Book again.

Static Excel files can be included in the Report Book via the Insert Static Excel Document button.

Note: All static Excel documents must be stored in the ...Clarity Systems\ClarityServer\Web\Books\static docs folder.

Delete Report BookClick on the Delete Report Book icon to delete an existing Report Book. Click on the OK button to confirm the deletion.

171


Select Page Opt ionsPage Options must be set for each report listed in the Selected Templates pane. Click on the Select Page Options button. The Page Options dialog appears:

To set Page Options:

• Select a member for each dimension using the ellipsis button or drop down lists to the right of the dimension.

• Check Override Selected Spec to override the hierarchical member selection with one of the following options:

• A variable defined in the cube

• A valid member

• A valid expression e.g. 'Bottom Only' members for selected dimension

• Check Allow Runtime Selection to allow the end user to select the Page Options at run time.

• Cascade Options generate multiple reports, based on the specification made for a selected dimension.

• Select a cascading specification from the Cascade On drop down list and then select a valid dimension in the second drop down list. There are six available specifications:

• Children

• IChildren

172

. . .


• Descendents

• Descendants

• Bottom Level Descendents

• A Report Script (if selected the Report Script text field is enabled)

• Enter text to the Description field to provide further details about the report.

Note: The same report may be selected several times but run for different divisions or regions, so the Description field should contain the division or region name.

Global Opt ionsIf Allow Run-time Selection is checked for one or more dimensions, then Global Options must be set. Click the Global Options button. The Global Run-Time Page Options dialog appears:

173


Note: A report script (Essbase) or MDX statement (MSAS) can be used to set the value of the dimension.

• Use the Preview button to validate the value of the dimension.

• Select Tree View Selection or Drop Down List option to display members available for selection, when running the Report Book.

• Select the Display Name or Display Alias option to display members available for selection, by name or alias, when running the Report Book.

• Select the Bottom Members Only option to display bottom level members for selection when running the Running Book.

174

. . .

. .R E P O R T B O O K SRun Report Books

R U N R E P O R T B O O K S

Generating previously defined Report Books is done via the Run Report Books feature, available to users belonging to "Clarity Report Book Users" role:

Generat ing a Report Book• Select a book from the Report Book drop down list.

• Select the Output Type for the Report Book. The following six output types are available:

• Excel

175

R E P O R T B O O K SRun Report Books

• PDF

• HTML

• TAB Delimited Text File

• Formatted Text File

• Printer (if selected a drop down list of available printers displays)

• Optional: Enter valid e-mail address or addresses in the Email Notification field to in order to send a notification email when the Report Book has completed generation.

• Make selections from the Output Options:

• Merge multiple reports into a single document consolidates all the reports into a single document in the specified Output Type. This option is only available if the report book is distributed via e-mail. When this option is selected, the following additional options will be available:

• Make reports available in 'View My Reports' makes the individual reports available via View My Reports feature.

• Sort Reports Alphabetically displays the reports alphabetically, by name, in the merged document.

• Generate Table of Contents builds a table of contents that precedes the reports in the merged document.

• Enter valid e-mail address or addresses in the Distribution List field to send the merged reports via e-mail.

• Click on the Run Report Book toolbox command.

Note: Report Books generate reports based on the page options defined via the Manage Report Books screen. If Global Run-Time Page Options were specified, users are prompted to select the page specifications before the Report Book is generated.

176

. . .

. .R E P O R T B O O K SView My Reports

V I E W M Y R E P O R T S

Viewing the previously generated reports is done via the View My Reports feature, available to users belonging to the reserved role of "Clarity Report Book Users":

Note: If a user does not have access to a particular report, based on Menu Administration security restrictions, the user will not be able to view the report as it will not be listed in the search results.

Refresh L ist of ReportsClick on the Refresh List of Reports toolbox command to display a list of reports that meet the selected criteria. The list displays columns with the following options:

• Report displays the name of the report and can be sorted alphabetically by clicking on the up and down arrows.

• Date/Time displays the date and time when the report was run and can be sorted by clicking on the up and down arrows.

• Size displays the size of the report.

177

R E P O R T B O O K SView My Reports

• View displays the output type of the report. Click on the icon to preview the report.

• Select checkbox to be used in conjunction with purging selected reports.

The list of reports can be filtered further by selecting:

• An individual book from the Report Book drop down list.

• An individual report from the Report drop down list.

• The radio button for All Dates.

• The radio button for Choose Dates which enables the From and To calendar controls to select a date range.

Purge ReportsPurge Reports enables users to delete the selected reports from the server. Click on the Purge Reports toolbox command. The Purge Reports dialog displays with three options:

PrintThe Print toolbox command sends all the selected reports to the defaulted printer.

Save AsThe Save as … toolbox command allows end user to save the selected reports to a local or network folder.

178

. . .

. .R E P O R T B O O K SView My Reports

Select Al lThe Select All toolbox command selects all the reports displayed in the list.

Deselect Al lThe Deselect All toolbox command clears all the previously selected reports.

179

R E P O R T B O O K SView My Reports

180

. . .

. .R E P O R T B O O K SSchedule Report Books

S C H E D U L E R E P O R T B O O K S

The Schedule Report Books feature allows administrators to schedule the running of previously defined Report Books on specific dates and times. This feature is available to users belonging to the reserved role of "Clarity Report Book Administrators":

181

R E P O R T B O O K SSchedule Report Books

Add ScheduleTo define a new schedule, click on the Add Schedule toolbox command. The Add/Edit Schedule dialog appears:

• The Schedule Name field defines the name of the schedule as it appears in the schedule list of the Schedule Report Books screen.

• The Report Book drop down menu is used to select the name of the Report Book that will generate when the schedule has been defined.

• The Schedule parameters determine how often the Report Book will automatically generate. Report books can be set to run daily, weekly (by day of the week) or monthly, at any time during the day.

182

. . .

. .R E P O R T B O O K SSchedule Report Books

• The Output Type radio button selections determine what type of output file the Report Book will be generated in.

• Refer to Manage Report Books section for use of the remaining fields.

Edit ScheduleTo modify an existing schedule, click on the Edit Schedule icon beside the relevant schedule. The Add/Edit Schedule screen appears with parameters previously defined.

Delete ScheduleTo delete a schedule, click on the Delete Schedule icon beside the relevant schedule. Click on the OK button to confirm the deletion.

183

R E P O R T B O O K SSchedule Report Books

184

Business rules enable the administrator to create, edit and run financial rules embedded in Clarity templates manually, or organize the rules into groups that can be scheduled to run at specific dates and times. This feature offers the advantages of automation and reduced manual tasks.


• Business Rules Configuration

• Creating and defining business rules

• Editing and scheduling business rules

Business Rules 11

185

B U S I N E S S R U L E S

186

. . .

. .B U S I N E S S R U L E SBusiness Rules Configuration

B U S I N E S S R U L E S C O N F I G U R A T I O N

For Business Rules to function correctly, there are required configuration steps for the Clarity application and web servers, as well as each client machine.

Note: Business Rules is a scheduled feature, which relies on the Clarity Scheduler. If the Clarity Scheduler is not installed or is disabled, the Business Rules feature will not work. Refer to the topic, “Clarity Scheduler Configuration” in the Clarity Installation Guide.

Business Rules XML Conf igurat ionThe config.xml located in the ...\Clarity Systems\ClarityServer\COM\bin folder contains the following attributes to set the folder path for Business Rules:

<allocations path="C:\Clarity Systems\ClarityServer\Web\Allocations\"/>

Report Books XML Conf igurat ionReport Books and Business Rules use a common engine to do the processing. However, Business Rules do not create any output files and therefore the attributes, within the XML file, referring to attachments or path to store output files are not applicable.

The following attributes control aspects of Report Books:

<reportbook loglevel=“3” rbemailfrom=“[email protected]” bremailfrom=“[email protected]” keepattachments=“false”

zipdattachments=“false” hidehiddenrowscols=“false” path=“C:\ClaritySystems\ClarityServer\ReportBooks\” notificationemaildisplaylink=“true” distributionemaildisplaylink=“false” reportbooksdummyemailfrom=“[email protected]” allocationsdummyemailfrom=“[email protected]” sendwarnings=“true”> <customvbsfunctions timeoutseconds=“180”></customvbsfunctions> </reportbook> ... <reportbookviewer ancestorlist=“essbase”/>

187

B U S I N E S S R U L E SBusiness Rules Configuration


<reportbook> loglevel Determines the detail level of the report book generation log files. Enter a value from 0 (no logging) to 3 (very detailed).

0, 1, 2, 3 reportbook loglevel=“3”

rbemailfrom The address that Clarity uses to gener-ate report book notification emails.


rbemail-from=“[email protected]”

bremailfrom The address that Clarity uses to gener-ate business rules notification emails.


bremail-from=“[email protected]”

keepattachments Indicates if attachments issued with report book emails will be stored on the Web Server or not. A value of true indicates that attachment files are stored on the Web Server. A value of false indicates that they are not.

truefalse

keepattach-ments=“false”

zipdattachments Indicates if zipped attachments issued with report book emails will be stored on the Web Server or not. A value of true indicates that attachment files are stored on the Web Server. A value of false indicates that they are not.

truefalse

zipdattach-ments=“false”

hidehiddenrows-cols

Indicates if rows and columns desig-nated as hidden rows and columns in the web interface are hidden when a report book is generated. A value of true indicates that rows and columns are automatically hidden, while a value of false indicates that they are not.

truefalse

hidehidden-rowscols=“false”

path The directory path where generated report books reside.

path=“C:\ClaritySys-tems\Clari-tyServer\ReportBooks\”

notificatione-maildisplaylink

Indicates if a hyperlink to the View My Reports screen is inlcuded in the notifi-cation email. A value of true indicates that the hyperlink is included, a value of false indicates that it is not included.

truefalse

notifica-tionemaild-isplaylink=“true”

distributione-maildisplaylink

Indicates if a hyperlink to the View My Reports screen is inlcuded in the dis-tribution email. A value of true indi-cates that the hyperlink is included, a value of false indicates that it is not included.

truefalse

distribu-tionemaild-isplaylink=“false”

188

. . .

.B U S I N E S S R U L E SBusiness Rules Configuration

.

C l a r i t y W e b I n t e r f a c e U R LThe following attributes set the URL of the web interface:

<cbwwebsite url=“http://localhost/Clarity6/” />

reportbooks-dummyemail-from

This value will appear as the email address in the From field of notifica-tion and distribution emails generated by the Report Book module.


reportbooks-dummyemail-from=“[email protected]”

allocationsdum-myemailfrom

This value will appear as the email address in the From field of notifica-tion and distribution emails generated by the Allocation part of the Report Book module.


allocations-dummyemail-from=“[email protected]”

sendwarnings Indicates if warning messages will be included in notification, distribution and error messages.

truefalse

sendwarn-ings=“true”

<customvbs-functions>

timeoutseconds This function is not supported in Clar-ity.

180 customvb-sfunctions timeoutsec-onds=“180”

<report-bookviewer>

ancestorlist Determines how ancestor members are retrieved by the feature. Enter a value of essbase if ancestors of members are to be retrieved directly from Essbase, or a value of relational to retrieve ancestors from the pre-populated MemberAncestors Clarity relational table.

essbaserelational

reportbook-viewer ancestorl-ist=“ess-base”


<cbwwebsite> url Address of the Clarity website. If missing or not correct, report books will not function correctly.

http://localhost/Clarity6/

cbwwebsite url=“http://local-host/Clarity6/”


189

B U S I N E S S R U L E SBusiness Rules Configuration

190

. . .

. .B U S I N E S S R U L E SBusiness Rules

B U S I N E S S R U L E S

Business rules enable the administrator to create, edit and run financial rules manually, or organize the rules into groups that can be scheduled to run at specific dates and times.

The following commands reside in the Business Rules menu:

• Manage Business Rules

• Schedule Business Rules

Manage Business Rules

The Manage Business Rules page contains a list of all existing business rules in the system. The administrator can create new business rules, delete, edit or run existing business rules:

191

B U S I N E S S R U L E SBusiness Rules

A d d / E d i t B u s i n e s s R u l eClick on the Add Business Rule toolbox command to create a new business rule or select the Edit Business Rule icon beside an existing business rule to edit same. The Add/Edit Business Rule dialog box displays:

Select the relevant templates to be used in the Business Rule.

192

. . .

. .B U S I N E S S R U L E SBusiness Rules

Click on the Select Page Options button for each selected template in order to define the allocations to be run. The Page Options dialog appears:

Refer to the Report Book section of this guide for setting Page Options.

R u n B u s i n e s s R u l eClick on the Run Business Rule icon beside an existing business rule to process same manually. The e-Mail Notification dialog displays:

Enter e-mail addresses in order to send notifications when the business rule has completed and click on the OK button. Click on OK button to confirm the Business Rule has been submitted to the queue.

D e l e t e B u s i n e s s R u l eClick on the Delete icon beside an existing business rule to delete same. Click on the OK button to confirm the deletion.

193

B U S I N E S S R U L E SBusiness Rules

Schedule Business Rules

The Schedule Business Rules command enables business rules to be scheduled to run at a specific date and time:

A d d / E d i t S c h e d u l eClick on the Add Schedule toolbox command to add a business rule to the schedule, or select the Edit icon beside the schedule to edit same. The Add/Edit Schedule dialog box displays:

D e l e t e S c h e d u l eClick on the Delete icon beside an existing schedule to delete same. Click on the OK button to confirm the deletion.

194

Clarity Modeling enables analysts to apply business rules to existing financial data stored in the Clarity database environments.

Clarity provides four types of Modeling functions that are defined in configuration files and accessed in the web interface:

• Calculation pages to apply a fixed business rule.

• What-if pages to apply a parameterized business rule.

• Versioning pages to copy a data set and optionally apply a fixed business rule.

• Goal Seeking pages to observe the possible effect on data, by entering target data and selecting what data is to be held at current value.

This section describes the features and functionality of Modeling including:

• Understanding Modeling

• Calculations

• What-if

• Versioning

Modeling 12

195

M O D E L I N G

196

. . .

. .M O D E L I N GUnderstanding Modeling

U N D E R S T A N D I N G M O D E L I N G

Clarity provides generic drivers for displaying and running the four types of Modeling pages.

Samples of the Modeling features are installed, by default, on the Clarity server. The menu commands and associated files are as follows:

• Modeling > Goal Seeking (web\versioning\Goal Seeking\Profit Loss Analysis.xml)

• Calculate > Clear What-if (web\versioning\calc3.xml)

• Modeling > What-if (web\versioning\whatif.xml)

• Modeling > Versioning (web\versioning\versioning.xml)

A Goal Seeking page can be used to perform target sensitivity analysis. Goal seeking functionality can be configured in Template Builder to work with a template.

What-if, clear what-if (calculation), and versioning affect the stored data values. For example, an analyst can use a Versioning page to copy a set of data into an area designated for modeling, then use a What-if page to modify that data in order to analyze the result. A Calculation page is then used to clear the modeling area when finished.

For these types of modeling pages, the same basic format is used. When the page is displayed in the web interface, the user is presented with a list of selection fields, similar to the Page Options dialog box for Templates and Reports. Once the user makes the appropriate selections, a Toolbox command is executed to run the configured script(s), using the selected values.

The configuration file for each page identifies the same basic items, although the format and options available may be different. The items are as follows:

• OLAP Connection information (currently each page affects only one cube).

• User selection information.

• Scripts to perform the desired actions using the selections made by the user.

197

M O D E L I N GUnderstanding Modeling

198

. . .

.M O D E L I N GCalculations

.

C A L C U L A T I O N S

A Calculation page displays a set of dimension selection fields that can be used to select members from configured dimensions and specifications. The selected members are then substituted into a configured script and the script is executed.

Calculat ion Scr iptsCurrently a Calculation page can only support a single Essbase calc script. The format of the configuration file is as follows:


<calcdb> Root node must be called calcdb <calcdb>

provider Type of OLAP database used by the page. Essbase provider="Essbase"

EBServer Name or IP address of the server that hosts the OLAP database used by the page.

olap server EBServer="local-host"

EBApplication Name of the OLAP application (Essbase) or database (MSAS) used by the page.

olap application EBApplica-tion="clarity"

EBDatabase Name of the OLAP database (Essbase) used by the page.

olap database EBData-base="demo60"

name Name of the xml file. If the file is renamed, this attribute must be updated.

<filename>.xml name="calc1.xml"

199

M O D E L I N GCalculations

<text> Node containing some configurable text. <text>

<MainTitle> text Text that appears at the top of the page in the web interface.

any text <MainTitle text="Calc All" />

<TreePrompt> text Text that appears in a selection field with a view attribute of “tree” when no OLAP mem-ber has been selected.

any text <TreePrompt text="Click icon to select a member ->"/>

<dimensions> Group of zero or more <dim> nodes, as defined below.

<dimensions> ...........................</dimensions>

<dim> Dimension selection field that will appear on the page in the web interface. Users can make selections that can be used in the calculation.

<dim ......>

view Type of control to be displayed for the user to select a member.

listtree

view="tree"

bottomonly Indicates whether selection will be limited to bottom (leaf) members when selecting from a tree.

yesno

bottomonly="no"

show Indicates whether this selection field will be displayed to the user. If it is not displayed, the view should be set to “list” and the first mem-ber resulting from the spec will be used as the value.

yesno

show="yes"

token Substitution token that corresponds to this selection field. Each <dim> should have a unique token. This token can be used in a script, to be replaced by the selected value in this field.

any word token="tokEntity"

<name> Name of the dimension from which the selectable values will be taken

any OLAP dimension from the configured cube


<caption> Label that will appear to the left of the selec-tion field.

any text <cap-tion><![CDATA[Entity]]></caption>


200

. . .

. .M O D E L I N GCalculations

<spec> Specification that will be used to determine the list of selectable members. For a tree, this should be a single member to be used as the starting point for the tree. For a list, this may be a report script or list of members.

OLAP mem-ber(s) or report script. May be enclosed in <![CDATA[ ]]> tags for readabil-ity and ease of maintenance.

<spec><![CDATA[<GetFromPageSe-curity]]></spec>

<script> Actual script to be run which should be an Essbase calc script. The tokens from the defined selection fields may be used in place of OLAP members, and the selected mem-bers will be substituted when the script is executed.

Custom Essbase calc script, usu-ally enclosed in <![CDATA[ ]]> tags for readabil-ity and ease of maintenance.

<script onserver="no"><![CDATA[SET UPDATECALC OFF; SET NOTICE DEFAULT;FIX ("tokYear", @RELATIVE ("tokEntity", 0))CALC DIM (Accounts, "All Products");ENDFIX@IDESCEND-ANTS("tokEn-tity");]]> </script>


201

M O D E L I N GCalculations

202

. . .

. .M O D E L I N GWhat-If

W H A T - I F

A What-if page displays a set of dimension selection fields that can be used to select members from configured dimensions and specifications.

Also displayed is a list of configured calculation methods that the user can select, and a field to enter a parameter (such as a percentage increase amount). The selected members and parameters are then substituted into the configured script for the selected calculation method, and the script is then executed.

Note: Currently only Essbase calc scripts are supported for What-if pages.

203

M O D E L I N GWhat-If

OLAP Connect ion and Formatt ingSimilar to the calculation configuration file, the first line of the file contains attributes defining the OLAP connection. The OLAP connection and additional formatting items are as follows:

Dimension Select ion F ie ldsThis section defines the selection fields used to capture the members to be used in the calculation script.

Node Attribute Description Possible Values Example<whatif > Root node must be called whatif. <whatif .... >

name Name of the xml file. If the file is renamed, this attribute must be updated.

<filename>.xml name="wha-tif.xml"

provider Type of OLAP database used by the page.

Essbase provider="Ess-base"

EBServer Name or IP address of the server that hosts the OLAP database used by the page.

olap server EBServer="local-host"

EBApplication Name of the OLAP application (Ess-base) or database (MSAS) used by the page.

olap application EBApplica-tion="clarity"

EBDatabase Name of the OLAP database (Essbase) used by the page.

olap database EBData-base="demo"

<text> Node containing some configurable text.

<text> .... </text>


any text <MainTitle text="What-If Modeling" />

<TreePrompt> text Text that appears in a selection field with a view attribute of “tree” when no OLAP member has been selected.

any text <TreePrompt text="Click icon to select a mem-ber ->"/>

Node Attribute Description Possible Values Example<dimensions> Group of zero or more <dim> nodes, as

defined below.<dimensions> ...............</dimensions>

<dim> Dimension selection field that will appear on the page in the web interface. Users can make selections that can be used in the calculation.

<dim .... </dim>


listtree

view="list"

bottomonly Indicates whether selection will be lim-ited to bottom (leaf) members when selecting from a tree.

yesno

bottomonly="yes"

204

. . .


Calculat ion MethodsThis section defines the items available in the list of calculation methods that the user can select.

show Indicates whether this selection field will be displayed to the user. If it is not dis-played, the view should be set to “list” and the first member resulting from the spec will be used as the value.

yesno

show="yes"


any word token="tokSce-nario"

<name> Name of the dimension from which the selectable values will be taken

any OLAP dimen-sion from the con-figured cube

<name><![CDATA[Sce-nario]]></name>

<caption> Label that will appear to the left of the selection field.

any text <cap-tion><![CDATA[Version]]></cap-tion>

<spec> Specification that will be used to deter-mine the list of selectable members. For a tree, this should be a single member to be used as the starting point for the tree. For a list, this may be a report script or list of members.

OLAP member(s) or report script. May be enclosed in <![CDATA[ ]]> tags for readability and ease of mainte-nance.

<spec><![CDATA[<CHILD "What If"]]></spec>


<calcoptions> List of calculation methods as defined by the <option> nodes within this node.

<calcoptions ........ >

name Identifier for the list of calc methods. any word name="group1"

<caption> Title that will appear above this list in the web interface

any text <cap-tion><![CDATA[Apply: ]]></cap-tion>

<option> Calculation method that will be presented to the user.

<option ..... </option>

name Identifier for the calculation method any word name="option1"

selected If present, indicates whether this option will be selected by default when the page opens.

yes selected="yes"


205


Member l is t for custom al locat ionA calculation method may involve custom allocations. This can be achieved by adding a <memberlist> node as defined below, within the <option> node that defines the calculation method.

Calculat ion scr iptsThis section defines the scripts that may be run, and named so that they are associated with calculation methods.

script Node in the <scripts> section defined below, which contains the script to be run when this calculation method is selected.

name of a node in the <scripts> sec-tion

script="per-centchange"

<caption> Text that will appear on the page, beside the radio button for this calculation method.

any text <cap-tion><![CDATA[% Change]]></cap-tion>

Node Attribute Description Possible Values Example<memberlist> Defines parameters for the custom alloca-

tion dialog, which appears when this calcu-lation method is selected by the user.

<memberlist ........ >

type Indicates whether the custom allocation dia-log will display the member list with input boxes or a tree with radio buttons

input type="input"

<radio>

<caption> not currently used

<name> The name of the dimension from which the member list will be retrieved


<spec> The specification that will be used to deter-mine the list of members. This may be a report script or list of members.

OLAP member(s) or report script

Node Attribute Description Possible Values Example<scripts> List of one or more scripts, each of which

corresponds to a calculation method defined above.

<scripts>


206

. . .


{option script} Value of the script attribute from an option defined in the calcoptions section.

any defined option script name

<script> Actual script to be run which should be an Essbase calc script. The tokens from the defined selection fields may be used in place of OLAP members, and the selected mem-bers will be substituted when the script is executed.

Custom Essbase calc script, usually enclosed in <![CDATA[ ]]> tags for readability and ease of mainte-nance.

<script>

<![CDATA[SET UPDATE-CALC OFF; SET NOTICE DEFAULT;FIX ("tok-Year",@IDESCEND-ANTS ("tokEn-tity"), @IDESCEND-ANTS ("tokAc-count")) "tokScenario" = "tokSce-nario" * (1 + (tokValue / 100));ENDFIX]]></script>


207


208

. . .

. .M O D E L I N GVersioning

V E R S I O N I N G

A Versioning page displays a set of dimension selection fields that can be used to select members from configured dimensions and specifications.

Versioning is typically used to copy data from one section of the cube to another and therefore displays sections for source, target and any additional filters.

The ‘Select Data to Copy’ section displays a list of selectable items that correspond to scripts. For example, Versioning may be applied to Line Item Detail and Cell Notes, as well as OLAP data. Batch files can also be executed to modify data or perform additional modeling tasks.

A Versioning page can support multiple Essbase scripts and relational procedures that may be grouped and presented to the user as options. The format of the file is explained below.

209

M O D E L I N GVersioning

OLAP Connect ion and Formatt ingSimilar to the calculation configuration file, the first line of the file contains attributes defining the OLAP connection. The attribute names are slightly different, and additional formatting items are as follows:

Dimension Select ion F ie ldsThis section defines the selection fields used to capture the members that will be used in the calculation script. Unlike the other Modeling functions, the selection fields on a Versioning page may be grouped into sections (option groups) with visible headers.

Node Attribute Description Possible Values Example<cpmcalc> Root node must be called cpmcalc. <cpmcalc ... >

provider Type of OLAP database used by the page. EssbaseAnalysisServices2K

provider="Ess-base"

OLAPServer Name or IP address of the server that hosts the OLAP database used by the page.

olap server OLAPServer="localhost"

OLAPApplication Name of the OLAP application (Essbase) or database (MSAS) used by the page.

olap application OLAPApplica-tion="clarity"

OLAPDatabase Name of the OLAP database (Essbase) or cube (MSAS) used by the page.

olap database OLAPData-base="demo60"

<text> Node containing some configurable text. <text> ... </text>


any text <MainTitle text="Version-ing"/>

<TreePrompt> text Text that appears in a selection field with a view attribute of “tree” when no OLAP member has been selected.

any text <TreePrompt text="Click icon to select a mem-ber ->"/>

Node Attribute Description Possible Values Example<option-groups>

List of zero or more <optiongroup> nodes, as defined below.

<option-groups> ..... </optiongroup>

<optiongroup> Group of dimension selection fields that will appear on the page in the web interface.

<optiongroup ..... >

id Identifier for the option group. any word id="copyfrom"

caption Text that will appear as a section header on the page.

any text caption="Copy From"

enabled Indicates whether the option group will be displayed and used.

TRUEFALSE

enabled="true"

<option> Dimension selection field that will appear on the page. Users can make selections that can be used in the calculations.

<option ... >

210

. . .


Calculat ion Scr iptsThis section defines the scripts that may be run from this page. Multiple scripts may be defined and organized into groups. If a group is defined as optional, it will be visible in the list of scripts which the user can select. A script group that is not defined as optional will be executed every time the Versioning command is done.

enabled Indicates whether this selection field will be displayed and used.

TRUEFALSE

enabled="true"


listtreemultitree

view="list"

bottomonly Indicates whether selection will be limited to bottom (leaf) members when selecting from a tree.

yesno

botto-monly="no"


any word token="tok-fromscenario"

caption Label that will appear to the left of the selection field.

any text caption="Ver-sion"

default If specified, this member will be used as the initial selection when the page is first opened.

any OLAP mem-ber

default="Base Plan"

minselect If the view is multitree, identifies the mini-mum number of members to be selected.

a number >= 1 minselect="0"

maxselect If the view is multitree, identifies the maxi-mum number of members to be selected.

a number >= 1 maxselect="0"

<dimspec> <dimspec ... >

dimensionname Name of the dimension from which the selectable values will be taken


dimension-name="Sce-nario"

<spec> Specification that will be used to determine the list of selectable members. For a tree, this should be a single member to be used as the starting point for the tree. For a list, this may be a list of members, an Essbase report script, or an MDX statement.

OLAP member(s), report script, MDX statement. May be enclosed in <![CDATA[ ]]> tags for readabil-ity and ease of maintenance.

<spec><![CDATA[<CHILD "Planning Sce-nar-ios"]]></spec>

<selected> Used for backend processing; this node should be present, but with no value.

leave blank <selected><![CDATA[]]></selected>


211


Relational scripts will be processed first, and will be rolled back in the event of an error. Batch files will be queued and run in a background process.

Node Attribute Description Possible Values Example<scriptgroup> List of calculation scripts that will be run as

a single transaction. The following attributes apply to the whole transaction.

<scriptgroup ...... </scriptroup>>

id Identifier for the list of scripts any word id="olap"

type Type of script, and therefore the type of processing required. The script may be an Essbase calc script, a relational procedure, or a batch file.

esbrelationalbatch

type="esb"

optional Indicates whether the user can choose to include or exclude this transaction when the Versioning command is executed.

TRUEFALSE

optional="true"

caption If optional, the text that will appear beside the checkbox for this script group, in the “Select Data to Copy” section.

any text cap-tion="OLAP Data"

abortonerror Indicates whether an error in the processing of this script group will cause the rest of the script groups to be skipped.

TRUEFALSE

aborton-error="false"

value not used value = "OLAP"

<script> Actual script to be run which should be an Essbase calc script, a relational procedure, or the path and name of a batch file. The tokens from the defined selection fields may be used in place of OLAP members, and the selected members will be substi-tuted when the script is executed.

Custom script of the type indicated in the type attribute. Scripts are usually enclosed in <![CDATA[ ]]> tags for readability and ease of mainte-nance.

<script name="Olap Script"><![CDATA[SET UPDATE-CALC OFF; SET NOTICE DEFAULT;FIX (@DESCEND-ANTS ("Office Products Inc"))CLEARDATA "toktoscenario";DATACOPY "tokfromsce-nario" TO "tok-toscenario";ENDFIX

]]>

</script>

name Caption for the script, used for displaying results of individual scripts.

any text name="Olap Script"

212

. . .


Creat ing Menu I temsOnce the definition file has been created, the page may be added to the menu using the following parameters:

The calcdb_menu.xml contains the following structure and may be used for all Modeling pages. If individual pages need customized information, these items may be added to the calculation definition page instead, and that page referenced in the Toolbox Location of the menu item:

Calculat ion ExampleThe sample Versioning page uses the following script to copy data into a Modeling scenario:

SET UPDATECALC OFF;

SET NOTICE DEFAULT;

FIX ("tokentity")

CLEARDATA "toktoscenario";

DATACOPY "tokfromscenario" TO "toktoscenario";

ENDFIX

The tokens “tokentity”, “toktoscenario”, and “tokfromscenario” are replaced at run-time with the user selections for the corresponding options containing these tokens. For example, the script that actually runs is as follows:

SET UPDATECALC OFF;

SET NOTICE DEFAULT;

Parameter Value CommentDocument Type Other

Document Location versioning/calcdb.asp?calc=<filename>.xml Calculation

versioning/whatif.asp?calc=<filename>.xml What If

versioning/versioning.asp?calc=<filename>.xml Versioning

Toolbox Location versioning/calcdb_menu.xml Standard

versioning/<filename>.xml Custom – see below

Node Attribute Description Possible Values Example<root> MinimizeToolbox Indicates whether the Clarity Toolbox

appears in minimized state when the page is first opened.

TRUEFALSE

MinimizeTool-box="false"

<menu> Node containing toolbox items that will appear in the Clarity Toolbox.

<menu> ....</menu>

<menuitem> Tool ID of a predefined toolbox item. Cur-rently custom functions are not supported, but custom toolbox items may be used to cus-tomize captions, icons and tool tips. The href for these items must be RunCalculate().

versioningsave <menuitem>ver-sioning-save</menuitem>

213


FIX ("Office Products R Us")

CLEARDATA "What If 2";

DATACOPY "Actual" TO " What If 2";

ENDFIX

This script deletes any pre-existing data in the “What If 2” scenario for the “Office Products R Us” entity, then replaces it with the “Actual” data for this entity.

Running Batch Fi les f rom Menu I temsSince the versioning functionality supports executing batch files, it can be used to create a menu item to simply run a batch file. The following code is an example of how to create an xml document that can be used to run a batch file within Clarity:

<cpmcalc>

<text>

<MainTitle text="Run Batch File"/>

</text>

<scriptgroup type="batch" optional="true" caption="Run Batch File - test.bat">

<script name="test.bat"><![CDATA[C:/Temp/Batch/test.bat]]></script>

</scriptgroup>

</cpmcalc>

Where:

• Run Batch File is the title that appears on the top of the page.

• Run Batch File - test.bat is the caption on the page. The user will click a checkbox next to this caption.

• test.bat is the caption that will appear after the batch is run, indicating the status.

• C:/Temp/Batch/test.bat is the full path to the batch file on the application server.

Once the xml document has been configured with batch information and placed somewhere within the ...\Clarity Systems\ClarityServer\Web subdirectory, Versioning parameters can be configured so the batch file can be run from a menu item:

Parameter ValueDocument Type Other

Document Location versioning/versioning.asp?calc=<filename>.xml ***

***Relative to versioning folder

Toolbox Location versioning/versioning.xml

214

The Clarity Detect and Alert feature allows administrators to create a conditional ‘check’ of existing data point(s) in the OLAP database.

When Detect and Alert is enabled, it continually monitors the selected data point(s). If the specified set of data does not match the chosen criteria when the check is performed, an alert is issued via email to notify the appropriate recipient(s).


• Creating an Alert Definition

• Creating a New Alert

Note: Detect and Alert is supported for Essbase only.

Detect and Alert 13

215

D E T E C T A N D A L E R T

216

. . .

. .D E T E C T A N D A L E R TDetect and Alert

D E T E C T A N D A L E R T

Administrators can configure Clarity to perform scheduled checks against predefined criteria, and send alerts via email if the defined criteria is not met, via the Detect and Alert function:

Detect and Alert enables administrators to regularly check data points in the OLAP database to ensure they are within a specified set of criteria. If those criteria are not met by the monitored data points, an alert is issued via email to notify the appropriate recipient(s).

The initial Detect and Alert page lists all alerts by alert name, threshold (the criteria that determines if an alert is sent), and schedule (the date and time the alert runs).

217

D E T E C T A N D A L E R TDetect and Alert

Note: The Detect and Alert is a scheduled feature, which relies on the Clarity Scheduler. If the Clarity Scheduler is not installed or is disabled, the Detect and Alert feature will not work. Refer to the topic, “Clarity Scheduler Configuration” in the Clarity Installation Guide.

Creat ing an Aler t Def in i t ionDetect and Alert Definitions are stored in the following folder on the web server:

...\Clarity Systems\ClarityServer\Web\DandA\AlertDefinitions

Aler t Def in i t ion XML Conf igurat ion

E x a m p l e o f C l a r i t y D e m o . x m l

<?xml version="1.0" ?>

<alertschedule name="addeditalert.xml" provider="Essbase" EBApplication="clarity" EBDatabase="demo" EBServer="localhost" SQLDatabase="CBW">

<frequencies>

<frequency value="1" caption="Daily"/>

<frequency value="2" caption="Monday"/>

<frequency value="3" caption="Tuesday"/>

<frequency value="4" caption="Wednesday"/>

<frequency value="5" caption="Thursday"/>

<frequency value="6" caption="Friday"/>

<frequency value="7" caption="Saturday"/>

<frequency value="8" caption="Sunday"/>

<frequency value="9" caption="Specific Day of Month"/>

</frequencies>

<daysofmonth>

<day value="1"/>

<day value="2"/>

<day value="3"/>

...

<day value="31"/>

</daysofmonth>

218

. . .

.D E T E C T A N D A L E R TDetect and Alert

.

<hours>

<hour value="1"/>

<hour value="2"/>

<hour value="3"/>

...

<hour value="12"/>

</hours>

<minutes>

<minute value="00"/>




...



</minutes>

<text>

<MainTitle text="Detect and Alert"/>

<TreePrompt text="Click icon to select a member ->"/>

</text>

<dimensions>

<group name="For the following data points" show="yes">

<dim view="list" bottomonly="no" show="yes" token="dim1" id="1">

<name><![CDATA[Time]]></name>

<caption><![CDATA[Time]]></caption>

<spec><![CDATA[&CurrMonth]]></spec>

</dim>




<spec><![CDATA[&CurrYear]]></spec>

</dim>




<spec><![CDATA[<child "Variances"]]></spec>

</dim>

219


<dim view="tree" bottomonly="no" show="yes" token="dim4" id="4">

<name><![CDATA[All Products]]></name>

<caption><![CDATA[Products]]></caption>

<spec><![CDATA["All Products"]]></spec>

</dim>

<dim view="tree" bottomonly="no" show="yes" token="dim5" id="5">

<name><![CDATA[Accounts]]></name>

<caption><![CDATA[Accounts]]></caption>

<spec><![CDATA[Accounts]]></spec>

</dim>

<dim view="tree" bottomonly="no" show="yes" token="dim6" id="6" lastdim="true" cascade="true">


<caption><![CDATA[Entity]]></caption>

<spec><![CDATA[<GetFromPageSecurity]]></spec>

</dim>

</group>

</dimensions>

</alertschedule>

220

. . .


Creat ing a New Aler t1. To create a new alert, click on the Add Alert command in the toolbox panel. The Alert

Definition selection dialog box displays:

2. Choose a definition and click OK. The Add/Edit Alert dialog box opens:

• The Alert Name field defines the name of the alert as it is listed on the Detect and Alert page.

• The Schedule fields determines when the system will check the specified data points. The Detect and Alert can be defined to run daily, monthly, or yearly, to a specific minute of the day, as required.

221


• The Data Points parameters define the data points that will be checked by the Detect and Alert. Select members for each dimension listed to create the data point intersection. Use the drop down list to the right-hand side of the dimension field list and select a cascading option if you want the Detect and Alert to check multiple data points at once.

If the Detect and Alert is defined to check multiple data values, an alert will be issued if only one of those values fails the criteria.

• Threshold parameters define the value range that triggers the alert notification email when a value fails a check. Select the check boxes beside the Boolean symbols and type values, as required, in the fields provided.

• The Specify Drill Through Report check box enables an administrator to associate a drill through report with the detect and alert. When defined, the detect and alert will examine the drill through values as well as the summary data point, as specified.

• The Email field defines the email address to which alert notification emails for failed values are sent. Use the drop down list beside the field to specify when the system should send notification emails on a failed check.

3. Choose the parameters required to create the required alert definition.

4. Click OK. Your changes are saved, and the new alert definition appears in a list on the Detect and Alert page.

222

. . .


Edi t an Exist ing Aler t Def in i t ion

1. To edit an existing alert, click the Edit button beside the alert to be changed. The Add/Edit Alert dialog box displays.

2. Edit the parameters to the existing alert definition.

3. Click OK. Your changes are saved, and the alert definition remains in the list on the Detect and Alert page.

223


Delete an Exist ing Aler t Def in i t ion

1. To delete an existing alert, click the Delete button beside the alert to be removed.

2. A confirmation dialog box appears:

3. Click OK to confirm deletion. The selected alert definition is deleted, and you are returned to the Detect and Alert page.

Detect and Aler t XML Conf igurat ion - Folder PathThe config.xml located in the ...\Clarity Systems\ClarityServer\COM\bin folder contains the following attributes to set the Detect and Alert feature folder path:

<detectalert path=“C:\Clarity Systems\Clarity6\Web\DandA\”/>


<detectalert> path The directory path where Detect and Alert definition files reside.

C:\Clarity Sys-tems\Clarity6\Web\DandA\

path=“C:\Clar-ity Sys-tems\Clarity6\Web\DandA\”

224

In order for end users to access Clarity through the web, an ActiveX control must be installed on the client machine.

The Clarity ActiveX control is called CPMActiveX.CBWX, and can be installed automatically or manually, provided the user has appropriate permissions on the machine.

This section contains the following:

• Installing the ActiveX control

• Applying Updates to the ActiveX control

• XML Configuration

ActiveX Control 14

225

A C T I V E X C O N T R O L

226

. . .

. .A C T I V E X C O N T R O LThe ActiveX Control

T H E A C T I V E X C O N T R O L

On occasion it may be necessary to update the ActiveX control with a newer version. Service Packs or Hot Fixes to Clarity may include an updated ActiveX control. In order for Clarity to use the new control, the classid and/or version in the config.xml file must be updated to reference the new control. Once Clarity is updated to use the new control, users will need to sign on again in order to get the new version.

1. Insta l la t ion

1 . 1 A u t o m a t i c D o w n l o a dBy default, Clarity is configured to allow automatic download of the control. The control is packaged as a CAB file (CPMActiveX.CAB) and is placed in the Web folder under the Clarity Systems install folder. The config.xml file, also in the Web folder, contains a reference to the classid and version of the control, and a relative path to the CAB file. When a user accesses Clarity, it detects whether the specified classid and version exists on the user's workstation. If it does not, the user will be informed, and if the user's browser settings allow it, the user will be able to download the control through the browser. Once the control is installed successfully, Clarity will use it without further notifications to the user.

1 . 2 M a n u a l D o w n l o a dIn some cases, clients wish to disallow automatic downloading of the control. This can be done either by removing/renaming the CPMActiveX.CAB file, or by removing the path to the CAB file in config.xml. If this is done, the ActiveX control needs to be installed on each workstation by some other method. The following files should be extracted from the CAB file, and either installed manually on the workstation, or "pushed down" from the server using software designed for this purpose.

CPMActiveX.OCX

XCeedBen.dll

XCeedSco.dll

XceedCry.dll

These files need to be copied to the workstation, then registered using the regsvr32 command. The files do not need to go into a specific location on the workstation.

227

A C T I V E X C O N T R O LThe ActiveX Control

2. Apply ing Updates to the Act iveX Contro l

2 . 1 A u t o m a t i c D o w n l o a dIf Clarity is configured to allow automatic download of the control, the updates to CPMActiveX.CAB and config.xml on the server are all that is required. Users will be informed of the new control the next time they access Clarity, and can download it through the browser.

2 . 2 M a n u a l D o w n l o a dIf the control is being installed manually or through push-down software, and the target machine already has a version of the control installed, generally only the updated CPMActiveX.OCX file needs to be reinstalled. The current file should be unregistered using the regsvr32 command with the -u option, then the new file (which can be extracted from the updated CAB file) should be copied to each workstation, and reregistered using the regsvr32 command.

2 . 3 T e s t i n g a n U p d a t e o n a S i n g l e W o r k s t a t i o nIf the classid of the updated control is the same as the one currently being used, it is possible for a workstation to use the updated control, without modifying Clarity (and thereby forcing all users to upgrade to the new control.) If the control was previously installed manually (not through automatic download) then the new control can be installed using the steps in 2.2. If the control was previously installed through automatic download, it should be removed from Downloaded Program Files, then installed using the steps in 1.2.

If the classid of the updated control is different from the one currently being used, testing on a single workstation is more difficult. It can be done by making a copy of the Clarity Systems\web folder, creating a Virtual Directory for this folder in IIS Manager, and updating the copy to contain the new CAB file and references to the new classid and version in config.xml. The control can be installed manually on a workstation, and tested by accessing the new virtual directory instead of the current one.

228

. . .

.A C T I V E X C O N T R O LThe ActiveX Control

.

A c t i v e X X M L C o n f i g u r a t i o nThe attributes for the ActiveX Control are found in the \web\config.xml file.

The ‘classid’ and ‘codebase’ attributes of the ‘cbwactivexhelper’ node, within the config.xml file, are used to configure the current version of the Clarity ActiveX Control:

<cbwactivexhelper enabled=“true” encryption=“true” compression=“none”> <control id=“CBWX”>

<classid>B68C8128-7193-40F7-A21F-FFD8B51FDE75</classid> <codebase>CPMActiveX.CAB#version=6,0,0,0</codebase>

</control> </cbwactivexhelper>


<cbwactivex-helper>

enabled Indicates if the Clarity Active X helper is enabled or disabled. This value should always be true.

true cbwactivex-helper enabled=“true”

encryption Indicates whether passwords entered on the login screen will be encrypted when sent to the server for authentica-tion.

truefalse

encryp-tion=“true”

compression Indicates the level of com-pression used when send-ing/receiving certain calls to the server. A high level of compression may increase performance on these calls.

none, h, m, l,0-9

compres-sion=“none”

<control id> Identifier by which the Active X Control is accessed.

CBWX(Do not change)

control id=“CBWX”

<classid> Auto-generated unique iden-tifier for the control. This must match the identifier of the compiled control.

classid>B68C8128-7193-40F7-A21F-FFD8B51FDE75</classid>

<codebase> Location and version of the compiled control, used for automatic download.

<code-base>CPMAc-tiveX.CAB#version=6,0,0,0</codebase>

229

A C T I V E X C O N T R O LThe ActiveX Control

230

A license key is a string provided by Clarity Systems that the application uses to determine the maximum number of registered users.

If an upgraded license key is required to accommodate more end users, contact Clarity Systems at (877) 410-5070.

This section provides information regarding the tasks and procedures required to install a Clarity license key and to replace an existing Clarity license key with a new license key.

License Keys 15

231

L I C E N S E K E Y S

232

. . .

. .L I C E N S E K E Y SAdministrating License Keys

A D M I N I S T R A T I N G L I C E N S E K E Y S

Insta l l ing the L icense KeyThe Clarity license key string is stored in the config.xml file which is located in the …\Clarity Systems\ClarityServer\COM\Bin folder on the web server.

Use Notepad to open the config.xml file and insert the Clarity license key string between the open (<maxusers>) and close (</maxusers>) tags.

S e r v e r L i c e n s e - X M L C o n f i g u r a t i o nThe following attributes control aspects of the Clarity Server license:

<license> <maxusers>DJWI2qnjJwk299D9j2DDi922BDJDIWNJ2210</maxusers>

</license>

Node Attribute Description Possible Vaues Example

<license>

<maxusers> The Clarity license key assigned to the specific instance of Clarity. The key defines the maximum number of users that can be logged on to the web interface at a given time.

(a valid licence key)

<maxus-ers>DJWI2qnjJwk299D9j2DDi922BDJDIWNJ2210</maxusers>

233

L I C E N S E K E Y SAdministrating License Keys

Replacing the L icense Key to Accommodate More End UsersWhen the number of end users logged on to the web interface exceeds the number of end users allowed by your instance of Clarity, the License Violation dialog will appear to all users logged on to the system:

U p d a t i n g t h e C l a r i t y L i c e n s e K e y

1. Open the text file containing the new license key. The key is a string of alphanumeric characters:

Note: Ensure that Word Wrap has been enabled so the entire string is displayed in the Notepad window or type Ctrl-A to select the entire contents.

2. Select the string, right-click on the highlighted area, and select Copy from the menu. The text is sent to the system clipboard.

234

. . .

.L I C E N S E K E Y SAdministrating License Keys

.

3. Use Notepad to open the config.xml file which is stored in the …\Clarity Systems\ClarityServer\COM\Bin folder on the web server:

4. Locate the <maxuser> attribute via Edit>Find. The old key exists between the open (<maxusers>) and close (</maxusers>) tags:

<maxusers>DJWI2qnjJwk299D9j2DDi922BDJDIWNJ2210</maxusers>

5. Select the old string, right-click on the highlighted area, and select Paste from the menu. The old string is replaced with the new string you copied in Step 2 above.

6. Save and close the XML file. The system automatically updates to accommodate more end users based on the specifications of the new license key. Once upgraded, the License Violation dialog will no longer appear.

235

L I C E N S E K E Y SAdministrating License Keys

236

Clarity can be configured to support multiple languages. When a user logs in to Clarity or uses a report, Clarity displays information in the user’s language of choice.

Note: Clarity 6.1 and higher support localization for Essbase 7 and greater.


• Understanding Localization

• Configuring Language Localization

Language Localization 16

237

L A N G U A G E L O C A L I Z A T I O N

238

. . .

. .L A N G U A G E L O C A L I Z A T I O NUnderstanding Localization

U N D E R S T A N D I N G L O C A L I Z A T I O N

Clar i ty EnvironmentClarity supports the use of multiple languages for end users. Clarity can be configured so that a user can select the language of their choice, or to explicitly use one particular language.

When the user is allowed to optionally select the language, a drop down menu appears in the Clarity login page:

Based upon user selection, the login page updates dynamically in the selected language:

239

L A N G U A G E L O C A L I Z A T I O NUnderstanding Localization

To provide a uniform language experience, menus, reports and text must be configured in Clarity to display the language of the end user. Clarity currently supports the following languages:

• English (en-US)

• French (fr-FR)

• German (de-DE)

• Japanese (ja-JP)

• Spanish (es-ES)

Note: To provide a uniform language to the end user, custom-built reports, custom menus or features need to include translations for each language used. Any text entered by the user in Clarity is not translated.

Essbase EnvironmentIn Essbase, alias tables can be set up to provide language translation of member names into other languages. Clarity can leverage these tables to provide member names in any language that is available in the Essbase alias tables.

Note: If a language translation is not available for a given member, by default Clarity will retrieve the original member name from the alias tables.

Windows EnvironmentOn the client machine, the Microsoft Language Toolkit must be installed. See the “Configure MS-Windows on Client Machine for Language Localization” topic in the Clarity Installation Guide.

240

. . .

.L A N G U A G E L O C A L I Z A T I O NConfiguring Language Localization

.

C O N F I G U R I N G L A N G U A G E L O C A L I Z A T I O N

To implement language localization for end users, the following configurations are performed:

• Localization XML Configuration

• Menu Security Configuration for Localization

• Create or Update Templates and Reports with Localization

Local izat ion XML Conf igurat ionThe following attributes in the ...Web\Config.xml file control language localization of Clarity:

<localization>

<hide_language_selection>true</hide_language_selection>

<force_default_culturecode>true</force_default_culturecode>

<default_culturecode>en-US</default_culturecode>

</localization>


<locali-zation>

<hide_language_selection>

Indicates if language selection is hidden from the user, or if it is available in the web interface.

If false, the user can choose their language. If true, the user cannot select a language.

TrueFalse

<hide_language_selection> true</hide_language_selection>

241

L A N G U A G E L O C A L I Z A T I O NConfiguring Language Localization

Menu Secur i ty Conf igurat ion for Local izat ionTo define localization for a menu item, perform the following steps:

1. Sign in as the Administrator.

<force_default_culturecode>

Determines the default language that all Clarity users must use.

Note: This setting only applies if the <hide_language_selection> attribute is set to true.

TrueFalse

<force_default_culturecode>true</force_default_culturecode>

<default_culturecode>

If no other language is selected by the user, then the default language is used.

Note: This setting only applies if the <hide_language_selection> attribute is set to true.

Any valid culturecode

English - US : en-US

French - France:fr-FR

German - Germany:de-DE

Japanese - Japan:ja-JP

Spanish - Spain:es-ES

<default_culturecode>en-US </default_culturecode>


242

. . .

. .L A N G U A G E L O C A L I Z A T I O NConfiguring Language Localization

2. From the menu, choose Administration > Security Services > Menu Administration. The Menu Administration page appears:

• This page allows the administrator to define aspects of user security, including what language(s) are displayed for the menu item.

243


3. To define the language(s) that are displayed for a menu item in Clarity, choose the Edit Menu Details icon next to the item. The Edit Menu Details dialog will appear:

• This page allows the administrator to enter languages for Captions and Tooltips of each menu or menu item.

244

. . .

. .L A N G U A G E L O C A L I Z A T I O NConfiguring Language Localization

• The Enter Country/Regional Caption icon allows an administrator to define the language displayed for the menu or menu item:

• The Enter Country/Regional Tooltips icon allows an administrator to define the language displayed when a user drags the mouse over the menu item:

Note: To add tooltips, a Caption must already exist for the menu or menu item. A tooltip will appear in the Enter Country/Regional Tooltips dialog only if a caption is available for the language in the Manage Regional Captions dialog.

For further reference on configuring security services settings, see “Menu Administration” on page -81 of this guide.

245


Create or Update Templates and ReportsFor more information on how to create templates and reports that utilize localization, refer to the Template Builder Administration Guide.

246

XML files store the properties and drive the functionality of most features in Clarity.

This section contains a general overview of how to configure and work with XML files. Specific syntax and parameters for XML commands can be found in the relevant sections of the Administration Guide.

Included in this section is an overview of:

• General XML structure

• Modifying XML files

• Config.xml file location

• Clarity features controlled by configuring XML file attributes

XML File Overview 17

247

X M L F I L E O V E R V I E W

248

. . .

. .X M L F I L E O V E R V I E WWorking with XML Configuration Files

W O R K I N G W I T H X M L C O N F I G U R A T I O N F I L E S

XML Fi les Used by Clar i tySome Clarity functionality is controlled by settings in text files that reside in folders on the Clarity Web and Application Servers. These text files contain data and parameters in Extensible Markup Language (XML) format. These files can be modified manually to configure certain Clarity features and to customize an implementation to meet the client’s needs and data storage requirements.

Changes can be made in various places within the XML files, to affect or enable certain functions within Clarity. However, it is important to understand the structure of these files, as making changes incorrectly may cause these functions to stop working completely. The basic structure of XML is described below, and the specific structure of each XML file is described in detail in the relevant section(s) of each Administration Guide.

XML StructureThe specifications for XML are quite detailed, and incorporate a rich set of functionality. For the purposes of the Clarity configuration files, only a small subset of this functionality is used, and can be described with the following examples and rules:

A node is text enclosed between a start tag and an end tag, with an arbitrary name:

<myNode>this is some text</myNode>

The text is optional:

<myNode></myNode>

A node may contain another node:

<myNode><myNestedNode>text of the nested node</myNestedNode></myNode>

When a node contains no text or nested nodes, the end tag may be omitted, and a slash added to the start tag instead:

<myNode/>

A node may contain one or more attributes of the form name=“value”:

<myNode name1=“value1” name2=“value2”/>

Text that contains special characters or white space to be preserved, a CDATA section is used:

249

X M L F I L E O V E R V I E WWorking with XML Configuration Files

<myNode><![CDATA[ This text has “space” around it ]]></myNode>

Except within CDATA sections, the following characters cannot be used directly and can be achieved by using their corresponding escaped values:

Names of nodes and attributes cannot contain spaces. A node cannot have two attributes with the same name, except within CDATA sections, extraneous white space (such as carriage returns) is ignored.

Modi fy ing XML Fi lesLocate the XML file containing the configuration setting to be changed, and open in a text editor. Scroll or use the search capability of the editor to find the section to be modified. Remove the old value and type in the new value. Save the file in the same location and close the editor.

Depending on the configuration settings changed, the browser may need refreshing and/or a service such as IIS, or an application in Component Services, may need to be restarted, in order for the new settings to take effect.

Notes:

• Make a backup copy of the file before making significant changes. If the changes cause any undesirable behavior, replace the backup copy while you make modification.

• It is recommended that a basic text editor such as Notepad.exe is used to modify XML files. Other editors may add automatic formatting such as spaces or “smart” quotes, that may invalidate the XML structure. Also, some XML files (such as template definition files) may contain non-ASCII text, which may be inadvertently modified by some editors.

• Be careful not to add or remove characters that are needed for the XML structure to be valid, such as quotes and angled brackets. After saving changes to the XML file, you can verify that the structure is valid by opening the file in Internet Explorer, which will display the contents or any errors.

Be careful not to delete nodes or attributes that may be needed by the Clarity application. Node and attribute names, and in many cases attribute values, are case sensitive. Ensure that the appropriate case is used, or the Clarity application may not recognize the parameters needed.

Character < > “ ’ &

Use instead < > " ' &

250

. . .

.X M L F I L E O V E R V I E WServer Configuration Files (Web and Application Config)

.

S E R V E R C O N F I G U R A T I O N F I L E S ( W E B A N D A P P L I C A T I O N C O N F I G )

The Web Server and Application Server both contain a file named config.xml. These files control the configuration of various Clarity features and functionality relating to each respective server. Although the files have identical names, they contain different attributes as applicable to each server.

Web Server Conf igurat ion F i leThe Web Server config.xml file resides on the Web Server in the following folder: ...\Clarity Systems\ClarityServer\Web.

The following Clarity features are controlled by the configuration attributes of this file:

• Web interface menu bar

• Web interface log on page

• Security Services

• Workflow

• The Office Web Component and the web interface display grid

• Clarity Active X Control

• Clarity Audit Trail

• Report Books

• Visualizer

• Clarity server-to-server communication

251

X M L F I L E O V E R V I E WServer Configuration Files (Web and Application Config)

Appl icat ion Server Conf igurat ion F i leThe Application Server config.xml file resides on the Application Server in the following folder: ...\Clarity Systems\ClarityServer\COM\bin.

The following Clarity features are controlled by the configuration attributes of this file:

• Report Books

• Detect and Alert directory path

• Proxy user

• Calculations

• Clarity Audit Trail directory path

• Email attachments

• Server license

• Relational database connections

252

Clarity ships with standard database indexes on necessary tables. Due to the flexibility of Clarity functionality, data records will increase over time as the application is used. The database indexes should be reviewed periodically to ensure database performance is acceptable.

Table Column Data Type Description

ActivityTrackingLog

sessionId varchar(50) Session ID of the user.

activityId int ID of the activity created by user under the session.

username varchar(100) Name of the end user.

applicationid int ID of the application.

moduleId int ID of the module.

functionalityId int ID of the functionality which is attached to the page.

program varchar(100)

action varchar(20) Action of the users: Add/ Delete/ Mod-ify/ Open

actiondetails varchar(4000) User friendly message of the user action such as “User xyz was deleted.”

serverIPAddress varchar(20) IP address of the server.

clientIPAddress varchar(20) IP address of the client.

ActivityDate datetime Date and time of the activity.

Application

ApplicationID int ID of the application.

FunctionalityId int ID of the functionality which is attached to the page.

ModuleId int ID of the module.

ApplicationName varchar(50) Name of the application such as Clarity Server, Template Builder, Consolida-tion and Batch Job.

CellIntersections Intersection points for Line Item Details.

ER Diagrams 18

253

E R D I A G R A M S

cellIntersectionId int(4) Primary key (autogenerated)

cubeId int(4) Foreign key to the Cubes table

cellIntesectionText char(240) Not currently used

dim1 varchar(300) member in first dimension of cube

dim2 varchar(300) member in second dimension of cube

dim3 varchar(300) member in third dimension of cube

dim4 varchar(300) member in fourth dimension of cube

dim5 varchar(300) member in fifth dimension of cube

dim6 varchar(300) member in sixth dimension of cube

dim7 varchar(300) member in seventh dimension of cube

dim8 varchar(300) member in eight dimension of cube

dim9 varchar(300) member in ninth dimension of cube

dim10 varchar(300) member in tenth dimension of cube

dim11 varchar(300) member in eleventh dimension of cube

dim12 varchar(300) member in twelth dimension of cube

dim13 varchar(300) member in thirteenth dimension of cube

dim14 varchar(300) member in fourteenth dimension of cube

oldid int(4) used when copying line item details

Cubes List of OLAP databases/cubes used in the application.

cubeId int(4) The id of the cube.

serverIPName varchar(150) The server IP name.

serverDNSName varchar(150) The server DNS name.

appName varchar(150) The application name.

cubeName varchar(150) The cube name.

provider varchar(30) "The provider, either Essbase or AnalysisServices2k."

alias varchar(50) A unique string to associate to the cube.

WritebackTableName varchar(100) Not currently used

DefaultOptions Options set by 'Set As Default' in the Clarity Options box.

user_name varchar(30) The username.

template_name varchar(100) The name of the template.


254

. . .

. .E R D I A G R A M S

options varchar(1000) The options to default to.

DetectAlertSchedule Detect and Alert information.

alert_id smallint(2) The ID of the alert.

alert_name varchar(80) The name of the alert.

config_file varchar(80) Which alert definiton you are using.

drillthrough_report varchar(80) The Drill Through Report.

lessthan float(8) The less than condition for the thresh-old.

greaterthan float(8) The greater than condition for the threshold.

schedule_frequency varchar(50) When to run the the schedule.

schedule_day smallint(2) If schedule_frequency is 'Specific Day of the Month' then this specifies the day.

schedule_time varchar(10) The time for the schedule to run.

notification_email varchar(100) Email address of the users to whom an alert should be sent if detected.

send_frequency smallint(2) The amount of times to send ('Always Send' or 'Send Once')

email_sent smallint(2) Indication for if the email has been sent to the users.

user_name varchar(25) The Username of the user who created the alert.

password varchar(50) The Password of the user who created the alert (decrypted)

cascade_option smallint(2) The Cascading option for the data points.

dim1 varchar(50) The member for the first dimension of the data points.

dim2 varchar(50) The member for the second dimension of the data points.

dim3 varchar(50) The member for the third dimension of the data points.

dim4 varchar(50) The member for the fourth dimension of the data points.

dim5 varchar(50) The member for the fifth dimension of the data points.

dim6 varchar(50) The member for the sixth dimension of the data points.

dim7 varchar(50) The member for the seventh dimension of the data points.


255

E R D I A G R A M S

dim8 varchar(50) The member for the eighth dimension of the data points.

dim9 varchar(50) The member for the ninth dimension of the data points.

dim10 varchar(50) The member for the tenth dimension of the data points.

dim11 varchar(50) The member for the eleventh dimension of the data points.

dim12 varchar(50) The member for the twelfth dimension of the data points.

dim13 varchar(50) The member for the thirteenth dimen-sion of the data points.

dim14 varchar(50) The member for the fourteenth dimen-sion of the data points.

dim15 varchar(50) The member for the fifteenth dimension of the data points.

Dimensions List of dimensions that correspond to the cubes in the Cubes table

dimensionId varchar(5) An id for the dimension. (i.e dim1 or dim4)

cubeId int(4) The id of the cube.

dimensionName varchar(150) The dimension name.

WorkFlowEnabled int(4) 1 if workflow is enabled and 0 if work-flow is disabled.

HierarchySecurityEn-abled

int(4) 1 if hierarchy security is enabled and 0 if workflow is disabled.

DefaultStartMember varchar(80) The member of the dimension to start at. (for the tree view)

WritebackTa-bleColumnName

varchar(100) Not currently used

DrillThrough This is only used by a demo report.

Division varchar(10)

AcctType char(3)

AcctNo varchar(10)

AcctName varchar(30)

InvNo char(10)

EntNo char(3)

EntName varchar(50)


256

. . .

.E R D I A G R A M S

.

InvYear char(5)

InvMth char(3)

InvDay int(4)

InvAmount float(8)

Scenario varchar(50)

ErrorLog Not currently used.

ErrorNumber int(4)

Description varchar(1000)

Source varchar(500)

FunctionCall varchar(1000)

ErrorDate datetime(8)

FileTypes Used by reportbooks

file_type_id int(4) The ID of the file type.

file_type_description varchar(50) The Description of the file type

file_type_extension char(3) The extension of the file type.

Form Used by Compliance form in Workflow

FormID int(4) Id of Form

FormNameID int(4) foreign key to FormName table

FormSectionID int(4) foreign key to FormSection table

SectionOrder int(4) number to denote order of the sections with the form

FormAnswers Used by Compliance form in Workflow

FormAnswerID int(4) Id for FormAnswers

FormName varchar(255) Description for Form Name

UserID varchar(500) User Name of person submitting the form

CostCenterID int(4) Foreign Key to WorkflowCostCentre table

PageOptions varchar(500) PageOptions for which workflow was submitted/approved

FormSectionId int(4) foreign key to FormSection table

FormQuestionId int(4) foreign key to FormQuestion table


257

E R D I A G R A M S

Answer varchar(1000) Decription for Answer

DateStamp varchar(20) DateTimeStamp

FormName Used by Compliance form in Workflow

FormNameID int(4) ID For FormName

FormName varchar(255) Name for the Form

FormQuestion Used by Compliance form in Workflow

FormQuestionID int(4) ID for Question

QuestionText varchar(255) Text of Question

FormQuestionTypeID int(4) Foreign Key to FormQuestionType table

FormQuestionType Used by Compliance form in Workflow

FormQuestionTypeID int(4) ID for FormQuestionType

question_type varchar(20) Code for question type

question_type_desc varchar(255) Description for question type

active_ind bit(1)

Forms Used by Compliance form in Workflow

FormsID int(4) Id for Forms table

FormID int(4) Foreign Key to Form table

cubeID int(4) Foreign Key to Cubes Table

FormSection Used by Compliance form in Workflow

FormSectionID int(4) Id For Form Section

FormSectionHeaderID int(4) Foreign Key to FormSectionHeader table

FormQuestionID int(4) foreign key to FormQuestion table

QuestionOrder int(4) Integer to denote Order of questions

Validated int(4) Not used

ValidationValue varchar(255) Not used

FormSectionHeader Used by Compliance form in Workflow

FormSectionHeaderID int(4) Id for Form Section Header

SectionHeaderText varchar(255) text for form section header


258

. . .


Functionalities

FunctionalityName varchar(50) Name of the functionality in the module. (For example, “Manage User” or “Man-age Roles” under the Security Services module.)

FunctionalityAdmin-Name

varchar(100)

action varchar(100) Action of the users: Add/ Delete/ Mod-ify/ Open.

moduleId int ID of the module.

IsTrackingEnable char(2) “Y/N” indicates that activity tracking is enabled/disabled.

LineItemDetail Data for Line Item Details.

lineItemDetailId int(4) Identity column

cellIntersectionId int(4) ID of cell intersection

description text(16) Description of Line Item detail

lineItemValue float(8) Value of line item detail

lineItemFormula varchar(4000) Formula of line item detail (if formula was entered in the LID screen)

sortOrder smallint(2) Order the LID should be displayed in the LID screen

userName varchar(50) name of user who entered the LID

dateStamp varchar(50) date the LID was added

MemberAccessTypes "Static list of OLAP Access Types: Read, Write, No Access."

MemberAccessTy-peID

int(4) The id of the Member Access Type.

MemberAccessType-Description

varchar(100) The description of the Member Access Type.

MemberSpecTypes "Static list of OLAP Spec Types: Single-Member, Idescendants, Children, etc."

MemberSpecTypeID int(4) The id of the Member Spec Type.

MemberSpecType varchar(100) The name of the Member Spec Type.

TreeEnabled int(4) "1 if the member spec type is supported by the Clarity Tree View, 0 otherwise."


259

E R D I A G R A M S

Menu Contains a listing of all menu items con-tianed in Clarity

MenuID numeric(9) The id of the menu item.

ParentFolder numeric(9) The id of the parent of the menu item. (0 = top level item)

Caption varchar(100) The caption of the menu item.

DocumentType varchar(20) The type of document that the menu item is.

Type varchar(50) The type of the menu item. (either a file or a folder)

DynamicBuild varchar(5) "true if the folder should be dynamically built, false otherwise."

DynamicFolder varchar(300) "If DynamicBuild = true, this is the location of the folder to generate dynamically."

Enabled varchar(5) "true if the item is enabled, false other-wise."

Image varchar(300) The image to display for the menu item.

Toolbar varchar(300) The toolbar for the menu item.

ToolTip varchar(300) The tooltip or text to show when you hover over the menu item.

HREF varchar(300) The location of the file that the menu item corresponds to.

WindowAction varchar(50) "The action the window is to perform. (either singe, mutiple or prompt)"

SortOrder numeric(9) A numerical value used to sort the menu item.

MENUKEY nvarchar(120) Key to map with Menu caption table

MenuSecurity Security for Menu Items. (Holds who has access to which menu items)

MenuSecurityID numeric(9) The id of the menu security item.

MenuID numeric(9) The id of the menu item (from the Menu table)

EntityID varchar(100) The id of the role or user (from Users or Roles table)

IsRole int(4) "1 if the entityid is a role, 0 if the entit-yid is a user."

AddedOn datetime(8) The date that the data was added.


260

. . .


Modules

ModuleId int ID of the modules.

ModuleName varchar(50) Name of the application such as Tem-plate, Report, Workflow or Security Services.

applicationId int ID of the application.

NoteList Intersection points for Cell Notes.

noteId int(4) Identity column

cubeId int(4) Foreign key to the Cubes table

dim1 varchar(300) member in first dimension of cube

dim2 varchar(300) member in second dimension of cube

dim3 varchar(300) member in third dimension of cube

dim4 varchar(300) member in fourth dimension of cube

dim5 varchar(300) member in fifth dimension of cube

dim6 varchar(300) member in sixth dimension of cube

dim7 varchar(300) member in seventh dimension of cube

dim8 varchar(300) member in eight dimension of cube

dim9 varchar(300) member in ninth dimension of cube

dim10 varchar(300) member in tenth dimension of cube

dim11 varchar(300) member in eleventh dimension of cube

dim12 varchar(300) member in twelth dimension of cube

dim13 varchar(300) member in thirteenth dimension of cube

dim14 varchar(300) member in fourteenth dimension of cube

oldid int(4) used when copying cell notes

Notes Data for Cell Notes.

noteLineId int(4) ID of note

noteId int(4) foreign key to NoteList table

note text(16) text of note - what data type is this?

hasFile bit(1) indicates whether this note has an attachment

filePath varchar(2000) "path to attachment, if applicable"

fileName varchar(256) "name of attachment, if applicable"

userName varchar(50) user who last updated this note


261

E R D I A G R A M S

dateStamp varchar(50) date/time of last update

OlapAuditTrail

OlapLogId int identity Identity column

CellId int Foreign key to OLAP cell table

TemplateLogId bigint Foreign key to Template Audit Trail table

CubeId int ID of cube from cube table

CellValue float Value of cell data

DateStamp varchar(50) Date/time of creation

Username varchar(100) User who inserted data

SessionID varchar(50) SessionID from Activity Tracking Log table

ActivityID int ActivityID from Activity Tracking Log table

OLAPCELLS

CUBEID int CubeID form cube table

CELLID int Identity column

CELLTEXT varchar(240) Not currently used

DIM1 varchar(250) member in first dimension of cube

DIM2 varchar(250) member in second dimension of cube

DIM3 varchar(250) member in third dimension of cube

DIM4 varchar(250) member in fourth dimension of cube

DIM5 varchar(250) member in fifth dimension of cube

DIM6 varchar(250) member in sixth dimension of cube

DIM7 varchar(250) member in seventh dimension of cube

DIM8 varchar(250) member in eight dimension of cube

DIM9 varchar(250) member in ninth dimension of cube

DIM10 varchar(250) member in tenth dimension of cube

DIM11 varchar(250) member in eleventh dimension of cube

DIM12 varchar(250) member in twelth dimension of cube

DIM13 varchar(250) member in thirteenth dimension of cube

DIM14 varchar(250) member in fourteenth dimension of cube


262

. . .


OnlineHelp Not currently used.

help_file varchar(100)

help_text text(16)

ReportBook All successfully run reportbooks' details are stored here

report_id int(4) Id For ReportBook

cube_id int(4) Foreign Key to Cubes Table

report_book_name varchar(500) Name of Report Book

template_id smallint(2) Template or Report ID

template_name varchar(100) Template or Report Name

page_options text(16) selected PageOptions xml for the report

physical_file_path varchar(500) file path to report generated

virtual_file_path varchar(500) Url to report generated

file_type varchar(50) "File type - Excel, pdf etc"

file_size int(4) size of file generated

run_date varchar(50) Date reportbook was run

run_user varchar(30) User Name who ran the reportbook

ReportBookPageOp-tions

The Page Options for Report Books

report_id int(4) The ID of the report

dimension varchar(80) The dimension of the page option

member varchar(80) The member of the dimension selected.

securityenabled smallint(2) Whether security is enabled.

alias varchar(500) The alias of the member.

securityProfile smallint(2) "0 if security is not enabled, otherwise the id of the associated profile"

ReportBookSchedule All Scheduled Report Books' details are stored here

schedule_id smallint(2) Id for schedule

schedule_name varchar(50) Name for the report book schedule

report_book varchar(100) Name of Report Book

schedule_frequency varchar(50) Frequency of Reportbook schedule

schedule_day smallint(2) Day of Reportbook schedule


263

E R D I A G R A M S

schedule_time varchar(10) Time of Reportbook schedule

file_type_id int(4) Foreign key to File_Type Table

printer_name varchar(100) Printer Name

notification_email varchar(255) Email address of user to be emailed after report book is complete

user_name varchar(25) Name of user who created the schedule

password varchar(255) Password of user who created the sched-ule

merge varchar(5) Merge all files - true or false

keepfiles varchar(5) Keep all temporary files - true or false

sort varchar(5) Sort all pages - true or false

toc varchar(5) Generate TOC - true or false

cbw_module varchar(128) Module name - type of schedule

distribution_email varchar(255) Email of user(s) to be notified with report attached after reportbook is com-plete

Roles A Clarity role is a collection of users grouped teogether logically

RoleID numeric(9) A numerical id for the role.

RoleName varchar(100) The name of the Role.

Description varchar(200) A Description for the Role.

Enabled int(4) "1 if the role is enable, 0 otherwise."


Systemrole int(4) "1 if the role is a system role (cannot be deleted), 0 otherwise."

HOMEPAGE int

ScenarioSecurity User and role access to security profiles

ScenarioSecurityID numeric(9) A numerical id for the security

ScenarioID numeric(9) The id of the security profile.





264

. . .


Schedule list of dates that have comments associ-ated with them

ScheduleId int(4) numerical id for the date

ScheduleDate varchar(20) the date

secGroupTem-plateAccess

Not currently used.

group_name varchar(25) Name of group

template_id smallint(2) Identity column

secTemplateList Deprecated


template_name varchar(100) Name of template

global_access bit(1) Type of access

disabled bit(1) Enable/disable

Description varchar(500) Type of document

DocumentType varchar(50) Enable/disable hierarchy security for template

HierarchySecurityEn-abled

bit(1)

SecurityProfile A listing of Hierarchy Security permis-sioins

PermissionID int(4) The id of the hiearchy security informa-tion.

Entity varchar(30) "The entity to assign the hierarchy secu-rity to. (If numeric then it is a role, oth-erwise it is a user)"

CubeID int(4) The id of the cube to assign permission to.

Member varchar(80) The member to assign the permission to.

DimensionID varchar(10) The id of the dimension to assign the permission to.

SecurityScenarioID numeric(9) The id of the security profile.

MemberAccessTy-peID

int(4) The id of the Member Access Type.

MemberSpecTypeID int(4) The id of the Member Spec Type.



265

E R D I A G R A M S

SecurityScenarios A Security Profile is a logical grouping of Hiearchy Security Permissions

SecurityScenarioID numeric(9) The id of the security profile.

SecurityScenarioN-ame

varchar(100) The name of the security profile.

SecurityScenarioDe-scription

varchar(500) The description of the security profile.

SecurityScenarioEna-bled

int(4) "1 if the security profile is enabled, 0 otherwise."


secUserTemplateAc-cess

Not currently used.

user_name varchar(25) Name of user


TaskList List of comments that appears on default Clarity home page.

TaskId int(4) id for the comment

ScheduleId int(4) foreign key to the Schedule table

Message text(16) text of the comment

UserName varchar(25) user who created the comment

GlobalMessage bit(1) "1 if the comment is global, 0 other-wise"

TBCATEGORY-CAPTIONS

Localized captions for toolbox catego-ries

TBCATEGORYCAP-TIONSID

int Primary key for this table

TOOLBOXCATEGO-RYID

nvarchar (150) Foreign key to ToolboxCategory table

CULTUREID numeric (18,0) Foreign key to CULTURE table

CAPTION nvarchar (300) The localization caption

tblCapital Used by demo templates only.

Options varchar(400)

ItemName varchar(50)

Description varchar(200)


266

. . .


Amount money(8)

Category varchar(50)

Priority varchar(2)

Justification varchar(200)

Discretionary varchar(20)

ApprovalStatus varchar(20)

TimePeriod varchar(20)

Alloc1 float(8)

Alloc2 float(8)

Alloc3 float(8)

Alloc4 float(8)

Alloc5 float(8)

Alloc6 float(8)

tblCapitalCategories Used by demo templates only.

CategoryId numeric(9)

CategoryDesc varchar(50)

DepreciationMethod varchar(20)

UsefulLife int(4)

BookDepreciation-Rate

numeric(9)

TaxDepreciationRate numeric(9)

tblHR Used by demo templates only.

Template varchar(100)

Options varchar(200)

LastName varchar(100)

FirstName varchar(100)

Position varchar(50)

JobCategory varchar(50)

Salary float(8)

Benefits float(8)

Bonus float(8)

Car float(8)

StartDate char(10)


267

E R D I A G R A M S

EndDate char(10)

NextIncrease float(8)

EffectiveDate char(10)

SUI float(8)

FUI float(8)

FICA float(8)

tblNotes Stores Template Notes.

Template varchar(100) The name of the template.

Options varchar(200) A set of page options for the template

Notes ntext(16) Notes entered for this template with these page options

tblSalary Used by demo templates only.

salarygrade varchar(53)

minsalary money(8)

midsalary money(8)

maxsalary money(8)

MeritIncrease numeric(9)

Bonus numeric(9)

fiscalYear varchar(20)

TemplateAuditTrail

TemplateLogId int identity Identity column

TemplateName nvarchar(150) Name of template

PageOptions nvarchar(2000) Selected page options

Filename varchar(50) Name of Template Audit file

IsOlapUpdated char(1) Not currently used

DateStamp varchar(50) Date/time of creation/insert

Username varchar(100) Name of user who modified template

SessionID varchar(50) SessionID from Activity Tracking Log table

ActivityID int ActivityID from Activity Tracking Log table

CompressionLevel char(1) Compression level of data saved on file


268

. . .


ToolboxCategory static list of headings for items in the Clarity Toolbox

CategoryID varchar(50) The id of the category.

CategoryDescription varchar(100) The description of the category.

CategoryOrder int(4) A numeric value for the order of the cat-egory to display.

ToolboxItems Items that may appear in the Clarity Toolbox.

ToolID varchar(50) The id of the toolbox item.

CategoryID varchar(50) The id of the category that the toolbox item should belong to.

Caption varchar(50) The caption of the toolbox item.

ToolTip varchar(200) The text to display when you hover over the toolbox item.

image varchar(100) The image to display for the toolbox item.

href varchar(200) The location or function to call when clicking on the toolbox item.

enabled varchar(20) "1 if the toolbox item is enabled, 0 oth-erwise."

ToolOrder int(4) A numeric value for the order of the toolbox item to display.

CBWmodule varchar(50) The module that the toolbox item belongs to.

StandardCBWFunc-tion

char(3) "yes if the toolbox item is a standard function, no otherwise."

OLAPToolOrder int(4) not used

RelationalToolOrder int(4) not used

defaultSaveMethod int(4) "1 if the href should be called as the default save method, 0 otherwise."

UserRoles Relationships and permissions between users and roles or roles and roles.

UserRoleID numeric(9) The id of the user/role relationship.


RoleID numeric(9) The id of the role (from Roles table)


269

E R D I A G R A M S


AssignRole int(4) "1 if the entity can assign users to the role, 0 otherwise."

AdministrateRole int(4) "1 if the entity can administrate the role, 0 otherwise."

BelongsToRole int(4) "1 if the entity belongs to the role, 0 oth-erwise."


UserRoles_Cache Flat list of the relationships and permis-sions between users and roles (including inheritance).

UserId varchar(100) The id of the user (from Users table)

RoleID decimal(9) The id of the role (from Roles table)

AssignRole int(4) "1 if the user can assign users to the role, 0 otherwise."

AdministrateRole int(4) "1 if the user can administrate the role, 0 otherwise."

BelongsToRole int(4) "1 if the user belongs to the role, 0 oth-erwise."

Inherited int(4) "1 if the permission was inherited by a role, 0 otherwise."


Users Users in Clarity.

UserID varchar(100) The username or id of the User.

FirstName varchar(100) The first name of the user.

LastName varchar(100) The last name of the user.

Email varchar(100) The email address of the user.

DefaultLanguage varchar(6) The default language of the User.

LastLoginDate varchar(25) The last date and time that the user logged in to Clarity.

Enabled int(4) "1 if the user is enabled, 0 otherwise."

DefaultTemplate varchar(200) The users default template.

ImportSource varchar(100) The source from where the user was added from.

DateCreated datetime(8) The date that the user was created.


270

. . .


DefaultHomePage int(4) The default home page of the user (the menu id of the page to use as default)

systemuser int(4) "1 if the user is a system user (cannot be deleted), 0 otherwise."

superuser int(4) "1 if the user is a super user (all access), 0 otherwise."

ROLEHOMEPAGE int

HomePageToUse int

UserSession Session data for Users connected to Clarity using single sign on.

UserSessionID int(4) Unique ID for table

UserID nvarchar(100) User ID for the user running Clarity

IPAddress nvarchar(30) IP address of the user connecting to Clarity (SSO use the combination of UserID and IPAddress and date to create the Token)

LoginDT nvarchar(50) date/time of last login

EncryptKey nvarchar(100) The Key fior encryption

EncryptIV nvarchar(100) The IV for Encryption

EncryptDT nvarchar(50) date/time of encryption

LastAction nvarchar(100) Last Action done by user

WorkFlow Owner Status Changes are stored here

WorkFlowID int(4) ID For Workflow table

StatusID int(4) Foreign Key to WorkflowStatus Table

Notes varchar(2000) Owner Notes

PageOptions varchar(512) Page Options for this status change

WorkFlowApprover-Status

Approver Status Changes stored here

WorkFlowID int(4) Foreign Key to Workflow Table

CostCentreID int Foreign Key to WorkflowCostCentre table

Approver varchar(512) Approver Name

StatusID int(4) Foreign Key to WorkflowStatus Table

Notes varchar(512) Approver Notes


271

E R D I A G R A M S

WorkFlowAuditTrail Log of all workflow status changes

LogID int(4) ID for AuditTrail table

EntityName varchar(1028) WorkflowCostCentre Name

EntityAlias varchar(1028) WorkflowCostCentre Alias

UserID varchar(128) User Name who made the status change

Status int(4) Foreign Key to WorkflowStatus table

PageOptionsName varchar(512) Page Options Name

PageOptionsAlias varchar(512) Page Options Alias

DateLastModified varchar(20) Date of Status Change

Notes text(16) Notes Saved when Status changed

Cubeid int(4) Foreign Key to Cube Table

workflowccoptions Combination of Workflow Costcentre and every possible page option - used to track sending collective emails

costcentreid int(4) Foreign Key to WorkflowCostCentre table

pageoptions varchar(128) Page Options

WorkFlowCostCen-tre

Workflow Entities Saved to this table

CostCentreID int(4) ID for WorkflowCostCentre table

CostCentreDesc varchar(512) Description of Cost Centre

CubeId int(4) Foreign Key to Cubes Table

WorkFlowOwner Workflow owner approver relationships store here for each entity

CostCentreID int(4) Foreign Key to Workflow CostCentre Table

OwnerID varchar(256) Owner Name

ApproverID varchar(1028) Approvers' Names (Pipe separated)

WatcherID varchar(256) Watcher Name

WorkFlowStatus static list of Workflow statuses and asso-ciated images

StatusID int(4) ID for WorkflowStatus Table


272

. . .


StatusDescEN varchar(64) Description for Status

ImageLocation varchar(128) Location of status image


273

E R D I A G R A M S

274

. . .


275

E R D I A G R A M S

276

. . .


277

E R D I A G R A M S

278

. . .


279

E R D I A G R A M S

280

. . .


281

E R D I A G R A M S

282

. . .


283

E R D I A G R A M S

284

. . .


285

E R D I A G R A M S

286

www.claritysystems.com

Global / North American Headquarters

2 Sheppard Avenue East, Suite 800 Toronto, Ontario, Canada M2N 5Y7

Toll free: 1.877.410.5070 Phone: 1.416.250.5500 Fax: 1.416.250.5533 Email: [email protected]

International / European Headquarters

83 Victoria Street, London, UK, SW1H 0WA

Phone: + 44 (0)203 1784038 Fax: +44 (0) 203 0086180

Regional Sales Offices:

Atlanta Boston Chicago Dallas Denver London, UK New York City Philadelphia Portland San Francisco Toronto, Canada Vancouver, Canada

For information on a Sales Office near you call toll free: 1.877.410.5070