©1998 by James Carr
What are Macros?
A macro is a special word that will be converted into a value when the form is processed by E-Forms EZ. Macros can be used in the Response Page, Message Text, Error Page, Results File Template and Receipt Text files. A macro represents a field name on your Feedback Form. It is denoted using the field name surrounded by symbols (%mail_to% for example). When the program is run, the macro is replaced by the value of the corresponding field on your form. If no value is defined for a field, "**" will be used. Any field on your form whether it is a E-Forms EZ required field or a field you create yourself such as home_phone can be used as a macro.
Remember, the field name on your Feedback Form cannot contain the % symbol. This symbol is only used for macros that represent your fields. For example, you might make a field called home_phone on your Feedback Form. If you want to use that value in your Message Text file, simply use %home_phone%. When E-Forms EZ processes the form, that text will be replaced with the value the user entered for the home_phone field. Here is an example from a Message Text file.
Please call me at %home_phone% at your earliest
When the message is sent it might read
Please call me at 867-5309 at your earliest convenience.
The following macros are built in to E-Forms EZ. Do not create fields on your Feedback Form using the same names as these special macros. However, you can use them just like any of the other macros.
|%ucgi_date%||Date according to the web server's clock. The format of this field is set by the date_format field.|
|%ucgi_time%||Time according to the web server's clock. The format of this field is set by the time_format field.|
|%ucgi_referer%||URL of HTML page which called e-forms.exe.|
|%ucgi_error_desc%||Description of the error that prevented the message from being sent|
|%refnum_(suffix)%||refnum_ is a special prefix to generate a reference number. A reference number is an automatically incremented number based on the name given after the refnum_ prefix. For example, you could add a macro called %refnum_UserID%. For each form submission this macro will return a unique number that is automatically incremented by one. You can have as many unique reference numbers as you want.|
|server variables||There are a number of pieces of information supplied by the web server itself. See the Server Variables page for a listing of common server variables.|