Purpose/Function
The AU_USER_SYM_EXPLODE subroutine changes the way hierarchical authority terms display. You can expand a hierarchy so that each term starts on a new line.
For example, if you are reporting on Address Place in the Person file, you could have the address Melbourne/Victoria/Australia display in your report as:
Melbourne
Victoria
Australia
You can also include or exclude related terms a certain level away from the current term, e.g. exclude all Broader terms more than one level away from the current term. In this case, Melbourne/Victoria/Australia would become:
Melbourne
Victoria
This subroutine is useful for producing address labels in Word Merge.
Argument syntax and parameters
auth.field!auth.mv!auth.file!explode.settings
auth.field |
Required |
Internal field name or FMC (Field Mark Count) of field to extract authority terms from. |
auth.mv |
Optional |
For multi-value authority fields, set to 0 to only process the first authority term, 1 to process all terms (default) or F to find first relevant data. |
auth.file |
Required |
System ID of the authority file that controls the auth.field field. |
explode.settings |
Required |
B$1 will display the current term and Broader terms one level away. F$1,N will display the current term, Used For terms one level away and all Narrower terms. Common codes are: B (Broader), N (Narrower), U (Use Instead), F (Used For), R (Related) and T (Translation). |
Parts of the argument are delimited by an exclamation mark.
Example:
ADDRESS_PLACE!!PLACE!B$1
This will extract all Place terms from the Address Place field in the Person file. For each Place entered, it will display the current term and Broader terms one level away, e.g. Melbourne/Victoria/Australia will become:
Melbourne
Victoria
Apply the conversion [AU_CONV,PLACE*AU_SHORT_NAME_OR] to display the Short Name of the Place term, e.g. Victoria will become VIC. This relies on data being entered in the Short Name field.
