Function Summary

Summary

You can also find additional information on variables and outputs.

Logic

#FunctionDescription
1ContainsChecks whether a value is found within another value
2EvaluateEvaluates an expression
3IFAllows a condition to be checked
4IIFAllows a condition to be checked with branching output
5IsValidChecks whether the provided value is non-empty and non-null
6IsEqualChecks for value equality
7IsNotEqualChecks for value equality

Caching

#FunctionDescription
1GetOutputs cached values previously set using "Set" or "SetGlobal" functions
2IsValidCacheChecks whether the cache contains a specific key
3SetSets a cache value
4SetGlobalSets a cache value before any merging is done

Numbers

#FunctionDescription
1DisplayFormatNumberOutputs a number with a specific format
2DisplayNumberOutputs a number with or without the pence if zero
3DisplayNumberRoundOutputs a rounded number
4DisplayNumberTextOutputs a number in alphanumerical format
5DecimalOutputs as a number dealing with nulls in which case 0 is returned.
6IsValidNumberChecks whether a number is valid

Strings

#FunctionDescription
1DisplayBrFromChrConverts string line breaks to html equivalent
2DisplayFilenameOutputs a filename containing only allowed characters
3DisplayFormatOutputs a value with a specific format
4DisplayHtmlConverts content into html
5DisplaySentencesOutputs sentences with parameters to restrict contents
6IsEmptyChecks whether the provided value is empty
7LowerConverts a value to lower case
8ReplaceReplaces all instances of one value with another value
9UpperConverts a value to upper case
10DisplayCsvConverts a value to a csv field
11DisplayBracesSurrounds a value with braces
12SplitSplits a string or formats an array of values
13TinyUrlConverts a url into a shorter version

Prices

#FunctionDescription
1AgentFeeCalculates the agent fee
2AgentSaleValueCalculates the agent sale value
3AgreedRentCalculates the agreed rent
4DisplayAgentFeeOutputs the agent fee
5DisplayAgentSaleValueOutputs the agent sale value
6DisplayAgreedRentOutputs the agreed rent
7DisplayManageFeeOutputs the manage fee
8DisplayPriceOutputs a price for display
9DisplayPriceSymbolOutputs the currency symbol for a given country
10DisplayPriceTypeOutputs the price type for display
11DisplayPriceTypeToForOutputs the price type for display
12ManageFeeCalculates the manage fee
13PropertyPriceOutputs a price for a property
14DisplayPriceFreqPerOutputs a price frequency "per" for display

Dates

#FunctionDescription
1DateConverts a value into a date
2DateAddDaysAdds a specific number of days to a date
3DateAddHoursAdds a specific number of hours to a date
4DateAddMinutesAdds a specific number of minutes to a date
5DateAddMonthsAdds a specific number of months to a date
6DateAddWeeksAdds a specific number of weeks to a date
7DateAddYearsAdds a specific number of years to a date
8DateCompareCompares two dates
9DateEqualsChecks whether two dates are equal
10DateNoTimeOutputs a date without time part
10DisplayDateOutputs a date with a specific format
11DisplayDaySuffixOutputs a suffix for a specific date
12DisplayNiceDateOutputs a date using a nice format
13DisplayNiceTimeOutputs a time using nice format
14DateDifferenceDaysReturns the number of days between two dates

Addresses

#FunctionDescription
1DisplayAddressOutputs an address in a specific format
2DisplayAddressBranchOutputs an address in a specific format for a branch
3DisplayAddressClientOutputs an address in a specific format for a client
4DisplayAddressCompanyOutputs an address in a specific format for a company
5DisplayAddressPropertyOutputs an address in a specific format for a property
6DisplayAddressPropertyMultiLineOutputs an address for a property using multiline breaks
7DisplayAddressSignAsBranchOutputs an address in a specific format for the signed in branch
8DisplayAddressSignAsBranchRegOutputs an address in a specific format for the signed in branches registered office
9DisplayAddressBoroughOutputs an address in a specific format for a borough
10DisplayCountryOutputs a country name

Clients

#FunctionDescription
1DisplayClientTypeOutputs the client type description
2DisplayNameOutputs a name for display

Lookups

#FunctionDescription
1DisplayCategoryOutputs the category description
2FindInfoFinds a record

Media

#FunctionDescription
1BranchLogoOutputs a html image for the branch logo
2BranchLogoUrlOutputs the URL for the branch logo
3DisplayImageOutputs a html image
4EpcGraphUrlOutputs the URL for the EPC graph
5PropertyMediaGenerates a html image for the provided property media
6PropertyMediaMaxSizeGenerates a html image for property media
7PropertyMediaUrlGenerates a URL for property media
8PropertyMediaUrlsGenerates URLs for property media

Phone Numbers

#FunctionDescription
1DisplayPhoneOutputs phone numbers for display
2DisplayPhoneBranchOutputs phone numbers for a branch
3DisplayPhoneClientOutputs phone numbers for a client

Properties

#FunctionDescription
1DisplayPropNumOutputs a number with a prefix and suffix
2DisplayPropNumBathOutputs the number of bathrooms
3DisplayPropNumBeddOutputs the number of double beds
4DisplayPropNumBedrOutputs the number of bedrooms
5DisplayPropNumBedsOutputs the number of single beds
6DisplayPropNumFloorOutputs the floor
7DisplayPropNumRecpOutputs the number of receptions
8DisplayPropNumRoomOutputs the number of rooms
9DisplayInternetLinkPropertyDisplays the internet link for a property
10PropertyUrlOutputs a URL for a property link

Tenancies

#FunctionDescription
1TenancyEmailsRetrieves the tenants emails.
2TenancyDataRetrieves the tenants data.
3LandlordEmailsRetrieves the landlords emails.
4LandlordDataRetrieves the landlords data.
5FindRentFinds the rent amount for a tenant.
6FindPayFreqFinds the payment frequency for a tenant.
7SetupTenancyMyExtrasSets up additional information about the tenancy that can be used in the output.

Finance

#FunctionDescription
1DisplayTraxModeDisplays a transaction mode.
2DisplayTraxTypeDisplays a transaction type.

Looping

#FunctionDescription
1LoopsLooping syntax.
2SetupTenantsSets up tenants for the looping code.
3SetupLandlordsSets up landlords for the looping code.