instruction stringlengths 5 72 | input stringclasses 1
value | output stringlengths 22 8.46k |
|---|---|---|
Calypso Development Environment | Section 1. Calypso Development Environment
Calypso components are contained in various jars that are scanned for Spring annotation to start the
servers. Therefore, client custom components must become part of jar files when starting the server.
To facilitate this, Calypso provides the Custom-Extensions directory locate... | |
Prerequisites | 1.1 Prerequisites
• Please refer to the Hardware and Software Recommendation Guide for proper JAVA.
• Eclipse (eclipse.org). Calypso uses the Neon 2 version of Eclipse. All examples and procedures
in this guide assume that your development environment also uses Eclipse Neon 2.
The procedures and... | |
Naming Convention for Custom Code | 1.2 Naming Convention for Custom Code
Using a naming convention for custom code prevents clashes in name space and makes the support
process smoother by making it clear in stack traces, thread dumps, and when the customization is
visible to the user (i.e. Pricer name), that we are dealing with custom code as oppose... | |
Custom-Extensions Overview | 1.3 Custom-Extensions Overview
The Custom-Extensions directory (<calypso home>/custom-extensions) is intended to capture all
local modifications made to an installation of Calypso. Such modifications may range from a simple
configuration file change, the addition of new Java classes to extend platform functionality... | |
Change Management | 1.4 Change Management
The default Calypso installation provides basic, disk based versioning which allows a client to roll back
any change performed by using the steps described above. This solution creates backup copies
(located in <calypso home>/patch-history) of all the binaries before any modification made by t... | |
Directory Layout | 1.5 Directory Layout
The custom-extensions directory contains the following sub-directories and files.
| bld
| bld.bat
| build.gradle
| README.txt
|
+---custom-projects
| | bld
| | bld.bat
| | build.gradle
| | gradle.properties
| | settings.gradle
| |
| +---custom-client
| | | ... | |
Using the Basic Custom-Extensions Workspace | 1.6 Using the Basic Custom-Extensions Workspace
This section provides a brief overview of using custom-extensions. Refer to Custom Extensions by
Example and Custom Extensions Audit for detailed information.
To use the workspace, add your code to the relevant sub-directories in <calypso home>/custom-
extensions/cus... | |
Custom Extensions by Example | Section 2. Custom Extensions by Example
The sections below describe the features of the custom extensions and tools provided with detailed
examples. Each example is provided as a zip file inside <calypso home>/custom-
extensions/samples.
In the examples below, <calypso home> represents the Calypso installation director... | |
Adding Third-Party Libraries | 2.1 Adding Third-Party Libraries
Calypso, as well as custom extensions developed by clients, may require third-party libraries to
function. These libraries may be as simple as a Market Data Provider’s custom libraries to technology
libraries, such as the MQ Series connectivity libraries.
Adding libraries involves t... | |
Adding a Common Library | 2.1.1 Adding a Common Library
You may add a common library from either the local file system or via a repository. The notation used
in this example will add a library and any transitive dependencies.
To add a new library from the local file system, place the jar in <calypso home>/custom-
extensions/custom-projects... | |
Upgrading an Existing Common Library | 2.1.2 Upgrading an Existing Common Library
To upgrade a common library, edit the build script to specify the library. Deploying the custom project
removes the old version from the server and replaces it with the new version. Furthermore, the audit
will detail any class file change. Third party libraries provided b... | |
Adding a Deployment-Specific Library | 2.1.3 Adding a Deployment-Specific Library
Adding a deployment-specific library follows a process similar to the previous section.
This example adds the library to a deployment-specific project (custom-client) instead of the custom-
shared-lib.
To add the jgoodies library (a Java Swing library) to a client deploym... | |
Adding a Custom Repository | 2.1.4 Adding a Custom Repository
By default, the public maven central repository has been used as the repository which loads all new
libraries. To specify an additional repository, edit the gradle.properties file in <calypso
home>/custom-extensions/custom-projects and specify the URL of the repository (the propert... | |
Removing Unwanted Libraries | 2.1.5 Removing Unwanted Libraries
To remove an unwanted jar from a WAR file, you need to create a file named "custom-project-
distribution.cpc" in <calypso home>/custom-extensions.
Add the jar entries to be removed to the file as in the example below:
<?xml version="1.0" encoding="UTF-8"?>
<commands>
<!--<r... | |
Deploying Library Changes | 2.1.6 Deploying Library Changes
With the newly updated template and files in place, the deployment tools can push the configuration
files into the deployment artifacts and ensure the proper audit trails are created.
Go to <calypso home>/custom-extensions:
$ bld deploy
bld deploy automatically adds the files to the... | |
Rolling Back Changes | 2.1.7 Rolling Back Changes
After running bld deploy, the installation contains artifacts from the custom-extensions. To remove
these artifacts, use patch.bat/.sh to roll back the installation.
| |
Example Audit Trail — Library Changes | 2.1.8 Example Audit Trail — Library Changes
When the deployment is complete, the sample audit recorded for this change in any of the
deployment artifacts. The audit file will contain similar entries:
<patch date="Mon Apr 14 22:02:00 PDT 2014" file="custom-project-distribution-1.0.0-SNAPSHOT-
rel.zip" md5="c8e14ebd1... | |
Sample Modifications — Libraries | 2.1.9 Sample Modifications — Libraries
<calypso home>/custom-extensions/samples/include-thirdparty-libraries.zip
contains the samples for this section. Extract sample files into the root of custom-extensions. All
previously mentioned modifications are present in this project. The main changes are:
• Added th... | |
Extending Calypso | 2.2 Extending Calypso
The Calypso application provides a number of extension points. These extensions require code to be
written, compiled and patched into the deployments. The following sections illustrate the steps to add
an extension by building a simple service to print a log message in the dataserver. A custom... | |
Unpacking the Sample | 2.2.1 Unpacking the Sample
<calypso home>/custom-extensions/samples/custom-dataserver-service.zip contains
the samples for this section. Extract the files into the root of the custom-extensions. After the sample
has been unzipped, there will be several java files available which have been documented below.
| |
Remote Interface | 2.2.2 Remote Interface
Because all deployments require the remote interface for invokation, the interface is in the custom-
shared-lib. The code for this example can be found in:
<calypso home>/custom-extensions/custom-projects/custom-shared-
lib/src/main/java/calypsox/tk/service/RemoteSampleService.java.
| |
Annotated Bean | 2.2.3 Annotated Bean
Following the JavaEE specification, an annotated Spring Bean class was created to implement the
remote service. The example can be found in <calypso home>/custom-extensions/custom-
projects/custom-dataserver-
services/src/main/java/calypsox/tk/service/SampleServiceBean.java. Note that
because ... | |
Spring Configurations | 2.2.4 Spring Configurations
A class is created with @Configuration annotation for Spring boot configuration to export the services.
The example can be found in <calypso home>/custom-extensions/custom-dataserver-
services/src/main/java/com/calypsox/springboot/CalypsoSampleServiceConfig.java
| |
Sample Client | 2.2.5 Sample Client
The sample client connects to the dataserver, looks up the remote service and invokes it.
<calypso home>/custom-extensions/custom-projects/custom-
client/src/main/java/calypsox/apps/startup/LoggingClient.java contains the sample code for
this section.
After deploying the project, run the sample... | |
Deploy | 2.2.6 Deploy
With the newly updated template and files in place, use the deployment tools to push the
configuration files into the deployment artifacts and ensure that the proper audit trails are created. Go
to <calypso home>/custom-extensions:
$ bld deploy
Once this command is executed, the files will be a... | |
Rolling Back Changes | 2.2.7 Rolling Back Changes
After running bld deploy, the installation contains artifacts from the custom-extensions. To remove
these artifacts, use patch.bat/.sh to roll back the installation.
| |
Example Audit Trail | 2.2.8 Example Audit Trail
Once the deployment is complete, the sample audit recorded for this change is visible in the
deployment artifacts. For most audit files, the following change will be recorded:
<patch date="Mon Apr 14 23:37:18 PDT 2014" file="custom-project-distribution-1.0.0-SNAPSHOT-
rel.zip" md5="7afd49... | |
Custom Extensions Audit | 2.3 Custom Extensions Audit
As previously noted, changes to deployment artifacts are strictly documented in a standard audit file
associated with each deployment artifact. The audit file structure is as follows:
<?xml version="1.0" encoding="UTF-8"?>
<hotfix>
<patch date="Thu Apr 03 12:15:53 PDT 2014" file="cus... | |
Connecting to the Data Server and Event Server | 3.1 Connecting to the Data Server and Event Server
When you create a client application that requires access to Calypso data such as domain data
(currency code list, reference index list, etc.) and persistent data (trades, curves, positions, etc.), the
client application must establish a connection to the Data Serv... | |
Handling a Lost Connection to the Data Server | 3.2 Handling a Lost Connection to the Data Server
If the Data Server connection is lost, your application may require a notification and might
subsequently attempt to reconnect to the Data Server. The Data Server provides the following
mechanisms to auto-reconnect if a connection is lost:
• DSConnectio... | |
Creating Custom Initialization Code | 3.3 Creating Custom Initialization Code
The Data Server provides two ways to invoke custom code:
• Session bean — Invokes initialization code when the Data Server is started.
• DSConnectionInit — Invokes initialization code on the client each time a DSConnection is
created.
Using a Session Bean... | |
Customizing the Calypso Navigator Startup | 3.4 Customizing the Calypso Navigator Startup
You can customize the startup of the Calypso Navigator by creating a class named
apps.startup.MainEntryStartUp<name> that implements
com.calypso.apps.startup.MainEntryStartUp. For example,
apps.startup.MainEntryStartUpPreloadCache.
1. Implement the method onSta... | |
Using the Data Server | 4.1 Using the Data Server
The Data Server is a single point of access for all Calypso data. No client application should ever
access the database directly. Once you have a connection to the Data Server as described in
“Connecting to the Data Server and Event Server”, the Data Server is accessed through a set of rem... | |
Using a Local Cache | 4.2 Using a Local Cache
LocalCache allows client applications to maintain client caches for a number of static data including
Currency Indexes, Rate Indexes, Rate Index Defaults, Currencies, Domains, and FX resets, thereby
enhancing the performance.
When data retrieval from LocalCache is attempted, if the data is n... | |
Using BOCache | 4.3 Using BOCache
BOCache allows client applications to maintain client caches for a number of static data including
Accounts, Books, Contacts, Legal Entities, Settlement and Delivery Instructions, Exchange Traded
Products, and Netting Configurations. BOCache also maintains client caches for quotes.
When data retri... | |
Providing Custom CacheClient and LocalCacheClient | 4.4 Providing Custom CacheClient and LocalCacheClient
You can set the environment property CACHE_CLIENT_EXTENDED = true to look for custom
implementations of CacheClient and LocalCacheClient.
For CacheClient, you can create a class named tk.bo.CacheClient that extends
com.calypso.tk.bo.CacheClient.
For LocalCacheC... | |
Using a Remote Service | 4.5 Using a Remote Service
The following example demonstrates how to obtain a trade and product from the Data Server and how
to subsequently save them as a new trade and product.
Using a remote service:
• Create a connection to the Data Server.
• Obtain the appropriate remote object from the Data Server... | |
Extending the Data Server | 4.6 Extending the Data Server
When a custom object that requires persistence is added to the system, the Data Server must be
extended to save, load, and cache the object. If necessary, the extension should also support event
publishing when the object is first saved or when it is modified.
The Calypso API provides ... | |
Creating a Data Server Service | 4.7 Creating a Data Server Service
Data Server services are stateless session beans and follow the EJB 3.1 specification. To create a Data
Server service, you will need to create at least 3 types:
• Remote interface: Exposes methods for use by remote Data Server client applications
• Local interface: Ex... | |
Read-Only Data Servers | 4.8 Read-Only Data Servers
A read-only Data Server provides a mechanism to off-load work from the active Data Server for read
operations. High volume read operations, such as generating reports, or other similar tasks could have
a negative impact on Data Server performance. Using a read-only Data Server allows acces... | |
Event Services | Section 5. Event Services
Calypso leverages a standard JMS bus to propagate events throughout the platform to listeners. The
implementation leverages a single JMS topic for all business related events. The ESStarter interface is
the starting point for all access to the event bus.
| |
Subscribing to and Publishing Events | 5.1 Subscribing to and Publishing Events
Listeners and publishers must be created through the ESStarter class and must leverage the
PSConnection and PSSubscriber interfaces to interact with the underlying JMS connection as
publishers and subscribers.
See “Connecting to the Data Server and Event Server" for a high... | |
Event Types and Filtering | 5.1.1 Event Types and Filtering
Events published to the bus are differentiated by their type. This type is represented by different
classes implementing each event container. All classes extend the PSEvent class, each derived class
represents a different specific event type.
Subscribers built via the ESStarter can... | |
Publishing Events | 5.1.2 Publishing Events
Once you have a PSConnection, you can:
• Publish non-persistent events using the publish() method on
com.calypso.tk.event.PSConnection.
• Publish persistent events using the saveAndPublish() method on
com.calypso.tk.service.RemoteTrade. This method saves and publ... | |
Subscribing to Events | 5.1.3 Subscribing to Events
Subscription to events requires the creation of a listener which implements the PSSubscriber interface.
This class will implement the basic event handling logic desired. An instance of this class will then be
passed to the ESStarter.startConnection method.
The subscriber class can do th... | |
Creating a Custom Event | 5.2 Creating a Custom Event
New event types can be added to the system to accommodate the addition of custom objects. For
example, when we add the EquityBasket in the Data Server extension example (“Extending the Data
Server"), we must also add a new event type PSEventEquityBasket to notify the system when an
Equity... | |
How to Create a Custom Daycount | 6.1 How to Create a Custom Daycount
Create a class named tk.core.CustomDayCountCalculator which implements the interface
com.calypso.tk.core.DayCountCalculator.
This class is invoked from com.calypso.tk.core.DayCount so that once it is compiled, the new
Daycount is made available in the system.
[NOTE: The maximum ... | |
How to Create a Custom Tenor | 6.2 How to Create a Custom Tenor
Create a class named tk.core.CustomTenorCalculator which implements the interface
com.calypso.tk.core.TenorCalculator.
This class is invoked from com.calypso.tk.core.Tenor so that after compiling, the new Tenor is
available in the system.
| |
How to Create a Custom Date Rule | 6.3 How to Create a Custom Date Rule
Create a class named tk.core.DateGenerator<custom_name> that implements the interface
com.calypso.tk.core.DateGenerator.
This class is invoked from com.calypso.tk.core.DateRule so that once it is compiled, the new Date
Rule is available in the system.
| |
How to Create a Custom Frequency | 6.4 How to Create a Custom Frequency
Create a class named tk.core.CustomFrequencyCalculator that implements the interface
com.calypso.tk.core.FrequencyCalculator.
This class is invoked from com.calypso.tk.core.Frequency so that once it is compiled, the new
Frequency is available in the system.
| |
How to Chain Exceptions | 6.5 How to Chain Exceptions
All calypso exceptions are derived from the class com.calypso.tk.core.CalypsoException.
Exceptions can be chained using setNext() and getNext(), which allows the system to throw multiple
exceptions.
In all SQL transactions under tk, the code catches all Throwable rather than just Excepti... | |
How to Create a Comparator Class for Sorting Objects | 6.6 How to Create a Comparator Class for Sorting Objects
You can create a custom comparator class to order aggregation groups in ScenarioAnalysisViewer.
Create a class named tk.util.<name>Comparator that implements java.util.Comparator.
You can access the comparator class using ComparatorFactory.getCustomComparator... | |
Engines | Section 7. Engines
Engines in Calypso are special type of event listeners. These specialized listeners manage the
guaranteed delivery of persisted events, the event bus reconnect features as well as allow for multi-
threaded processing of events.
| |
Creating a Custom Engine | 7.1 Creating a Custom Engine
A custom engine is implemented by extending the Engine base class. All jars for engines are included
in the custom-engine prohect and the engines are started with all of the jars and run as a springboot
server (referred to as the Engine Server). Within an Engine Server instance, there c... | |
Extend the Engine Base Class | 7.1.1 Extend the Engine Base Class
Create a class that extends com.calypso.engine.Engine. The custom engine class must follow the
following conventions:
• The class must implement the following constructor Engine(DSConnection dsCon, String
hostname, int port) where:
− dsCon - a valid DSConn... | |
Registering the New Engine | 7.1.2 Registering the New Engine
To register a custom engine, bring up Web Admin, and choose Manage > Engines.
Then click “Create New Engine”:
Enter the engine name, engine class, event subscription, event filter and parameters as needed, and
save.
You can then start / stop the engine directly from the... | |
How to Customize the Transfer Engine | 7.2 How to Customize the Transfer Engine
The Transfer engine uses a process based on a BOProductHandler for a given product, and the
Transfer rules if settlement instructions have been set up, to generate transfers as follows.
• The BOProductHandler creates all the transfers relating to a Trade using cash flo... | |
Creating a Custom BOProductHandler | 7.2.1 Creating a Custom BOProductHandler
The base class for producing trade cashflows and transfers with settlement instructions is
com.calypso.tk.bo.BOProductHandler. Each product will usually have its own BOProductHandler. A
BOProduct<product_type>Handler can itself extend or override another
BOProduct<product_t... | |
BOSimpleRepoHandler | 7.2.2 BOSimpleRepoHandler
BOSimpleRepoHandler is a custom handler that extends com.calypso.tk.bo.BOSimpleRepoHandler.
It provides, for example, the possibility to add an attribute to a Transfer by using the UpdateTransfer()
method.
| |
Creating a Custom Interest Dispatch Process | 7.2.3 Creating a Custom Interest Dispatch Process
It is possible to customize the behavior of the interest dispatch process for repos.
Create a class named tk.bo.BORepo<dispatch_method>DispatchInterestHandler that implements
com.calypso.tk.bo.BORepoDispatchInterestHandler.
BORepoDispatchInterestHandler has two me... | |
Creating a Custom Date Filter | 7.2.4 Creating a Custom Date Filter
The default behavior will generate the Product transfers up to the next event date if engine parameter
XFER_NEXT_EVENT = True.
Create a class named tk.product.<product_type>ProductNextEventDate that implements the
interface com.calypso.tk.product.ProductNextEventDate.
<product_t... | |
Creating a Custom Date Selector | 7.2.5 Creating a Custom Date Selector
Create a class named tk.bo.CustomBOTransferDateSelector which implements the interface
com.calypso.tk.bo.BOTransferDateSelector.
CustomBOTransferDateSelector is invoked by com.calypso.tk.bo.BOProductHandler to set the dates
on the transfers.
| |
Creating a Custom Transfer Matching Mechanism | 7.2.6 Creating a Custom Transfer Matching Mechanism
This interface determines whether a Transfer must be canceled, updated, or created. For instance, it
allows the user to disable some criteria during the matching of two transfers.
Create a class named engine.payment.<product_type>TransferMatching or
engine.paymen... | |
Creating a Custom Netting Handler | 7.2.7 Creating a Custom Netting Handler
You can create a custom netting handler to modify how netting is done. Create a class named
tk.bo.<netting_handler>NettingHandler that implements com.calypso.tk.bo.NettingHandler.
The default implementation is DefaultNettingHandler.
Register the <netting_handler> in th... | |
Creating a Custom Netting Method Selector | 7.2.8 Creating a Custom Netting Method Selector
A custom Netting Method Detector automatically sets the Netting Type on the Transfer Rules and lets
you override the Netting Method default value.
Create a class named tk.bo.<product_type>NettingSelector which implements the interface
com.calypso.tk.bo.NettingSelector... | |
Creating a Custom Persistence Routine for Transfer Attributes | 7.2.9 Creating a Custom Persistence Routine for Transfer Attributes
Create a class named tk.bo.sql.CustomTransferAttributeSQL that implements the interface
com.calypso.tk.bo.sql.TransferAttributeSQL.
CustomTransferAttributeSQL is invoked from com.calypso.tk.bo.sql.BOTransferSQL when saving
transfers. TransferAttri... | |
Customizing the Message Engine | 7.3 Customizing the Message Engine
The Message engine generates messages for various events as applicable (Trade, Transfer, etc), using
the following process:
• The Message engine identifies the roles to which sending the message using TradeRoleFinder.
Once, the roles are determined, receiver contact inf... | |
Creating a Custom Update Transfer | 7.3.1 Creating a Custom Update Transfer
A custom Update Transfer can modify the Transfer depending on the Transfer, Trade, and Cashflow.
Create a class named tk.bo.CustomUpdateTransfer that implements the interface
com.calypso.tk.bo.UpdateTransfer.
| |
Creating a Custom Role Finder | 7.3.2 Creating a Custom Role Finder
For example, you want to retrieve the possible receivers of a message based on the Legal Entity role.
Write this class to retrieve the Legal Entities for a given Role defined in a Trade, a Product, or a
Transfer.
Create a class named tk.bo.<product_type>RoleFinder or tk.bo... | |
Creating a Custom Message Selector | 7.3.3 Creating a Custom Message Selector
For instance, the SampleCustomMessageSelector returns False when there is no SWIFT address for the
Receiver Contact, causing a message to not be generated by the Message engine.
Create a class named engine.advice.CustomMessageSelector which implements the interface
com.calyp... | |
Customizing Message Selection | 7.3.4 Customizing Message Selection
A custom interface allows customers to implement a specific behavior of AdviceConfigSelection in the
MessageEngine.
The customized implementation must be called engine.advice.CustomAdviceConfigSelector and
must implement com.calypso.engine.advice.AdviceConfigSelector.
The Default... | |
Creating a Custom Message Handler | 7.3.5 Creating a Custom Message Handler
Create a class named tk.bo.BO<product_type>MessageHandler or
tk.bo.BO<product_family>MessageHandler which extends com.calypso.tk.bo.BOMessageHandler.
[NOTE: For message types without a product type, such as STATEMENT, you can create a
class named tk.bo.BOSTATEMENTMessageHand... | |
Creating a Custom Type of Formatter | 7.3.6 Creating a Custom Type of Formatter
Calypso provides formatter support for HTML, Text, SWIFT, and XML, standard. However, it might be
necessary to support the FIX format and hence, create a FIX generator class.
Create a class named tk.bo.<format_type>Formatter which implements the interface
com.calypso.tk.bo.... | |
Creating a Custom Template Selector | 7.3.7 Creating a Custom Template Selector
Create a class named tk.bo.<product_type>TemplateSelector which implements the interface
com.calypso.tk.bo.TemplateSelector.
Invoke TemplateSelector from com.calypso.tk.bo.FormatterUtil to choose a template selector.
| |
Creating a Custom Message Formatter Selector | 7.3.8 Creating a Custom Message Formatter Selector
Create a class named tk.bo.<message_type>MFSelector which implements the interface
com.calypso.tk.bo.MFSelector.
Invoke MFSelector from com.calypso.tk.bo.MessageFormatterUtil to choose a MessageFormatter
selector.
| |
Creating a Custom Message Formatter | 7.3.9 Creating a Custom Message Formatter
A Message Formatter is responsible for extracting the information from a trade and matching the
appropriate keywords in the template.
See “How to Create an HTML Template,” for information on how to create an HTML template.
Create a class named tk.bo.<message_type><product... | |
Creating a Custom Persistence Routine for Message Attributes | 7.3.10Creating a Custom Persistence Routine for Message Attributes
Create a class named tk.bo.sql.CustomMessageAttributeSQL that implements the interface
com.calypso.tk.bo.sql.MessageAttributeSQL.
MessageAttributeSQL is invoked from com.calypso.tk.bo.sql.BOMessageSQL when saving
messages. MessageAttributeSQL inclu... | |
Creating a Custom XML Generator | 7.3.11Creating a Custom XML Generator
Create a class named tk.bo.xml.<template_name>XMLGenerator or
tk.bo.xml.DefaultXMLGenerator that implements the interface
com.calypso.tk.bo.xml.XMLGenerator.
XMLGenerator is invoked from com.calypso.tk.bo.xml.XMLUtil.
| |
Creating Multiple BOMessages per Message Type | 7.3.12Creating Multiple BOMessages per Message Type
Create a class named tk.product.<product_type> that implements the interface
com.calypso.tk.product.MultiMessageProduct.
For example, an FX Swap needs two trade confirmations when you verify the trade; one confirm for the
near leg and a second confirm for the far... | |
How to Customize a Statement Message | 7.3.13How to Customize a Statement Message
The AccountStatementInterface interface is used by the Message engine to set the Message Reference
on the Statement messages. It provides flexibility in the population of the fields:
fillMessageReference(MessageArray message, AccountStatement statement, DSConnection dsCon)... | |
How to Customize the Statement Configuration | 7.3.14How to Customize the Statement Configuration
You can create a custom panel in the Statement Config window: Make sure that the statement type is
defined in the domain “StatementType”, and create a class named
apps.refdata.accounting.statement.<statement type>AccountStatementConfigPanel that
implements the inte... | |
How to Customize MessageIdentifier | 7.3.15How to Customize MessageIdentifier
Create a class named tk.engine.advice.BOMessageMessageIdentifierHandler that implements
com.calypso.engine.advice.IMessageIdentifier to customize MessageIdentifier.
This class is invoked from com.calypso.engine.advice.MessageEngine.
| |
How to Customize SWIFT Messages | 7.4 How to Customize SWIFT Messages
SWIFT messages can be generated from an XML template using SWIFTFormatter.
| |
Using SWIFTFormatter | 7.4.1 Using SWIFTFormatter
Creating a Custom SWIFTFormatter
Create a class named tk.bo.swift.<name>SWIFTFormatter that extends
com.calypso.tk.bo.swift.SWIFTFormatter.
The name should be the name of the template (MT360 for example).
SWIFTFormatter is invoked from com.calypso.tk.bo.SWIFTFormatterUtil.
By default, th... | |
Applying Custom Validation to SWIFT Messages | 7.4.2 Applying Custom Validation to SWIFT Messages
Create a class named tk.bo.swift.CustomSwiftMessageValidator that implements the interface
com.calypso.tk.bo.swift.SwiftMessageValidator.
CustomSwiftMessageValidator is invoked by com.calypso.tk.bo.swift.SwiftMessage before the
message is saved.
| |
Customizing IsFinancial in SWIFT Messages | 7.4.3 Customizing IsFinancial in SWIFT Messages
Create a class named tk.bo.swift.CustomSwiftUtilInterface that extends
com.calypso.tk.bo.swift.DefaultSwiftUtilInterface.
• Method – getIsFinancial: This method determines whether or not the provided Legal Entity is a
financial organization.
• In... | |
Customizing EntityInfo for SWIFT Messages | 7.4.4 Customizing EntityInfo for SWIFT Messages
Create a class named tk.bo.swift.CustomEntityInfo that implements
com.calypso.tk.bo.swift.EntityInfo.
CustomEntityInfo is invoked by com.calypso.tk.bo.swift.SwiftUtil.
| |
How to Customize the Sender Engine | 7.5 How to Customize the Sender Engine
The Sender engine uses DocumentSender objects to physically transmit message documents to a
given address method or gateway. Calypso provides EMAILDocumentSender to send documents via
e-mail. Address methods are stored in the “addressMethod” domain.
[NOTE: When sending ... | |
How to Customize the Accounting Engine | 7.6 How to Customize the Accounting Engine
The Accounting engine uses the following process to generate postings for various events (Trade,
Valuation, Liquidation, etc.) as applicable:
• The Accounting engine selects which accounting rule to apply using a mapping mechanism
between the events it subscr... | |
Generating Fee-Related Postings | 7.6.1 Generating Fee-Related Postings
You can define a CustomFeeAccountingHandler that extends DefaultFeeAccountingHandler which
implements FeeAccountingHandler to support new fee-related event types, or to redefine existing
event types.
For a fee-related accounting event type such as PREMIUM, call the get... | |
Creating a Custom Mapping Mechanism to an Accounting Rule | 7.6.2 Creating a Custom Mapping Mechanism to an Accounting Rule
Create a class named engine.accounting.CustomAccountingRuleSelector that implements the
interface com.calypso.engine.accounting.AccountingRuleSelector.
CustomAccountingRuleSelector is invoked from
com.calypso.engine.accounting.AccountingEngine to sele... | |
Creating a Custom Product Accounting Handler | 7.6.3 Creating a Custom Product Accounting Handler
Create a class named tk.bo.accounting.<product_type>AccountingHandler or
tk.bo.accounting.<product_family>AccountingHandler which extends
com.calypso.tk.bo.accounting.AccountingHandler.
The AccountingHandler should have a get<accounting event type>() method for e... | |
Creating a Custom Event Accounting Handler | 7.6.4 Creating a Custom Event Accounting Handler
Create a class named tk.bo.accounting.<event_type>AccountingHandler that implements the
interface com.calypso.tk.bo.accounting.EventAccountingHandler.
A custom event AccountingHandler is invoked from
com.calypso.tk.bo.accounting.AccountingHandler to generate a posti... | |
Creating a Custom Posting Description | 7.6.5 Creating a Custom Posting Description
Create a class named engine.accounting.CustomFillPostingDescription that implements the
interface com.calypso.engine.accounting.FillPostingDescription. You can implement
fillDescription() for adding attributes and fillPostingDates() for customizing the dates set on the
p... | |
Creating a Custom Accounting Matching Mechanism | 7.6.6 Creating a Custom Accounting Matching Mechanism
Create a class named engine.accounting.<product_type>AccountingMatching or
engine.accounting.DefaultAccountingMatching that implements the interface
com.calypso.engine.accounting.AccountingMatching.
AccountingMatching is invoked from com.calypso.engine.account... | |
Creating a Custom Account Keyword for Automatic Accounts | 7.6.7 Creating a Custom Account Keyword for Automatic Accounts
Create a class named tk.bo.accounting.keyword.<keyword>AccountKeyword which implements the
interface com.calypso.tk.bo.accounting.keyword.AccountKeyword.
AccountKeyword is invoked from com.calypso.tk.bo.accounting.keyword.KeywordUtil.
Then register the... | |
Applying Custom Validation to Accounting Rules | 7.6.8 Applying Custom Validation to Accounting Rules
Create a class named apps.refdata.CustomAccRuleValidator which implements the interface
com.calypso.apps.refdata.AccRuleValidator.
CustomAccRuleValidator is invoked from com.calypso.apps.refdata.AccountingRuleFrame prior to
saving an accounting rule.
| |
Apply Custom Validation to Account Interest | 7.6.9 Apply Custom Validation to Account Interest
Create a class named apps.refdata.CustomAccountInterestConfigValidator that implements
com.calypso.apps.refdata.AccountInterestConfigValidator.
AccountInterestConfigValidator is invoked from
com.calypso.apps.refdata.AccountInterestConfigWindow.
| |
Apply Custom Validation to Manual Postings | 7.6.10Apply Custom Validation to Manual Postings
Create a class named tk.bo.accounting.CustomManualPostingValidator that implements
com.calypso.tk.bo.accounting.ManualPostingValidator.
ManualPostingValidator is invoked from com.calypso.apps.reporting.EditPostingWindow and
com.calypso.apps.reporting.EditMultiplePo... | |
Applying a Custom Filter to Account Postings | 7.6.11Applying a Custom Filter to Account Postings
Create a class named engine.accounting.CustomAccountingFilterEvent or multiple classes named
engine.accounting.<Name>AccountingFilterEvent, each implementing
com.calypso.tk.bo.accounting.AccountingFilterEventInterface. When using multiple classes,
define e... |
End of preview. Expand in Data Studio
No dataset card yet
- Downloads last month
- 10