GoldMine Report Macros
The following is a compiled listing of information pertaining to the macros used within GoldMine reports along with a short description.
Some macros are only available within the “Calendar Printouts” reports category. The remaining macros are available in all of the report categories. They have been separated within this document for organizational purposes.
All Report Categories
&FullAddress
Displays Address1, Address2, City, State, Zip, and Country. A line feed separates address lines. City, State, Zip values are displayed on one line.
&Company&Address
Displays Contact Name, Company Name, Address1, Address2, City, State, Zip, and Country. A line feed separates all fields except for City, State, and Zip, which are displayed on one line.
&Address1&2
Displays Address1 and Address2 data separated by a line feed.
&Contact, Company
Displays Contact Name and Company Name separated by a semi-colon.
&Name&Address
Displays Contact Name, Title, Department, Company Name, Address1, Address2, City, State, Zip and Country. A line feed separates all fields except for City, State, and Zip, which are displayed on one line.
&Company
Contact Company Name, Contact Name separated by a semi-colon.
&Title&Address
Contact Name, Title, Department, Company Name, Address1, Address2, City, State, Zip, and Country. All fields separated by a line feed, except for City, State, Zip, which appear on the same line.
&CityStateZip
City, State, Zip displayed on the same line. City and state values are separated by comma.
&SourceFile
Returns the name of the database file being accessed in the current Section.
&CalActvName
Outputs the name of the scheduled activity being printed, based on the RECTYPE. For example, if a record of RECTYPE S is printed, the macro will return a value of “Sale”.
&HistActvName
Works in the same manner as &CalActvName, except that it returns names based on history records, not calendar data.
&User
Outputs the user name of the currently logged in user.
&FullName
Returns the full name of the currently logged in user, as defined in File > Configure GoldMine > Users File.
&Licensee
Outputs the “Licensed To:” company name as defined when the GoldMine serial number was specified.
&Sort1
Outputs the data from the field set as the primary sort for the report. Can also be used to specify a break field within a sort header. For example, if the primary sort of a report is set to contact1->company and I insert the value of &Sort1 for the break field in the sort header, the report will then break on contact1->company.
&Sort2
Outputs the data from the field set as the secondary sort for the report. Can also be used to specify a break field in the same manner as the &Sort1 value.
&Sort3
Outputs the data from the field set as the tertiary sort for the report. Can also be used to specify a break field in the same manner as the &Sort1 value.
&Phones
Outputs all three of the phone numbers, the fax number, and the extension fields.
&LocalLabel
Returns the local label of the field specified after the colon.
&Suppfile=”xxx” Used to specify break fields and filters within sections of reports. The “xxx” value must be at least two characters, but no greater than three. It is used to specify the database and record types you want to include in a report section. The first two characters specify the database and the third specifies the RECTYPE within that database. Possible values for the different databases are as follows: cs = CONTSUPP.DBF, ca = CALENDAR.DBF, ch = CONTHIST.DBF. The different RECTYPEs that can be specified as the third character are listed in the “Database
A collection of data fields and related tables, storing information that facilitates access and retrieval. Structures” section of your manual.
NOTE: The ADDRESS3 field data found in the GoldMine CONTACT1 table is included in those macros that return address information.
Calendar Printouts Section Only
&Detail1
Displays the information that has been specified in the “Options” window for the report.
&Year
Returns the value of the current year in four-digit format, such as 2009. The macro will also return the value of the year for all dates within the specified date range under the report’s options. For example, if the date range is set as 01/01/07 to 01/31/09, the macro will return all values that fall within the date range (i.e. 2007, 2008, and 2009).
&Month Returns the numeric equivalent of the current month. For example, January = 1, February = 2, etc. The macro also returns the value of the month for all dates within the specified date range in the report’s options. For example, if the date range is set as 10/01/08 to 01/31/09, the macro will return all values that fall within the date range (i.e. 10, 11, 12 and 1).
&CMonth
Returns the name of the current month (For Example, January, February, etc.). The macro will also return the value of the month for all dates within the specified date range under the report’s options. For example, if the date range is set as 10/01/08 to 01/31/09, the macro will return all values that fall within the date range (i.e. October, November, December and January).
&CMonthYr
Returns the name of the current month, plus the 4-digit year (For example: January 1998). The macro will also return the value of the month and year for all dates within the specified date range in the report’s options. For example, if the date range is set as 11/01/07 to 01/31/09, the macro will return all values that fall within the date range (i.e. November 2007, December 2008, and January 2009).
&Day
Returns the numeric value of the current day (For example, 12, 100, 300, etc.). The macro will also return the value of the day for all dates within the specified date range under the report’s options. For example, if the date range is set as 01/29/09 to 01/31/09, the macro will return all values that fall within the date range (i.e. 29, 30, and 31).
&Dow
Returns the numeric value of the day of the week. For example, a date which falls on Wednesday would return a value of 4, etc. Sunday is considered as being the 1st day of the week. This macro will also return all values within a date range.
&CDow
much in the same manner as the &Dow macro, except that instead of returning a numeric value, it returns the actual name of the day. For example, if a date falls on a Sunday, the macro will return the value “Sunday” and so forth.
&DayNo
Returns the day number based on the year. For Example: January 2, 2009 = Day 2.
&WeekNo
Returns the week number of the year, similar to &DayNo. Jan 5–11 = Week 2.
&WDay1
Returns the numeric day value of the Monday for the workweek in which the date falls. Assume that we are looking at records that fall on Wednesday January 28, 2009, the value returned by the macro would be 26. Since the 28th is a Wednesday, Monday is the 26th for the week of January 28, 2009.
&WDay3
Functions in the same manner as the macro &Wday1, except that it returns the numeric day value of the third work day of the week, or Wednesday.
&WDay4
Functions in the same manner as the macro &Wday1, except that it returns the numeric day value of the fourth work day of the week, or Thursday.
&WDay7
Functions in the same manner as the macro &Wday1, except that it returns the numeric value of the seventh work day of the week, or Sunday.
&Hour
Displays the time in hourly increments from 7:00 AM to 7:00 PM, generated in 12-hour format.
&Time
Returns the scheduled time for calendar records, in 12-hour format.
&FrDate
Displays the From: date entry from the report’s options.
&ToDate
Displays the To: date entry from the report’s options.
&LastMonth
Generates a graphical representation of the prior month, based on the date of the calendar records on the current report page. For example, if my report is displaying items for the month of January, the macro will print the graphical month of December.
&ThisMonth
Generates a graphical representation of the current month, based on the date of the calendar records on the current report page. For example, if my report is displaying items for the month of January, the macro will print the graphical month of January.”
&NextMonth
Generates a graphical representation of the next month, based on the date of the calendar records on the current report page. For example, if my report is displaying items for the month of January, the macro will print the graphical month of “February.”
