Other Important Function Handlers
reviewed: 22 February 2025
Note: you can find a list of all function handlers that are supported by the runtime of an application and all function supported by each function handler through the page development/functions.cms.
Overview of Handlers
General purpose:
| Function handler | Usage |
|---|---|
| csv | Support for .csv file processing |
| docx | Functions to interact with Open Office .docx files |
| eml | Functions to manage the eml email object |
| excel | Functions to interact with Microsoft Excel |
| fileSystem | Access to (server-side) file system |
| ftp | FTP support |
| host | Network host related functions |
| httpRequest | Functions for web services and low-level HTTP handling |
| image | Image related functions |
| imap | Functions to interact with IMAP |
| json | Functions to manage JSON |
| jwt | Support for JSON Web Tokens |
| oauth | Support for oAuth authentication |
| pop3 | Functions to interact with POP3 |
| regex | Function to handle regular expressions |
| request | Functions for low-level HTTP request procesing |
| response | Functions for low-level HTTP response procesing |
| sb | CaseMaster implementation of string builder |
| sftp | SFTP support |
| shell | (Windows) shell support |
| smtp | Functions to interact with SMTP |
| spreadsheet | Function to interact with Open Office spreadsheet files |
| stopwatch | Implementation of stopwatch (useful for performance and tracing) |
| textFile | Function to create and read text files |
| totp | Support for time based on-time-passwords |
| webSocket | Functions to support websockets |
| word | Functions to interact with Microsoft Word |
| xml | Functions to manage XML |
CaseMaster specific:
| Function handler | Usage |
|---|---|
| app | Access to application settings |
| bo | Business object related functions |
| boDesc | Business Object Descriptor related functions |
| cache | Access to CaseMaster runtime cache |
| devUtils | Development utilities |
| document | Functions related to CaseMaster document management |
| error | Error handling functions |
| iterator | Functions related to Casemaster iterators |
| javascript | Functions to generate CaseMaster savvy Javascript code |
| lambda | Functions to create and invoke lambda functions |
| language | Functions for multi-language support |
| page | Functions related to CaseMaster page handling |
| pb | Functions related to Casemaster property bags |
| process | Functions related to Casemaster processes |
| qs | Functions related to Casemaster query string |
| qualifier | Functions related to Casemaster qualifiers |
| script | Functions related to Casemaster scripts |
| service | Functions related to Casemaster services |
| session | Functions related to Casemaster session management |
| sql | Functions related to Casemaster SQL |
| tdg | Functions related to Casemaster test data generator |
| test | Functions related to Casemaster test harness |
| trace | Functions related to Casemaster tracing |
| tx | Functions related to Casemaster transactions |
The Most Important Handlers
app - Access to application settings
The app function handler gives you information about the CaseMaster runtime.
boDesc - Accessing BO Descriptors
The boDesc function handler gives you access to a BO descriptor. This enables reflection and can be used to develop highly generic code that works for any business object. It also allow you to change settings on a BO descriptor. This is known as massaging a descriptor. This can be used to alter the behavior of a BO at runtime.
page / script / qualifier / service / document - Namespace Specific Handlers
We have already seen the specific namespace function handlers in action to call functions (see here).
language - Localisation
The language function handler can be used for localisation support (such as checking and setting the culture, user language, right-to-left or left-to-right pages, etc).
qs - Accessing the URL Query String
The qs function handler is used to get and set values from the query string of a HTTP request and will be discussed in detail here.
request / response / httpRequest - HTTP Processing
The handlers request, response and httpRequest are used for HTTP processing (web based systems and web services).
json - JSON Processing
The json handler is designed to process JSON.
xml - XML Processing
The xml handler is designed to process XML
sb - String Building
The sb handler is designed to build and stream strings. It is a more performant and easy to use way to build strings (instead of using the concat() function).
filesystem - Accessing the File System
The filesystem handler gives you access to the file system of the server.
textFile - Writing and Reading Text Files
The textFile handler is used to create / write and read text files. It supports multiple code-pages.
<End of document>