Developer s Guide. April 09, 2013 (Publication: AAIAEDADG11.0) Release 12.0 ASSET ARENA INVESTONE. For Global Asset Managers

Transcription

1 ASSET ARENA INVESTONE For Global Asset Managers Developer s Guide April 09, 2013 (Publication: AAIAEDADG11.0) Release 12.0 United States 377 East Butterfield Road Lombard, IL Phone: (630) Fax: (630) United Kingdom 25 Canada Square 40 th Floor London, United Kingdom E14 5LQ Phone +44 (0) Fax: +44 (0) Client Services: AAIA.CSC.NA@sungard.com General Info:

2 Record of Revisions Date of Revision Revisions March 31, 2006 Version Initial release of Enterprise Distributed Architecture 6.0 Documentation December 31, Version 2.0 Updated release of Enterprise Distributed Architecture documentation. Revised the section on Uploading Templates in Chapter 3 Report Designer to reflect the changes made to the screens in Enterprise DA 6.1. August, 2007 Version 3.0 Updated branding and release numbering. No major changes made otherwise to content. April, 2008 Version 4.0 Updated for releases and This guide was not released for general distribution. November, 2008 Version 5.0 Updated for release 8.0. March, 2009 Version 6.0 Updated Section 3: Report Designer June, 2009 Version 7.0 General Updates April, 2010 Version 8.0 General Updates September 29, Version 9.0 General Updates 2011 April 15, 2012 Version 10.0 Updated Section EMS Rule Designed Build Utility Screen and provided General Updates. June 13, 2012 Version 10.1 Revised Section 4.0 Apollo Report Publishing: updated content and flowcharts for Adding NEW Report Template and Updating Existing Report Template. April 9, 2013 Version 11.0 General Updates SunGard. SunGard, the SunGard logo and Asset Arena are trademarks or registered trademarks of SunGard Data Systems Inc. or its subsidiaries in the U.S. and other countries. All other trade names are trademarks or registered trademarks of their respective holders. All rights reserved. No part of this document may be reproduced, transmitted or stored electronically without SunGard s prior written permission. This document contains SunGard's confidential or proprietary information. By accepting this document, you agree that: (A)(1) if a pre-existing contract containing disclosure and use restrictions exists between your company and SunGard, you and your company will use this information subject to the terms of the pre-existing contract; or (2) if no such pre-existing contract exists, you and your Company agree to protect this information and not reproduce or disclose the information in any way; and (B) SunGard makes no warranties, express or implied, in this document, and SunGard shall not be liable for damages of any kind arising out of use of this document. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

3 1 Table of Contents Preface... 3 WHO SHOULD READ THIS GUIDE?... 3 WHAT S COVERED IN THIS GUIDE?... 3 OTHER SOURCES OF INFORMATION... 4 CONTACTING CUSTOMER SUPPORT... 5 NOTATION CONVENTIONS OVERVIEW GENERAL TERMS AND DEFINITIONS BASIC OVERVIEW OF AAIA ENTERPRISE DA GENERAL INSTALLATION - REPORT DESIGNER TOOL OVERVIEW REQUIRED THIRD-PARTY SOFTWARE RECOMMENDED SYSTEM REQUIREMENTS WINDOWS: INSTALLING E.SPREADSHEET DESIGNER How to install on Windows 2000 and Windows XP Typical Configuration Insert the product CD into your CD drive to start the install wizard STARTING E.SPREADSHEET DESIGNER REPORT DESIGNER OVERVIEW Steps in building a report GETTING STARTED WITH MICROSOFT EXCEL TO DESIGN REPORTS DESIGNING A REPORT (REPORT WORKSHEET) Report data Data Mapping Mapping Formulas Formatting Sorting Grouping Hyperlinks Freeze Panes Print setup Reporting directives HideColumns HideRows HideRangeRows ZeroSuppress NoDataRange SortRows UPLOADING TEMPLATES TROUBLE SHOOTING APOLLO REPORT PUBLISHING OVERVIEW CUSTOM APOLLO REPORTS ON AAIA ENTERPRISE DA ADD REPORT TEMPLATE SCREEN TEST REPORTS Test Requests REPORT AVAILABILITY THROUGH PROCESS MANAGER EMS RULE DESIGNER OVERVIEW SCREEN FEATURES Object Definition Screens - EMS Expression Editor Operators Expression Object Definition Screens - Grid Update Controls Object Definition Screens - Other Misc. Features ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

4 2 View Mode/Change Hyperlink Object Modeling Security Model Control Buttons Browser Screens OBJECT SCREENS EMS DataSource Browser EMS DataSource Definition Screen Main Tab Arguments Tab Columns Tab EMS Rule Browser EMS Rule Object Definition Screen Main Tab Arguments Tab Exception Message Tab Researching Links Tab User Fields Tab System Fields Tab Comments Tab EMS Package Browser EMS PACKAGE DEFINITION SCREEN Main Tab DataSources Tab Columns Tab Rules Tab Arguments Tab UTILITY SCREENS EMS Database Server Browser EMS Database Server Definition Screen EMS Rule Designer Import Utility EMS Rule Designer - Export Utility EMS Rule Designer - Delete Utility EMS Rule Designer DataSource Search Utility EMS Rule Designer EMS Category Definition EMS Rule Designer - Build Utility Screen Test EMS Package Main Tab Arguments Tab Grid Tabs EMS View XML Utility Sample XML Display of Rule Designer Object EXPRESSIONS Logical Expression Severity Expression Column Filter Expressions Common Researching Link Functions Financial Statement Link UI Link Internet Hyperlink Cache Functions cachelookup Function cachecount Function CacheSum Function formatnumber Function Appendix Index DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

5 3 PREFACE This document covers the designing and publishing of reports that work with Asset Arena Investment Accounting (AAIA) Enterprise data, and how to use the rule designer for Exception Management Systems (EMS) applications. WHO SHOULD READ THIS GUIDE? This guide provides information for report designers who create reports for use in the Enterprise DA environment, and for use by EMS rules designers in defining custom exception processing packages. WHAT S COVERED IN THIS GUIDE? The table below describes each chapter in this guide: Chapter Contents Chapter 1, Overview This chapter introduces the reader to the general terms used in this guide and provides an illustrated overview of Enterprise. Chapter 2, General Installation - This chapter discusses the installation of a third-party Report Designer Tool software tool for designing reports that are downloaded as templates from the Report Toolkit utility in Enterprise Distributed Architecture (DA). The software tool, Actutate e.spreadsheet Designer, is required to create Enterprise report templates which can be used as a basis to customize your own reports. Chapter 3, Report Designer This chapter is written to assist the reader in the creation of Enterprise reports by defining presentation templates using Actuate s e.spreadsheet Designer. Most of the content in this chapter was created using Actuate 8 with e.spreadsheet Designer 10 functionality. Chapter 4, Report Publishing This section is written for users who familiar with creating Apollo reports and understand the functionality of Process Manager. Chapter 5, EMS Rule Designer The Rule Designer module is a browser-based tool that aids EMS users in defining custom exception processing packages to facilitate a tailor made exception based processing environment. Using the object definition screens, the EMS Business Analyst will be able to devise EMS Rules, grouping those rules into EMS Packages. Processes in the Rule Designer will validate the Packages as they have been defined and make them available to the Exception Engine that supports the Exception Management System (EMS). ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

6 4 OTHER SOURCES OF INFORMATION Your Enterprise Distributed Architecture software includes documentation for each phase of the implementation. The following table provides a complete list of Enterprise Distributed Architecture documentation. Refer to this Document: Enterprise Distributed Architecture User s Guide Enterprise Distributed Architecture Administration and Configuration Guide Enterprise Distributed Architecture Technical Guide Enterprise Distributed Architecture Installation Guide Enterprise Distributed Architecture Developer s Guide Enterprise Distributed Architecture Reporting and Data Extraction Guide Purpose of Document: This document provides general information for all users of Enterprise with regard to login, general layout, navigation, user preferences, and other information necessary to successfully use the features available in Enterprise. This guide provides information for Administrators to be able to configure the Enterprise Distributed Architecture. Provides technical information on System Settings, Administration, Batch Reports, Browser CUI, Process Manager, Central Pricing System, Browser Reporting, Management Fee Calculator, Expense Calculator, Exception Manager, and Browser Spectra. The purpose of this document is to describe the process for installing the Enterprise Application. The application consists of the Enterprise Database, Main Enterprise App Server Application, IIS application components, and additional App Server modules. Covers the designing and publishing of reports that work with Enterprise data and how to use the rule designer for EMS applications. This document details the Investment Accounting (InvestOne) Enterprise functionality found in the Reporting and Data Extraction application for the Distributed Architecture (DA) environment. It is a useful resource for anyone who plans to use this application to create and design a report. The above documentation is only available in Portable Document Format (PDF), and is accessible from either the CD that was supplied at the time of your installation or from our web site. The web site for this documentation is located at (see the Electronic Doc link). DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

7 5 CONTACTING CUSTOMER SUPPORT If you need assistance, call Enterprise Customer Support at (630) press 1, or Or call the London Customer Support at Please check our web site at NOTATION CONVENTIONS If you are reading this manual online, you can click on the highlighted portion of a link to go directly to the related information. To see how a link works, click on the phrase "table of contents." Once you are "linked into" the table of contents, find the link in the table of contents section called Notation Conventions. Click Notation Conventions to return here. The following are types of NOTATION CONVENTIONS used in this guide: Type of Link General Link Cross Reference Link Symbol Description Links to a section, text or object. Generally does not include a section number, section heading or page number. Links to a section, text or object. It generally includes a section number, section heading and page number. Indicates an important NOTE that should be read. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

8

9 7 1 OVERVIEW This chapter introduces the reader to the general terms used in this guide and provides an illustrated overview of Enterprise. 1.1 GENERAL TERMS AND DEFINITIONS The following terms and definition will give you a better understanding of the content in this document These terms are referred to throughout the Rule Designer documentation. Term Argument Column Category DataSource Grid ID Definition Arguments are used in two different contexts for the Rule Designer module in the DataSource context and the Rule context. DataSource Arguments are inputs defined at the DataSource level that are required to query database table contents. Rule Arguments are values that are passed through from the Package Definition to the Exception engine at runtime. Examples of Rule Arguments are Severity Level, Rule Enablement, and Rule Level Argument Values. A column is a data item that has either been defined at the Package or DataSource level, and is either used as a value in various types of expression calculations or a value in display fields such as a User Field or an Exception Message. A functional area of a mutual fund accounting organization examples would be Pricing, Corporate Actions, etc. DataSources are collections of selected data items that reside on an existing database server table. Assigning a DataSource object to a Package object makes all data items specified in the DataSource available to the associated Package. A Grid ID is an alias defined in the Package object that relates DataSource objects to specific Rules and Package Columns defined within the Package. Logical Expression The logical expression is the part of a rule that is evaluated to determine if a processing condition is outside of a predefined acceptable tolerance. Object Browser Screen Object Definition Screen Owner An Object Browser screen displays all objects that have been defined for the specified object type. The objects are displayed in a sortable grid that can be filtered using the filtering options located above the grid. The Object Definition screen allows users to add, change, delete, or view Rule Designer objects - each action is accomplished by entering the associated mode for the screen (either from the Menu or from the Browser screen). The screens are broken up into logical groups and displayed in a multi-tabbed layout. One set of object definition screens exists for each object type. Owner can either be defined as System or as User System owned objects have been predefined and are the default SunGard EMS packages. User owned objects have either been custom developed for clients by SunGard Investment Management Systems, or have been ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

10 8 Term Package Rule Severity System Field User Field Definition custom developed by the client s EMS business analyst group. Along with Owner Type an Owner Name will be specified for each EMS object. A Package is a collection of EMS Rules that has been grouped into a logical set that will be executed at predetermined times during the processing day. All data items that are used to supply the EMS Rules with the necessary values for execution are contained within the package object. A Rule is a pass/fail criterion that is defined by the EMS business analyst that evaluates a processing scenario and determines whether or not it falls within user-defined tolerance. The Severity defined for a rule determines what Severity Level is assigned to a created exception record. Rules can have varying levels of severity either based on the assigned severity level (Rule Definition), or based on a Severity Expression that determines the degree of severity by analyzing the amount of variance. Up to ten levels of severity may be defined per rule. System fields are default fields assigned to all Rule objects. The values provided by these fields are required by the Exception Engine. User fields are display fields that are defined in Rule objects once user fields are defined they are displayed in the Exception Detail on the Exception Clearing screen. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

11 9 1.2 BASIC OVERVIEW OF AAIA ENTERPRISE DA The following illustration demonstrates the fundamental structure of AAIA Enterprise DA and the relationship of each supporting component. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

12

13 11 2 GENERAL INSTALLATION - REPORT DESIGNER TOOL 2.1 OVERVIEW This chapter discusses the installation of a third-party software tool for designing reports that are downloaded as templates from the Report Toolkit utility in Enterprise Distributed Architecture (DA) 8.0. The software tool, Actutate e.spreadsheet Designer, is required to create Enterprise report templates which can be used as a basis to customize your own reports. Since the Report Designer tool is a separate software tool that works outside of the Enterprise DA environment, it has its own installation procedure and requirements that are documented here. 2.2 REQUIRED THIRD-PARTY SOFTWARE Enterprise DA 8.0 requires Actuate e.spreadsheet Designer RECOMMENDED SYSTEM REQUIREMENTS WINDOWS: The recommended system requirements for installing Actuate e.spreadsheet Designer 8.0 are: Windows 2000/XP Pro NOTE: The technical requirements listed here are for guideline purposes only. Please consult Actuate Support Services for the precise requirements for your specific environment. 2.4 INSTALLING E.SPREADSHEET DESIGNER You need to install e.spreadsheet Designer using the installation wizard. The installation wizard: Prompts you to set the install location Copies Actuate e.spreadsheet Designer program, online documentation, and internationalization resource files to the install location Creates icons in the Start menu for Actuate e.spreadsheet Designer Copies Java Runtime Environment (JRE) version to your system How to install on Windows 2000 and Windows XP 1. Insert the product CD into your CD drive. 2. Use Windows Explorer to navigate to Setup.exe. 3. Double-click Setup.exe. 4. The installation wizard guides you through the installation process; see Typical Configuration on page Install the online documentation, including online help and PDF files of the product manuals, from the Documentation CD, which ships with your software. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

14 12 NOTES: Both documentation and localization resource file updates can become available between releases. The Actuate Localization and Online Documentation Update tool provides replacement files and additional files for PDF documentation, online help, and localization of installed Actuate products. The tool is available from the Actuate Customer Support web site, also known as the e.support site, at the following URL: Use the Actuate Localization and Online Documentation Update tool that corresponds to the release of your Actuate products. For example, if you have Actuate 8 Service Pack 1, install the Actuate Localization and Online Documentation Update for Release 8 Service Pack 1. If no update tool for your release appears on the e.support site, no updates exist for the release Typical Configuration INSERT THE PRODUCT CD INTO YOUR CD DRIVE TO START THE INSTALL WIZARD If you do not see the following screens after inserting the CD then you will need to launch Explorer and search for the Setup.exe file on the CD, and click on this file to run the Installation Wizard manually. Initial Splash Screen that appears when your system recognizes the Setup manager on the CD, and begins the installation wizard. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

15 13 1. Select Next > to start installing Actuate e.spreadsheet Designer on your computer. 2. Select I accept the terms of the license agreement and press Next >. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

16 14 3. Recommended: Choose a setup type of Typical and click Next >. 4. You should see the above setup screen after selecting Next > to install e.spreadsheet Designer for a typical setup. NOTE: The following is a screen capture of the components that are installed and the default target directory that is created: DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

17 15 5. Click Finish to complete the installation and to view the ReadMe file. NOTE: The ReadMe file contains release notes that identify known limitations and list customer-reported defects that are fixed by this release. Also, the release notes include links to Actuate s site for updates. 2.5 STARTING E.SPREADSHEET DESIGNER 1. Windows XP Pro: Click on Start > All Programs > Actuate 8 > Actuate e.spreadsheet Designer ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

18 16 2. The above screen appears as the default book in e.spreadsheet Designer. 3. See the next chapter on Report Designer for information on how to use Actuate e.spreadsheet Designer to create Enterprise report templates. These templates can than be used as a basis to customize your own reports. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

19 17 3 REPORT DESIGNER 3.1 OVERVIEW This chapter is written to assist the reader in the creation of Enterprise reports by defining presentation templates using Microsoft Excel. Most of the content in this chapter has been created using Microsoft Excel Focusing on using the Microsoft Excel application to create Enterprise report templates, this chapter illustrates how the user can utilize the templates to be the base for customizing their own reports. The remainder of this document provides: an overview of the steps involved with creating a report instructions on how to use Microsoft Excel standards and tips on creating the actual report involving formatting, data mapping, headers, etc examples of some of the report functionality such as sorting, grouping and linking to reports troubleshooting hints Steps in building a report The following is a summary of the steps to build a report. You should refer to the other Help documents for further details. Use the Enterprise Report Toolkit application to select the desired report data elements o Create one or more report field sets o Create a skeletal report presentation template CREATE/UPDATE REPORT PRESENTATION TEMPLATE Download the skeletal template. Use the Microsoft Excel application to map the available report data items in each fieldset to one or more presentation worksheets. Once you have created your template, you will need to upload the report to the Enterprise server via the Report Toolkit screens. THE TEMPLATE CAN BE MODIFIED AND UPLOADED AS NEEDED. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

20 GETTING STARTED WITH MICROSOFT EXCEL TO DESIGN REPORTS The Report Toolkit application will generate a skeletal template for each new report defined. This skeletal template will contain a basic report layout with the required data structures. This will be used as a basis for designing the final report presentation. 1. Once downloaded using the above hyperlinked file, open the template by selecting File Open on the Excel toolbar. Select the directory where the template is located: DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

21 19 2. Select the template and then Open. Each template file will consist of at least four worksheets (Control, Links, Report, & Data Field Set): Control The Control sheet is used to define report processing. It is initially formatted to contain the following sections: Parameters Lists each defined report input parameter. When the report is executed, the current value of the parameter will be displayed in the Parameter Value column. Sorts Allows defining report specific sorts for each report fieldset. Post-Processing Provides an area for specifying post processing directives. Notes Time stamp for when the initial template was created. Links The Links worksheet is used to define links to sub reports. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

22 20 DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

23 21 Report(s) This is the actual report which will use the data on the fieldsets created in the Report Toolkit. By default, the skeletal template will contain one Report worksheet. To create another presentation worksheet, select Insert > Worksheet. Data worksheet(s) The data from each fieldset created in the Report Toolkit will be placed onto its own data worksheet in the template. The skeletal template will contain one worksheet for each fieldset. Example: NOTES: A. Report is the actual report that will be displayed. B. DataFieldSet1 and DataFieldSet2 are the data worksheets that contain the data from the fieldsets. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

24 DESIGNING A REPORT (REPORT WORKSHEET) The skeletal template creates a Report worksheet containing field mappings for each defined fieldset. The next step is to modify the contents of the report sheet to create the desired presentation. Initial report layout showing each fieldset. 1. Modify the Report worksheet to create the required heading information. Delete the existing data mappings by highlighting the rows (6 through 10), right-clicking and selecting delete. 2. Create the required report heading information using the available cell formatting. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

25 Report data DATA MAPPING During report execution, the requested data will be retrieved from the underlying data sources by the Enterprise Report Engine. The retrieved data from each data source will be placed on the appropriate data worksheets. This retrieved data must be mapped to the desired locations on the report worksheet. To map data from the data worksheet to the report, highlight the cell in the Report worksheet, in this case, cell A8 and type the equal sign = as shown below. 1. Go to the data worksheet that contains the data and highlight the cell to be mapped. In this case, the fieldset data is on the worksheet named DataFieldSet2. 2. Hit the Enter key. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

26 24 The cell is now mapped in the report template. The cell could also be mapped by typing the formula =DataFieldSet1!R4 in cell B31. Once mapped, the cell of the Report worksheet displays the value =[TO]. This is a placeholder value to indicates that this cell will contain the TO data element when the report is executed. This process should be repeated for each data element that should appear on the report. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

27 25 3. The next important step is to define a range for the data in the report worksheet. This ensures that all data rows will be displayed on the report. If this is not done, only the first row of data from the datasource will be displayed on the report. This is done in the following manner using the previous example. 4. Highlight the range on the report worksheet. 5. Select Insert Name->Define 6. Enter Report! (the name of the report worksheet) followed by the fieldset name of the data worksheet being referenced plus the word Range. In this case, Report!DataFieldSet1Range: 7. In the Formula section, the appropriate range should be specified. If it is not, simply enter the correct range. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

28 26 8. Select Add to add this range. MAPPING FORMULAS The following are some standard mapping formulas used in Enterprise. Conditional Mapping for column headings containing text and dates: If the cell is blank, return a space. Otherwise return the cell s value in text format. Date format is applied in case the description is a date. =IF(DataFieldSet1!$C$2=,,(TEXT(DataFieldSet1!$C$2, m/dd/yy ))) Conditional Mapping for columns containing dates: ap the cell reference. =DatFieldSet1!$C$2 Use Format Cells Number to set the appropriate date format. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

29 27 FORMATTING Some formatting guidelines include: Dollar values are formatted to two decimal places and are right-justified. Negative values are displayed in parenthesis and in red. 1. Highlight the cells to be formatted. 2. Select Format Cells Custom and select the appropriate format: Column widths can be set by selecting Format Column Width. Auto Fit Selection can also be used. This is will set the column width to the widest width of data. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

30 28 Data in columns can be right-justified by using the Align Right toolbar icon or select the cells to be formatted and use Format Cells Alignment and set the horizontal to right. Centering and left-justifying data can aslo be done in this manner. SORTING To sort data in a report, you must sort the range in the data worksheet. The Control worksheet in the skeletal template contains predefined sort locations for each report fieldset: For example, you may want to sort the following data by ascending account number and ascending tranaction code. 3. Modifiy the contents of the Sort column for the DataFieldSet1!FieldSet1Sort Data Range in column C16 on the Control sheet to contain the value DA, GA. The format is: <Column><Sort>[,<Column><Sort>][,<Column><Sort>] A will sort the data in ascending order D will sort the data in descending order The contents of the sort field are evaluated to perform the sort request. Any formulas entered here are evaluated before performing the sort operation. This allows created dynamic sorts based on report parameters. The following formula will sort the data range on columns B and C only if the Sort request parameter is true. Otherwise no sorting will occur: =IF(PARM_SORT= true, BA,CA, ) DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

31 29 GROUPING Grouping on Enterprise reports is accomplished by structuring columns on the report presentation sheet that can be interpreted by the grouping function. HYPERLINKS Hyperlinks allow a user to click on a cell in one report and request a related report. The requested report will open in the same report viewer window. Report links are defined on the Links worksheet. Each row entered is a hyperlink. The first four columns of the worksheet are used: Column A contains the name of the Report data range within which the link should be available. Leaving this cell blank allows a link to function acrosss multiple data ranges. Column B contains the column number within the data range that will display the hyperlink. Column numbering begins with zero. (A=0, B=1, ) If multiple hyperlinks are specified for the same datarange / column, the links will be shown in the pop-up menu in the order they are entered into the worksheet. Column C contains the text to be displayed in the popup menu when the user right cliks on the cell. Column D is where the relative URL is specified that will be used if the link is selected by the user. This text can be entered as text or as an Excel Formula. The URL for Apollo reports will start with the string ioexcel.asp?rept= followed by the filename of the Excel template. Each required parameter for the report must be specified using the syntax &parmname=value. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

32 30 For example, the following formula: ="ioexcel.asp?rept=securities_at_value.xls"&"&account="&parm_account&" &Date="&TEXT(PARM_Date, mm/dd/yyyy ) Will evaluate to: ioexcel.asp?rept= Securities_At_Value.xls&Account= &Date=09/02/2006 and will navigate the user to the specified report for the same account and date used on the current report. For links that are based on the contents of the cell currently selected (i.e. a security number), the names IO_CUR_ROW and IO_CUR_COL can be used in conjunction with the INDIRECT formula. For example, the following formula: = ioexcel.asp?rept=position_detail.xls&account= & PARM_Account & &Date= & TEXT(PARM_Date, mm/dd/yyyy ) & &Security= & INDIRECT( Report!A & IO_CUR_ROW) Will evaluate to ioexcel.asp?rept=position_detail.xls&account= &date=09/02/2006& Security= Where the value of the security parameter will change based on the selected row. The URL for RTK reports will start with the string ="fwtoreportviewpage.do?reportid= followed by the filename of the Actuate template. Each required parameter for the report must be specified using the syntax &parmname=value. For example, the following formula: ="fwtoreportviewpage.do?reportid=accountdetail_729&account="&parm_account Will evaluate to: fwtoreportviewpage.do?reportid=accountdetail_729&account= DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

33 31 and will navigate the user to the specified report for the same account used on the current report. For links that are based on the contents of the cell currently selected (i.e. a memo number), the names IO_CUR_ROW and IO_CUR_COL can be used in conjunction with the INDIRECT formula. For example, the following formula: ="fwtoreportviewpage.do?reportid=tradedetailreport_1383"&"&account=" &PARM_Account&"&Memo_Number=" &INDIRECT("Broker_Trade_Report!E" & IO_CUR_ROW) Will evaluate to fwtoreportviewpage.do?reportid=tradedetailreport_1383&account= &Memo_Number=5067 Where the value of the memo number parameter will change based on the selected row. FREEZE PANES For list/tabular reports, it is helpful to use the Freeze Panes functionality to keep certain row and column information static. 1. Select where the freeze panes should start in the report. 2. For this example, you may want to see category name and the column headings when scrolling through the report. Highlight the appropriate cell, in this case, K8. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

34 32 3. Then to set Freeze Panes, select Format Freeze Panes 4. To disable the freeze pane functionality, select Format Unfreeze Panes. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

35 33 PRINT SETUP The following will explain some of the printing options available. 1. Select File Page Setup Page 2. Select Portrait or Landscape depending on the size and layout of the report. NOTE: The report can also be specified to fit on one page. This should only be done for reports that will not extend beyond one page. If a report has too much data and is set to print on one page, the data will not fit the page correctly. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

36 34 Margins can be set by selecting the Page Setup tab: DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

37 35 1. To assign information to print on each page, highlight the row headings to be repeated. Make sure that the row headings, and not just the cells, are highlighted: 2. Make sure that the print area is cleared by selecting File Print Area Clear Print Area. 3. Then select File Print Titles Set Print Titles REPORTING DIRECTIVES Once the report template has been populated with data from the data extracts, additional formatting can be performed using one or more predefined directives. These directives allow modifying the report presentation. All of the directives for a report must be located within a range of cells on the Control sheet named DIRECTIVE_RANGE. Directives take the following form: <DirectiveName> <Option1>, <Option2>,<Option3>, A simple directive to hide the third row on the Report sheet would appear as: HideRows Report, True, 3 Directives are evaluated based on the value of the cells in the DIRECTIVE_RANGE range. This allows creating directive commands based on formulas. The following directive formula dynamically determines whether to hide or show column four on the Report sheet based on the value in cell A1: =IF(Report!A1=5,"HideColumns Report, False, 4", "HideColumns Report, true, 4") Only directives contained within the DIRECTIVE_RANGE will be executed. Blank rows within this range will be ignored. Rows within the range containing text that cannot be evaluated as a valid directive will be ignored. Only cells in the first column of the named range will be evaluated. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

38 36 Available directives: HideColumns Hides (or shows) one or more columns of cells Format: HideColumns <SheetName>, <true false>, <columnnumber>[,<columnnumber>] Example: HideColumns Report, true, 3,4 This example hides the third and fourth columns (C & D) on the Report sheet. HideRows Hides (or shows) one or more rows of cells Format: HideRows <SheetName>, <true false>, <RowNumber>[,<RowNumber>] Example: HideRows Report, false, 5,6,7 This example ensures that the fifth, sixth and seventh rows of the Report sheet are shown. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

39 37 HideRangeRows Hides (or shows) all of the rows defined by the supplied named range Format: HideRangeRows <true false>,<rangename> Example: HideRangeRows true, DataRange This example hides all of the rows contained within the defined name DataRange. ZeroSuppress Hides the row of the specified cell if the value of the cell is zero. Ensures that the row is shown if the value of the cell is non-zero. If two cell ranges are supplied, the row will only be hidden if the value of both cells evaluate to zero. Format: ZeroSuppress <RangeName1>[, <RangeName2>] ZeroSupporess <SheetName>, <RowNumber>, <ColumnNumber> Example: ZeroSuppress Report!A4 This example will hide row 4 on the worksheet named Report if the value of the A4 cell evaluates to zero. ZeroSuppress Report!A4, Report!C4 This example will hide row 4 on the worksheet named Report if the values of both the A4 and C4 cells evaluate to zero. NoDataRange Displays an error or information message if the referenced FieldSet contains no data. If the optional Message text is not supplied, a default message No items match selected request criteria will be displayed. Format: NoDataRange <FieldSetName>, <LocationRange>[,<Message>] Example: NoDataRange FieldSet2, Report!$A$6, No rows returned This example displays the message No rows returned on the worksheet named Report if the data extract for FieldSet2 returns zero rows. SortRows Allows sorting ranges on the worksheet after the data has been populated. Format: SortRows <SheetName>, <Row1>, <Column1>, <Row2>, <Column2>, <Sort1> [[, <Sort2>][, <Sort3>]] SheetName Identifies the worksheet to be sorted Row1, Col1 Identifies the upper left corner of the range to be sorted Row2, Col2 Identifies the lower right corner of the range to be sorted ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

40 38 The Row and Column parameters must be specified as integer values. Sort1, Sort2, Sort3 Integer representing the positional column to be sorted. 1 will sort based on the first column in the range 2 will sort based on the second column in the range. Positive column values will sort ascending. Negative integers will sort in descending order. Up to three sort columns are allowed. Example: SortRows Report, 6, 1, 22, 10, 2 Sorts rows 6 through 22 on the Report worksheet in ascending order on column 2. SortRows Report, 6, 1, 22, 10, -2, 3 Sorts rows 6 through 22 on the Report worksheet in descending order on column 2 and then in ascending order on column 3. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

41 UPLOADING TEMPLATES The following steps show how to upload a report template using the Report Toolkit option from within Enterprise. For more information on the Report Toolkit option, please see the Reporting and Data Extraction User s Guide. 1. Begin the above process by either selecting Change Desktop from the Enterprise DA Top Menu and select the Fund Accounting Role, or log in initially as a Fund Accounting role. NOTE: You must have your role set to Fund Accounting to be able to proceed with the following steps. 2. Select from the Enterprise DA menu bar: Reporting Report Design Report Toolkit. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

42 40 3. The next step is to either define a report first, or find an existing unpublished report using the Find Report option, and select a report in the pop-up window for the Function List. The report must have been tested and the message Files have been moved to the test folder. Please use the Test Reports screen to test the report must show before you will be able to proceed further in this step. This step is necessary before the DOWNLOAD button becomes enabled which allows you to make edits in e.spreadsheet Designer, and to subsequently be able to UPLOAD templates. Once the report definition or find report phase is completed, enter a name for the report and either type the file path and VTS name, or use the Browse button to specify the correct VTS file for the Upload file field. 4. BROWSE to search for a VTS file to upload, and press UPLOAD which is now an active button. If the path and file are not inlcuded, the UPLOAD button is not enabled, and only VTS files can be uploaded or the following error message will appear: DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

43 41 5. UPLOAD your customized VTS template. After this, you can do any of the following: a. DOWNLOAD again to see whether the template that you UPLOADED is the one that you see on DOWNLOAD. b. Click on PREVIEW to see whether your changes are visible. c. Click on the TEST button to promote your changes and execute the Report to see your custom report. 6. Select from the Enterprise DA menu bar: Reporting Report Design Test Reports. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

44 42 7. Proceed to the Test Reports screen, you may need to refresh to find the new report. Select the desired report and click the Publish Button to publish the report. If the report sources have been correctly setup, the Test Reports screen will display a Report has been published status message. Remember that the parameters displayed and the order of the parameteres are determined from the report sources used as the datasources in the associated VTS file. 8. Return to the Report Defintion Report Details screen, and click Preview to view the published report in a pop-up Window. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

45 TROUBLE SHOOTING The following are some common issues that may be encountered when designing Enterprise reports 1. Issue: Only one line of data is being displayed on report. Resolution: Need to define a range for the data in the report worksheet. This will enusre that all rows will be displayed when running the report. This is done in the following manner: Highlight the range on the report worksheet. Select Insert Name Enter Report! followed by the range name under data manager of the data worksheet being referenced, in this case, Report!AllocRange. Select Add. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

46 44 In the formula section, the appropriate range should be specified. If it is not, simply enter the correct range. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

47 45 Also make sure that all data worksheets in the VTS files begin with Data. 2. Issue Incorrect data coming back on reports Resolution check the data displayed in the data worksheets. For production reports, this can be done by selecting Enable Data Tabs under Reports. After submitting a report request, the report as well as the data tabs will be available for review. The data tabs automatically display for staged reports. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

48 46 3. Issue report print is too small. Resolution check the print setup. Select File Page Setup Page If fit to one page is selected, this may cause the data to print too small. Uncheck this option so that the report will print on more than one page. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

49 47 4. Issue print titles are not printing on report pages. Resolution Make sure that print titles are set correctly. Highlight the rows including the row headings: And not just the cells: ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

50

51 49 4 APOLLO REPORT PUBLISHING 4.1 OVERVIEW This section is written for users who familiar with creating Apollo reports and understand the functionality of Process Manager. AAIA Enterprise DA allows the execution of existing Apollo reports using a pass-thru mechanism. This works for a typical User s Apollo report request that is passed thru to the underlying Apollo instance for execution. The resulting Excel report is returned to the User s browser using the Enterprise report viewer. The architecture for AAIA Enterprise DA renders the menus, and performs user authentication and authorization. Existing Apollo reports have been added to the base SunGard implementation shipped with AAIA Enterprise DA as functions, and actions related to the function. 4.2 CUSTOM APOLLO REPORTS ON AAIA ENTERPRISE DA Within the AAIA Enterprise DA Architecture is a publishing procedure that is available to allow users and/or administrators, who have been authorized to utilize this functionality, to deploy new or updated Apollo reports under the AAIA Enterprise DA framework. This procedure is similar to the requirements for making an Apollo report available in the Process Manager with some additional AAIA Enterprise DA specific steps. The following flowcharts illustrate the steps that are required for deploying a NEW or UPDATED Apollo report under Enterprise. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

52 50 Add NEW Report Template: Start Create NEW report template Are custom changes made to the report parameters? Yes Deploy custom Apollo_Parms.ini and/or custom parameter files to database library Changes to Apollo-Parms.ini? Yes Restart managed co-existence servers No No Add NEW report template (UploadRpt) Test report (TstRpt) Publish report (TstRpt) Run Menu Synchronization (MenuSync) Run published report End DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

53 51 Update Existing Report Template: Start Modify existing report template Are custom changes made to the report parameters? Yes Deploy custom Apollo_Parms.ini and/or custom request parameters to database library (LibraryFileManagement,jsp) Changes to Apollo-Parms.ini? Yes Restart managed co-existence servers No No Update existing report template (UploadRpt) Is report defined in process manager? Yes Were any changes made that affect parameter execution for this template? Yes Run Task Maintenance Update (TaskMaint) No No Run published report End ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

54 ADD REPORT TEMPLATE SCREEN The Add Report Template screen provides a User the ability to add or update custom Apollo Report templates as Report functions. When a new or existing report template is submitted, the system performs the following tasks: Adds or updates an excel template to all Apollo server instances in the appropriate Customer Financial Statement folder. For a new report, adds the function to the Function_Main, Function_Action, Func_Customer, Func_Version, and Func_Vers_Stat tables. Adds or updates database entries to the clnt_task_tbl and the clnt_task_parm_tbl. For a new report, exposes a new Report function to the user who added a report for unit testing before adding the function to a function collection for publishing purposes. For an existing report, automatically overwrites the report template for an existing report function which is then immediately available under AAIA Enterprise DA for subsequent execution. Jump To: UploadRpt Screen Fields Field Name Report Name Description JumpTo Name Upload Report Template Description The name of the report function to be added or updated. For a new report function, enter a unique name that is not already defined. To update an existing report function, enter the name of the existing report function exactly as it is defined. This field allows the user to input any type of description necessary for the report being added. This field allows the user to designate the Jump To name for the report function. For a new report, this is an optional field. For an existing report, this entry must exactly match that its existing JumpTo Name. This field is used to designate the report path source of the report file. Report must be an.xls format. Action Buttons Browse SUBMIT When selected, Choose File Microsoft IE pop-up box displays for the user to select a file from the Choose File screen (as shown in the screen capture following this table). Submit updates to the appropriate tables to add the report as a new valid function or update the report template to an existing function. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

55 53 RESET Resets the page and clears any entered data that has not already been submitted. Related Links Test Reports Link to the Test Reports screen. New reports added by means of the Add Report Template will appear on this screen for further processing until published. Example of Microsoft s screen to Choose file: Once submitted on the Add Report Template screen, confirmation message Template upload successful will display. When submitting a new report, the report will now appear on the In Process Reports Summary page. Link is available on the Add Report Template page to allow navigation directly to the page. When submitting an existing report that was previously published, the updated report template is immediately available for subsequent execution in AAIA Enterprise DA. Error messages are provided and must be resolved for the following conditions to upload successfully: Required fields are not populated Entry for a new Report Name references a pre-existing JumpTo Name Entry for a new JumpTo Name references a pre-existing Report Name The template is not an.xls file ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

56 TEST REPORTS The Test Reports page provides a listing of all reports submitted by a User by means of the Add Report Template page, but those which have not yet been published nor assigned to any Function Collection. Jump To: TstRpt Screen Fields Field Name Description Select Selecting one of the available radio buttons will enable the Publish and Reset buttons. Report Name Link to Report Request page for report execution/validation prior to publishing. Report Description This is the description of the report. Share/Do Not Share Report Applicable only for Enterprise Standard Reports (RTK). Action Buttons Publish Reset The method by which the selected Report Name may be published to one or more available Function Collections. The Select Function Collection dialog is used interactively for the user to indicate one or more function collections that the selected Report Name should be published to. Deselects any selected Report Name and disables the Publish and Reset buttons Test Requests When a User clicks on any of the Report Names listed on the Test Reports screen, the Report Request page for the report will display, and allow the requested report to be executed, and viewed using the Enterprise Report Viewer. From the example below, the Corporate Actions Report was selected. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

57 55 The request page displays, which allows the user to review the input parameters, execute the report request, and to view the results in the Report Viewer for AAIA Enterprise DA. NOTE: Since the report has not been added to a function collection/menu at this point, this page ensures that any required security entries are created to allow a user who added the report to execute the displayed reports. The page is capable of refreshing any cached security information on each execution. Unpublished Apollo reports are determined by finding all reports owned by the current user that exist as Functions and Function Actions, but do not appear in a Function Collection. Once a report is attached to a Function Collection it will no longer be available using the Test Reports page. Refer to the AAIA Enterprise DA Administrator and Configuration Guide for further information regarding creating and updating function collections. 4.5 REPORT AVAILABILITY THROUGH PROCESS MANAGER Any report which is added must have a task created for it using the Task Definition screen, which is required in order to allow the report to be made available through Process Manager. The selection button next to the Report Template input field displays a File Browser window allowing the user to locate and select the correct template from the Apollo server file system. The file system places reports under the appropriate Customer file. Once a report has been included in a menu and has had a task created for it, the task can then be included in a Process Manager process. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

58 56 File Browser Function is available as a pop-up from the Task Definition screen as shown below: NOTE: The File Browser component allows navigating through the existing Apollo directory structure to locate the desired report template. Clicking the Add button on the Add Task Definition screen initiates the process of adding the report and report parameters to the Apollo process tables. The Apollo Add Task function executes an AAIA Enterprise DA service to create or update the corresponding Function and Function Action tables in the AAIA Enterprise DA database. Apollo requests the execution of this service using a callback mechanism. An HTTP request is initiated on Apollo and sent to AAIA Enterprise DA to update the tables. Once the new report is added as a task, the report is now also available to add into new or existing processes. Refer to the Process Manager Chapter in the AAIA Enterprise DA User s Guide for detailed explanations regarding functionality. Screen Fields Field Name Task Type Task Name Description Type of the task that is being defined. Task type could be either Browser Reports or Exception Template. Name of the task that is being defined. The task name can not be a DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

59 57 Task Description Report Template duplicate of an existing task. This field allows user to input any type of description necessary for the task that is being defined. The report template file for the task being defined. The selection popup button, which is next to this field, can be used to browser through the available template files Action Buttons Add Reset Close Adds the task and completes the task definition process. Resets the page and clears any entered data that has not already been submitted. Closes the page without saving the information. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

60

61 59 5 EMS RULE DESIGNER 5.1 OVERVIEW The Rule Designer module is a browser-based tool that aids EMS users in defining custom exception processing packages to facilitate a tailor made exception based processing environment. Using the object definition screens, the EMS Business Analyst will be able to devise EMS Rules, grouping those rules into EMS Packages. Processes in the Rule Designer will validate the Packages as they have been defined and make them available to the Exception Engine that supports the Exception Management System (EMS). Several SunGard objects are available to be used by clients in lieu of creating custom EMS objects. The Rule Designer module provides an enhanced ability to maintain those objects. In order to effectively utilize the Rule Designer utility it is expected that the Business Analyst will have a solid understanding of the EMS module and the InvestOne components that support it. 5.2 SCREEN FEATURES Several tools are provided throughout the Rule Designer screens to assist the user in writing expressions, updating grids, and linking from Object Browser screens to Object Definition screens. These features are described once in this section as they are duplicated many times throughout Rule Designer Object screens Object Definition Screens - EMS Expression Editor The EMS Expression Editor is available to assist the EMS business analyst in constructing complex functions for expressions defined within Packages and Rules. Wherever the Expression Builder is available for a text box an icon will be visible next to the text entry box for the expression. Expression Editor Link Icon Expression Editor Dialog ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

62 60 Expression Editor Fields Field Label Field Description Context Selecting an item in this list will determine which Package/Grid combination will be used to populate the Arguments and Columns selection boxes. If a context relationship does not already exist for the expression being edited, pressing the button to the right of the dropdown will dynamically load all available Package/Grid combinations. Arguments For the Package/Grid combination selected, all available DataSource Arguments are displayed. If the value in the Arguments list is [Blank], pressing the button to the right of the dropdown will dynamically load all available Arguments. This will also load the Columns list for the selected context. Columns For the Package/Grid combination selected, all available DataSource and Package Columns are displayed. Functions The Functions list contains all the functions recognized by the Exception Engine. Selecting an item in the list will automatically append the text for the function command plus a ( to the end of any existing text in the Expression text entry box. ) For an explanation of the most recently selected Function pressing the? box next to the dropdown will display a message box containing information related to the Function structure and a brief summary of the Function s application. Functions are described further in the Rule Designer Appendix. Example of Help Display for the last selected function: OPERATORS All buttons displayed to the right of the Operator s label represent the valid operators recognized by the Exception Engine. Clicking one of the buttons appends the text for the selected operator to the end of the expression string in the Expression text entry box. EXPRESSION Contains the expression text for the field being modified. Any entries in this box are inserted in the associated field on the object definition screen. NOTE: Not all functions that are provided by the Exception Engine are currently supported for use in EMS processes. Please check the Currently Used in sgobjects column in the Rule Designer Appendix for more information the functions with * in this column have been verified for use by SIMS. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

63 Object Definition Screens - Grid Update Controls Throughout the Object Definition screens a Grid/Detail Pane relationship exists the detail pane provides a form to update grids in Add and Change modes for items that can be updated. Below is an example of a sample detail pane: The buttons (controls) shown above appear on virtually every editable detail pane, and perform the following functions: Control Add Button Delete Button Control Description Press the Add button to clear all detail pane values and default the screen focus to the first available input field. No grid updates are performed at that point. When a record is selected in the grid above the detail pane pressing the Delete button will delete that selected record. Grid Order Buttons The buttons from left to right are as follows: Move To Top: Moves the selected row to the top of the grid. Move Up: Moves the selected row up one position in the grid. Move Down: Moves the selected row down one position in the grid. Move To Bottom: Moves the selected row to the bottom of the grid. Apply If all required fields have been entered in the detail pane, pressing Apply will add the newly created record to the grid. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

64 Object Definition Screens - Other Misc. Features VIEW MODE/CHANGE HYPERLINK For all object definition screens in View mode a hyperlink is provided in the bottom right hand corner titled Change Screen. Accessing this link will forward the user to the Change mode screen for the object that is being displayed. OBJECT MODELING For all object definition screens in Add mode a modeling feature is available to invoke object modeling the user will select an item from the Model: (see image below), input an object name, and click the Submit button. At that point all input fields are populated with the data from the source object (the Object selected as the model). Once the newly created object is saved the Modeled object name is displayed on Change and View screens in the Model: field. Object Modeling NOTE: Relational integrity will not be enforced for changes to the source model object, i.e. if the source object is changed those changes will not be reflected in the modeled object. SECURITY MODEL To protect the integrity of Sungard EMS Packages, Rules, and DataSources a security model has been created. Any user that is classified as an Internal User or higher and has the EmsRD_Developer user parameter set to Yes will be able to edit the protected Sungard objects. Otherwise users will not be able to edit those objects (this will be the default setting for all users). Sungard Investment Management Systems cannot guarantee the integrity of any SunGard supplied objects if the client chooses to configure itself as an EMS RD Developer and make changes to sgobjects. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

65 Control Buttons Browser Screens At the bottom of each Object Browser screen a series of buttons are displayed that perform certain functions. The Add, Change, Delete, View, and Report buttons require that a record be selected in the Browser screen grid. Each button function is described below. Browser Screen Button Functions Button Filter Add Change Delete View Report Action If any filtering items have been specified in the filter parameters the Filter button invokes the filtering process, and only the filtered items are displayed. The Add button forwards the user to the Object Definition Screen in add mode with the object that is highlighted in the grid selected as the Modeled Object. The Change button forwards the user to the Object Definition Screen in change mode for the object that is highlighted in the grid. The Delete button forwards the user to the Object Definition Screen in delete mode for the DataSource object that is highlighted in the grid. The View button forwards the user to the Object Definition Screen in view mode for the DataSource object that is highlighted in the grid. Invokes the printable version of the selected Object. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

66 OBJECT SCREENS EMS DataSource Browser Grid Items: Owner, DataSource, Description, Modified By, Date. Filter Label Owner Name DataSource Description Filter Description A dropdown list that displays all Owner values available in the DataSource grid. Text entry box that provides partial sting filtering capability on the DataSource name field. Text entry box that provides partial string filtering capability on the Description field. When saving the EMS DataSource Definition report, Excel is the recommended 'save as' format. When Tabbed Text or CSV save as formats are used, only the currently viewed tab on the report is saved. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

67 EMS DataSource Definition Screen MAIN TAB Select a Server Name value to dynamically populate the Table dropdown box with all tables available on the selected server. Select a Table Name value to populate the values in the Name dropdown on the Columns tab (same screen). Screen Fields Field Label Model DataSource Owner-Type Owner Created By Modified By Server Name Table Name Description Field Description Object that has been/can be used as a basis for other objects (if applicable). Key field for the DataSource object. Can be defined as either 'System Owned' or 'User Owned.' Unique value associated to the EMS business analyst the default value is defined in the Apollo User Profile (EmsRD_Owner parameter). User ID of the user who created the DataSource object. User ID of the last user who modified the DataSource object. Contains all Servers that have been defined on the EMS RFC Server definition screen. Contains all Tables that are associated with the selected Server. User defined description values. Quotation marks ( ) are not valid in the Description field; they cause truncation errors in the DataSource Browser screen. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

68 66 ARGUMENTS TAB Grid Values: Argument Name, Data Type, Argument Value/Expression. Detail Pane Fields Field Label Associated Grid Description Column Name Argument Name Label assigned to the Argument record. DataType Data Type Data Type for the Argument record. See Appendix for all available data types. Value Argument Value/Expression Values defined here are the default values used at run time (when DataSource requests are executed by the Exception Engine). Arguments are primarily request parameters for Spectra requests. External database requests might not require arguments. These are the 8 default arguments that are required for INVEST ONE (IO) requests: Argument Name DataType Argument Value/Expression REQ_UserGroup String REQ_Account_Number Double 1 REQ_Database_Name String REQ_Sub_Account Double 1 REQ_From_Date Integer CCYYMMDD (Any numeric date, such as ) REQ_To_Date Integer CCYYMMDD (Any numeric date, such as ) REQ_Process_Name String A REQ_Task_Name String A DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

69 67 COLUMNS TAB DataTypes defined at the DataSource level are only meaningful for displays on the Test Package Utility screen. Otherwise the actual DataType of the data item is cast from the characteristics defined on the database tables. When a datasource is created based off of an IO Server (InvestOne Spectra Request) - by default certain column filters must be defined. These items are as follows, grouped by IO Server Table name. Please see the Default DataSource Columns table in the Appendix for the necessary settings. Grid Values: Column Id, Name, Long Name, DataType, Column Filter Expression. Detail Pane Fields Field Label Associated Grid Column Name Name and Long Name Description IO Data Item Code (Short Name for External Databases) as supplied by the Data Dictionary (supplied by database tables for External Databases). When a Name is selected from the Name dropdown on the Columns tab, a system-generated suggested Column ID is automatically populated in the Column ID field. This Column ID can either be accepted as-is or modified as necessary. Column Id Column Id The label assigned to the Column record. This will be used as the reference value whenever this Column is used in a Rule or Package level expression. See 'Name' Field above. Data Type DataType Data Type for the Column record. See Appendix for all available data types. Description Long Name Description supplied by data dictionary. Filter Column Filter Expression An expression that can be defined for the created column record that will limit the data returned for the defined data item. Column filters are further described in the Expressions Section. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

70 68 NOTES: 1. For data that exists on the IO Server, data type is derived from the Data Dictionary and automatically mapped to a valid EMS data type. For external database applications outside of the IO Model, this mapping is based on existing data type standards. 2. Spectra codes that utilize an arithmetic operator are not valid for IoProxyServerbased tables and therefore, excluded from the column picklist. 3. DataSource objects that existed in releases prior to Apollo 4.1, must be opened in Change mode and saved in order to be used in Apollo 4.1 and later releases. The process of re-saving the object converts Column Id s to the new naming scheme used in Apollo 4.1 and later releases. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

71 EMS Rule Browser NOTE: When saving the EMS Rule Browser report, Excel is the recommended 'save as' format. When Tabbed Text or CSV save as formats are used, only the currently viewed tab on the report is saved. Grid Items: Owner, Rule, Description, Modified By, Date, Built By, Date, Version. Filter Label Owner Name Rule Description Filter Description A dropdown list that displays all Owner values available in the browser grid. Text entry box that provides partial sting filtering capability on the Rule name field. Text entry box that provides partial string filtering capability on the Description field. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

72 EMS Rule Object Definition Screen Rule objects that existed in releases prior to Apollo 4.1 are still compatible even though a category is not defined. A category may be added to an existing object by opening the object in Change mode and re-saving the object. MAIN TAB Screen Fields Field Label Model Rule Owner-Type Owner Version Created By Modified By Built By Logical Expression Severity Level Severity Expression Category Category Expression Description Field Description Object that has been/can be used as a basis for other objects (if applicable). The name of the Rule Object (Key Field). Can be defined as System-Owned or User-Owned. Unique value associated to the EMS business analyst the default value is defined in the Apollo User Profile (EmsRD_Owner parameter). Sequential value based on the number of Rule builds that have occurred for the selected Rule object. User ID of the user that created the Rule object. User ID of the user that last modified the Rule object. User ID of the user that last built the Rule object. The function is executed and evaluated on a True/False basis to determine if a business condition is an exception. Determines the value of the Severity when the rule is triggered as an exception. Possible values are 0-9 or [Blank]. If Severity Level is set to [Blank], then Severity Expression must have an expression specified. If Severity Level is set to [Blank] then the Severity Expression is evaluated to determine the Severity Level of the exception. Logical and Severity Expressions are further defined in the Expressions Section. Assigning a value here assigns a category to the rule. A Dropdown menu contains categories that have been defined on the Category Definition screen. Exceptions that are generated with Category = Blank are available to all users. Display of the category argument. User defined description values. Quotes ( ) are not valid in the Description field; they cause truncation errors in the Rule Browser screen. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

73 71 ARGUMENTS TAB Grid Values: Argument Name, DataType, Argument Value/Expression. Detail Pane Fields Field Label Associated Grid Column Description Name Argument Name The name (alias) that will be referenced by Rule level expressions and passed to the Task and Account level for overrides. DataType DataType Data Type for the Argument record. See Appendix for all available data types. NOTE: Where DataType = Boolean, valid values include 0 and 1, where: 0 is False/No and 1 is True/Yes. Value Argument Value/Expression An expression that can be defined for the created Argument record that limits the data returned for the defined data item. Currently the Exception Engine only supports numeric values for the Values field. Expressions are not supported. For argument expressions with a leading negative sign, a zero is required before the decimal point. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

74 72 EXCEPTION MESSAGE TAB Typically the Exception Message contains text describing the error condition indicated by the exception. Expressions are also valid for this field. Detail Pane Fields Field Label Exception Message Expression Field Description This value is the Exception Message that is displayed on the Exception Detail screen when the modified exception has been triggered. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

75 73 RESEARCHING LINKS TAB Researching Link Expressions are further defined in the Expressions Section. Grid Values: Link Name, Link Value/Expression. Detail Pane Fields Field Label Associated Grid Column Description Name Link Name The text that represents the researching link on the Exception Detail screen. Value Link Value/Expression The defined path for the researching link. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

76 74 USER FIELDS TAB A maximum of 15 User Fields can be defined for each Rule object. If multiple values are going to be concatenated together for the purpose of display in one user field, the tostring function should be applied to each column in the expression. Grid Values: User Field Name, User Field Value/Expression. Detail Pane Fields Field Label Associated Grid Column Description Name User Field Name Label text for the User Field on the Exception Detail screen. Value User Field Value/Expression The expression that is evaluated to determine the User Field value displayed on the Exception Detail screen. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

77 75 SYSTEM FIELDS TAB The Exception Engine requires that all System Fields be appropriately defined. Because of this all six fields are defaulted with values that should be overridden when necessary. The required definitions are displayed in the Default System Field Values located in the Appendix. Grid Values: System Field Name, System Field Value/Expression Detail Pane Fields Field Label Associated Grid Column Description Name System Field Name Label text for the System Field on the Exception Detail screen. Value System Field Value/Expression This expression is evaluated to determine the System Field display on the Exception Detail screen. When an exception is generated, System Fields represent a portion of the unique identifier (key) for that specific exception. The Default System Field Values located in the Appendix create unique keys for exceptions in all but two cases. Those cases, as well as an approach to create a unique key in each case, are provided as follows. Not ensuring that a rule has unique key causes errors in the Exception Regeneration process. Rule Type Condition Resolution Account Level Multiple Classes Of Shares If a rule has been defined to generate exceptions against all classes of shares for a fund insert the following expression in the Security Number System Field (copy statement as it shown below, spacing needs to be correct): if(classofshares > 0,("UNITS " + if(classofshares > 9, "000","0000") + ClassOfShares),0) The ClassOfShares column is representative of IO Column = io_ac. If this column has a different alias it should be substituted for ClassOfShares. This expression will create a valid security number for the underlying class of shares and will ensure a unique exception is generated for each share class. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

78 76 Rule Type Condition Resolution Holding Level Tax Lot or Currency Contract Level Holdings Records Add the Tax Lot Memo Number (io_lt) to the Memo Number System field using an appropriate column alias. If this is done a unique key will be generated. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

79 77 COMMENTS TAB A maximum of 20 Comments can be defined for each Rule object. Grid Values: Sequence, Comment Text Detail Pane Fields Field Label Associated Grid Column Description Seq Sequence Comment dropdown sequence on the Exception Clearing screen. Text Comment Text Label text for the comment on the Exception Clearing screen. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

80 EMS Package Browser NOTE: When saving the EMS Package Definition report, Excel is the recommended save as format. When Tabbed Text or CSV save as formats are used, only the currently viewed tab on the report will be saved. Grid Items: Owner, Package, Description, Modified By, Date, Built By, Date. Filter Label Owner Name Package Description DataSource Rule Name Filter Description A dropdown list that displays all Owner values available in the browser grid. Text entry box that provides partial sting filtering capability on the Package name field. Text entry box that provides partial string filtering capability on the Description field. Contains all DataSources (by DataSource name) available in the Rule Designer component. Contains all Rules (by Rule name) available in the Rule Designer component. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

81 EMS PACKAGE DEFINITION SCREEN MAIN TAB Screen Fields Field Label Model Package Owner-Type Owner Created By Modified By Built By Description Field Description Object that has been/can be used as a basis for other objects (if applicable). The name of the Package Object (Key Field). Can either be defined as System-Owned or User-Owned. Unique value associated to the EMS business analyst the default value is defined in the Apollo User Profile (EmsRD_Owner parameter). User ID of the user who created the Package object. User ID of the last user who modified the Package object. User ID of the last user who built the Package object. User defined description value. Quotation marks ( ) are not valid in the Description field; they cause truncation errors in the Package Browser screen. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

82 80 DATASOURCES TAB Grid Values: Grid ID, DataSource. Detail Pane Fields Field Label Associated Grid Column Description Grid ID Grid ID Name assignment for the selected DataSource object. DataSource DataSource Selection list that contains all DataSources defined in the Rule Designer module. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

83 81 COLUMNS TAB Package level columns added to the Package in ADD mode are not retained when the object is saved. To successfully add Package level columns, first add and save the Package object. Then, open the created object in CHANGE mode. Columns added at this point are saved successfully to the package object. Grid Values: Grid ID, Column ID, DataType, Expression, Source. Detail Pane Fields Field Label Associated Grid Column Description Grid ID Grid ID References the Grid tab this assigns a column to a Grid, and means that this column can only reference the Data Items that are in the associated Grid DataSource (or Package if the Grid ID is the same). Source Source Indicates whether a Column has been defined at the DataSource or Package level. Only Package level columns can be added and deleted on this screen. DataSource level columns are displayed on this screen for informational purposes only and cannot be added, altered, or deleted. This is for display purposes only. Column ID Column ID The label assigned to the Column. If this column is referenced by other columns or expressions this is the value that should be used. Data Type Data Type Data Type for the Column record. See the Data Types available in the Appendix for all available data types. Expression Expression Expression that is evaluated to determine the value of the created column. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

84 82 RULES TAB The Grid ID selected for each Rule corresponds to the Grid ID assigned to the DataSources and Package Level columns required to execute the selected rule. Grid Values: Grid ID, Rule Name, Version. Detail Pane Fields Field Label Associated Grid Description Column Grid ID Grid ID References the Grid tab this assigns a Rule to a Grid, and means that this Rule can only reference the Data Items that are in the associated Grid DataSource (or Package if the Grid ID is the same). Rule Name Rule Name Selected Rule (All created rules are available). Version Version Version of the selected Rule. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

85 83 ARGUMENTS TAB These values are for display purposes only. If modification is necessary it must be done at the associated Rule level. Grid Values: Argument Name, DataType, Argument Value/Expression. Detail Pane Fields Field Label Associated Grid Column Description Name Argument Name Name of the Argument that has been passed from the designated Package Rules. DataType DataType Data Type of the Argument. Value Argument Value/Expression The default Argument Value or Expression for the selected Argument. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

86 UTILITY SCREENS Within the Rule Designer component, Utility Screens exist that execute a variety of tasks to support the Rule Designer, as well as the EMS Module EMS Database Server Browser Grid Values: Server, UserName, Password, ImplServerName, ImplDatabaseName, Implementation, Modified By, Date. The Add, Change, Delete, and View buttons at the bottom of the browser screen perform the same functions as the same buttons on the object browser screens. The Add button does not, however, invoke object modeling on the resulting Add mode screen. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

87 EMS Database Server Definition Screen Defining a database server on this screen makes that database and all associated tables available for selection on the main tab of the DataSource definition screen. Screen Fields Field Label Field Description EMS Server The name of the Server Definition object. Name Implementation The type of Database that this server is defined as can be either: Sybase: A database that is created and maintained using the Sybase database application. Representative of a relational database structure. IO: The InvestOne mainframe database accessed via a proxy connection. Created By User ID of the user that created the Server Definition. Modified By User ID of the last user that updated the Server Definition. Database The name of the server that holds the database. Server Database Name The actual name of the database as it is defined on the server. User Id The User ID used to establish a connection with the database server. Password The password required to authenticate the database server connection. Help Content This is an informational field that could be updated to contain any helpful information that might be required to maintain a specific server definition. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

88 EMS Rule Designer Import Utility The default import location is defined as c:\emsrd\import this means that if an import is being performed the object will be moved from the specified folder into the Rule Designer module. The folder structure for the default import process should look like this: Selection Boxes Object Type Available Objects Grid Contents Object Type Object Name Import Status Date_Time Action Buttons Submit Status Msg Description Allows the user to select Rules, DataSources, or Packages. Select a value in this dropdown to populate the Available Objects selection box. Multiple objects can be selected within one object type by using the Ctrl key and selecting a row. Those selections are retained if other rows are selected in the other object type. Displays all objects that are available for Import from the folder location defined in the EmsRD_Import_Folder user parameter. Description The imported object type. The imported object name. Displays the status of the Import process. Displays the Date and Time of the Import execution. Description Initiates the Import process. If the Import Status value is not fully displayed in the Grid, click this button to display the entire Status message in a popup box EMS Rule Designer - Export Utility Based on which object type is exported, a folder is created (if it does not already exist) within the destination folder defined in the EmsRD_Export_Folder user parameter. The default export location is processed as follows: DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

89 87 The default export path is defined as c:\emsrd\export this means that if an export is being performed the object will be sent to this folder and placed in the associated subfolder. The folder structure for the default export process looks like this: Selection Boxes Object Type Available Objects Grid Contents Object Type Object Name Export Status Date_Time Action Buttons Submit Status Msg Description Allows the user to select Rules, DataSources, or Packages. Select a value in this dropdown to populate the Available Objects selection box. Multiple objects can be selected within one object type by using the Ctrl key and selecting a row. Those selections are retained if other rows are selected in the other object type. Displays all objects that are available for Export in the Rule Designer module. The target folder for the Export process is determined by the EmsRD_Export_Folder user parameter. Description The exported object type. The exported object name. Displays the status of the Export process. Displays the Date and Time of the Export execution. Description Initiates the Export process. If the Export Status value is not fully displayed in the Grid, click this button to display the entire Status message in a popup box. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

90 EMS Rule Designer - Delete Utility Any object can be deleted on this screen (including SunGard objects). The user should take great care when deleting Rule Designer objects. Selection Boxes Object Type Available Grid Contents Object Type Object Name Delete Status Date_Time Action Buttons Submit Status Msg Description Allows the user to select Rules, DataSources, or Packages. Selecting a value in this dropdown will populate the Available Objects selection box. Multiple objects can be selected within one object type by using the Ctrl key and selecting a row. Those selections are retained if other rows are selected in another object type. Displays all objects that are available to be Deleted in the Rule Designer module. Description The deleted object type. The deleted object name. Displays the status of the Deletion process. Displays the Date and Time of the Delete execution. Description Initiates the Delete process. If the Delete Status value is not fully displayed in the Grid, clicking this button will display the entire Status message in a pop-up box. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

91 EMS Rule Designer DataSource Search Utility Selection Boxes Owner Name Server Name Table Name Column Name Column Id Grid Contents Object Type Object Name Owner Name Modified By Modified At Action Buttons Submit Select Report Description A dropdown list that displays all the Owner values assigned to any created DataSource objects. A dropdown list that displays all Servers that have been defined on the EMS Server definition screen and utilized in the Rule Designer objects. A dropdown list that contains all data tables associated with the selected Server Name. Data Item Code or External Database Column Short Name. The value assigned to a defined Package or DataSource Column and referenced by Rule and/or Package level expressions. Description The EMS object type. The EMS object name. The Owner Name associated with that particular DataSource, Package, or Rule. User ID of the last user that modified the object. Date/Time stamp of modification. Description Initiates the DataSource search process. Opens the object definition screen for the selected object in View mode. Links to a printable version of the DataSource Search Utility screen. NOTES: 1. Server Name and Table Name filters can be set to Blank, which implies a Package Level search, or can be set to valid Server and Table names, which implies a DataSource Level search. 2. When a DataSource Level search is initiated, the Column ID or Column Name input as the filter represents a DataSource-level column and identifies Rules and Packages that refer to the specified DataSource-level column. For a Rule to return as a search result it must be assigned to a Grid within a resulting Package that contains a resulting DataSource. 3. When a Package Level search is initiated, the Column ID input as a filter represents a Package-level column. The search results will include Packages containing the entered Column ID and any Rules that reference that Column ID in the same Package Grid. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

92 90 4. Either Column ID or Column Name must be supplied as filters. Both values cannot be populated for a search at the same time. 5. If the Column Name filter value is populated, then both Server Name and Table Name must be something other than Blank. 6. Column ID and Column Name searches are case sensitive and identify exact matches only. 7. On a DataSource-level search, if Owner Name has a filter value not equal to Blank, only DataSources with that specified Owner Name are in the search results. If a Package with a different Owner Name has a qualifying DataSource Owner Name assigned to it, however, then that Package will display. This assumption is applied to Rules as well if it is associated with a resulting Package. 8. On a Package-level search, if Owner Name has a filter value not equal to Blank, only Packages with that specified Owner Name are in the search results. If a Rule with a different Owner Name is associated with a qualifying Package, however, then that Rule will display EMS Rule Designer EMS Category Definition See the User s Guide for documentation regarding the EMS Category User Assignment screen. Field Label Associated Grid Column Category ID Category ID Description Identification number used to identify each individual category. If a Category ID that has been assigned to a rule is deleted, that same Category ID can be re-added at a later date with the same or a different name. If the Category ID is not added back after being deleted, any rules using the deleted Category ID need to be amended to ensure that exceptions are accessible. Name Name A category name, usually defining a functional area of investment accounting. (i.e. Pricing, Corporate Actions, etc.) Description Description User defined description value. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

93 91 Buttons Add Delete Submit Reset Action Resets Category ID to default and clears other detail pane values. No grid updates are performed at that point. Deletes the selected record in the grid. Sends the specified information to the server for processing. Deletes the temporary data stored in the grid. Does not remove any data that has been previously processed. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

94 EMS Rule Designer - Build Utility Screen For the build process all selected Rule Objects will be built before Package objects. This ensures that any selected rules required to be built for selected packages have already been built. Rule Object Versioning When a Rule object is created it is assigned a version # of 0. Each time that Rule object is built on the Build Utility screen, the version # will increase sequentially by one digit. Object versioning is not supported for Package objects. Selection Boxes Description Object Type Allows the user to select Rules or Packages. Selecting a value in this dropdown will populate the Available Objects selection box. Multiple objects can be selected within one object type by using the Ctrl key and selecting a row. Those selections are retained if other rows are selected in another object type. To deselect items, hold down the Ctrl Key and click the selected record. Available Objects Displays all objects that are available to be Built in the Rule Designer module. Last Modified Date Last Modified By Grid Contents Object Type Object Name Build Status Date_Time Buttons Reflects a date & time on which Rule or Package is added, modified or imported. This column can be sorted ascending or descending depending on user s need. Once Rule or Package is built successfully, date & time stamp will be removed. Displays Enterprise UserID of a user who has last added, modified or imported a Rule or Package. This column can be sorted ascending or descending depending on user s need. Once Rule or Package is built successfully, UserID stamp will be removed. Description The built object type. The built object name. Displays the status of the Build process. Displays the Date and Time of the Build execution. Action DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

95 93 Submit Status Msg Initiates the Build process. If the Build Status value is not fully displayed in the Grid, clicking this button will display the entire Status message in a pop-up box Test EMS Package MAIN TAB Field Label Package Field Description Select a Package to determine which Package is tested on the screen. Only Packages that have been successfully built using the Build Utility feature will be eligible for Test Package processing. All other fields on this screen are for display purposes only and correspond to fields defined on the main tab of the Package Definition screen. Once a Package Name has been selected clicking the Submit button will load the Arguments tab for overrides. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

96 94 ARGUMENTS TAB Grid Values: Argument Name, DataType, Argument Value/Expression. Detail Pane Fields Field Label Associated Grid Description Column Name Argument Name Name of the argument as defined on the Rule or DataSource objects. DataType DataType DataType for the selected argument. Value Argument Value/Expression Default Argument Value or Expression for the selected argument. Once Argument Value/Expression values have been overridden, clicking the Submit button initiates the Test Package process. Additional tabs containing Grid data are then displayed. Although all Arguments are eligible for override, only three DataSource level argument overrides are used for Test Package processes: Argument Name Argument Name/Value Override REQ_Sub_Account This can be a Reporting Account or an Individual Account this value corresponds to the value that would be input in the Account field on the Process Request screen. REQ_From_Date The from date of the request corresponds to the value that would be input in the From Date field on the Process Request screen. REQ_To_Date The to date of the request corresponds to the value that would be input in the To Date field on the Process Request screen. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

97 95 GRID TABS The results of the Test Package processes are displayed in browser grids that can be sorted by column in ascending/descending order. Each tab created is representative of a Grid ID that has been created on the Package Definition screen. Grids are displayed in order of definition on the Grids tab in the Package Definition screen. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

98 EMS View XML Utility Only one XML object can be selected and displayed for a single request. Selection Boxes Object Type Available Objects Button Submit Description Allows the user to select Rules, DataSources, or Packages. Selecting a value in this dropdown will populate the Available Objects selection box. Displays all objects available to be displayed in the Rule Designer module. Action Displays the XML representation for the selected object. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

99 97 SAMPLE XML DISPLAY OF RULE DESIGNER OBJECT Display for sgnav_round_1 Package Object 5.5 EXPRESSIONS Logical Expression The logical expression is the statement evaluated by the Exception Engine to determine whether a business condition is in fact an exception. In basic terms, the expression contained in the Logical Expression text input box is evaluated on an IF basis. If the expression is True, then the condition is recorded as an exception. If the expression is False, then the condition is considered within exception tolerances and is not created as an exception. Typically the logical expression is a series of evaluation statements connected by logical operators (And, Or). See example below. Example: Logical Expression from sgnav_imp_of_price_chg_currshares For the purposes of this example this is the assumed business condition. Data Item Name Data Item Type Value OfferBaseUnrealizedGLNAVImpact Package Column.001 Price_Change_NAV_Impact_Low Rule Argument CarryValue DataSource Column 1000 SecurityNumberFull DataSource Column Logical Expression abs(offerbaseunrealizedglnavimpact) > Price_Change_NAV_Impact_Low and CarryValue!= 0 and SecurityNumberFull not in ("CASH", "UNITS", "EXPENSE") 1 st Statement Evaluation abs(offerbaseunrealizedglnavimpact) > Price_Change_NAV_Impact_Low Interpretation: This statement is comparing the absolute value of the OfferBaseUnrealizedGLNAVImpact package level column and the Price_Change_NAV_Impact_Low rule level argument ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

100 98 If OfferBaseUnrealizedGLNAVImpact is greater than Price_Change_NAV_Impact_Low, then the 1 st Statement is true and the 2 nd Statement will be evaluated. If it is not greater, then the business condition does not meet the exception criteria. Business Scenario: abs(-.005) >.001 = True 2 nd Statement Evaluation CarryValue!= 0 Interpretation: This statement is evaluating the value that has been returned for the CarryValue column if it is not equal to 0 then, the 2 nd Statement is true and the 3 rd Statement will be evaluated. If it is equal to 0 then the business condition does not meet the exception criteria. Business Scenario: 1000!= 0 = True 3 rd Statement Evaluation SecurityNumberFull not in ("CASH", "UNITS", "EXPENSE") Interpretation: This statement determines whether or not the SecurityNumberFull value is not CASH, UNITS, or EXPENSE. If it is not any of those values then (since all other exception criteria have been met) this business condition is in fact an exception Business Scenario: not in ( CASH, UNITS, EXPENSE ) = True This business condition would trigger the sgnav_imp_of_price_chg_currshares rule. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

101 Severity Expression If the Severity Level value for a Rule Object is set to [Blank] then an expression can be defined that determines the level of severity assigned to an exception, based on the degree of variance from the acceptable business condition. By design this should typically be accomplished by creating an IF statement that evaluates each level of severity, comparing a computed value to the value assigned to each rule level argument. If more than two severity levels are desired, nested IF statements are necessary. The example below describes a scenario where four severity levels have been defined and a nested IF statement is required. NOTE: For the purpose of this example, a calculation that originally occurred in the logical expression: (round (abs((payuppaydownprincipalsum - (PriorCost - Cost))/PayupPaydownPrincipalSum),9)) - was condensed into a Package Level column called SeverityColumn. This aided in the simplification of the Severity Expression, and is a good practice when a calculation will be used multiple times in a Rule Object. An example of a Severity Expression that only evaluates two severity levels can be viewed in the Severity Expression defined for the sgearned_expense_nav_impact Rule Object. Example: Modification of the sgpayup_paydown_cost Rule For the purposes of this example this is the assumed business condition. Data Item Name Data Item Type Value PayUpDownFlag DataSource Column 1 SeverityColumn Package Column.254 Payup_Paydown_Difference_0 Rule Argument Payup_Paydown_Difference_3 Rule Argument 0.25 Payup_Paydown_Difference_6 Rule Argument 0.5 Payup_Paydown_Difference_9 Rule Argument 1 Logical Expression PayUpDownFlag <> 0 and SeverityColumn > Payup_Paydown_Difference_0 Interpretation: Based on the business conditions described above this is a valid exception condition. Severity Expression if(severitycolumn >= Payup_Paydown_Difference_3, if(severitycolumn >= Payup_Paydown_Difference_6, if(severitycolumn >= Payup_Paydown_Difference_9, 9, 6),3),0) Interpretation: The Severity assigned to the exception recorded for the business condition is 3, and was determined by taking the following steps: Step # IF (Comparison is True) Then Else 1 SeverityColumn >= Go to Step #2 Severity = 0 Payup_Paydown_Difference_3 2 SeverityColumn >= Payup_Paydown_Difference_6 Go to Step #3 Severity = 3 3 SeverityColumn >= Payup_Paydown_Difference_9 Severity = 9 Severity = 6 ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

102 100 DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE

103 Column Filter Expressions When a column is defined at the DataSource level the user has the option of filtering the column values returned at the point of execution by defining a Column Filter expression. This filtering logic is similar to a Where clause in an SQL statement, and will be based on values that are already known, such as DataSource Arguments. The location of this entry is in the Columns tab of the DataSource Definition screen. Example: Effective Date Column from sground_2_transactions Database Field (IO Data Item) io_ed Filter Expression io_ed > REQ_From_Date This expression takes the REQ_From_Date value, which is already a known value, and adds that value as a filtering item for the DataSource request. If, for example, the REQ_From_Date for this request was 01/01/2003, then all records returned for this datasource would have an Effective Date (io_ed) greater than 01/01/2003. ENTERPRISE DISTRIBUTED ARCHITECTURE 12.0 DEVELOPER S GUIDE

104 Common Researching Link Functions FINANCIAL STATEMENT LINK Rules can be defined with links that point to Financial Statements defined within Enterprise. The link is a concatenated string that constructs an internal reference to the report template using Rule specific data to fill out the required Financial Statement request parameters. Example of a Financial Statement Link Rule Name sgearned_amort_nav_impact Link Text Earned Amortization Link "ioexcel.asp?rept=earned_amortization.xls&account=" + REQ_Sub_Account + Expression "&Date=" + ValuationDate Linked Financial Statement Earned Amortization 1 st Parameter (&Account) Account, uses the REQ_Sub_Account field (System Field) as the input value. 2 nd Parameter (&Date) Date, uses the ValuationDate column as the input value. DEVELOPER S GUIDE 12.0 ENTERPRISE DISTRIBUTED ARCHITECTURE