Skip to main content
Share / Export

Setting Up VA Custom Form Buttons

VA Custom Form Buttons creates buttons on standard forms and UD custom forms that open a form, run a report, launch an external application, or run a stored procedure (including Stored Procedure to File), with optional parameters. Menu: Viewpoint Administration > Programs > VA Custom Form Buttons. Trimble procedure title: Create Custom Form Buttons.

Before you start​

  • Have access to VA Custom Form Buttons.
  • Know the host form (F4) and the target action (form, report, stored procedure, or executable path).
  • Parameters are optional; if you use them, know which Default Types you need.

Steps​

  1. Open VA Custom Form Buttons. New-record icon.
  2. Form: F4, the form that hosts the button.
  3. Button ID: enter + (or New / N) for the next ID. Unique among custom buttons on that form, not globally.
  4. Info tab, Text: label shown on the button.
  5. Action Type: Form, Report, Stored Procedure, External Application, or Stored Procedure to File.
  6. Action: form (F4); report (F4); stored procedure (F4); executable path (Browse for External Application); for Stored Procedure to File, the stored procedure (F4) whose output is written to a file.
  7. Button Refresh: No Refresh, Refresh Record, or Refresh Data Set (procedure may say “Refresh Dataset”).
  8. Parameters tab (optional; see below), then Save.
  9. Open the host form → Tools > Move Custom Buttons → position/resize → Accept. A button placed outside the normal tab control is not in the tab order.

Parameters (Name=Value)​

  • Parameter ID: + (or New / N) for next ID.
  • Name: descriptive for Form/Stored Procedure (optional but recommended); report parameter via F4 for Report; third-party parameter name for External Application.
  • Default Type and Default Value:
    • 0-Fixed Value: enter a literal in Default Value.
    • 3-Form Input Value: Default Value is the field sequence number (F4 lists fields on the Form).
    • Other types pass a system value; Default Value is display-only.
  • Published Default Type codes: 0 Fixed Value, 1 Current Date (+/−), 2 Current Month (+/−), 3 Form Input Value, 4 Active Company, 5 Active Project, 6 Active Job, 7 Active Contract, 8 Active PR Group, 9 Active PR End Date, 10 Active JB Prog Bill Mth, 11 Active JB Prog Bill#, 12 Active JB TM Bill Mth, 13 Active JBTM Bill#, 16 Current User, 17 Current Record ID. Codes 14 and 15 are not listed.
  • The system always inserts a hidden current-company parameter. Do not add one or the button may not work.
  • Save. For stored procedures, optionally create a Stored Procedure Success Message.

Hard rules​

  • Do not add a current-company parameter.
  • Button ID unique per form.
  • Off-tab placement drops the button from tab order.
  • External Application uses Browse; other action types use F4.
  • Purpose/intro text may omit Stored Procedure to File even though Action Type and Set Parameters cover it.

Notes​

  • Related: Create Custom Form Buttons; Set Parameters for Custom Form Buttons; Move Custom Buttons on the host form. Same area: VA Custom Field Combo Boxes, VA Custom Fields Wizard, VA Custom Form Tabs.