Page Comparison

OPTION

NAME

DESCRIPTION

Participant Type

Date and Phone Format

Display currency as text

Will convert currency to a text string.

For example: 53.47 will display as “Fifty Three Dollars and Forty Seven Cents”.

As per other doc-merge syntax, fm=TEXT will return in all caps, fm=text will return in lower-case and fm=Text will be in Mixed Caps.

The currency will be detected from either the associated sale/purchase record or the base currency defined in accounting for the database.

Record Number

Used to identify a specific record or participant number if there could be more than one.

For example there may be several “Trustee” participant types linked to a particular action.  If you wanted to create a signature block for each trustee then you could specify each one using rn=1, rn=2, etc.

Record numbers are most commonly used in REPEAT blocks (see below).

Boolean TRUE

The text that should be inserted if the data type of the linked custom data field is Boolean and the live data value of this field is “true”.  
Checkboxes will be “true” when checked or “false” when not checked.

For example if you have a custom data Boolean field (checkbox) called “has_insurance” then you might specify the option as

true=”the_client_has_insurance_cover”

which will generate as “the client has insurance cover” in place of this merge field when the document is generated.

(note the use of underscores to specify spaces)

If you do not specify a value for this option then Actionstep will substitute the text “true” for this merge field.

If you woudl like one of the options to returna  blank result (for example, leave blank if "false") then you will have to have that option equaling nothing and insert ifnull=ignore to the merge filed. For example:

[[boolean_field_name|true=My_true_text|false=|ifnull=ignore]]

In this example if the reulst is true the output will read "My True text"

If the result is false the result will be blank.

Boolean FALSE

Opposite of Boolean TRUE.  See above.

Choice One

Similar to Boolean choices except this applies to general merge fields that have two choices.  Examples of these merge fields include “i_c” (individual or company) and “s_p” (singular or plural).

“c1” = First choice in merge fields that conditionally substitute text.

Example: The merge_field "i_c" substitutes text depending on whether the participant is an individual (i) or a company (c). So,

will be read by the application as: "Find the 3rd (rn=3) shareholder (pt-Shareholder) associated with the action and substitute text “Resides at” if it's an individual or  “Has its offices at” if it is a company.

Choice Two

Second choice (see above)

Pronoun Person

First, Second, Third person for Pronouns (pn=1st, pn=2nd, pn=3rd) - only these values are allowed.

Actionstep will substitute pronouns (he, she, her, theirs, etc) depending on the gender and number of participants referenced in the live data.  This field specifies whether to create the pronoun in the first, second, or third person format.

This option is valid for merge fields

• pronoun1
• pronoun2
• pronoun3
• pronoun4

Example: [[Pronoun1|pn=1st|pt=Client_Primary_Contact]]

Refer to the pronoun substitution table in Appendix A for technical details on how the substitutions will be performed.

Sort Order

Sort directive for multi-row data collection in a repeat block (see below).

Missing Data Override

If this is not specified then Actionstep will insert the 'Missing Merge Field Text" specified in Workflow->Admin->Settings.  However sometimes you just want to leave it blank if there is no data e.g. if address_line_2 is empty then just don't insert anything.

ifnull=ignore  (this will leave it blank)

ifnull=Any_other_text (will print this text instead). Remember to use '_' for spaces.  So "Any_other_text" will merge as "Any other text" .

Image width

For fields like DivisionLogo which inserts an image this formatting option can specifiy either the width or height of the image in pixels.  The default behaviour is to display the image in it's natural dimensions.

Unlink the display_width option (See below) this will resize the image completely.  

Image height

See width

For fields like DivisionLogo which inserts an image this formatting option can specifiy either the width or height to display the image in pixels.  The default behaviour is to display the image in it's natural dimensions.

This will not resize the image that is displayed, just the dimensions that it takes on the document.

As an example, if you upload a 10mb image which is 10,000 x 10,000 pixels and you want it to be 400 x 400 in high res, you may want to use:

width=1200|display_width=400

This will resize the actual image file to 1200x1200 but display it on the document in 400x400, meaning that it will be 3x the DPI compared to regular width=400.

Image zoom

zoom=T, if true the image will be zoomed rather then scaled, ie 100x100 image with width=50|height=100 will zoom the image to 100 height and clip the left/right 25px, zoom=F would use white bars on the sides that do not match the aspect ratio

Repeat Table Row

Used to specify the beginning and end of a row of cells in a table.

If used in a repeat block then  the repeat block will include the whole row (see examples below under Repeat Blocks).  This is helpful because quite often in Word you cannot see where exactly your merge field is being placed relative to the hidden mark-up language fields which specify the start and end of the row.  If you use tablerow then ActionStep will automatically scan for the start and end tags in the mark-up language and take care of this for you.

Decimal Places

For data fields marked as decimal or currency and accounting fields this sets the number of decimal places to display.  Note that the "money" data type is not affected since it inherits this setting.

Bold text style

Currently only available for sale/purchase merge fields.

heading=bold,italic or item=bold,italic or child=bold,italic. This way you can bold a heading, ie: heading=bold or italics a child item: child=italic. Works in docx, html or rtf. Requires code logic so currently only in sale/purchase line-item code. Multiple styles can be used with commas: ie heading=bold,italic|item=bold|child=italic

Italic text style

See bold

Optional text before (prefix), or after (suffix), a number or text field

If you want to add text before/after a number field e.g. “You have 5 days to respond” you could code this as

You have [[DaysToRespond|suffix=_day,_days]] to respond

Notes:

• the underscore will insert spaces and
• for number fields the comma separates the singular and plural versions of the prefix/suffix (plural is optional).

Remove space characters

Useful for merge fields like InitialsAll which will change “A B K” to “ABK”.

Values: “T” – strip spaces, “F” – do not strip spaces (default)

Example [[InitialsAll|pt=Attorney|strip_spaces=T]]

Summary operations on multi-row numeric data

Use with multi-row data-collection fields (it will also work on single-row, but all methods will return the same number)

You can now add |calc=sum,avg,max,min on any multi-row number/currency field.

For example: [[test_field|calc=sum]] will return the sum of all the data in that field.

Sum will add all the numbers together

Avg will sum then divide by the count

Max will return highest number

Min will return lowest number

NOTE: this will *only* work when there is no |rn= flag

Set UPPERCASE or lowercase

Example: “the QUICK brown fox”

|case=upper == “THE QUICK BROWN FOX” – upper case all letters

|case=lower == “the quick brown fox” – lower case all letters

|case=ucfirst = “The QUICK brown fox” – upper case the first letter of the phrase, no-change the rest

|case=ucwords = “The QUICK Brown Fox” – upper case the first letter of every word, no-change the rest

|case=uclowerwords = “The Quick Brown Fox” – upper case the first letter of every word, lower-case the rest

|case=uclowerfirst = “The quick brown fox” – upper case the first letter, lower-case the rest

None of these options are “Mc” friendly etc… ie “mcdonand”  can’t be converted to “McDonanld”

This feature runs AFTER the existing formatting of |pt=CLIENT or pt=Client or pt=client formatting, but unlike pt= it will run on the result of *any* field.

This is commonly used in address blocks where you want something like

Name
Address Line 1
Address Line 2
City, State, Zip

But if there is no Address Line 2 for the contact then you will end up with a blank line in the output.

The solution is to use the newline option:

[[Fullname|pt=Client]]
[[Addressline1]][[Addressline2|newline=before]]
Etc..

This will insert a newline before AddressLine2 only if it contains a value.

The syntax is quite simple: [[Field|newline={option}]]

Where {option} can be one of: before, after, 2before, 2after, both, 2both  (where the 2* options are for two line breaks).