Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UI Text Box
sizemedium
typeinfo

This function returns a specific part of a text by setting the start index and the end index of the text to be returned.


Code Block
languagebash
titlesyntax
linenumberstrue
substring(text, startIndex, endIndex) #Output: Text


UI Expand
titleExamples

Take this text as an example:

01234567891011121314151617181920212223
HAMBURGERS
ARE
DELICIOUS


Parser expressionDescription


Code Block
languagebash
linenumberstrue
substring("HAMBURGERS ARE DELICIOUS", 11, 14)


This example returns

ARE


Code Block
languagebash
linenumberstrue
substring("HAMBURGERS ARE DELICIOUS", 15, 24)


This example returns  

DELICIOUS



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
text

Status
subtletrue
titleText

Any given text.
startIndex

Status
subtletrue
titleNumber

A number that specifies the index of the first character for the substring.

UI Text Box
typenote

The index starts at 0.


endIndex

Status
subtletrue
titleNumber

A number that specifies the index-1 of the last character for the substring.

UI Text Box
typenote

The length of the substring is endIndex → startIndex.




UI Expand
titleOutput

This function returns a

Status
subtletrue
titletext



Use cases and examples

Page properties report
firstcolumnUse case
headingsJWT feature, Workflow function, Field type, Automated action, Parser functions
cqllabel = "parser_func_substring" and space = currentSpace()


Page properties
hiddentrue



Status
Tech review

Status
colourGreen
titledone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description

Returns a specific part of a text.

Output

Status
subtletrue
titletext

Available since

Status
subtletrue
colourRed
titleneeds lookup

Label

Status
colourRed
titlestaff pick