Predefined Substitution Parameters
Some commonly used variables have been predefined as substitutions and you do not need to include them in the Substitutions table. However, you still need to prefix them with the @ sign when you reference them. Note also that the names of substitution parameters are NOT case sensitive. This fact can be used to clarify the visibility of the substitution parameters when entered in a plot text file.
The plot file substitution parameter @secwintowards, for example, is much easier to read as a mixed case expression: @SecWinTowards.
There are two kinds of predefined substitution parameter: System (Global) and Contextual (Local).
System
System substitutions (which exist for the current session) use system information and the metadata associated with a current user's session. Since they are "global" you can use them anywhere in the application where substitutions can be made, for example, in a Text Frame in a 2D or a 3D plot.
For example, suppose you have a plot layout that you use in several projects, and in each of those you want to include the project name and the date in the title. The solution is to define the data sets in the title once, with the text: @project and @ddmmyy.
These are predefined variables which do not require any further description in the substitution table. Each time this plot is printed, the project name and the current date will be automatically inserted into the title.
The following System (global) substitutions are provided:
| Parameter | Description |
|---|---|
| @ddmmyy | Current date, e.g. 26/5/23 |
| @mmddyy | Current date, e.g. 5/26/23 |
| @yyyymmdd | 1Current date, e.g. 20230601 |
| @yymmdd | 1Current date, e.g. 230601 |
| @time | Current time, e.g. 12:34 |
| @yyyy | Current year, e.g. 2010 |
| @mm or @month | Current month, e.g. 11 or Nov |
| @dd | Current day, e.g. 23 |
| @project | Current project, e.g. DEMO |
| @projdir | Current project folder, e.g. C:\PROJECTS\TEST |
| @projtitle | Current project title, e.g. DEMO PROJECT |
| @username | Current user's username |
| @networkdomain | Current user's network domain |
| @licenceID | Current user's application licence ID |
| @licenseID | Current user's application license ID |
| @mmversion | Current user's application version number |
| @computername | Current user's computer name |
| @windowsversion | Current user's Windows operating system version |
1An all-numeric format allows these dates to be stored and sorted in a numeric field column.
Contextual
Like predefined System substitution parameters, Contextual substitution parameters exist for the current session. However, they are not "global" since they can only be used in a particular context, for example, in the context of a Plot File, a Ring Design or Blast Design Plot, or the Drillhole Log, etc.
Plot File
Plot File substitutions (system information, plot metadata, and metadata associated with the current user's session) are written to the header of the plot file at the time the file is generated.
Both System and Plot File substitutions can be referenced in a 2D Plot. Vizex plots (and Ring Design and Blast Design plots) are only able to reference System substitutions. This is because a Vizex plot is rendered directly from a live or saved Vizex view and there is no associated PEL file.
The following Plot File substitutions are provided:
| Parameter | Description |
|---|---|
| @cusername | Plot file creator's username |
| @cnetworkdomain | Plot file creator's network domain |
| @clicenceID | Plot file creator's application licence ID |
| @cmmversion | Plot file creator's application version number |
| @ccomputername | Plot file creator's computer name |
| @cwindowsversion | Plot file creator's Windows operating system version |
| @cddmmyy or @cmmddyy | Plot file create date |
| @cyyyy or @cyy | Plot file create year |
| @cmm or @cmonth | Plot file create month |
| @cdd | Plot file create day |
| @plotFile | This substitution parameter can be used to plot the name of the plot file in the referenced plot frame. |
| @Scale | The scale of the plot. If xscale and yscale are different then scale is set to xscale. |
| @xCentre, @yCentre | These substitution parameters can be used to plot the X Centre and Y Centre values from the referenced plot frame. |
| @xScale, @yScale | These substitution parameters can be used to plot the X Scale and Y Scale values from the referenced plot frame. |
| @xMin, @yMin | These substitution parameters can be used to plot the X Min and Y Min values from the referenced plot frame. |
| @xMax, @yMax | These substitution parameters can be used to plot the X Max and Y Max values from the referenced plot frame. |
| @Section | This substitution parameter can be used to plot the section value. The section value is written to the plot file at the time the plot file is generated. If the plot file does not contain section data or the section can not be expressed as a single number value (e.g. a transform section) then the Section substitution is blank. |
| @SecType | This substitution parameter can be used to indicate the type of section, i.e. whether the section being plotted is an orthogonal (Plan, Looking Up, Looking North, Looking East, Looking South, Looking West) section or a transform section. |
| @SecStartX, @SecStartY | Each section is defined by two points. These substitution parameters can be used to plot the X and Y coordinates of the section starting point. The coordinates of the section points are recorded in the plot file at the time the plot file is generated. If the plot file does not contain section data, the SecStartX and SecStartY substitutions are blank. |
| @SecEndX, @SecEndY | Each section is defined by two points. These substitution parameters can be used to plot the X and Y coordinates of the section end point. The coordinates of the section points are recorded in the plot file at the time the plot file is generated. If the plot file does not contain section data, the SecEndX and SecEndY substitutions are blank. |
| @SecWinAway, @SecWinTowards | These substitution parameters can be used to plot the section window away and section window towards parameters. The section window values are recorded in the plot file at the time the plot file is generated. If the plot file does not contain section data then the SecWinAway and SecWinTowards substitutions are blank. |
| @LnScale | Set this parameter to 1 to draw a line scale. |
| @Lnsc_units | This parameter is used to set the line scale units, for example, m for metres. |
Ring Plot
The following Ring Plot substitutions are provided:
| Parameter | Description |
|---|---|
| @ringdesigndatabasename | The name of the current ring design database |
| @ringname | The name of the current ring selection. |
Blast Design Plot
The following Blast Design Plot substitutions are provided:
| Parameter | Description |
|---|---|
| @blastholedatabasename | The name of the current blasthole database (BHDB) |
| @blastblockname | The name of the current blast block. |
Drillhole Log
The content of a Text frame can be typed into a text box. As well System substitutions and user-defined text , a number of Drillhole Log specific substitutions can be specified:
| Properties | Description |
|---|---|
| @Hole | Current hole name |
| @CollarX | X coordinate of the current hole collar |
| @CollarY | Y coordinate of the current hole collar |
| @CollarZ | Z coordinate of the current hole collar |
| @CollarInclination | Inclination of the current hole |
| @CollarAzimuth | Azimuth of the current hole |
| @TotalDepth | Total depth of the current hole |
| @Page | Current page number for the current hole |
| @Pages | Total number of pages for the current hole |
| @TotalPage | Current page number across all holes |
| @TotalPages | Total number of pages across all holes |
| @Attribute1-10 | Collar attributes per the Drillhole Database |