Replace User Report Variable Text

Overview

The Replace User Report Variable group allows you to globally configure User Report Variables, and define Place Holders that may be added to User Report Variables which at output time will be replaced by the Replace Text Expression.

The order of replacement of User Report Variables is:

  1. User Report Variable
  2. User Defined Place Holder
  3. System Place Holder

Hence, you may refer to System Place Holders in User Place Holder Replace Text Expressions, and refer to System Place Holders and User Place Holders within User Report Variable type replacers.

User Report Variable Replacers

The User Report Variable column has a lookup list containing System values (described in the following table), and all User Report Variables from all reports in the current library.

System User Report Variable Replacer

Description

Auto Counter Start

Enter a number in Replace Text Expression. Overrides the auto counter for report rows, useful to start figure numbers at a number other than 1/a/A

Initial Figure Number

Allows the user to set a global value for the Initial Figure Number text box in the top right of the gINT OUTPUT Screen.


The value for a User Report Variables listed in the Replace User Report Variable grid is replaced with the Replace Text Expression.

The User Report Variable field on the Reports tab must be populated with the gINT script syntax text in order for this to work.

Place Holders

You may enter special text strings into User report Variables that will be replaced when you click Execute. System Place Holders allow for incrementing of figure or page numbers. User Defined Place Holders could be used to append a string on the end of an existing User Report Variable Value, set a drawn by name or drawn date etc.

  • Place holders are case sensitive
  • Replace text expressions that contain a comma must be surrounded in double quotes, e.g.:


"<<ListBuildSepTrim( - ,\[\[Group\]\], \[\[Report Type\]\], \[\[Report Name\]\], \[\[Caption\]\], \[\[Remark\]\], \[\[Key Set\]\], \[\[GDW Page No.\]\])>>"


System Place Holders

The following place holder within User Report Variables will be replaced when the user clicks Execute during the script generation.

Place Holder

Description

[[Auto Counter 1]]

Report grid item number, 1 based

[[Auto Counter A LC]]

Similar to above, except this will return lower case letters.

[[Auto Counter A UC]]

Report grid item number converted to an upper case letter, 1 based. Will return A to ZZ, e.g. 30th report grid row will return AD.

[[Caption]]

Reports grid column

[[Counter Increment]]

Reports grid column

[[Current URV.<URV Name>]]

Current user report variable value in the reports grid field for <URV Name> Name, or the value set in a preceding row in the Replace User report Variable grid

[[Current URV]]

Current user report variable value in the reports grid field for current Name, or the value set in a preceding row in the Replace User report Variable grid

[[GDW Page No.]]Reports grid column

[[Group]]

Reports grid column

[[Key Set]]

Reports grid column

[[Range Filter Criteria]]

Current range filter criteria code, only applicable to Group by Range Filter

[[Range Filter Description]]

Current range filter description, only applicable to Group by Range Filter

[[Remark]]

Reports grid column

[[Report Name]]

Reports grid column

[[Report Type]]

Reports grid column

User Defined Place Holders

You can define custom place holders to replace text in User Report Variable rows. The place holder may be surrounded by text within a row.

Example Usage


This example does the following:

  1. Sets the Auto Counter Start to 4, so the first figure number will be Figure 4
  2. For all reports listed in the Reports tab, the value for User Report Variable named Drawing Sub Title will set to New Area
  3. For all reports listed in the Reports tab, the value for User Report Variable named Drawn will set to PMW
  4. Sets the Initial Figure Number for each report to the Auto Count Incrementing Number

  5. Replaces sub-strings _\[\[Add Desc\]\]_ within the User Report Variable for all reports with the string _– PRELIM

After setting the configuration in the Replace User Report Variable Text group, move to the Reports tab and for all reports in the grid do the following:

  1. Click on the User Report Variable edit button for a row

  2. Place the text \[\[Add Desc\]\] at the end of the Drawing Title value, highlighted in the red box.  Note how there is no space before \[\[, this allows you to set the Place holder to "" if desired and no empty spaces will be applied


    Note the System Place Holders highlighted in the blue box

  3. Click OK
  4. Apply the place holder to other reports

Example Usage of Current URV

Replace User Report Variable Text grid

User Report Variable: Drawing Title

Replace Text Expression: 
[[Current URV.Scale Text]], [[Current URV.Drawing Title]], ][Current URV]], WHOLE SITE"

Example Output

AS SHOWN, BULK DENSITY VS ELEVATION, BULK DENSITY VS ELEVATION, WHOLE SITE

On this page