Inline Functions in Nintex

Function reference

fn-Abs

Returns the absolute val­ue of a num­ber.

Exam­ple

fn-Abs({WorkflowVariable:Number})

Argu­ments

  • Num­ber The num­ber to return the absolute val­ue of.

fn-Currency

Rep­re­sents a numer­ic val­ue as a cur­ren­cy for­mat­ted text.

Exam­ple

fn-Currency({WorkflowVariable:Cost})

Argu­ments

  • Num­ber A vari­able con­tain­ing a numer­ic val­ue.

fn-DateDiffDays

Deter­mines the num­ber of days between two dates. The result can be a dec­i­mal val­ue includ­ing par­tial days.

Exam­ple

fn-DateDiffDays({WorkflowVariable:StartDate}, {WorkflowVariable:EndDate})

Argu­ments

  • Start date The start­ing date and time to cal­cu­late the dif­fer­ence between.
  • End date The end date and time to cal­cu­late the dif­fer­ence between.

fn-DateDiffHours

Deter­mines the num­ber of hours between two dates. The result can be a dec­i­mal val­ue includ­ing par­tial hours.

Exam­ple

fn-DateDiffHours({WorkflowVariable:StartDate}, {WorkflowVariable:EndDate})

Argu­ments

  • Start date The start­ing date and time to cal­cu­late the dif­fer­ence between.
  • End date The end and time date to cal­cu­late the dif­fer­ence between.

fn-DateDiffMinutes

Deter­mines the num­ber of min­utes between two dates. The result can be a dec­i­mal val­ue includ­ing par­tial min­utes.

Exam­ple

fn-DateDiffMinutes({WorkflowVariable:StartDate}, {WorkflowVariable:EndDate})

Argu­ments

  • Start date The start­ing date and time to cal­cu­late the dif­fer­ence between.
  • End date The end and time date to cal­cu­late the dif­fer­ence between.

fn-DateDiffSeconds

Deter­mines the num­ber of sec­onds between two dates. The result can be a dec­i­mal val­ue includ­ing par­tial sec­onds.

Exam­ple

fn-DateDiffSeconds({WorkflowVariable:StartDate}, {WorkflowVariable:EndDate})

Argu­ments

  • Start date The start­ing date and time to cal­cu­late the dif­fer­ence between.
  • End date The end and time date to cal­cu­late the dif­fer­ence between.

fn-FormatDate

Rep­re­sents a date time val­ue in text of a spe­cif­ic for­mat.

Exam­ple

fn-FormatDate({WorkflowVariable:MyDate}, d)

Argu­ments

fn-Insert

Adds text in to a larg­er string.

Exam­ple

fn-Insert({WorkflowVariable:Text}, 4, {ItemProperty:Title})

Argu­ments

  • Text The text to mod­i­fy.
  • Start posi­tion The char­ac­ter posi­tion to insert the new text at. The first char­ac­ter in the string is at posi­tion 0.
  • New text The addi­tion­al text that will be added at the start posi­tion.

fn-Length

Returns the num­ber of char­ac­ters in a string.

Exam­ple

fn-Length({WorkflowVariable:Text})

Argu­ments

  • Text The string to count the char­ac­ters of.

fn-Max

Returns the greater of two num­bers.

Exam­ple

fn-Max({WorkflowVariable:Number1}, {WorkflowVariable:Number2})

Argu­ments

  • Num­ber 1 The first num­ber to com­pare.
  • Num­ber 2 The sec­ond num­ber to com­pare.

fn-Min

Returns the less­er of two num­bers.

Exam­ple

fn-Min({WorkflowVariable:Number1}, {WorkflowVariable:Number2})

Argu­ments

  • Num­ber 1 The first num­ber to com­pare.
  • Num­ber 2 The sec­ond num­ber to com­pare.

fn-NewGuid

Gen­er­ate a glob­al­ly unique iden­ti­fi­er.

Exam­ple

fn-NewGuid()

fn-PadLeft

Returns the pro­vid­ed string right aligned and padded to the total length with a spe­cif­ic char­ac­ter.

Exam­ple

fn-PadLeft({WorkflowVariable:Text}, 6)

fn-PadLeft({WorkflowVariable:Text}, 6,-)

Argu­ments

  • Text The string to pad.
  • Length The tar­get total length of the padded result.
  • Char­ac­ter Option­al. The char­ac­ter to pad the orig­i­nal string with. A space char­ac­ter is used by default.

fn-PadRight

Returns the pro­vid­ed string left aligned and padded to the total length with a spe­cif­ic char­ac­ter.

Exam­ple

fn-PadRight({WorkflowVariable:Text}, 6)

fn-PadRight({WorkflowVariable:Text}, 6,-)

Argu­ments

  • Text The string to pad.
  • Length The tar­get total length of the padded result.
  • Char­ac­ter Option­al. The char­ac­ter to pad the orig­i­nal string with. A space char­ac­ter is used by default.

fn-Power

Rais­es a num­ber to the spec­i­fied pow­er.

Exam­ple

fn-Power({WorkflowVariable:Number}, {WorkflowVariable:Power})

Argu­ments

  • Num­ber The num­ber to raise to the pow­er.
  • Num­ber The pow­er to raise num­ber to.

fn-Remove

Removes a sec­tion of text in a larg­er string.

Exam­ple

fn-Remove({WorkflowVariable:Text},xxx,{ItemProperty:Title})

Argu­ments

  • Text The text to mod­i­fy.
  • Start posi­tion The char­ac­ter posi­tion from which to remove the fol­low­ing char­ac­ters. The first char­ac­ter in the string is at posi­tion 0.
  • Length Option­al. The num­ber of char­ac­ters from the start posi­tion to remove. All remain­ing char­ac­ters will be removed by default.

fn-Replace

Replaces a sec­tion of text in a larg­er string.

Exam­ple

fn-Replace({WorkflowVariable:Text},xxx,{ItemProperty:Title})

Argu­ments

  • Text The text to mod­i­fy.
  • Old val­ue The text to search for and replace.
  • New val­ue The text to replace Old val­ue with.

fn-Round

Rounds a dec­i­mal val­ue to the near­est inte­ger.

Exam­ple

fn-Round({WorkflowVariable:Number})

Argu­ments

  • Num­ber The dec­i­mal num­ber to round.

fn-SubString

Extracts a por­tion of text from a string.

Exam­ple

fn-SubString({WorkflowVariable:Text},5,10)

Argu­ments

  • Text The text to extract a val­ue from
  • Start index The posi­tion in the text of the first char­ac­ter to retrieve. The first char­ac­ter in the string is at posi­tion 0.
  • Num­ber of char­ac­ters The num­ber of char­ac­ters to retrieve from the start index.

fn-ToLower

For­mats text in a string to all low­er case.

Exam­ple

fn-ToLower({WorkflowVariable:Text})

Argu­ments

  • Text The string to con­vert to all low­er case.

fn-ToTitleCase

For­mats text in a string to title case.

Exam­ple

fn-ToTitleCase({WorkflowVariable:Text})

Argu­ments

  • Text The string to con­vert to title case.

fn-ToUpper

For­mats text in a string to all upper case.

Exam­ple

fn-ToUpper({WorkflowVariable:Text})

Argu­ments

  • Text The string to con­vert to all upper case.

fn-Trim

Removes lead­ing and trail­ing white­space from a string.

Exam­ple

fn-Trim({WorkflowVariable:Text})

Argu­ments

  • Text The text to remove lead­ing and trail­ing white­space char­ac­ters from.

fn-XmlEncode

Encodes a string to make it safe for view­ing in html.

Exam­ple

fn-XmlEncode({WorkflowVariable:Text})

Argu­ments

  • Text The text to encode.

fn-XmlDecode

Decodes a html safe string to reg­u­lar text.

Exam­ple

fn-XmlDecode({WorkflowVariable:Text})

Argu­ments