You are on page 1of 80

System Guide

Webadmin Guide

15 August 2013 Calypso Technology, Inc.

System Guide Webadmin Guide Applicable to: V14.x


15 August 2013
19972013, Calypso Technology Inc.
Calypso is a registered trademark of Calypso Technology, Inc. The Calypso logo is a trademark of Calypso Technology, Inc.
Red Hat and JBOSS are registered trademarks of Red Hat, Inc. in the U.S. and other countries
Windows is a registered trademark of the Microsoft Corporation.
Bloomberg is a trademark and service mark of Bloomberg Finance L.P., a Delaware limited partnership, or its subsidiaries. All rights reserved.
Citrix is a register trademark of Citrix Systems, Inc.
Markit, Markit Wire, and Markit are trademarks or register trademarks of the Markit Group Limited.
Cisco is a registered trademark of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries.
UNIX is a trademark registered in the United States and other countries, licensed exclusively through X/Open Company, Ltd.
Excel is a trademark of the Microsoft Corporation.
Oracle, Coherence, and Java are registered trademarks of the Oracle Corporation and/or its affiliate.
Sybase is a registered trademark of Sybase, Inc.
All other trademarks and servicemarks are the property of their respective holders.
Refer to jars/legal/ for copies of required third-party licenses.
The information contained in this document is subject to change without notice. Changes, technical inaccuracies, and typographical errors will be corrected in subsequent editions of this document.
The software and procedures described in this manual constitute proprietary information of Calypso Technology, Inc. (Calypso) and is furnished only under a license agreement. The software may be used only in accordance with the terms of the agreement. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical, including photocopying,
recording, or facsimile, for any purpose other than the licensee's own internal use without the express written consent of Calypso Technology, Inc.
Calypso may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Calypso, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual
property.

Document History
Revision date
15 August 2013

Edition
First edition

Comments
Release 14.0

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Contents

Contents
Document History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
14.0.0 30 August 2013 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1

Managing the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8


1.1

WebAdmin Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.2
Convention for Specifying WebAdmin Menu Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.2

Detecting Operational Anomalies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8


1.2.1
General Diagnostic Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2.2
Diagnosing Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.3

WebAdmin Common Menu Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14


1.3.1
Server Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.3.2
Metrics > Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.3.3
Profiler > Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.3.4
Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.4

Data Server WebAdmin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22


1.4.1
The Data Server WebAdmin Server Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.4.2
Data Server Metrics Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.4.3
Data Server Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

1.5

Engine Server WebAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27


1.5.1
Engine Server Manage Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.5.2
Engine Server Metrics: Event Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1.6

Risk Server WebAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28


1.6.1
Monitoring > Presentation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.6.2
Monitoring > Calculation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.7

Generating and Viewing Error Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32


1.7.1
Enhanced Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.7.2
JMX Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.7.3
Setting Logging Behaviour, Levels, and Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.7.4
Enhanced Application Logging Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.7.5
Application Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.7.6
Task WorkStation Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1.7.7
Sample PROD_REQUEST Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.8

Risk Infrastructure Monitoring Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.9

Risk Infrastructure Performance Monitoring Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49


1.9.1
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.9.2
Troubleshooting Log Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

1.10 Event Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56


1.10.1
Launching the Event Monitoring Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.10.2
Event Monitoring Log Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 3

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.10.3
1.10.4

Contents

Event Monitor Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57


Raw Log Output Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Recommended Routine Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Database Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

3.1

Configuration Management Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

3.2

Calypso Application and Migration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

3.3

Import of Swaps Monitor Holidays into Calypso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67


3.3.1
Holiday Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
3.3.2
Holiday Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

How to Find Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69


4.1

Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

4.2

Main Entry Help Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

4.3

Environment Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Troubleshooting Tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
5.1

Java Tuning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

5.2

Date Stamps or Time Stamps are Wrong . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

5.3

Trade Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

5.4

Sybase Administrator Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


5.4.1
Sybase User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
5.4.2
SQL Interpreter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Contacting Calypso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Americas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Europe, Middle East, Africa. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Asia Pacific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 4

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Tables

Tables
Table 1-1:
Table 1-2:
Table 1-3:
Table 1-4:
Table 1-5:
Table 1-6:
Table 1-7:
Table 1-8:
Table 1-9:
Table 1-10:
Table 1-11:
Table 1-12:
Table 1-13:
Table 1-14:
Table 1-15:
Table 1-16:
Table 1-17:
Table 1-18:
Table 1-19:
Table 1-20:
Table 1-21:
Table 1-22:
Table 1-23:
Table 2-1:
Table 2-2:
Table 2-3:
Table 2-4:
Table 2-5:
Table 2-6:
Table 4-1:

Web Admin Server Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14


DataServer WebAdmin Metrics > Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Data Server GUI Controls and Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
WebAdmin Data Server: Server Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Risk Server WebAdmin Monitoring > Presentation Server . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Risk Server WebAdmin Monitoring > Calculation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
RiskServer Webadmin Monitoring > Calculation Server: Services Table . . . . . . . . . . . . . . . 31
JConsole Overview Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
JConsole Memory Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
JConsole Threads Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
JConsole Classes Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
JConsole VM Summary Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
JConsole MBeans Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Metrics Exposed by All Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Metrics Exposed by the Data Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Logging Environment Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Enhanced Application Logging Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Event Log Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Server-Side Request Log Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Client-Side Request Log Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
SQL Log Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Work Flow Log Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Task Worstation Log Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Schedule Task Configuration Window Purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Schedule Task Configuration Window Purge Inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Reports that use History Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Schedule Task Configuration Window Archive Trade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Schedule Task Configuration Window Mature Trade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Schedule Task Configuration Window Mature Position Trade . . . . . . . . . . . . . . . . . . . . . . . 65
Help Menu Item Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 5

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Figures

Figures
Figure 1-1:
Figure 1-2:
Figure 1-3:
Figure 1-4:
Figure 1-5:
Figure 1-6:
Figure 1-7:
Figure 1-8:
Figure 1-9:
Figure 1-10:
Figure 1-11:
Figure 1-12:
Figure 1-13:
Figure 1-14:
Figure 1-15:
Figure 1-16:
Figure 1-17:
Figure 1-18:
Figure 1-19:
Figure 1-20:
Figure 3-1:
Figure 3-2:
Figure 4-1:
Figure 4-2:

DataServer WebAdmin Metrics: Caches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17


Data Server WebAdmin Configure Server Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Engine Server WebAdmin Metrics Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
WebAdmin Common Request Profiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
WebAdmin Common Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
WebAdmin Data Server Metrics: Task Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
WebAdmin Data Server Metrics: Pending Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
WebAdmin Data Server Metrics: Event Publishing Statistics . . . . . . . . . . . . . . . . . . . . . . . . 25
WebAdmin Data Server Monitoring: Connected Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Data Server WebAdmin Monitoring SQL Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Data Server Webadmin Monitoring SQL Statements: Connection Counts . . . . . . . . . . . . . . 26
Data Server Webadmin Monitoring SQL Statements: Full Connection Data . . . . . . . . . . . . 27
Engine Server Webadmin Manage Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Engine Server Webadmin Metrics: Manage Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Risk Server WebAdmin Monitoring: Presentation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
RiskServer Webadmin Monitoring: Calculation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Java Monitoring & Management Console (JConsole) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
JConsole New Connection Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Log Properties Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Select Categories Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Import Holidays Codes Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Import Holidays Holiday Dates Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Environment Properties Displayed in Web Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 6

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Changes

Changes
The Maintenance and Tuning Guide features Change Bars (see left margin) to draw attention to new and changed material in the guide.

14.0.0 30 August 2013

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 7

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Managing the System


The purpose of this section is to describe the tools offered by Calypso to
detect and resolve operational anomalies.

1.1

WebAdmin Overview

1.1.1

Introduction
The Calypso WebAdmin web application is displayed in a web browser and
is available for each deployed war file (dataserver.). By default, the Data
Server WebAdmin is available at http://localhost:8080/dataserver.
The port number for other WebAdmin pages is offset by 100 (default). For
example, the Engine Server is: http://localhost:8180/engineserver.
Port offsets are specified in:

$CALYPSO_HOME\tools\local-jboss-deployer\config\serverDeploymentConfig.properties

Admins can change the port offset by changing the


-Djboss.socket.binding.port-offset setting in
$CALYPSO_HOME/start*server.bat/.sh. By default, the offsets increment
by 100 (100, 200, etc.) from the Data Servers 0 offset.
Only members of the Admin group in Calypso, or another group explicitly
granted the AdmServer function via the Access Permissions window (Main
Entry > Configuration > User Access Control > Access Permissions...), can
login to WebAdmin.

1.1.2

Convention for Specifying WebAdmin Menu Items


Each Calypso war has a dedicated WebAdmin web application available on
the configured port. Throughout this document, rather than show a URL for a
specific WebAdmin page, a pseudo-menu structure will specify the server
and the menu path on the WebAdmin page.
For example, to configure cache settings for the Data Server, the menu path
WebAdmin > Data Server > Metrics > Caches represents the URL
http://ds_host_name:port_number/dataserver/admin/caches.
Likewise, accessing the Cache information for an Engine Server would be
WebAdmin > Engine Server > Metrics > Caches, rather than the URL:
http://localhost:8180/engineserver/admin/metrics/localCaches

1.2

Detecting Operational Anomalies

1.2.1
Note:

General Diagnostic Strategy


As a general rule, when performance is deteriorating or when your system is running out
of memory, restarting the Data Server should be the last resort.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 8

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.2.2

Managing the System

Check the indicators described below and attempt to remedy the anomalies using the available tools.
In general, first diagnose the client application using the tools provided in
the client, to determine if the anomaly originates from the client. More
tools are available in the WebAdmin to diagnose client applications, in
particular with respect to database usage.
If the anomaly comes from a client application, you can stop that client
from the WebAdmin, if needed.
If the anomaly does not come from the client application, you should
then diagnose the servers and the engines using WebAdmin.

Diagnosing Applications
The tools for diagnosing applications allow detecting operational anomalies
in the following areas:
Client Performance
Memory
Risk Infrastructure
Database
Data Server Performance

1.2.2.1

Client Performance
Tips for maximizing the performance of client applications:
When loading trades, use trade filters with books specified as part of the
selection criteria. Trades are cached by book in the Data Server and
loading by book will cache the trades. This will result in much faster
retrieval if someone else has already loaded the trade, or the next time
you need the trade.
Main Entry > Processing > Task Station > Configure > Load Trades,
Load Messages, Load Transfers options Turn these options off
(unchecked) to load only tasks in the Task Station. To load a trade, a
message or a transfer, double-click a task, and the corresponding trade,
message, or transfer will be loaded individually.
Back Office Task Report > Tools > Load Trades/Load Messages/Load
Transfers options Same as above.
For custom applications:
Use the local caches BOCache and LocalCache for retrieving
static data, instead of accessing the Data Server directly.
Whenever possible, use bulk loading instead of loading items
one at a time.
Consider implementing your own externalization instead of using
Javas default serialization.
Refer to the Calypso Developers Guide for details.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 9

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.2.2.2

Managing the System

Memory Usage
You can check the memory using the following tools:
Check the Data Server memory See Information in Table 1-1, Web
Admin Server Menu Items, on page 14 for details.
Use the Watcher to monitor specific indicators and send emails when a
certain threshold is reached. Refer to the Watcher topic in Calypsos
Documentation Portal for details.
To free the memory, you can:
Call Garbage Collection multiple times Refer to Garbage Collection
(Main Entry > Utilities > Maintenance > Cache/Memory > Garbage
Collection) in the Documentation Portal.
Check and release unused database connections see Section
1.4.3.2, SQL Statements, on page 26 for details. Call Garbage Collection after this operation.
Clear the caches, and lower the cache limits See Section 1.3.2, Metrics > Caches, on page 17 for details.
Check SQL Statements for long and costly requests. You can then diagnose the source of the anomaly using SQL Monitoring (see Section
1.4.3.2, SQL Statements, on page 26). Based on the anomaly, you may
need to release the connection.
Allocate more memory to the application. The allocated memory for a
given application is specified at startup.

1.2.2.3

Risk Infrastructure
The Risk Server WebAdmin provides monitoring capabilities for the Calculation Server, Presentation Server, and Market Data Server.
Select a Server to view (listed in a drop down on either tab). Once you
have selected a server, the controls on the tab operate against that
server.
View the Log (click Show Log)
Clear the Log (click Restart Log)
Configure the Log (click Cfg Log)
View the name and count of objects in the cache (click Cache)
Perform Garbage Collection (click GC)
View the clients connected to the server
Refresh the Connected Clients list (click Clients Refresh)
Launch the Profiler application for the server (click Profiler)
View the list of tasks for the server
Refresh the Tasks list for the server (click Tasks Refresh)
Additionally, on the Calculation Server tab, you can choose to include the
cancelled/terminated tasks for a preceding length of time.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 10

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.2.2.4

Managing the System

Database Performance
Check SQL Statements to identify queries that take too long to execute. You
can monitor the SQL queries to diagnose the source of the anomaly using
WebAdmin > * >Profiler > SQL (see Section 1.4.3.2, SQL Statements, on
page 26 for details). It can indicate that an index is missing in the database
schema, that a query is improperly configured, or that you should archive
unused data from the database tables. If none of those conditions apply, it
can indicate a defective application, in which case you must kill the corresponding process.

1.2.2.5

Tips for Improving Performance

Performance can be impacted by unconsumed events Use


WebAdmin > Data Server > Metrics > Pending Events to detect unconsumed events. See Stats under Section 1.5, Engine Server WebAdmin, on page 27 for details.
In general, to improve the performance of the system you should perform the recommended maintenance routine. Calypso offers a number
of scheduled tasks to archive and delete unused objects. See Section 2,
Recommended Routine Maintenance, on page 58.

The following environment properties allow improving the performance of


the Data Server:
Note:

Data Server properties may be set from the User Env and System Env windows. See
Section 9.2.7, Environment Properties, on page 58 in the Calypso Installation and
Upgrade Guide for details. You can view Calypso Environment Properties using
WebAdmin > * > Server > Environment Properties.

AUDIT_PRICER_CONFIG True or False. True to enable Pricer Config Audit. Setting this to False will result in no audit of Pricer Config modifications, and will speed up Pricer Config saving. Default is true.
COMPRESS_FLOWS_IN_MEMORY True or False. True to save
customized cashflows for Swap, Cap, Floor and Swaption in a compressed form in memory until they are used. Should be used in conjunction with SAVE_FLOWS_AS_BLOB. Default is true.
COMPRESS_RMI_PACKETS True of False. True to compress RMI
packets sent and received, or False otherwise. Default is False.
DS_EVENT_BUFFER_POOL_MAX_SIZE Maximum number of
events handled by a given PSConnection. When the maximum is
reached, another PSConnection is started. This number will vary from
installation to installation, and some adjustment will be necessary as the
system is deployed. The initial value should be 10,000.
This feature prevents the Data Server from blocking the Event Server.
Events are not published to the Event Server by waiting for a handshake.
Instead, a pool is set up to store the events, and a separate thread is
used to process the events.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 11

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

This feature is also available at the command line using the eventbuffersize <size> option.

JDBC_CACHE_STATEMENT True or False. True to use cache for


Java PreparedStatements in Data Server connections. This saves time
in the building of the strings in PreparedStatements. Default is false.
JDBC_USE_BATCH True of False. True to use batch update mode
whenever possible. Default is true.
JDBC_USE_STORED_PROC True or False. True to use database
stored procedures whenever possible. Default is false.
KEEP_CURVE_AS_BLOB True or False. True to compress curves in
memory. The in-memory compression happens after a curve is saved or
loaded. Whenever a compressed curve is needed, it will be uncompressed. Default is true.
KEEP_VOLATILITY_AS_BLOB True or False. True to compress volatility surfaces in-memory. The in-memory compression happens after a
surface is saved or loaded. Whenever a compressed surface is needed,
it will be uncompressed. Overall, the compression results in less memory
consumption. Default is true.
LEGAL_ENTITY_MAX_NAMES Maximum number of legal entity
names allowed per query. Since most users will not need to browse
more than a fixed number of counterparties or legal entities at one time,
setting this limit results in a faster load. Default is 1000.
MAX_DOCUMENTS_PER_USER Maximum number of documents
that a user can bulk load at once. If set, the number of documents
returned by the Data Server will be limited to this value. This prevents
one large query from using an inordinate amount of memory in the Data
Server during the load. Default is 100000.
MAX_MESSAGES_PER_USER Maximum number of messages that
a user can bulk load at once. If set, the number of messages returned by
the Data Server will be limited to this value. This prevents one large
query from using an inordinate amount of memory in the Data Server
during the load. Default is 100000.
MAX_TASKS_PER_USER Maximum number of tasks that a user can
bulk load at once. If set, the number of tasks returned by the Data Server
will be limited to this value. This prevents one large query from using an
inordinate amount of memory in the Data Server during the load. Default
is 500000.
MAX_TRADES_PER_USER Maximum number of trades that a user
can bulk load at once. If the limit is reached, a PersistenceException is
thrown and the query is cancelled. This prevents one large query from
using an inordinate amount of memory in the Data Server during the
load. Default is 0, no limit.
MAX_TRANSFERS_PER_USER Maximum number of transfers that
a user can bulk load at once. If set, the number of transfers returned by
the Data Server will be limited to this value. This prevents one large

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 12

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

query from using an inordinate amount of memory in the Data Server


during the load. Default is 100000.
SAVE_AN_OUTPUT_AS_BLOB True or False. True to save Risk
Analysis reports in a compressed form in the database. If you will not
need to query your report results directly from the database, you should
always choose to save your reports to blob format for performance reasons. There can be a factor of ten in speeding up the saving of the
report.
SAVE_FLOWS_AS_BLOB True or False. True to save and load customized cashflows of Swap, Cap, Floor and Swaption trades in a compressed form. Cashflows saved in the compressed form will not need to
be compressed prior to the trades insertion into cache, therefore this
option should always be used in conjunction with
COMPRESS_FLOWS_IN_MEMORY. Default is false.
STORE_EVENT_TIMESTAMP True or False. True to store a timestamp with each event. This should not be used under normal circumstances since there is a large impact upon performance. Hence, it is
recommended to set it to False. Default is false.
TASK_MIN_PRODUCT_INFO True or False. True to load minimum
product information in Task Station, Task Selector, Payment Report,
Advice Report, Posting Report. Only the keywords, fees and a small
product image are loaded with the Tasks. It is only when you access
trade details, by double-clicking in the respective GUI, that all the
remaining information is loaded. This results in a much faster initial load.
Default is true.

The following environment property allows improving the performance of the


Event Server:
EVENT_SERVER_QUEUE Maximum number of events buffered on
the event server queue. The average size of a Calypso event is 1K byte.
Keep in mind that there is also one event queue per Event Server client.
Default is 0, no limit.
Note:

Event Server properties may be set in User Env and System Env. See Section 9.2.7,
Environment Properties, on page 58 in the Calypso Installation and Upgrade Guide for
details.
A number of engine parameters allow improving the performance of the
engines. Refer to the Engine Thread topic in the Documentation Portal.
The following setting will improve the performance of the task engine:
Kickoff/Cutoff Configuration It is important to carefully consider your
Scan Frequency setting and set this to match your business requirements. A too frequent scan frequency will have an adverse impact upon
performance. Kickoff/Cutoff Configuration is set in the Main Entry > Configuration > Workflow menu.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 13

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Please use IDs greater than 150. If an Engine ID is later used by Calypso in a subsequent
release, simply ensure that all events have been processed, and then change that your
Engine ID to the next available Engine ID.

Note:

1.3

Managing the System

WebAdmin Common Menu Items

1.3.1

Server Menu
The menu items common to the Server menu of all WebAdmin instances are
described below.

Table 1-1: Web Admin Server Menu Items

Menu Items
Information

Description
Displays server information, such as, Current Server Time, Memory Statistics, Calypso System Settings, and the Active Data Servers list.

Server Information: Current Server Time The current date and time, including the
server Timezone setting.

Memory Statistics The Usage, Capacity, Initialized, Used, and Committed statistics for
Heap Memory and Non-Heap Memory. If the memory usage is too high, see Section
1.2.2.2, Memory Usage, on page 10 for information on freeing memory.

Calypso System Settings The current settings of Access Permissions and Authorizations. These setting are controlled via command-line arguments .

Active Data Servers The Name, Host Address, Start Date, and Read-Only (yes/no)
particulars of each Data Server that has connected to the current database.:

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 14

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-1: Web Admin Server Menu Items (Continued)

Menu Items

Description

Environment Properties

Displays the Calypso Environment properties used to launch the Server.

System Properties

Displays the System (JVM) Properties:

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 15

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-1: Web Admin Server Menu Items (Continued)

Menu Items

Description

View JNDI

Displays the JDNI resources available to the server:

Messenger

Allows the admin to broadcast messages to all client users:

Message Sent:

Message received by the Client:

This server-based version of messenger provides the functionality of Main Entry > Help >
Instant Messenger. Refer to the Calypso Getting Started User Guide for details.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 16

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.3.2

Managing the System

Metrics > Caches


Cache information is available on both the Data Server and Engine Server
WebAdmin screen.

1.3.2.1

Data Server Caches


WebAdmin > Data Server > Metrics > Caches allows Admin users to configure Data Server caches, evict trades (i.e., Trade Removal), and clear
selected Data Server Caches or all Client Caches caches. Data available for
the Server Cache is Limit Name, Hit Ratio, Current Size, and Max Size. This
information is not displayed in the Engine Server WebAdmin.
Figure 1-1: DataServer WebAdmin Metrics: Caches

Table 1-2: DataServer WebAdmin Metrics > Caches

Fields

Description

Cache Name

Name of the cache.

Hit Ratio

Percentage of cache requests that returned an object from the cache without having to access
the database.

Current Size

Current number of objects in the cache.

Max Size

The maximum number of objects held in cache since the last restart.

Client Limit

Client cache limit. Modify as applicable. A value of zero means that no limit is enforced on that
cache.
Note that this setting has an impact on the amount of memory that is allocated to the client
applications at startup.

Server Limit

Server cache limit. Modify as applicable. A value of zero means that no limit will be enforced on
that cache.
Note that this setting has an impact on the amount of memory that is allocated to the Data
Server at startup.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 17

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Select (check) one of more Server caches, then click


to clear
those caches. Although the Client Caches are not displayed, admins can
click
to clear all Client Caches. Client Caches are visible in the
Engine Server and Risk Server WebAdmin under Metrics > Caches
Admins can also configure server caches. Select the desired Cache, then
enter the Client Limit and the Server Limit. Click
to save the configuration:.
Figure 1-2: Data Server WebAdmin Configure Server Caches

1.3.2.2

Engine Server Caches


WebAdmin > Engine Server > Metrics > Caches allows the admin user to
view the cache object count and clear the client cache.
Figure 1-3: Engine Server WebAdmin Metrics Caches

Click

to clear all caches.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 18

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.3.2.3

Managing the System

Risk Server Caches


WebAdmin > Risk Server > Metrics > Caches provides the same functionality as WebAdmin > Engine Server > Metrics > Caches. See Section 1.3.2.2,
above.

1.3.3

Profiler > Request


WebAdmin > * > Metrics > Profiler allows the admin user to view or download profiling information for the each Server. The Data Server (show in Figure 1-4) displays request from Calypso servers, while the Profiler in the
Engine Server and Risk Server display requests from Clients:
Figure 1-4: WebAdmin Common Request Profiler

Click On to enable Request logging.


Click

to download a plain-text version of the Request Profile log.

Click
to download a version of the Request Profile log to Excel or to
another spreadsheet configured to view Excel spreadsheets.
Click

to clear the current information from the Request log.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 19

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.3.4

Managing the System

Logs
The WebAdmin > * > Logs screen is available for servers. Using the logs
screen, you can configure Server logging levels, restart, view, or download
logs, and download logs and diagnostic information.
Figure 1-5: WebAdmin Common Logs

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 20

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-3: Data Server GUI Controls and Fields

Fields
Categories

Description
Begin typing to select a Category from the dropdown selector. Additional selected items
are automatically separated by a comma. The default is ALL. If left blank, click
to use
the default:

You can exclude certain log categories when the log category is set to ALL by prefixing a
category with as shown in the example below:

Log Levels
Debug

Select to include Debug level trace in the Data Server log.

Info

Select to include Info level trace in the Data Server log.

Warn

Select to include Warning level trace in the Data Server log.

Error

Select to include Error level trace in the Data Server log.

Controls
Click to begin using the specified logging categories and levels in this session of the Data
Server.
Click Restart Log to archive the current logs and begin a new logs.
Click to download the selected logs and a text file containing diagnostic information for
your Calypso implementation. The name of the zip-compressed file that contains the log(s)
and diagnostic information file is:

calypso-server-logs-YYYY-MM-DD-HH-MM-SS.zip
Click to download a text file with Calypso Diagnostic Information. The file contains:

DataServer Options
Engine Parameters
Event Configuration
Calypso Environment Properties
JVM/Java/JBoss System Properties

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 21

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.4

Managing the System

Data Server WebAdmin


The Data Server WebAdmin allows the user to view information and logs
pertaining to the Data Server. WebAdmin allows the admin to change logging levels and categories and Server cache limits. Other runtime control
changes are not supported.

1.4.1

The Data Server WebAdmin Server Menu


Items common to WebAdmin pages for all servers are covered under Section 1.3.1, Server Menu, on page 14. The following items are specific to the
Data Servers WebAdmin Server Menu

Table 1-4: WebAdmin Data Server: Server Menu Items

Menu Items
Login Attempts

Description
Opens the Login Attempt window which allows the admin to view, delete or archiving login
attempts, as shown below.

Enter a From date and a To date. You can also enter an SQL where clause on the
user_login_att table. Then click Load.

Click Delete to physically delete the login attempts currently loaded.


Click Purge to archive the login attempts currently loaded.

Note that the user_login_hist table gets filled from the user_login_att table
(which records user login attempts) when user_login_att is purged.
You can disable auditing of login attempts for all users by setting the environment property
DISABLE_LOGIN_AUDIT to True.
You can disable auditing for a list of users by setting the environment property
ACCOUNT_LOGINS_NOT_AUDITED to a list of comma separated list of user names that will
not be audited (only applies if DISABLE_LOGIN_AUDIT is set to False).
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 22

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-4: WebAdmin Data Server: Server Menu Items

Menu Items

Description

Restricted Mode

When the Data Server is operating in Restricted Mode, this item gives access to the Allow
Login function, whereby an Admin can allow specified users to login.
This option can only be chosen if the Data Server is launched in Restricted Mode.

Allow Login

Only applies when the Data Server is started in restricted mode. See Section 10.3, Data
Server Arguments, on page 63 for details.
Opens the Allow Login window as shown below.

1.4.2

You can select all non admin groups, or a subset of non admin groups. The corresponding non admin users will be displayed. You can select all non admin users or a subset of
non admin users.

Click Apply to allow the corresponding users to reconnect.

Data Server Metrics Menu


WebAdmin > Dataserver > Metrics menu provides the following Data Server
information:
Caches Covered in Section 1.3.2.1.
Tasks Covered below.
Pending Events
Publish Statistics

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 23

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.4.2.1

Managing the System

Task Statistics
WebAdmin > Dataserver > Metrics > Tasks provides the Task Statistics for
the Data Server:
Figure 1-6: WebAdmin Data Server Metrics: Task Statistics

The screen displays one Task and its associated statistics per row.

1.4.2.2

Pending Events
WebAdmin > Dataserver > Metrics > Pending Events displays the Pending
Events screen:
Figure 1-7: WebAdmin Data Server Metrics: Pending Events

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 24

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.4.2.3

Managing the System

Publish Statistics
WebAdmin > Dataserver > Metrics > Publishing Statistics displays the Event
Publishing Statistics screen:
Figure 1-8: WebAdmin Data Server Metrics: Event Publishing Statistics

1.4.3

Data Server Monitoring

1.4.3.1

Clients
You can view all connected client applications from WebAdmin > Dataserver
> Monitoring > Clients:
Figure 1-9: WebAdmin Data Server Monitoring: Connected Clients

Note:

Note that SQL monitoring consumes considerable resources and should only be used to
diagnose database issues.
The screen displays one connected client application per row. From this
screen you can:
Click
to disconnect any particular client by clicking the stop button on
its row.
Click
to disconnect all connected clients.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 25

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.4.3.2

Managing the System

SQL Statements
You can view and monitor database connections and statistics from
WebAdmin > Dataserver > Monitoring > SQL Statements:.
Figure 1-10: Data Server WebAdmin Monitoring SQL Statements

You can view the database connections for all Hosts and Connections, a
specific Host or Connection, or a combination of the two.

Only View Connection Counts


1. Select Off.
2. Click
to display connection counts for the selected Host/Connection
combination:
Figure 1-11: Data Server Webadmin Monitoring SQL Statements: Connection Counts

You can also set the KEEP_CONNECTION_STACK_TRACE=Y environment property to trace the database connections by defaults.
Only SQL statements that take an extended time appear in this panel. If
a given SQL statement takes too long and impacts the performance of
the system, it can indicate an index missing in the database schema, an
improperly configured query, or database tables that should be archived
to remove unused data.
It can also indicate a defective application, in which case you need to kill
the corresponding process: select the connection that initiated the
request from the Connections field and click Release Connection to stop
it.

View All Connection Data


1. Select On.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 26

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

2. Click
to display all connection data for the selected Host/Connection combination:
Figure 1-12: Data Server Webadmin Monitoring SQL Statements: Full Connection Data

Other Actions

1.5

Click
tor.
Click

to break the connection specified in the Connection selecto clear currently displayed connections from the screen.

Engine Server WebAdmin

1.5.1

Engine Server Manage Engines


WebAdmin > Engine Server > Manage > Engines allows the admin to view
the status and Startup Properties of engines available in the Engine Server,
and to start or stop listed engines:
Figure 1-13: Engine Server Webadmin Manage Engines

Rows for running engines are light green. Click


engine.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

or

to stop or start an

Page 27

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.5.2

Managing the System

Engine Server Metrics: Event Statistics


WebAdmin > Engine Server > Metrics > Event Processing Statistics displays
event statistics for each engine:
Figure 1-14: Engine Server Webadmin Metrics: Manage Engines

1.6

Risk Server WebAdmin


The Risk Server has only a single menu option that is not covered under
Section 1.3, WebAdmin Common Menu Items, on page 14.

1.6.1

Monitoring > Presentation Server


WebAdmin > Risk Server > Monitoring > Presentation Server provides monitoring information for the current Presentation Server. Runtime changes and
configuration changes are not possible from this screen:

Figure 1-15: Risk Server WebAdmin Monitoring: Presentation Server

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 28

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

The Official checkbox indicate if the Presentation server is the primary


Presentation Server or an ad hoc server.
Table 1-5: Risk Server WebAdmin Monitoring > Presentation Server

Item Name

Description

Presentation Server Details


Configuration Name

The name of the configuration used to launch the server.

Client Port
Server Start Time

The time the server launched.

Official

Is the server Official or Ad Hoc?

Presentation Server Clients


Username

The name of the User who initiated the report.

Host

The machine that is running the server.

Port

The port.

Analysis

Analysis Type

Params

The parameters the report was run with.

Trade Filter

The name of the trade filter that this analysis is run


against.

Pricing Env

The pricing env that this analysis uses.

Val Date

The valuation datetime of the analysis.

Application Name

The name of the report.

Subscribe Time

The time the user subscribed to the report.

Last Query Time (ms)

The time the report began.

Last Response Time (ms)

The duration spent creating the output.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 29

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.6.2

Managing the System

Monitoring > Calculation Server


WebAdmin > Risk Server > Monitoring > Calculation Server provides monitoring information for the current Calculation Server. Runtime changes and
configuration changes are not possible from this screen:

Figure 1-16: RiskServer Webadmin Monitoring: Calculation Server

The Official checkbox indicate if the Calculation server is the primary Calculation Server or an ad hoc server.
Table 1-6: Risk Server WebAdmin Monitoring > Calculation Server

Item Name

Description

Calculation Server Details


Configuration Name

The name of the configuration used to launch the server.

Client Port
Server Start Time

The time the server launched.

Official

Is the server Official or Ad Hoc?

Calculation Server Clients


Username

The name of the User who initiated the report.

Host

The machine that is running the server.

Port

The port.

Application Name

The name of the report.

Uptime (minutes)

How long the server has been running.

Subscribe Time

The time the user subscribed to the report.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 30

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

The following information is provided in the Services Table:


Table 1-7: RiskServer Webadmin Monitoring > Calculation Server: Services Table

Columns Names

Description

Service ID

Unique identifier of the analysis run

Start Time

The time at which this analysis was first loaded

Uptime (mins)

The total time this analysis has been up and running in minutes

Data Table

The name of the database table to which the results of analysis run are persisted to.

Iteration

The number of runs or iteration this analysis has gone


through

Analysis

Analysis Type

Params

Name of analysis parameters.

Trade Filter

The name of the trade filter that this analysis is run against.

Pricing Env

The pricing env that this analysis uses.

Val Date

The valuation datetime of the analysis.

Trade Freq

Frequency of trade incremental update (in seconds).

MDI Freq

Frequency of the market data incremental update (in seconds).

Current Run

Current Run

Status

Status of the current run. Should be:


Initialization

Market Data
Update

Initial Run

Local/Grid Trade
Local/Grid MDI & MDI
Ready

Trade Count

Number of trade in this run.

Start Time

The time at which this run was initiated.

Run Type

Type of the run such as "Initial' or "Trade."

Status

Status of current Market Data Update.

Trade Count

Number of trades in current market data run.

Start Time

Start time of this market data run.

Start Time

Start time of this initial run.

Duration(s)

The duration of the initial run in seconds.

Trade Count

Number of trades in the initial run.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 31

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-7: RiskServer Webadmin Monitoring > Calculation Server: Services Table (Continued)

Columns Names
Next Run

Last Run

Trade Update

Queue Size

The number of trades in the next trade update.

Start Time

Scheduled start time of the next trade update.

Market Data
Update

Queue Size

The number of trades in the next market data update.

Start Time

Scheduled Start time of the next Market data update.

Market Data
Catchup

Queue Size

The number of trades in the market data catch up queue.

Trade Update

Start Time

The time at which the last trade update happened.

Duration(s)

Duration of how long the last trade update took.

Trade Count

The number of trades in the last trade update.

Start Time

The time at which the last market data update took place.

Duration(s)

Duration of how long the last market data update took.

Trade Count

The number of trades in the last market data update.

Start Time

The time at which the last market data catchup started.

Duration(s)

Duration of the last market data catch up.

Trade Count

Number of trades in the last market data catchup.

Market Data
Update

Market Data
Catchup

1.7

Description

Generating and Viewing Error Logs


When a problem is encountered or suspected, be sure to check your log
files. In particular, always check the Server log (Data Server, Engine Server,
and the Risk Servers separate CalculationServer and PresentationServer
logs) files in addition to the log file for the application you are trying to run.
Calypsos logging system:
Is Based on a named category set
Has 6 priority levels: DEBUG, INFO, WARN, ERROR, FATAL, and
SYSTEM
Is optimized for speed and is thread-safe
Is Designed to handle Java Exceptions
Provides a GUI log viewer and filter

1.7.1

Enhanced Logging
Calypso contains enhanced logging capabilities using the ASF's1 log4j logging library. Application logging, as well as Calypso's own monitoring logging
is provided.
Logging provides a substantial portion of the information required for system
analysis. Calypso's enhanced logging is very configurable and provides
many levels of detail for various functional categories. Enhanced logs are
stored in the same location as standard application logs.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 32

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Application logs contain the following types of information:


JAVA_HOME
USER_HOME
JAVA_VERSION
OS Name
OS Arch
OS Version
User
Timezone
Classpath (List of class path elements with missing items designated as
missing.)
Hostname
Data Server Name
RMI Port
Logs generated by Enhanced Logging contain information for specific areas
of application operation:
SQL
Events
WorkFlow
ClientRequest
Engine
TaskStation
Not every Category is applicable to every application. For example, Main
Entry does not process any SQL and therefore, the Main Entry's SQL monitoring log is always empty. The data contained in Monitoring logs differs by
category.

1.7.2

JMX Monitoring
Calypso supports the use of the Java Monitoring & Management Console
(JConsole). By default, JMX Monitoring is enabled for all applications.
Use the following command line to launch the pre-configured JConsole that
is included with JBoss. The invoking script file is pre-configured to attach to
the JBoss server:
$JBOSS_HOME/bin/jconsole

1. The Apache Software Foundation provides organizational, legal, and financial support
for a broad range of open source software projects. The Foundation provides an
established framework for intellectual property and financial contributions that simultaneously limits contributors potential legal exposure. Through a collaborative and meritocratic development process, Apache projects deliver enterprise-grade, freely
available software products that attract large communities of users.
http://www.apache.org/
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 33

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Figure 1-17: Java Monitoring & Management Console (JConsole)

1.7.2.1

Using JConsole
Operation and analysis data from JConsole is beyond the scope of this document. Please refer to JConsole -> Help > Online Help to view JConsoles
documentation (maintained by Oracle) or visit:

http://docs.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 34

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.7.2.2

Managing the System

Making a Connection from JConsole to Calypso


1. In JConsole, press CTRL+N or select Connection > New Connection...
from the menu to open the New Connection window:
Figure 1-18: JConsole New Connection Window

2. Select the desired application.


3. Click

to open the Monitoring window.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 35

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

The following images are example of the Monitoring window displaying information pertaining to the Calypso Task Engine:
Table 1-8: JConsole Overview Tab

Table 1-9: JConsole Memory Tab

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 36

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-10: JConsole Threads Tab

Table 1-11: JConsole Classes Tab

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 37

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-12: JConsole VM Summary Tab

Table 1-13: JConsole MBeans Tab

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 38

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.7.2.3

Managing the System

Exposed Metrics in Calypso


Exposed by All Server Components

Table 1-14: Metrics Exposed by All Server Components

Metric Name

Description

Application Start Time

Time when the application was started

Exposed by the Data Server


Table 1-15: Metrics Exposed by the Data Server

Metric Name

Description

Persisted Event Queue

Current persisted event queue per engine.

Cache Metrics

The following are exposed for each Cache within the Data Server:

List of Logged in Users

Configured Max Size


Current size
Hit Ratio

List of Users logged on for the Corresponding Tenant that this DataServer
belongs to (Multi-Tenancy implementations), or simply a list of Users currently
logged on to the Data Server (traditional Calypso implementation).

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 39

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Exposed by Engines
Metric Name

Description

Engine Mode

Current mode of the engine in the following form:

Real-Time Indicates that events are being received via the bus.

Batched Load Indicates that the engine has switched to batch mode and
is currently loading missed events.

Idle Indicates that there are no events to process.

Batched Processing Indicates that the engine has switched to batch mode
and is catching up on event processing.

Thread Count

The number of engine threads currently running.

Unconsumed Events count /Event


Type

They count of the unconsumed Events by Event Type.

Bad Event Count

The count of events that the engine was not able to read/process.

Unconsumed Good Events

The difference between the Unconsumed Events Count and Bad Events Count. If
this number is positive and not decreasing, the engine is not consuming events.

Average Event Load Time

The Average time to load events from the Database.

Event Load Count

The number of times that events are loaded from the Database.

Start Time

Engine start time

MaxEventsInBatch

The maximum number of Events to fetch from the Database in a single request
when the engine is in batch mode.

MaxEventsInQueue

The maximum number queued Events held the engine before the engine
switches to batch mode.

OldestUnConsumedEventTimeStamp

The creation timestamp of the oldest unconsumed Event.

1.7.2.4

Disabling JMX Monitoring


If you wish to disable JMX Monitoring, launch Calypso using the following
JVM argument:

-Dcom.calypso.management.jmxenabled=false

1.7.3

Setting Logging Behaviour, Levels, and Categories


Application Log statements are output to the log depending on their Level
and Category. The application programmer uses Categories and Levels to
maintain runtime control over which statements are printed. You can change
the logging Levels and the Categories that are logged using the Admin Monitor Window or from the command line when launching a Calypso application.
You can alter the filesystem behaviour of Calypso's logging using environment properties.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 40

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.7.3.1

Managing the System

Log File Behaviour


Modify the following environment properties to change logging behaviour as
desired:

Table 1-16: Logging Environment Properties

LOG_MAXFILESIZE=nnn

The size of the file in bytes (10000000 is 10MB) before it is backed up/
rolled. Sizes below 10MB are not supported.`

LOG_MAXBACKUPINDEX=n

The maximum number of back up files to retain.

1.7.3.2

Setting Categories and Log Levels


Set the logging Levels and Categories or alter them at runtime using WebAdmin > * > Logs screen or from the Main Entry menu: Utilities-> Maintenance -> Log -> Configure Log. You can also use the application's
arguments on the command line to control logging. You can save Log levels
and categories in your User Env and System Env.

Note:

Command-line arguments override log settings in User Env and System Env.
To access the Log Properties Window, select Main Entry -> Utilities ->
Maintenance -> Configure Log:
Figure 1-19: Log Properties Dialog

Alternatively, open the Admin Monitor Window to the Apps tab, where you
can also modify Log Properties:
The Logging Levels are selected using the checkboxes (highlighted).
Whether you modify the Log Properties from the Admin Monitor Window or
from the Log Properties window, the process is identical.
1. Select the desired Log Levels.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 41

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

2. Click the Ellipsis button to open the Select Categories window.


Figure 1-20: Select Categories Dialog

3. Select the desired Categories and shift them to the right-hand pane to
use or shift them back to the left hand pane to ignore.
4. Click OK to retain selected Categories, or click Cancel to abandon any
changes.

1.7.4

Enhanced Application Logging Contents


Enhanced application log entries are directed to a log file or to the console.
An event is published to the Event Server when the Log level is ERROR,
SYSTEM, or FATAL, and it has an associated Exception. Log Levels and
Categories are configured from the Admin Monitor Window or from the Log
Properties window.
Table 1-17: Enhanced Application Logging Fields

S.No

1.7.4.1

Information

Description

LOGLEVEL

DEBUG/INFO/WARN/ERROR/SYSTEM/FATAL

DATE

LOG CATEGORY

Logging category

THREAD

Executing Thread

HOST

Client Host (if any) on whose behalf the code that


produced the log is executed

CLIENT DESCRIPTION

Client Description, if any, on whose behalf the code


that produced the log is executed.

MESSAGE

Message passed as the log statement

Application Log Naming


Each application log filename has the format:
AppName_UserEnv_MonitoringCategory_CalypsoVersion.log
Where:
AppName the name of the application being monitored.
UserEnv the current environment name

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 42

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

MonitoringCategory The type of event being monitored.


Each Logging Category writes to a specific file for the Application being
monitored, with the format:
AppName_UserEnv_MonitoringCategory_CalypsoVersion.log

For example, the rel100000 UserEnv application logs have the following filenames:
UserEnv_myenv_CLIENTREQUEST_100000.log
UserEnv_myenv_WORKFLOW_100000.log
UserEnv_myenv_TASKSTATION_100000.log
UserEnv_myenv_SQL_100000.log
UserEnv_myenv_SERVEREVENTS_100000.log
UserEnv_myenv_REQUEST_100000.log
UserEnv_myenv_ENGINE_100000.log
Once the specific logging category is enabled, the corresponding log files
can be found in the same location as the standard application logs. Note that
a specific application may might not have functions for any particular category and therefore that log would be empty.

1.7.5

Application Logs

1.7.5.1

Event Log
Event logs contain details on all events passing through the system. Each
event is a single entry having the following information:

Table 1-18: Event Log Fields

S.No

Information

Description

CURRENT TIME IN MILLIS

Current time in milli seconds

EVENT OCCURED TIME

Time the event has occured

EVENT ID

Event ID

EVENT CLASS NAME

Event Class Name

EVENT DESC

Event Description

1.7.5.2

Request Logs
Request Logs can be toggled at runtime. When enabled, a single line for
each request is logged.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 43

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Server-Side Request Logs


Server-side requests log the following items:
Table 1-19: Server-Side Request Log Fields

S.No

Information

Description

REQUEST TIME

Time request has been received

RESPONSE TIME

Time spent executing the request

REQUEST SQL TIME

Time spent in executing sql as part of this


request

REQUEST BEGIN FREE MEMORY

Free Memory available at the start of the


request

REQUEST END FREE MEMORY

Free Memory available at the End of the


request

TOTAL MEMORY

Total memory available

WF TIME

Time spent in the workflow as part this


request

REQUES TEVENTS

Total no of events saved as part of this


request

REQUEST USED JDBC CONNECTIONS

JDBC Connections that are used at the point


this log message is logged

10

REQUEST AVAILABLE JDBC CONNECTIONS

Free JDBC Connections available at the


point this log message is logged

11

CLIENT HOST

Host of the client that made this request when


available

12

CLIENT DESCRIPTION

Description of the client that made this


request when available

13

REQUEST ID

Unique request ID (i.e., unique during this


server session) that is generated for this
request

14

SERVICE NAME

Name of the service that received the request

15

METHOD NAME

Name of the requested method.

Client-Side Request Log


Client-side requests log the following items:
Table 1-20: Client-Side Request Log Fields

S.No

Information

Description

REQUEST TIME

Time request was sent to the server

RESPONSE TIME

Time taken to receive the response from the


server

REQUEST BEGIN FREE MEMORY

Free Memory available at the start of the


request

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 44

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-20: Client-Side Request Log Fields

S.No

Information

Description

REQUEST END FREE MEMORY

Free Memory available at the End of the


request

TOTAL MEMORY

Total memory available

METHOD NAME

Name of the remote method that is accessed

1.7.5.3

SQL Log
The SQL Log records all SQL activity and may be controlled at anytime. This
log is controlled by a toggle and threshold on execute time. All values above
the execute threshold are logged. If the threshold is set to 0, all SQL statements are logged.

Table 1-21: SQL Log Fields

S.No

Information

Description

S.No

Information

Description

STARTTIME

SQL Execution start time in milli seconds

EXECUTETIME

Time taken to execute the SQL in milli seconds

LOG CATEGORY

Logging category, Possible values are:


Monitoring.Sql.Execute.Statement
Monitoring.Sql.Execute.PreparedStatement
Monitoring.Sql.Execute.Callable

NUMBER OF ROWS READ

No of rows read if this statement is a query

RESULT SET OPEN TIME

Total time result set was open in milli seconds

RESULTSET CREATE TIME

Time the result set was created in milli seconds

RESULTSET LAST FETCH TIME

The time when the result set next was called before the
log statement(close of the resultset)

CLIENT HOST

Host of the client that made this request when available

CLIENT DESCRIPTION

Description of the client that made this request when


available

REQUESTID

Unique request id(Unique for the time the servers session) that is generated for this request

SQL STATEMENT

The sql statement executed

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 45

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.7.5.4

Managing the System

Work Flow Log


The Workflow Log records all the workflow rules run for this request.

Table 1-22: Work Flow Log Fields

S.No

Information

Description

STARTTIME

Start time of the execution of the rule

RULEEXECUTIONTIME

Time spent executing the work flow rule

WORKFLOWNAME

Name of the work flow

WORKFLOWRULECLASSNAME

Class of the WorkFlow Rule

WORKFLOWCLASSNAME

Class of the Work Flow

WORKFLOWID

Work Flow Id

LOGCATEGORY

Logging category possible values are:


Monitoring.WorkFlow
Monitoring.Workflow.Trade
Monitoring.Workflow.Trade.Update
Monitoring.Workflow.Transfer.Check
Monitoring.Workflow.Message
Monitoring.Workflow.Message.Check
Monitoring.Workflow.Message.Update
Monitoring.Workflow.Entity
Monitoring.Workflow.Entity.Check
Monitoring.Workflow.Entity.Update

1.7.5.5

Engine Log
The Engine Log provide event timing details for the engines.

Engine Log Fields


S.No

Information

Description

STARTTIME

Start time of the execution engine process for the


event

EXECUTIONTIME

Time spent executing the the engine process for


the event

EVENTID

The id of the event received

EVENT DESCRIPTION

Description of the event

LOG CATEGORY

Logging category, possible values are:


Monitoring.Engine.Process

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 46

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.7.6

Managing the System

Task WorkStation Log


The Task Workstation log provide information on events related to Task
Workstation Events.

Table 1-23: Task Worstation Log Fields

S.No

Information

Description

Monitoring.TaskStation.Tab
1

START TIME

DURATION

ALLTRADETASKSIZE

ALLTRADETASKSIZE-PREVIOUSALLTRADETASKSIZE
ALLPAYMENTTASKSIZE
ALLPAYMENTTASKSIZE-PREVIOUSALLPAYMENTTASKSIZE
ALLMESSAGETASKSIZE
ALLMESSAGETASKSIZE-PREIOUSALLMESSAGETASKSIZE
ALLEXCEPTIONTASKSIZE
ALLEXCETIONTASKSIZE-PREVIOUSALLEXCEPTIONTASKSIZE
TABITEMNAME/TABEITEMEVENTCLASS

This data repeats for each tab item

TABITEMTASKSIZE - PREVIOUSTABITEMTASKSIZE
ACCEPTED
TASK DESCRIPTION
Monitoring.TaskStation.Show
START TIME
DURATION
ALLTRADETASKSIZE
ALLPAYMENTTASKSIZE
ALLMESSAGETASKSIZE
ALLEXCEPTIONTASKSIZE
TABITEMNAME/TABEITEMEVENTCLASS

This data repeats for each tab item

Monitoring.TaskStation.Event
START TIME
DURATION
CURRENTEVENTCOUNT
PENDINGEVENTCOUNT
EVENTID
EVENT DESCRIPTION
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 47

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

Table 1-23: Task Worstation Log Fields (Continued)

S.No

Information

Description

Monitoring.TaskStation.Load.Task/Monitoring.TaskStation.Load.Trade
Monitoring.TaskStation.Load.Transfer/Monitoring.TaskStation.Load.Message
START TIME
DURATION
SIZE

Size of Task/Trade/Transfer of Message

Monitoring.TaskStation.Load
START TIME
DURATION
TASK ENDTIME-TASK STARTTIME
ALLTASKSSIZE
TRADE ENDTIME TRADE STARTTIME
ALL TRADE SIZE
TRASFER ENDTIME TRANSFER STARTTIME
ALL TRANSFER SIZE
MESSAGE ENDTIME MESSAGE STARTTIME
ALL MESSAGE SIZE

1.7.7

Sample PROD_REQUEST Log


Sample lines from DataServer_PROD_REQUEST_90003.log. Each line
contains the fields previously described, with a | delimiter between fields.

Example Log Lines


1212450488654|232|27|49408224|57778008|527761408|0|0|0|2|
10.1.1.13 (hostname.calypso.com)|calypso_user/hostname:3290/Admin|297|
ReferenceDataServer|public abstract com.calypso.tk.event.EngineConfig
com.calypso.tk.service.RemoteReferenceData.getEngineConfig() throws
java.rmi.RemoteException
1212450490605|75|73|57778008|57842952|527761408|0|0|0|2|
10.1.1.13 (hostname.calypso.com)|calypso_user/hostname:3290/Admin|298|
AccessServer|public abstract java.util.Hashtable
com.calypso.tk.service.RemoteAccess.getPendingProcessingCount(java.lang.String) throws
java.rmi.RemoteException

1.8

Risk Infrastructure Monitoring Logs


Risk Infrastructure logging and performance logging is available from the following servers/clients:

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 48

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.9

Managing the System

Risk Infrastructure Performance Monitoring Logs


Risk Infrastructure performance logging is available from the following
servers/clients:
Calculation Server
CalculationServer_ENV_NAME_EXECUTION_VERSION.log

Presentation Server
PresentationServer_ENV_NAME_EXECUTION_VERSION.log

Calypso Work Station


RemoteReport, Presentation
Composite Analysis

Pricing Analysis

CompositeAnalysis
PricingAnalysis

Reset Risk Analysis


ResetRiskAnalysis

Cross Asset P&L


CrossAssetPLAnalysis

Simulation
SimulationAnalysis

1.9.1

Logging

1.9.1.1

Calculation Server
Calculation Server Monitoring Logs have names in the form:
CalculationServer_ENV_NAME_EXECUTION_VERSION.log

All columns providing a time period are in milliseconds.


Log Categories to enable
Monitoring.CalculationServer.Run
The following information is logged in sequence given:
EVENTOCCUREDTIME - The time at which event took place.
RESPONSETIME - The time required to process the event.
SOURCE - The source that triggered this event, which is one of
the following:
INITIAL_RUN_AD_HOC
INITIAL_RUN_COLD_START
INITIAL_RUN_WARM_START
TRADE_UPDATE
MARKET_DATA_UPDATE

NEWTRADECOUNT - The number of new trades in this run.


MODTRADECOUNT - The number of modified trades in this run.
REMTRADECOUNT - The number of removed trades in this run.
JOBSCOUNT - The number of jobs produced. One, if not using

calculators.
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 49

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

ROWSCOUNT - The number of rows saved into database.


TRADELOADINGTIME - The time taken to load trades ( only dur-

ing initial run).

BUILDMKTDATADEPENDENCIESTIME - The time required to build

market data dependencies (only during the initial run).


GENERATEHEADERTIME - The time required to generate the
header ( only during initial run).
CREATEDATASTORETIME - The time required to create data
stores and tables (only during initial run).
ANALYSISRUNTIME - The time required to run the analysis.
ANALYSISRESULTTRANSLATIONTIME - The time required to
translate analysis output into rows to be saved into the database.
SAVERESULTSTIME - The rimerequired to save the results into
the database.
MARKCOMPLETIONTIME - The time taken to mark the run complete, which includes marking rows to be visible for users and
deleting old rows.
SERVICEID - The unique service ID of this run.
SERVICEDESC - A service description, which includes the trade
filter name, analysis name, etc.
CLIENTDESC - The requester of this service.
BEGINFREEMEMORY - Memory before the run.
ENDFREEMEMORY - Memory after the run.
TOTALMEMORY - Total memory.

Example
1281051325562|54313|INITIAL_RUN_COLD_START|2|-1|
-1|1|2|4407|0|156|5797|25110|16|141|1000|calc-server-1 1 1281051325421|Composite/
2601/default/pricing1/calc-server-1/null/1/-1/-1|[calypso_user/hninaunglt:1349/
PresentationServer]|8046256|6550944|29798400|Initialization Done

1.9.1.2

Other Logs
Main Entry
Calypso Workstation

1.9.1.3

Analysis-Specific Logs

Composite Analysis (CompositeAnalysis)


Pricing Analysis (PricingAnalysis)
Reset Risk Analysis (ResetRiskAnalysis)
CAPL (CrossAssetPLAnalysis)
Simulation Analysis (SimulationAnalysis)

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 50

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.9.2

Managing the System

Troubleshooting Log Errors


Error while creating table for analysis

Caused by: java.sql.SQLSyntaxErrorException: ORA-00955: name is already used by an


existing object

PROBLEM
The Middle Tier creates tables and views on the fly when attempting to save
analysis results. The table name is usually cs_xxx. When attempting to create a new table, a table or view having the same name exists and was not
cleaned up (i.e., deleted) during a prior run.

SOLUTION
The following solutions are listed in the order of their suitability. Note that
option three is offered as a last resort and should be used with extreme caution as changing table seeds may have have unforeseen consequences.
1. Drop and recreate your new Middle-Tier database and run executesql
again.
2. Clean up your Middle-Tier database. Delete all tables and views that are
cs_xxx or delete_xxx.
3. Run the following sql against the middle tier db:
update middletier_seed set last_id=yyyy where seed_name='TableSeed';"

yyyy must be a number that is greater than any table number in the
Middle Tier. For example, if your middle-tier database has a table named
cs_5000_xxxx, then, set yyyy=5001.

PREVENTION
Always manually unload an analyses before shutting down the Middle Tier.

Could not load analyses-persistence.properties


Caused by: java.lang.RuntimeException: Could not load
analyses-persistence.properties

PROBLEM
analyses-persistence.properties is required to launch the Middle Tier.
The file is not in your classpath and cannot be located.

SOLUTION
1. Place analyses-persistence.properties in
$CALYPSO_HOME/resources.
2. Ensure that $CALYPSO_HOME/resources is in the classpath before
launching the Calculation Server and Presentation Server.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 51

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

PREVENTION
Ensure that $CALYPSO_HOME/resources is in your classpath and that
analyses-persistence.properties is present.

Middle Tier DB may not be hosted on Calypso core database


java.lang.RuntimeException: Middle Tier DB may not be hosted on Calypso core
database

PROBLEM
The Middle Tier requires its own dedicated database. This database cannot
be the same as the Core Calypso database. There are two possibel causes
for this error:
1. The Middle-Tier Database settings in your
calypso*.properties.ENV_name file are pointing to your Core Calypso
database.
2. When running ExecuteSQL on the Middle-Tier database,
SchemaBase.xml was used, rather than the required
MiddleTierSchemaBase.xml.

SOLUTION
1. Verifiy that the Middle-Tier Database settings in
calypsouser.properties.ENV_name and calypsosystem.properties.ENV_name (if it exists) match the parameters for your Middle-Tier
database.
2. Drop all tables in the Middle-Tier database, then run ExecuteSQL using
the -MiddleTier argument.

PREVENTION
For the MIddle-Tier Database, ensure that ExecuteSQL is run with the
-MiddleTier argument
Ensure that the Middle-Tier Database settings are correctly pointing to your
MIddle-Tier database.

ERRORS FROM SQLBASEDANALYSISOUTPUT.JAVA


java.lang.NullPointerException
at java.text.MessageFormat.applyPattern(MessageFormat.java:434)
at java.text.MessageFormat.<init>(MessageFormat.java:365)
at java.text.MessageFormat.format(MessageFormat.java:823)
at com.calypso.tk.risk.analysis.output.SQLBasedAnalysisOutput.buildCreates
(SQLBasedAnalysisOutput.java:437)
at com.calypso.tk.risk.analysis.output.SQLBasedAnalysisOutput.buildStatements
(SQLBasedAnalysisOutput.java:390)
at com.calypso.tk.risk.analysis.output.SQLBasedAnalysisOutput.<init>
(SQLBasedAnalysisOutput.java:366)
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 52

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

at com.calypso.tk.risk.analysis.AOBatchedPersistor.<init>(AOBatchedPersistor.java:66)
at com.calypso.tk.risk.AnalysisOutputPersistorFactory.getPersistor(
AnalysisOutputPersistorFactory.java:204)
at com.calypso.tk.risk.AnalysisOutputPersistorFactory.getPersistorInterface
(AnalysisOutputPersistorFactory.java:169)
at com.calypso.tk.risk.AnalysisOutputPersistorFactory.getPersistor
(AnalysisOutputPersistorFactory.java:67)
at com.calypso.tk.risk.DefaultAnalysisOutputTempDAL.initializeDataStore
(DefaultAnalysisOutputTempDAL.java:241)
at com.calypso.tk.risk.service.RiskOnDemandServiceWorkerImpl
$RiskOnDemandServiceWorkerCallBack.incrementalJobCompleted
(RiskOnDemandServiceWorkerImpl.java:1746)
at com.calypso.tk.distproc.AnalysisDispatcher.incrementalProcessJobOutput
(AnalysisDispatcher.java:445)
at com.calypso.tk.distproc.AnalysisDispatcher.taskFinished
(AnalysisDispatcher.java:394)
at com.calypso.tk.distproc.ScenarioAnalysisDispatcher.taskFinished
(ScenarioAnalysisDispatcher.java:1205)
at com.calypso.tk.distproc.DistAnalysis.jobFinished(DistAnalysis.java:463)

PROBLEM
There are three probably causes:
1. The $CALYPSO_HOME/resources directory is not in your classpath.
2. analyses-persistence.properties is not in $CALYPSO_HOME/resources
resources directory
3. Your copy of analyses-persistence.properties is outdated.

SOLUTION
1. Ensure that $CALYPSO_HOME/resources directory is in the classpath.
2. Ensure that $CALYPSO_HOME/resources is in the classpath before
launching the Calculation Server and Presentation Server.
3. Ensure that
$CALYPSO_HOME/resources/analyses-persistence.properties

is the version delivered with your release and not one copied from a previous release..

PREVENTION
Ensure that the $CALYPSO_HOME/resources directory is in the classpath
and that analyses-persistence.properties is present and current.

Invalid config name


Time:02 Nov 2010 11:25:02,140 Level:ERROR Thread:main Host:Category:com.calypso.ConfigRetriever
Message:
Invalid config name=[MYCS]
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 53

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

PROBLEM
You have either specified the wrong calculation-server or presentationserver name, or one that does not exist.

SOLUTION
1. Specify the correct Calculation Server or Presentation Server name.
a. Verify the Calculation Server name:
Main Entry -> System -> Calculation Server ...
b. Verify the Presentation Server name:
Main Entry -> System -> Presentation Server ...
c. Ensure that the configuration name you specify is correct and that
they exist.

PREVENTION
Correctly specify your Calculation Server and Presentation Server names.

Risk Infrastructure cannot connect to your database


org.hibernate.TransactionException: Transaction not successfully started
...
org.hibernate.exception.GenericJDBCException: Cannot open connection
...
Caused by: java.sql.SQLException: Connections could not be acquired from the
underlying database!
...
Caused by: com.mchange.v2.resourcepool.CannotAcquireResourceException: A
ResourcePool could not acquire a resource from its primary factory or source.
...

PROBLEM
Risk Infrastructure cannot connect to your database. There are two probably
causes:
1. The Middle Tier Database properties in
calypso*.properties.ENV_name are incorrect. For example, the database password is incorrect, etc.
2. The RDBMS is not online.

SOLUTION
1. Ensure that the Middle Tier Database properties in
calypsouser.properties.ENV_name and
calypsosystem.properties.ENV_name (if it exists) are correct.
2. Ensure that the RDBMS is online. Either restart the RDBMS or, if it is
hosted on a shared server, ask the DBA.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 54

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

PREVENTION
Verify that the Middle-Tier Database properites in
calypso*.properties.ENV_name are correctly and that your database is
online.

Invalid config name


Time:02 Nov 2010 11:25:02,140 Level:ERROR Thread:main Host:Category:com.calypso.ConfigRetriever
Message:
Invalid config name=[MYCS]

PROBLEM
You have either specified the wrong calculation-server or presentationserver name, or one that does not exist.

SOLUTION
1. Specify the correct Calculation Server or Presentation Server name.
a. Verify the Calculation Server name:
Main Entry -> System -> Calculation Server ...
b. Verify the Presentation Server name:
Main Entry -> System -> Presentation Server ...
c. Ensure that the configuration name you specify is correct and that
they exist.

PREVENTION
Correctly specify your Calculation Server and Presentation Server names.

Risk Infrastructure cannot connect to your database


org.hibernate.TransactionException: Transaction not successfully started
...
org.hibernate.exception.GenericJDBCException: Cannot open connection
...
Caused by: java.sql.SQLException: Connections could not be acquired from the
underlying database!
...
Caused by: com.mchange.v2.resourcepool.CannotAcquireResourceException: A
ResourcePool could not acquire a resource from its primary factory or source.
...

PROBLEM
Risk Infrastructure cannot connect to your database. There are two probably
causes:

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 55

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Managing the System

1. The Middle Tier Database properties in the


calypso*.properties.ENV_name are incorrect. For example, the database password is incorrect, etc.
2. The RDBMS is not online.

SOLUTION
1. Ensure that the Middle Tier Database properties in
calypsouser.properties.ENV_name and
calypsosystem.properties.ENV_name (if it exists) are correct.
2. Ensure that the RDBMS is online. Either restart the RDBMS or, if it is
hosted on a shared server, ask the DBA.

PREVENTION
Verify that the Middle-Tier Database properites in
calypso*.properties.ENV_name are correctly and that your database is
online.

1.10 Event Monitoring


Event Monitoring complements Enhanced Logging. The Event Monitor is a
standalone java process that passively listens and logs events being transmitted throughout the system.
The Event Monitor Analysis scripts parse this data and generate a data file
and graph showing the number of events generated per second.

1.10.1

Launching the Event Monitoring Tool

java com.calypso.apps.startup.LogEvent -trace ALL


-env {ENV_NAME} -log -user {USER_NAME} -password {PASSWORD}
-resource file:///c:/path/to/eventlist/eventclasses.txt

-resource is the URL location of the text file where users list the events to
monitor. Events are listed one per line.
Once the Event Monitor is launched, the corresponding log files can be
found in the same location as the standard application logs

1.10.2

Event Monitoring Log Name


Event Monitoring logs are available in the file:
LogEvent_${envname}_SERVEREVENTS_${version}.log

Where:
LogEvent The type of Event. E.g., PSEventAdmin, PSEventLog,
PSEventFXRateReset , etc.
${envname} and ${version} correspond to the Calypso environment and Calypso
Version.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 56

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

1.10.3

Managing the System

Event Monitor Output


The resource eventclasses.txt contains the list of classes (e.g.,
PSEventAdmin, PSEventQuote, PSEventTrade, etc.) that the Event Monitor
will record to a log. The following fields are captured for each entry:
CURRENT TIME The current time expressed as milliseconds
EVENT OCCURRED TIME The time the event was received
expressed as milliseconds
EVENT ID The event ID
EVENT CLASSNAME The event class name
EVENT TYPE The event type
EVENT DESCRIPTION The event description

1.10.4

Raw Log Output Example


Note that fields are separated by the Bar ( | ) character.

1202470718147|1202470718147|102036033|PSEventTrade|VERIFIED_TRADE|VERIFIED_TRADE 6804857
BondTSY 4 2016/0D/07/09/2016/4%
1202470718152|1202470718147|-2195|PSEventTask|EventTask|EventTask Task 155746444 eventType:
VERIFIED_TRADE tradeId: 6804857 book: 801337 status: NEW owner: null time: 08/02/08
11:38:37.640 o'clock GMT priority : NORMAL Object Status : VERIFIED
1202470718365|1202470718365|102036034|PSEventCre|NOM_CLEAN|NOM_CLEANId: 25307762 TradeId:
6804857

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 57

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

Recommended Routine Maintenance


To ensure the optimal operation of your system, you should perform routine
maintenance. Below is a set of processes and scheduled tasks that should
be run on a regular basis. You may tailor them to your environment by
changing the execution frequency.
Scheduled tasks are configured using Main Entry > Configuration > Scheduled Tasks. The Calypso Scheduler must be running for Scheduled Tasks to
function.

Login Attempts
Purge the login attempts on a regular basis using WebAdmin > Dataserver >
Server > Login Attempts. Refer to Login Attempts in Table 1-4 for details.
You can also use the PURGE Scheduled Task to purge login attempts, see
below.

Consumed Events
Purge the consumed events on a regular basis using Main Entry > Utilities >
Maintenance > Monitoring > Clean-up > Purge Consumed Events. Refer to
Clean-up in the Documentation Portal for details.
You can also use the PURGE Scheduled Task to purge consumed events,
see below.

Scheduled Task PURGE


The PURGE scheduled task allows deleting a number of unused objects.
The recommended execution frequency is specified below for each object.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 58

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

The configuration window appears as shown below.


Table 2-1: Schedule Task Configuration Window Purging

Specify the attributes as applicable, and save the configuration. Note


that you can setup multiple PURGE scheduled tasks that purge different
objects, and are executed with different frequencies.
PURGE EVENTS Select true to purge all consumed events,
including guarantee-delivery events. Run on a daily basis.
Note that if you are using the PURGE scheduled task to purge
consumed events, you should set the EventPurgeTimeout environment property to 0, so that there is not double-processing for
purging events.
PURGE CLIENTS CACHE Select true to purge all client caches.
Run periodically.
Restart Engines Select an engine to be restarted.
PURGE_COMPLETED_TASKS Select true to purge all completed tasks. Run periodically.
Note that if you want to archive completed tasks instead of deleting them, you can use the Archive scheduled task.
PURGE_LOG_FILES Set to true to purge all log files, in particular log files from a previous version of the system. Run periodically.
PURGE_LIQUIDATED_POSITIONS Select true to purge all processed liquidation records, for example, those created when
trades are amended. Run periodically.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 59

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

PURGE_BALANCE_POSITIONS Select true to purge balance


positions on or before a given date. Enter the date in the
BALANCE_DATE attribute. Run periodically.
PURGE_MARGIN_CALL_POSITIONS Select ALL, SECURITIES,
or CASH to purge the corresponding margin calls on or before a
given date. Enter the date in the MARGINCALL_DATE attribute.
Run periodically.
PURGE LOGIN ATTEMPTS Select true to purge login attempts
that have been in the system for a certain time. Enter the time in
the LOGIN ATTEMPTS OLDER THAN attribute. Run periodically.

Scheduled Task PURGE_INVENTORY


The PURGE_INVENTORY scheduled task allows deleting inventory positions
that satisfy a number of user-defined criteria, and that are older than a certain date. Run periodically.
The configuration window appears as shown below.
Table 2-2: Schedule Task Configuration Window Purge Inventory

Specify the attributes as applicable, and save the configuration. Note


that you can setup multiple PURGE_INVENTORY scheduled tasks with
different sets of attributes that are executed with different frequencies.
INVENTORY TYPE Select ALL, CASH or SECURITY. Note that
when the LADDER attribute is true, the INVENTORY TYPE should
be ALL.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 60

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

DATE TYPE Select ALL, TRADE, SETTLE, or AVAILABLE. Note


that when the LADDER attribute is true, the INVENTORY TYPE
should be ALL.
POSITION TYPE Select ALL, ACTUAL, THEORETICAL ,or
FAILED. Note that when the LADDER attribute is true, the INVENTORY TYPE should be ALL.
POSITION CLASS Select ALL, EXTERNAL, CLIENT, or INTERNAL. Note that when the LADDER attribute is true, the INVENTORY TYPE should be ALL.
INVENTORY DATE Select the inventory date. All inventory positions that exist on or before the inventory date with the specified
attributes will be removed.
LADDER Select true to create an inventory position (ladder
position) at a given date for all existing positions on or before that
date. If you run the Back Office Position report starting on the ladder position date, only the ladder position and subsequent positions (for the specified number of days) will be loaded, therefore
improving the performance of the loading process.
Note that when you run the PURGE_INVENTORY scheduled task
with LADDER to true, no position is actually deleted.

Scheduled Task Archive


The Archive scheduled task allows archiving a number of objects. Run at
least once a year. The archiving process copies objects from current tables
to history tables, and deletes the copied objects from the current tables.
Certain reports can also use data archived in history tables:
Table 2-3: Reports that use History Tables

Report Name
AccountEnrichmentReport
AuditReport
BOCashPositionReport
BOSecurityPositionReport
BOTradeTransferReport
GenericCommentReport
MessageReport
PostingReport
SalesMarginReport
SpotRiskHedgeReport

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 61

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

Table 2-3: Reports that use History Tables (Continued)

Report Name
TradeAuditReport
TradeReport
TransferReport

To archive trades, Calypso recommends that you use the ARCHIVE_TRADE


scheduled task, instead. See Help > Info about task in the Scheduled Tasks
window for details.
The configuration window appears as shown below.
Table 2-4: Schedule Task Configuration Window Archive Trade

Specify the attributes as applicable, and save the configuration. Note


that you can setup multiple Archive scheduled tasks that archive different objects and that are executed with different frequencies.
Oldest to archive (# of days back) Enter the number of days
from which you want to archive.
Newest to archive (# of days back) Enter the number of
days up to which you want to archive.
Archive Trades Select true to archive the trades and specify
a Filter Set OR a Trade Filter to select the trades to be archived.
Archive Audits of type Select the type of audit values you
want to archive.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 62

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

Archive completed Tasks of type Select the type of completed tasks you want to archive (Message, Transfer, Trade, or
Exception).
List of Task-related event types Enter a comma-separated
list of task event-types for the selected type of task.
Task event types are defined in the eventType domain.
Trade related event types have the form <trade_status>_TRADE,
where <trade_status> comes from the tradeStatus domain.
Transfer related event types have the form
<transfer_status>_SEC_DELIVERY,
<transfer_status>_SEC_RECEIPT,
<transfer_status>_PAYMENT and <transfer_status>_RECEIPT,
where <transfer_status> comes from the transferStatus domain.
Message related event types have the form
<message_status>_<message_type>, where <message_status>
comes from the messageStatus domain and <message_type>
comes from the messageType domain.
Exception related event types have the form
EX_<exception_type>, where exception type comes from the
exceptionType domain.
Archive Transfers with status Select the transfer status you
want to archive.
Archive Messages with status Select the message status
you want to archive.
Archive Postings with status Select the posting status you
want to archive.
Archive CREs with status Select the CRE status you want to
archive.
Archive PL Positions WHERE Enter an SQL where clause
on the pl_position table to select PL Positions that you want to
archive.
Archive Advice Documents Select true to archive advice
documents for a given SQL where clause. Enter the where
clause on the advice_document table in the WHERE attribute.
Archive Open Quantities Select true to archive open quantities.
WHERE clause for Advice Docs Enter a valid WHERE clause
to select advice documents from the advice_document table.
Archive Quotes Leave blank, or select true or false.
Source Name for Archive Quotes Enter the quote source
name for real-time quotes.
Oldest (Entered Date) For Quote Enter the number of entered
days back from the valuation date for starting the archive
(optional - specifies the oldest date to archive).

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 63

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

Newest (Entered Date) For Quote Enter the number of


entered days back from the valuation date for ending the archive
(optional - specifies the most recent date to archive). For example, 1 for yesterday.

Scheduled Task MATURE_TRADE


The MATURE_TRADE scheduled task applies an action to mature trades. It
should be run on a daily basis.
The configuration window appears as shown below.
Table 2-5: Schedule Task Configuration Window Mature Trade

Specify the attributes as applicable, and save the configuration.


APPLY_ACTION Select the action to apply. The action needs to
be available within the trade workflow. For example, if you select
the action MATURE, the trade workflow must have a transition
VERIFIED/MATURE/MATURED.
FILTER_TRADE_STATUS Select the trade status to which you
want to apply the MATURE action. If not specified, only VERIFIED
trades are selected.

Scheduled Task MATURE_POSITIONTRADE


The MATURE_POSITIONTRADE scheduled task applies a MATURE action
(previously defined in your workflow) to position-based trades which have a
Value Date < Scheduled Task Process Date. This should be run on a daily
basis.
Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 64

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

The configuration window appears as shown below.


Table 2-6: Schedule Task Configuration Window Mature Position Trade

Specify the attributes as applicable, and save the configuration.


APPLY_ACTION Select the action to apply to mature trades.
The action needs to be available within the trade workflow. For
example, if you select the action MATURE, the trade workflow
must have a transition VERIFIED/MATURE/MATURED.
UNMATURE ACTION Select the action to apply to mature
trades in status MATURED. The action needs to be available
within the trade workflow. For example, if you select the action
UNMATURE, the trade workflow must have a transition MATURED/
UNMATURE/VERIFIED to take into account any modification of
previously fully liquidated trades (already in status MATURED).
FILTER_TRADE_STATUS Select the trade status to which you
want to apply the MATURE and UNMATURE actions. If not specified, only VERIFIED trades are selected for the MATURE action,
and only MATURED trades are selected for the UNMATURE
action.
NUMBER_SAVE_TRADE Enter a number of trades to be processed together.
PROCESS_TYPE Select whether the scheduled task is performing the MATURE process, the UNMATURE process, or both.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 65

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Recommended Routine Maintenance

Scheduled Task INVENTORY_BALANCE


The INVENTORY_BALANCE scheduled task updates the inventory balance
when the inventory engine parameter PROJECTED_DAYS is specified.
For performance reasons, the Inventory Engine may now compute balances
for only a given number of projection days (PROJECTED_DAYS parameter).
Balances will be kept for only PROJECTED_DAYS # of days. After that, for all
future cashflows, daily inventory amounts are kept. The final balance is computed through the INVENTORY_BALANCE scheduled task. It should be run
on a daily basis.
This scheduled task does not require any specific parameters.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 66

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Database Utilities

Database Utilities

3.1

Configuration Management Tool


The Calypso Configuration Management (CM) Tool allows importing and
exporting configuration between Calypso systems using XML based objects.
It utilizes the Java API for XML Binding (JAXB) API from Sun Microsystems.
Refer to the CalypsoML Developers Guide and to the Calypso Configuration
Management Tool Tool Users Guide for details.

3.2

Calypso Application and Migration Tool


The Calypso Application and Migration (CAM) Tool allows importing and
exporting data between Calypso systems using XML based objects. It utilizes the Java API for XML Binding (JAXB) API from Sun Microsystems.
Refer to the CalypsoML Developers Guide and to the Calypso Application
and Maintenance (CAM) Tool Users Guide for details.

3.3

Import of Swaps Monitor Holidays into Calypso


Calypso allows importing Holidays from the Swaps Monitor system using
calypsox/tk/refdata/ImportSwapsMonitorHolidays.java.
In order to use this feature, you must first compile this Java class. Then, it
can be run at the command line, here is the syntax (this is a on-line command):

java calypsox.tk.refdata.ImportSwapsMonitorHolidays env <envName> -user <userName>


-password <password> -holidayCodeFile <holidayCodeFileName>
-holidayDatesFile <holidayDatesFileName>

Two files have to be provided:


holidayCodeFileName
holidayDatesFileName

3.3.1

Holiday Code
The program expects to have a text file with the following format; the values
are separated by tabulation:
CODE
CENTER
COUNTRY
CURRENCY
TYPE
ISOCOUNTRY
DEFINE1 (can be null)

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 67

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Database Utilities

DEFINE2 (can be null)

This file is used to create and save the HolidayCode Calypso object. Note
that any missing currency will be automatically created by the import program.
Figure 3-1: Import Holidays Codes Panel

3.3.2

Holiday Dates
The program expects to have a text file with the following format; the values
are separated by tabulation:
DATE / CODE
Value: g, w or a number
This file is used for 2 purposes:
Determine the first and second non business days necessary to create
the HolidayCode Calypso object. This is done when finding the w
value. Note that if a HolidayCode has no entry in this file, we apply the
default week-end which is Saturday and Sunday.
Create the Holiday dates when finding a number.

Figure 3-2: Import Holidays Holiday Dates Panel

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 68

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

4
4.1

How to Find Help

How to Find Help


Documentation
The Calypso Online Help system provides access to the entire Calypso documentation set in the form of Web Help and PDF documents. You can view
the documentation by logging on to the Calypso web site:
http://www.calypso.com/login/client_login.php or by accessing help from the
applications Help button Help menu.

4.2

Main Entry Help Menu


Available from Main Entry > Help:
Figure 4-1: Help Menu

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 69

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

How to Find Help

Help Menu Items


Table 4-1: Help Menu Item Descriptions

Menu Items
About...

Description
Displays the Calypso Data Server name; Access Permissions, Authorizations, and Workflow status; JVM information; and host system information.

Click
to view the More Info window. Tabs on More info list version
information for Calypso applications and the Classpath:

Search Documentation

Launches the Calypso Documentation Portal. You must configure the


HELP_LOCATION environment property to display the help system.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 70

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

How to Find Help

Table 4-1: Help Menu Item Descriptions (Continued)

Release Notes

Launches your default browser to the Client Login Page of Calypso.com.

Instant Message

Instant messenger between users of your local Calypso system.

Data Model

Displays the database schema.

Class Library

Link to the Calypso support web site where you can access the Javadoc
class library for the latest Calypso version.

Domain Values

Opens the Documentation Portal to the page listing Domain Values available throughout the system.

Shortcuts

Opens the Documentation Portal to the page listing keyboard shortcuts


available throughout the system.

Day-Count Conventions

Opens the Documentation Portal to the Daycount conventions page.


Daycounts are used throughout the system for calculating the number of
days in a period.

Date Roll Conventions

Opens the Documentation Portal to the Date Roll conventions page. Date
Rolls are used throughout the system to roll dates that fall on business
dates.

Rounding Methods

Opens the Documentation Portal to the page describing the rounding


methods used throughout the system.

Message Template Keywords

Opens the Documentation Portal to the page describing the keywords


used in message templates.

Report Template Keywords

Opens the Documentation Portal to the page listing keywords used in


report templates.

Pricer Measure Help

Opens the Documentation Portal to the page describing all Pricer Measures.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 71

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

4.3

How to Find Help

Environment Properties
All environment properties are described on the Environment Properties
page. Click Help from the User Env or System Env applications to launch the
Web Help and then select Environment Properties from the General
Resources panel:

Figure 4-2: Environment Properties Displayed in Web Help

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 72

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Troubleshooting Tips

Troubleshooting Tips

5.1

Java Tuning
The Java arguments allow users to better tune their implementation. Java
arguments are applied within the $CALYPSO_HOME/start*server.bat/sh file.
If you need to use a Java arguments for only one engine within the Engine
Server, you must create a Custom Engine Server to run that server and
apply the Java argument in that servers start file. See Custom Engines in
the Calypso Installation and Upgrade Guide for details on creating a Custom
Engine Server.

Maximum and
Minimum Heap Size

Xmx and Xms

These options specify the maximum and minimum Heap Sizes, respectively.
Typically, both settings are identical as there is little reason to allow the
memory to grow and shrink.
However, it may be useful if the DataServer is being sized for a possible
large usage and is expected to generally operate far below this setting. The
option can use m or g to represent megabytes and gigabytes, respectively.
For example, Xmx1024m and Xmx1g, both represent a one gigabyte heap
size.

Young Generation

XX:NewSize and XX:MaxNewSize

Increase or decrease the Young Generation settings based on the observation of Garbage Collection frequency. The young generation should not be
grown to larger than 800Mb (i.e., -XX:MaxNewSize=800m).
Other Recommended
Settings:

XX:TargetSurvivorRatio=90
The default TargetSurvivorRatio of 50 is too small for Calypso, which causes
the tenuring threshold to drop, thereby causing memory to be promoted to
the older generation faster than necessary, which in turn causes more Garbage Collection activity in the old generation. Such Garbage Collections on
tDXX:SurvivorRatio=2
This increases the size of the survivor spaces so that Calypso can hold more
data over young generation Garbage Collections. The aim is to have prevent
temporary memory used during RMI calls from being promoted into the old
generation.
XX:MaxTenuringThreshold=31
Although this is the default, we have found that with some versions of the
Sun JVM, not using this flag leaves the threshold unset, which results in all
young generation Garbage Collections promoting into the old generation.
XX:+UseConcMarkSweepGC
Any reasonable size heap should be using concurrent mark and sweep as
the collector. By reasonable sized heap, this would be greater than 1Gb.
When switching from the ParallelGC collector you should increase the mem-

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 73

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Troubleshooting Tips

ory by 30% to allow for the operation of the Concurrent Mark and Sweep. In
general the old generation usage should be kept below 68% of the total old
generation otherwise the concurrent mark and sweep starts more aggressive collection. This threshold can be modified by -XX:CMSInitiatingOccupancyFraction=<percentage>. Newer JVMs seem to have the value
calculated by the JVM, rather than having a set value.
XX:+UseParNewGC
Use a parallel collector on the young generation. With the concurrent mark
and sweep in later JVMs this is on by default. But setting it causes no harm.
XX:-CMSParallelRemarkEnabled
Using this optional flag will reduce the performance of the Garbage Collection. Use this flag to possible solve unexplained hotspot errors during Garbage Collection activities.
verbose:gc
Gererate Garbage Collection information in the standard output of the JVM,
not that of the application; this will not go in the application's log file. This is
very useful for examining the JVM from a memory perspective. Also, see
-XX:+PrintGCDetails, -XX:+PrintGCTimeStamps, and
-XX:+UsePerfData
XX:+PrintGCDetails
Adds more information to the basic verbose gc data.
XX:+PrintGCTimeStamps
Includes timestamp information for the Garbage Collection. This flag should
always be on when verbose:gc is on.
XX:-OmitStackTraceInFastThrow
By default, the JVM will not put stack traces into exceptions. When analysis
is necessary, use this option to display stack traces.
XX:+UsePerfData
This setting is not necessary, but should be invoked when using VisualGC
for monitoring.
Dsun.rmi.dgc.client.gcInterval=3600000
Dsun.rmi.dgc.server.gcInterval=3600000
These options determine how often the RMI stubs should be Garbage Collected. Effectively, they should never be Garbage Collected as they are
always used.

5.2

Date Stamps or Time Stamps are Wrong


Make sure you set the reference time zone in the database as shown in
Section 1.5, Set the Reference Time Zone, on page 18 in the Calypso DBA
Guide. This must be done before you begin saving data in the system.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 74

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

5.3

Troubleshooting Tips

Trade Status
This applies to installations that use the Calypso automatic trade workflow.
When you save a trade, the Data Server should automatically advance the
Trade Status to the next lifecycle stage as specified by you in the Task Workflow Configuration. Typically, your Workflow Configuration will be set up to
advance a newly entered trade to PENDING or VERIFIED status. If a trade
does not get the correct status, then the problem could be:
The Workflow System in the Data Server is not activated. You can
check this in Main Entry or in the Data Server. In Main Entry, go to the
Help menu and choose About. If the Workflow is running, the Workflow
checkbox will be checked. If it is not, open the Data Server window or the
Admin Monitor Window and check the Workflow checkbox.
Your Workflow Config is not configured to automatically advance your
trades to the status you want (for example from PENDING to VERIFIED). Also, be aware that the administrator may have purposely configured the system for manual (rather than automatic) advancement of
trades. If the system is set up for manual advancement, you must use
the Task Station window to advance each trade from PRICING to PENDING to VERIFIED.
The Task Engine did not receive the event or failed to process the trade.
Check the Task Engine window to make sure the tasks appear in its blotter. Also, check the log files for Main Entry, Data Server, Event Server,
and Task Engine.

5.4

Sybase Administrator Permissions


When creating or upgrading the Calypso database, you will log into the Sybase server as sa or another user with table create/update/delete privileges.
To verify the Sybase administrator's privileges for Windows, the system
administrator should run Sybase Central and follow these steps:
Make sure the Sybase server is running.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 75

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Troubleshooting Tips

1. In the tree browser on the left side of the window, double-click on the
Server node to display all its databases.
2. In the tree, double-click on your database to display its list of settings.
3. In the tree, click on the Users node to display the database's users.
4. Right-click on the desired user name, and select the Properties command.
5. In the Properties window, select the Commands panel.
6. In the Status column, check each cell.
7. Click OK.

5.4.1

Sybase User Permissions

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 76

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Troubleshooting Tips

Remember that the system requires only one Sybase user account: that of
the user who runs the Calypso Data Server. To verify Sybase user privileges
for Windows, the system administrator can run Sybase Central and follow
these steps:
1. Make sure the server is running.
2. In the tree browser on the left side of the window, double-click on the
Server node to display all its databases.
3. In the tree, double-click on your database to display its list of settings.
4. In the tree, click on the Users node to display the database's users.
5. Right-click on the desired user name, and select the Properties command.
6. In the Properties window, select the Object Permissions panel.
7. The table will contain a list of all the objects (tables and procedures)
related to the database. All of the checkboxes should be checked.
8. Click OK.

5.4.2

SQL Interpreter
Many tasks required to install and maintain Calypso require the use of an
SQL Interpreter. Sybase and Oracle each ship with a suitable application.
Third-party SQL interpreters can also be used.
Ensure that the ISQL or SQLPLUS program (or your preferred SQL interpreter) is in your path. For Sybase, ISQL is in the Sybase/bin directory. For
Oracle, SQLPLUS is in the Oracle/bin directory.
You can verify that an RDBMS-provided SQL application is in your path by
typing isql or sqlplus at the command line. If it is available, the application
should respond by prompting you for an SQL login and password.

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 77

Calypso System Guide: Webadmin Guide


Applicable to: V14.x

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 78

Calypso Technology

Contacting Calypso

Contacting Calypso
Americas
SAN FRANCISCO

NEW YORK

595 Market Street


Suite 1800
San Francisco, CA 94105
USA

99 Park Avenue,
Suite 930
New York, NY 10016
USA

T +1 415 817 2400


F +1 415 284 1222
info@calypso.com

T +1 212 905 0700


F +1 212 905 0724
sales_nyc@calypso.com

SANTIAGO
Cerro Colorado 5240
Piso 10, Torre II
Chile
56-2-434-5300
sales_santiago@calypso.com

Europe, Middle East, Africa


LONDON

PARIS

One New Change, 6th Floor


London EC4M 9AF
United Kingdom

106/108 rue de La Botie


75008 Paris
France

T +44 20 7826 2500


F +44 20 7826 2501
sales_london@calypso.com

T +33 1 44 50 13 99
F +33 1 44 50 12 84
sales_paris@calypso.com

FRANKFURT

JOHANNESBURG

Junghofstrasse 24
2nd floor
60313 Frankfurt Am Main
Germany
T +49 69 920389 0
F +49 69 920389 11
sales_frankfurt@calypso.com

Nelson Mandela Square


2nd Floor, West Tower
Maude Street
Sandton, 2196
South Africa
T +27 11 881 5708
F +27 11 881 5611
sales_johannesburg@calypso.com

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 79

Calypso Technology

Contacting Calypso

COPENHAGEN

MOSCOW

Calypso Technology Denmark


Regus City Center, Office 308
Larsbjornstraede 3,1454 Copenhagen
T +45 33 37 71 79
F +45 33 32 43 70
sales_copenhagen@calypso.com

Office 14, 5th floor


Maliy Cherkasskiy pereulok 2
109012 Moscow Russia
T +7 495 728 4292
F +7 495 225 8500
sales_moscow@calypso.com

Asia Pacific
TOKYO

SINGAPORE

Kojimachi Place 10F


2-3 Kojimachi
Chiyoda-ku
Tokyo 102-0083
Japan
T +81 (0)3 5214 1800
F +81 (0)3 5214 1801
sales_tokyo@calypso.com

1 Phillip Street, #12-02


Singapore 048692
Singapore
T +65 6372 1121
F +65 6372 1161
sales_singapore@calypso.com

SYDNEY

MUMBAI

Level 4, 95 Pitt Street


Sydney, NSW 2000
Australia
T +61 2 8249 8115
F +61 2 8249 8116
sales_sydney@calypso.com

Unit 401, Akruti Center Point


MIDC Central Road
Near Marol Tel. Exchange
MIDC, Andheri (E)
Mumbai 400 093
India
T +91 22 6681 5600
F +91 22 6681 5611
sales_mumbai@calypso.com

CHENNAI

HONG KONG

Plot No.23 & 24


Door No.33
South Beach Avenue
MRC Nagar, Chennai
Tamil Nadu 600028
India
T +91 44 4347 5350
F +91 44 4347 5378
saleschennai@calypso.com

Unit 1238, Level 12, Infinitus Plaza,


199 Des Voeux Road Central,
Hong Kong
T +852 3478 3796
+852 3478 3797
F +852 3478 3880
sales_hongkong@calypso.com

Calypso Technology, Inc. All Right Reserved. Confidential Material.

Page 80

You might also like