Cy Think Survey

Programmer's Guide to Parameter Use

Once you have added a new CMS parameter to JshPARM.pm it will show up when you click the Parms button. This document gives the programmer some guidance on how to use a parameter once it has been defined.

There are six groups of parameters. The first five groups are intended to be manipulated by administrators and advanced users. These parameters are documented on the following pages:

Administrator's Guide to Debug Parameters

The general procedure to add a parameter is the same for all types of parameter. It does not matter to which of the groups the parameter may belong. Here is the procedure.

1. Decide on the parameter name. Follow the established naming convention. A parameter that controls whether a table is to shown to the user has the prefix "show_" followed by the table name. A parameter that controls whether a field is to shown to the user has the prefix "show_" followed by the table name followed by "_" followed by the field name.
2. Verify it is not being used by searching for it in JshPARM.pm.
3. Test the implementation and fix as needed.

This procedure is abbreviated and high level. It is documented to prompt the programmer as to the needed steps and is not intended to be a detailed step-by-step procedures.