Application Framework Reference

Splunk API

replaceTokens()

The replaceTokens() method performs regular expression-based token replacement in the specified fragment. If the given fragment is an object, replacement will be performed in both keys and values.

Synopsis

result = Splunk.util.replaceTokens( fragment , reg , val )

Parameters

fragment

String,

Object

Fragment to perform replacement on.

reg

String

Regular expression used for replacement.

val

String

Value with which to replace tokens matching reg .

Return Value

String,

Object

Fragment with tokens replaced.

Example

if (USE_AUTOMATIC_STRING_REPLACEMENT) {
    var context = this.getContext();
    var baseSearch = search.toString();
    var tokens = Splunk.util.discoverReplacementTokens(baseSearch);  
    for (var i=0; i<tokens.length; i++) {
        var replacer = new RegExp("\\$" + tokens[i] + "\\$");
        baseSearch = Splunk.util.replaceTokens(baseSearch, \
                                               replacer, \
                                               context.get(tokens[i]));
        search.setBaseSearch(baseSearch);
    }  
}