Defining Report Templates
A default HTML report template is provided out-of-the-box under <calypso home>/client/resources/com/calypso/templates/report/default.html. It can be customized or you can create your own templates using View > Views > HTML > Configure HTML View from any report. HTML report templates must be registered in the domain “REPORT.Templates”.
Templates contain free-form text as well as template
keywords to retrieve information from reports. All available report keywords
are described below. Keywords have the format |keyword name|, they are bracketed using the "|" symbol.
Ⓘ [NOTE: Template files need to be copied to <calypso home>/tools/calypso-templates/resources/com/calypso/templates/report. You will then need to deploy the files to your applications servers]
| Keyword Names | Description |
|---|---|
|
APP_VERSION |
Calypso Version of Application |
|
CURRENT_DATETIME |
Current Date and Time |
|
DATE |
Current Date |
|
DB_URL |
Database URL |
|
DS_NAME |
Data Server Name |
|
END_DATE |
Specified End Date of Report |
|
FILTER_SET |
Name of Filter Set used, if any |
|
MARGIN_CALL_PO |
Margin call - processing org |
|
MARGIN_CALL_COUNTERPARTY |
Margin call - Counterparty |
|
MARGIN_CALL_CONTRACT_ID |
Margin call - contract id |
|
MARGIN_CALL_CONTRACT_TYPE |
Margin call - contract type |
|
MARGIN_CALL_PROCESS_DATETIME |
Margin call - process date and time |
|
PARAMS |
Table containing report template parameters |
|
PATCH_VERSION |
Patch Version |
|
PRICING_ENV |
Pricing Environment |
|
RECEIVER_ID |
rec.getId() |
|
RECEIVER_LEID |
rec.getLegalEntityId() |
|
RECEIVER_ROLE |
rec.getLegalEntityRole() |
|
RECEIVER_CONTACT_TYPE |
rec.getContactType() |
|
RECEIVER_CONTACT_NAME |
rec.getContactName() |
|
RECEIVER_TITLE |
rec.getTitle() If null return PARENT_RECEIVER_TITLE |
|
RECEIVER_ADDRESS |
rec.getMailingAddress() |
|
RECEIVER_EMAIL |
rec.getEmailAddress() If null return PARENT_RECEIVER_EMAIL |
|
RECEIVER_FAX |
rec.getFax() If null return PARENT_RECEIVER_FAX |
|
RECEIVER_TELEX |
rec.getTelex() If null return PARENT_RECEIVER_TELEX |
|
RECEIVER_PHONE |
rec.getPhone() If null return PARENT_RECEIVER_PHONE |
|
RECEIVER_SWIFT |
rec.getSwift() If null return PARENT_RECEIVER_SWIFT |
|
RECEIVER_COMMENT |
rec.getComment() |
|
RECEIVER_CODE |
le.getName() |
|
RECEIVER_FULL_NAME |
LegalEntity le = BOCache.getLegalEntity(dsCon,rec.getLegalEntityId()) le.getName() |
|
RECEIVER_CITY |
rec.getCityName() If null return PARENT_RECEIVER_CITY |
|
RECEIVER_ZIPCODE |
rec.getZipCode() If null return PARENT_RECEIVER_ZIPCODE |
|
RECEIVER_STATE |
rec.getState() If null return PARENT_RECEIVER_STATE |
|
RECEIVER_COUNTRY |
rec.getCountry() If null return PARENT_RECEIVER_COUNTRY |
|
REPORT_OUTPUT |
HTML Table representing Report Data |
|
REPORT_TITLE |
Title of Report |
|
REPORT_TYPE |
Type of Report (Trade, Transfer, Message, ...) |
|
SENDER_FULL_NAME |
LegalEntity le = BOCache.getLegalEntity(dsCon,sender.getLegalEntityId()) le.getName() |
|
SENDER_CODE |
le.getName() |
|
SENDER_ID |
sender.getId() |
|
SENDER_LEID |
sender.getLegalEntityId() |
|
SENDER_ROLE |
sender.getLegalEntityRole() |
|
SENDER_CONTACT_TYPE |
sender.getContactType() |
|
SENDER_CONTACT_NAME |
sender.getContactName() |
|
SENDER_TITLE |
sender.getTitle() If null return PARENT_SENDER_TITLE |
|
SENDER_ADDRESS |
sender.getMailingAddress() If null return PARENT_SENDER_ADDRESS |
|
SENDER_EMAIL |
sender.getEmailAddress() If null return PARENT_SENDER_EMAIL |
|
SENDER_FAX |
sender.getFax() If null return PARENT_SENDER_FAX |
|
SENDER_TELEX |
sender.getTelex() If null return PARENT_SENDER_TELEX |
|
SENDER_PHONE |
sender.getPhone() If null return PARENT_SENDER_PHONE |
|
SENDER_SWIFT |
sender.getSwift() If null return PARENT_SENDER_SWIFT |
|
SENDER_COMMENT |
sender.getComment() |
|
SENDER_CITY |
sender.getCityName() If null return PARENT_SENDER_CITY |
|
SENDER_ZIPCODE |
sender.getZipCode() If null return PARENT_SENDER_ZIPCODE |
|
SENDER_STATE |
sender.getState() If null return PARENT_SENDER_STATE |
|
SENDER_COUNTRY |
sender.getCountry() If null return PARENT_SENDER_COUNTRY |
|
START_DATE |
Start Date of Report |
|
TEMPLATE_NAME |
Name of Report Template used |
|
USER |
Name of User running report |
|
VALUATION_DATE |
Valuation Date |
How are we doing?