Parameter Forms

Parameter forms are html screens that allow the user to set parameters to restrict the output of entity that is being run and are used in conjunction will all entities except screens and converters.  Parameter forms are optional, and can be set up at the template level if a standard parameter form is desired.

Fields on parameter forms have many of the same options and properties as the fields set up for screens in that they can be set up as buttons, checkboxes, images, etc.

Entity output is restricted in two ways.  

The Target Column property for the field can be set to a specific column for a database block on the entity.  When the report is run, if a value was entered in the field, that block will be restricted by the value entered.

Fields without target columns can be defined to set global values by which the entity will be restricted.  These global values are set when the report is run from either a link or button on the parameter form.  In order for the entity to be restricted by the values, the where clause of the database block on the report must be set up to restrict the data by the global values.

Parameter forms should also always have one link or button on the block that will run the entity.  This button should be set up with the Type of Text, and in the On Mouse Click property, ExecuteReport(); should be entered.  When this button is pressed, the restrictions for the fields on the parameter form are set, and the entity is generated.

Information about fields on parameter forms can be viewed here as they are the same as screen fields.

Adding Parameter Forms to Data Exchanges, Reports, Spreadsheets, and XML Documents

1. Parameter forms are used to define the columns by which the entity will be restricted each time the entity is run.  For instance, if you were creating a report for sales analysis, you might wish to restrict it by customer and period.  The parameter form allows you to do this.

2. Set the Create Heading flag to determine if a heading will be created for this block.  Set this flag to on to create a heading.  Set this flag to off if no heading should be created.

3. In the Body Style pop-list, select the body style to be applied to the parameter form.  You must select a Body Style.

4. In the Editable Field Style pop-list, select the style to be applied to the editable fields on this parameter form.  You must select an Editable Field Style.

5. In the Non-Editable Field Style pop-list, select the style to be applied to the labels and display only fields on this parameter form.  You must select a Non-Editable Field Style.

6. In the Link Style pop-list, select the link style that defines the styles that will be used for the hyperlinks on this parameter form.  You must select a Link Style.

7. Click on the Next button to continue.

8. If a database block already exists for this entity, a list of block.field references will be displayed, referencing the columns in the database block.  This allows you to select the fields by which the entity will be restricted by the parameter form.  
   
   If no database block exists, this screen will be blank.
   
   For each block.field reference, if you click on the name, the Field flag and the Label Flag will be set to on automatically.

9. Set the Field flag to on for each field that you wish to include on the parameter form.
   
   To set the Field flag for all fields, left click once on the gray Field column header.

10. Set the Label flag to on for each field for which you wish a label to be created.  
    
    To set the Label flag for all displayed fields, left click once on the gray Label column header.

11. Click on the Next button in the bottom right of the screen to continue.

12. The next step is to set up the order of the fields for the block. Using the Move Up and Move Down buttons, arrange the fields to be in the order that you wish them to be displayed on the block.

13. At this point a new screen is displayed.  If you wish to add another block, set the Add Block or Labels flag to on and press the Next button.  

• A new screen will be displayed to allow you to select whether you want to add another block to an existing block or the entity.  Click on the desired object and press the Add Block button to continue to add blocks as described above.

• The screen also allows you to add labels to a block.  Click on the desired block and press the Add Labels button to add labels to the block as described for the Not From Query query type.

14. Otherwise, press the Finish button in the bottom right of the screen.

Xephr is a registered trademark of NDS Systems, LC.

Copyright © 2007 NDS Systems LC.