Field Builder Examples

The following examples display the field builder functions and mask formats that can be applied when building the layout. Check back after each update has been installed as the examples will be updated often.

Concatenate

Note: This function is useful whenever there is a need to combine 2 or more fields together. The example shown does not trim extra spaces that may exist in the data. Note the quote marks surrounding the comma and spaces. By adding the quotes the function assumes the enclosed characters are to be printed as is between the fields.

Example:

print $contract.city & ", " & $contract.state & " " & $contract.zip;

Multiple Line Fields

Note: This function is useful whenever there is a need to multiple lines of text in a field. For example addresses or options. The smart fill field must be defined as a multiple line text box on the PDF prior to merging. The "println" command is used once per line and should be at the beginning of each line's function.

Example:

println $Address1;
println $Address2;
println $city & ", " & $state & " " & $zip;

Phone Mask

Note: This format is used whenever the phone number needs the proper mask applied. In the example shown the customer phone is being printed in the US phone number mask format.

Example:

print @mask("{0:num:(###) ###-####}", $customer.phone);

Date Mask

Note: This format is used whenever the date needs the proper mask applied. Note most Dates in DockMaster are stored in the internal date format and need conversion mask applied. The example shown converts the internal date to xx/xx/xxxx format. Change D4 to D2 to print a 2 digit year.

Example:

print @d3mask("D4/", $proposal.datecreated);

Amount Mask

Note: This format is used whenever the amount needs the proper mask applied. Note most amounts in DockMaster are stored with no decimal and need the proper need precision conversion mask applied. The example shown converts the stored number to the 9,999.99 format.

Example:

print @d3mask("MR2", $proposal.amt);

Layout Extract

Note: This example shows the use of question lines to determine what phone number to print on the PDF layout. When the layout is printed with the example shown the clerk will be prompted to select which phone to print (H)ome or (M)obile. There are multiple ways to use the @layout.extract function, additional examples will be added as encountered.

Example:

if @layout.extract("Page_1:~Question0","") == "h" then
  print $prospect.homephone;
elseif @layout.extract("Page_1:~Question0","") == "m" then
  print $prospect.workphone;
endif

Calculation Question

Note: This example is used when a calculation requires manual input of data that is not stored in DockMaster. The example shown utilizes two question lines to prompt for the amounts then applies the MR2 mask, and multiplies the total by 100 to print in the format 9,999.99

Example:

print @d3mask("MR2$",((@layout.extract("Page_1:~Question1","num") + @layout.extract("Page_1:~Question2","num")) * 100));

Item or Record ID

Note: Special note, This prints the entire item id or record id for the file selected. (for example the BSC id 00121 or CR 00005*4596)

Example:

print root.arg0;

Record ID sub-value such as CR reference

Note: Special Note; Prints the sub-value of the record id, (what value position behind the *) For instance if you wanted to get a portion of the id in files where the id is a combination such as cash receipts, you would use a script such as this, it gives the receipt number as shown in the CR item. The id format example is 00005*00012 with the first part being the customer id and the second part being the reference number.

Example:

print @str.field(root.arg0, "*", 1, "");

If statement for printing text based on attribute value

Note: This example checks for the boat unit type and based on the data in the attribute prints the assigned text in the field. Its useful for titling documents that ask for the type to be selected. Can also be used for any field that may contain data or specific text.

Example:

If $boatunit.(1).type == "B" then
  print "X";
endif

If statement for checking a box based on a value

Note: Special Note: == is equals, != is not equal to. Can also use <, >, <=, >= as well. If using to compare the value of another field, don't forget to set the priority level to be higher than the field being compared to.

Example:

If $contract.balloonpayment == "0" then
  print "Yes";
endif

Comment out a line

Note: Add // to the beginning of a line to bypass the line or add comments. This is used whenever a note or comment for reference is required to explain what is being done. See example.

Example:

//This field calculates the net total of the contract without taxes.

Loop

Note: This example counts the number of values in a multi-value item and prints each value on individual lines (requires a multi-line field). It will iterate through all values until the counted number of values have been printed.

Example:

For $i = 1 to count $boatunit.(1).optiondesc do
  println @mv.extract($boatunit.(1).optiondesc,1,$i);
next

Linear Address

Note: This example will print the address in a single line (Add1 Add2 City St Zip) and suppress any blank address fields, such as add2 which is not always used.

Example:

Print $customer.add1 & " ";
if $customer.add2 != "" then
  print ", " & $customer.add2;
endif
print ", " & $customer.city & "," & " " & $customer.zip;

Print the value of a custom dictionary item by dictionary name

Note: This example shows the pickdict function located in the field builder being used to select a custom dictionary item from the file. This example is pulling the data for option 1 from the QUO file, the record id of the QUO item and then custom dictionary name DEALER*OPT1. Special note: to avoid delayed generation of the PDF whenever possible, the fields that already exist should be utilized to extract data instead of calling custom dictionary names unless the dictionary calls a program process the information at the database level first.

Example:

print @pickdict(QUO,root.arg0,dealer*opt1)