Clicky

The myStorman Knowledgebase is for users of Storman v8 and v9. If you use Storman v10, please use our new Support Knowledgebase. | Dismiss for today

List of common references (#NTCRFCM01)

Last updated:   Applies to:   In industries:   Of versions:   Special contents:
20131209 (Andy)   Pro, MultiUser, MultiSite, MultiView   Self Storage EditionMarina EditionVault Edition   7.X (and higher)   n/a

What is a reference?

A reference in StorMan is exactly the same as a reference in real life. In other words, it is an object containing information which refers to data stored elsewhere, as opposed to containing the data itself. The great thing about references is that because they merely refer (and don't contain the actual data themselves), they are easily changed, or updated. Update the master object and everything referring to it changes to - instantly.

  • StorMan v9.1 (and higher) uses a slightly different display method for references embedded in email Notices. The only difference is the wrapper around the reference; the actual reference itself remains the same. Note that some Advanced references will not work in email Notices.

 

List of common General References

Reference Result
[Agreement]MoveIn This will display the Agreement's move-in date
[Agreement]MoveOut This will display the Agreement's move-out date
[Agreement]NextBillDate This will display the Agreement's next bill date
[Agreement]RegRent This will display the Agreement's regular rent amount
[Agreement]UnitsOccup This will display the Berths / Units / Vaults occupied by that Agreement
[Contacts]Firstname This will display the sales enquiries firstname 
[Contacts]MailAddress This will display the sales enquiries mail address
[Contacts]MailCity This will display the sales enquiries mail city
[Contacts]MailState This will display the sales enquiries mail state
[Contacts]MailZIPCode This will display the sales enquiries mail post/zipcode
[Customer]ABNNo This will display the Customers ABN (tax) number
[Customer]Balance This will display the Customers balance
[Customer]CustomerCode This will display the Customers Customer code
[Customer]CustomerName This will display the Customers name
[Customer]DateofBirth This will display the Customers date of birth
[Customer]EmailAddress This will display the Customers email address
[Customer]MailAddress This will display the Customers mail address
[Customer]MailCity This will display the Customers mail city
[Customer]MailPostZIPCode This will display the Customers mail post/zipcode
[Customer]MailState This will display the Customers mail state
[Customer]MobilePhone This will display the Customers mobile phone number
[Customer]Password This will display the Customers StorMan Online Payments password
[Customer]PhoneBus This will display the Customers business phone number
[Customer]PhonePrivate This will display the Customers home (or private) phone number
[Customer]StreetAddress This will display the Customers physical address
[Customer]StreetCity This will display the Customers physical city
[Customer]StreetState This will display the Customers physical state
[Customer]StreetZIPCode This will display the Customers physical post/zipcode
[Facility]BusinessName This will display your business name
[Facility]LetterSignOff This will display your signoff (more on System Setup tab: #SYSSETTAB1101)
[Facility]Phone This will display your phone number
[Unit]DoorSize This will display the Berth / Unit / Vault door size
[Unit]UnitLength This will display the Berth / Unit / Vault length
[Unit]UnitNo This will display the Berth / Unit / Vault number
[Unit]UnitSize This will display the Berth / Unit / Vault size
[Unit]UnitType This will display the Berth / Unit / Vault type
[Unit]UnitWidth This will display the Berth / Unit / Vault width

 

List of common Advanced References

Reference Result
[Agreement]BalanceOwing:$###,##0.00;-$###,##0.00 This will display the Agreement owing at the time the notice is generated.
[Agreement]BillPlanQuote This will display a table of Billing Plans that have the 'Include in Notices Reference' option (more on this option) enabled. The first column of the table displays the Billing Plan Name, followed by two tab-spaces, then the price of the Customer's current Berth / Unit / Vault - per period (based on the billing plans being displayed), then finally the total price of the Customer's current Berth / Unit / Vault - over the entire duration of the billing plan (based on the billing plans being displayed).
[Agreement]LastBillDate:Abbr: Month Day, Year   This will show the last bill date.
[Agreement]NewRentFrom:Abbr: Month Day, Year This will display the date at which a new rent amount applies, if present (generally used on Rent Change notices).
Current Date This will display the current date (as at the time the document is generated by StorMan), on said document.
Current date+35 This will show a date that is 35 days ahead of the current date (at the time the notice is generated).
Current Time This will display the current time (as at the time the document is generated by StorMan), on said document.
[Customer]Balance:$###,##0.00;-$###,##0.00 This will show the total balance owing for the current Customer (generally used on Late notices).
GetFirstName This will get the Customer's firstname only (if this field is blank, StorMan will insert "Sir/Madam").
[Letters]DateSent:Abbr: Month Day, Year This will display the date at the time the notice is generated.
Lowercase([BillPlan]Description) This will display the name of the Agreement's assigned billing plan (in lowercase).
Reverse([Customer]CustomerName) This will reverse & display the data in the 'Customer Name' field (nb. names are usually stored as "Lastname, Firstname").
Reverse([Customer]UserName) This will reverse & display the data in the 'Contact Person' field from the Agreement.
«Substring(String([Facility]BankAcNo);1;2)+"-"
+Substring(String([Facility]BankAcNo);3;4)+"-"
+Substring(String([Facility]BankAcNo);8;7)+"-"
+Substring(String([Facility]BankAcNo);16;2)»
This reference reformats the Facility 'Bank Account Number' field, so that it displays according to common New Zealand display practices.
«(Current date – [Agreement]PaidToDate)» This reference will display the number of days overdue for a particular customer.

 

Changes to Rent Increase References from v914

In version 9.1.4 (build 02/11/12), we enhanced the references available for displaying items relating to rent increases. The old references will still work, but you can now create loops which automatically loop the data for each Berth / Unit / Vault (which is handy if you're writing a rent increase letter and the customer has more than one Berth / Unit / Vault with you. Once the desired code has been inserted into your Notice as a reference, adjust the spaces between the references and add or delete references (as required) inside the 4DLOOP.

Basic reference Enhanced (looping) reference
[[4DTEXT [Agreement]RentIncreaseUnits]]

[[4DLOOP [Unit]]][[4DIF ([BillPlan]WeeksMonths=true)]]
[[4DTEXT [Unit]UnitNo]]     $[[4DTEXT String([Unit]WeeklyNewRentAmt;"###,##0.00")]]     [[4DTEXT [Unit]IncreaseFrom]]
[[4DELSE]]
[[4DTEXT [Unit]UnitNo]]     $[[4DTEXT String([Unit]NewRentAmt;"###,##0.00")]]     [[4DTEXT [Unit]IncreaseFrom]]

[[4DENDIF]][[4DENDLOOP]]
[[4DTEXT [Agreement]RentIncreaseUnitsNew]]

[[4DLOOP [Unit]]][[4DIF ([BillPlan]WeeksMonths=true)]]
[[4DTEXT [Unit]UnitNo]]     $[[4DTEXT String([Unit]WeeklyNewRentAmt;"###,##0.00")]]     [[4DTEXT [Unit]IncreaseFrom]]
[[4DELSE]]
[[4DTEXT [Unit]UnitNo]]     $[[4DTEXT String([Unit]NewRentAmt;"###,##0.00")]]     [[4DTEXT [Unit]IncreaseFrom]]
[[4DENDIF]][[4DENDLOOP]]

[[4DTEXT [Agreement]ORCIncrease]]

[[4DLOOP [OtherChgs]]]
[[4DTEXT [OtherChgs]Description]]     $[[4DTEXT String([OtherChgs]Amount;"###,##0.00")]]     $[[4DTEXT String([OtherChgs]NewAmount;"###,##0.00")]]
[[4DENDLOOP]]

 

Reference display tricks

StorMan features a number of built-in tricks to display your referenced data in different ways. These tricks only apply to references that contain a persons name, & are defined as follows...

  • Using mode 1 displays the name in the most readable way (if it has a comma) - so Smith, Mr John becomes Mr John Smith
  • Using mode 2 automatically finds the first name - so Smith, Mr John becomes John
  • Using mode 3 drops the first name (if it has a comma) - so Smith, Mr John becomes Mr Smith
  • Using mode 4 changes an uppercase name to a per-word Capitalisation - so SMITH, MR JOHN becomes Smith, Mr John

 

So if, for example, you wanted to display "John" (mode 2), then you would setup your reference as Reverse([Contacts]ContactName;2). Keep in mind that these only work when used in conjunction with the Reverse command, as per the example above.

 

How do I insert Database References into my Notices?

For email Notices, see #NTCUREN01. For print Notices, see #NTCURPN01.

 

Can you reference images (pictures)?

Yes - see: #NTCAITNG01.

Related articles:   Article tags:   How did we do?
         
 

list of common references, 4D references, 4Dref, common references in storman, letter reference, database field, database fields on letters, database fields on emails, insert database field, insert database reference

Did we miss a tag?
Tags improve search results. If you think this article needs more tags to help index & identify it, please suggest some using the form to the right...

 

If this article requires an update or needs more information, please contact support@storman.com.

Thank you for your assistance!

 

 


 

Copyright 2017 Storman Software | Visit our new knowledgebase