Skip to content

ESDL Functions Overview

This document provides an overview of Enterprise Service Description Language (ESDL) functions available in the HPCC Systems platform.

Content Masking Functions

canMaskContent
API documentation for the canMaskContent function, which determines whether content can be masked based on current context.

getMaskingPropertyAwareness
API documentation for the getMaskingPropertyAwareness function, which retrieves masking property awareness settings.

getMaskValueBehavior
API documentation for the getMaskValueBehavior function, which returns the current mask value behavior configuration.

maskContent
API documentation for the maskContent function, which applies masking to specified content.

masking context scope
Documentation for masking context scope functionality in ESDL.

maskValue
API documentation for the maskValue function, which masks individual values according to defined policies.

updateMaskingContext
API documentation for the updateMaskingContext function, which modifies the current masking context.

String Processing Functions

compressString
API documentation for the compressString function, which compresses string data.

decompressString
API documentation for the decompressString function, which decompresses previously compressed string data.

decodeBase64String
API documentation for the decodeBase64String function, which decodes Base64-encoded strings.

encodeBase64String
API documentation for the encodeBase64String function, which encodes strings using Base64 encoding.

escapeXmlCharacters
API documentation for the escapeXmlCharacters function, which escapes special XML characters in strings.

unescapeXmlCharacters
API documentation for the unescapeXmlCharacters function, which unescapes XML character entities.

XML Processing Functions

toXmlString
API documentation for the toXmlString function, which converts data structures to XML string format.

Tracing and Debugging Functions

isTraceEnabled
API documentation for the isTraceEnabled function, which checks whether tracing is currently enabled.

setTraceOptions
API documentation for the setTraceOptions function, which configures tracing options.

trace
API documentation for the trace function, which outputs trace information.

traceContent
API documentation for the traceContent function, which traces content with optional formatting.

trace options scope
Documentation for trace options scope functionality in ESDL.

traceValue
API documentation for the traceValue function, which traces individual values.

Transaction Summary Functions

getTxSummary
API documentation for the getTxSummary function, which retrieves transaction summary information.

txSummaryTimer
API documentation for the txSummaryTimer function, which manages timing information in transaction summaries.

txSummaryValue
API documentation for the txSummaryValue function, which manages values in transaction summaries.

Utility Functions

delay
API documentation for the delay function, which introduces processing delays.

operations
Overview of available ESDL operations and their usage patterns.

Deprecated Functions

deprecated decrypt string
Documentation for the deprecated decrypt string API. This function should not be used in new implementations.

deprecated encrypt string
Documentation for the deprecated encrypt string API. This function should not be used in new implementations.

Additional Resources

For comprehensive information about ESDL operations and implementation patterns, refer to the operations documentation.

Released under the Apache-2.0 License.