Category: Variables
Variables that can be used in any output are documented here.
Category: Addresses
| # | Function | Description |
|---|---|---|
| 1 | DisplayAddress | Outputs an address in a specific format |
| 2 | DisplayAddressBranch | Outputs an address in a specific format for a branch |
| 3 | DisplayAddressClient | Outputs an address in a specific format for a client |
| 3 | DisplayAddressCompany | Outputs an address in a specific format for a company |
| 4 | DisplayAddressProperty | Outputs an address in a specific format for a property |
| 5 | DisplayAddressPropertyMultiLine | Outputs an address for a property using multiline breaks |
| 6 | DisplayAddressSignAsBranch | Outputs an address in a specific format for the signed in branch |
| 7 | DisplayAddressSignAsBranchReg | Outputs an address in a specific format for the signed in branches registered office |
| 8 | DisplayCountry | Outputs a country name |
Category: Caching
| # | Function | Description |
|---|---|---|
| 1 | Get | Outputs cached values previously set using "Set" or "SetGlobal" functions |
| 2 | IsValidCache | Checks whether the cache contains a specific key |
| 3 | Set | Sets a cache value |
| 4 | SetGlobal | Sets a cache value before any merging is done |
Category: Clients
| # | Function | Description |
|---|---|---|
| 1 | DisplayClientType | Outputs the client type description |
| 2 | DisplayName | Outputs a name for display |
Category: Dates
| # | Function | Description |
|---|---|---|
| 1 | Date | Converts a value into a date |
| 2 | DateAddDays | Adds a specific number of days to a date |
| 3 | DateAddHours | Adds a specific number of hours to a date |
| 4 | DateAddMinutes | Adds a specific number of minutes to a date |
| 5 | DateAddMonths | Adds a specific number of months to a date |
| 6 | DateAddWeeks | Adds a specific number of weeks to a date |
| 7 | DateAddYears | Adds a specific number of years to a date |
| 8 | DateCompare | Compares two dates |
| 9 | DateEquals | Checks whether two dates are equal |
| 10 | DateNoTime | Outputs a date without time part |
| 10 | DisplayDate | Outputs a date with a specific format |
| 11 | DisplayDaySuffix | Outputs a suffix for a specific date |
| 12 | DisplayNiceDate | Outputs a date using a nice format |
| 13 | DisplayNiceTime | Outputs a time using nice format |
Category: Logic
| # | Function | Description |
|---|---|---|
| 1 | Contains | Checks whether a value is found within another value |
| 2 | Evaluate | Evaluates an expression |
| 3 | IF | Allows a condition to be checked |
| 4 | IIF | Allows a condition to be checked with branching output |
| 5 | IsValid | Checks whether the provided value is non-empty and non-null |
| 6 | IsEqual | Checks for value equality |
| 7 | IsNotEqual | Checks for value equality |
Category: Media
| # | Function | Description |
|---|---|---|
| 1 | BranchLogo | Outputs a html image for the branch logo |
| 2 | BranchLogoUrl | Outputs the URL for the branch logo |
| 3 | DisplayImage | Outputs a html image |
| 4 | EpcGraphUrl | Outputs the URL for the EPC graph |
| 5 | PropertyMedia | Generates a html image for the provided property media |
| 6 | PropertyMediaMaxSize | Generates a html image for property media |
| 7 | PropertyMediaUrl | Generates a URL for property media |
| 8 | PropertyMediaUrls | Generates URLs for property media |
Category: Numbers
| # | Function | Description |
|---|---|---|
| 1 | DisplayFormatNumber | Outputs a number with a specific format |
| 2 | DisplayNumber | Outputs a number with or without the pence if zero |
| 3 | DisplayNumberRound | Outputs a rounded number |
| 4 | Decimal | Outputs as a number dealing with nulls in which case 0 is returned. |
| 5 | IsValidNumber | Checks whether a number is valid |
Category: Phone Numbers
| # | Function | Description |
|---|---|---|
| 1 | DisplayPhone | Outputs phone numbers for display |
| 2 | DisplayPhoneBranch | Outputs phone numbers for a branch |
| 3 | DisplayPhoneClient | Outputs phone numbers for a client |
Category: Pricing
| # | Function | Description |
|---|---|---|
| 1 | AgentFee | Calculates the agent fee |
| 2 | AgentSaleValue | Calculates the agent sale value |
| 3 | AgreedRent | Calculates the agreed rent |
| 4 | DisplayAgentFee | Outputs the agent fee |
| 5 | DisplayAgentSaleValue | Outputs the agent sale value |
| 6 | DisplayAgreedRent | Outputs the agreed rent |
| 7 | DisplayManageFee | Outputs the manage fee |
| 8 | DisplayPrice | Outputs a price for display |
| 9 | DisplayPriceSymbol | Outputs the currency symbol for a given country |
| 10 | DisplayPriceType | Outputs the price type for display |
| 11 | DisplayPriceTypeToFor | Outputs the price type for display |
| 12 | ManageFee | Calculates the manage fee |
| 13 | PropertyPrice | Outputs a price for a property |
Category: Properties
| # | Function | Description |
|---|---|---|
| 1 | DisplayPropNum | Outputs a number with a prefix and suffix |
| 2 | DisplayPropNumBath | Outputs the number of bathrooms |
| 3 | DisplayPropNumBedd | Outputs the number of double beds |
| 4 | DisplayPropNumBedr | Outputs the number of bedrooms |
| 5 | DisplayPropNumBeds | Outputs the number of single beds |
| 6 | DisplayPropNumFloor | Outputs the floor |
| 7 | DisplayPropNumRecp | Outputs the number of receptions |
| 8 | DisplayPropNumRoom | Outputs the number of rooms |
| 5 | DisplayInternetLinkProperty | Displays the internet link for a property |
| 9 | PropertyUrl | Outputs a URL for a property link |
Category: Strings
| # | Function | Description |
|---|---|---|
| 1 | DisplayBrFromChr | Converts string line breaks to html equivalent |
| 2 | DisplayFilename | Outputs a filename containing only allowed characters |
| 3 | DisplayFormat | Outputs a value with a specific format |
| 4 | DisplayHtml | Converts content into html |
| 5 | DisplaySentences | Outputs sentences with parameters to restrict contents |
| 6 | IsEmpty | Checks whether the provided value is empty |
| 7 | Lower | Converts a value to lower case |
| 8 | Replace | Replaces all instances of one value with another value |
| 9 | Upper | Converts a value to upper case |
Category: Tenancies
| # | Function | Description |
|---|---|---|
| 1 | SetupTenantsHmo | Sets up the looper for tenants |
| 2 | SetupTenantsProperty | Sets up the looper for tenants |
| 3 | TenancyEmails | Retrieves the tenants emails. |
| 4 | TenancyData | Retrieves the tenants data. |
| 5 | LandlordData | Retrieves the landlords data. |
| 3 | FindRent | Finds the rent amount for a tenant. |
| 3 | FindPayFreq | Finds the payment frequency for a tenant. |
