Parameter values and input controls can be created with a dynamic or static list of values:
Note: The active controls cannot be associated to any parameters in the layout. This type of control can only be associated with an active report in the layout.
Note: TOC controls cannot be associated to any parameters in the layout. This type of control can only be associated with certain input controls in the layout. For more information, see Integrating a Report With a Table of Contents and On Demand Paging.
The Parameters tab enables you to create and modify parameter values, input controls, and customize parameter conditions. You may also bind parameters to controls and chain controls to one another. The Parameters tab consists of the following components:
Input control objects. You may select the input control object to view and edit the Properties and settings of the control.
Add new parameters. Right-click anywhere on the Parameters tab to add a new parameter.
Note: Manually adding a parameter creates an unbound parameter. For details about adding new parameters, see Adding a New Unbound Parameter.
Refresh unresolved parameters. All parameters on the parameters tab are parsed every two minutes to check if any are unresolved. If there are, their surrounding polygon is colored red. If you want to check for unresolved parameters on demand, right-click and select Refresh unresolved.
Binding controls and parameters. Input controls and parameters can be bound and unbound from the Parameters tab.
You may bind a parameter to an input control, or bind an input control to a parameter.
Chain one control to another. Chaining will populate controls based on the selected value from the prior control in the chain. You can chain static and dynamic controls, link or unlink parts of a chain, and create conditions on links in a chain. Chains are represented by lines connecting control objects on the Parameters tab. By clicking the arrow head in a link of a chain, the Properties and settings dialog box enables you to modify and set properties and conditions of the chain.
Note: Chaining is applicable only for controls, not parameters. For details about chaining, see Chaining Controls for Dependencies in HTML Composer.
How to: |
An unbound parameter is useful when passing a parameter value used on another page. You may also bind the new parameter to a control to create an incoming parameter, or bind a control to the parameter.
The following steps describe how to add a new parameter:
Enter the parameter value information. Options are Single select, Multiselect OR, and Multiselect AND.
Note: Single select is the default option when adding a new parameter.
If this field is left blank, it automatically applies the Alphanumeric format to the value field.
The Value, Display, and Selected columns appear.
Note: If opening HTML Composer with an existing page from a previous release and the tool cannot resolve the Value and Display fields, XML index values appear for the fields instead. If creating a new page that cannot resolve the Value and Display fields, you can manually type them in the Properties and Settings dialog box from the Parameters tab, or leave them blank. Unresolved Value and Display fields occur as a result of -INCLUDE, or amper variables, that may exist in an existing procedure.
Repeat these steps until the list contains all of the values you want to include.
Tip: You may also use the Undo and Redo buttons located on the Standard toolbar. Note that the undo/redo buttons treat the entire Properties and settings dialog as one action.
For details about creating an input controls, see Using Input Controls to Supply Parameter Values.
How to:
Reference: |
When creating a list of static values, you can select from the following options:
When the options are added to the Value list, the display text can be customized, but the value cannot be changed.
You may create an unbound static parameter, an incoming static parameter (a parameter that is bound to a control), or a control that is bound to a static parameter. For details, see How to Add a New Static Value.
The Properties and settings dialog box appears when creating or editing a static value on the Parameters tab.
The options available depend on the type of static value.
The following image is the Properties and settings dialog box that appears for an incoming static parameter (a parameter that is bound to a control), and an unbound control (a control that is not bound to a parameter).
The Properties and settings dialog box contains the following fields and options when Static is selected as the Data type.
Determines whether values are obtained from a static or dynamic list, an active report, or Table of Contents.
Static. Uses a static list of values you supply. A list of static values can also be created in Report Painter. For an example of importing static values that were created in Report Painter, see Adding Static Field Values From Report Painter.
Is a list of supplied values for a static list.
Value. The value to be passed to the selected parameter.
Display. The text that represents the value in the control the user views. Press the Ctrl + Shift keys to add a value to the Display field.
Selected. The value to act as the default value. If the control is multi-select, more than one value can be selected.
New. Creates a new value.
Delete. Deletes a supplied value from the list.
Move Up. Moves the selected value up in the list.
Move Down. Moves the selected value down in the list.
Select this option to send the display value, rather than the actual data, to the parameter. For more information, see How to Send the Display Value for Static and Dynamic Controls.
The Send display value option appears when creating an incoming static parameter (a parameter that is bound to a control), or an unbound control (a control that is not bound to a parameter). It is not available when creating an unbound static parameter.
Select this option to have a control populated with procedure names, so that when a value is selected, that procedure executes. The Value column is the procedure name itself and cannot be edited. The Display column is editable.
For more information on how to use the Values are procedures names option, see How to Use Procedure Names as Values.
The Properties and settings dialog box appears when creating or editing a static value on the Parameters tab.
The options available depend on the type of static value.
The following image is the Properties and settings dialog box that appears when adding a new unbound parameter.
The Properties and settings dialog box contains the following fields and options when adding an unbound parameter with Single select. Single select is the default option when adding a new parameter.
The default name assigned to the parameter. Optionally, you may enter a new name for the parameter.
The Format field defines the format of the parameter, such as A20, or D12.2.
This field is optional. If this field is left blank, it automatically applies the Alphanumeric format to the value field.
Enter the selected value to be assigned to the parameter.
The Properties and settings dialog box contains the following fields and options when adding an unbound parameter with Multiselect OR or Multiselect AND, as shown in the image below.
Is a list of supplied values for a static list.
Value. The value to be passed to the selected parameter.
Display. The text that represents the value in the control the user views. Press the Ctrl + Shift keys to add a value to the Display field.
Selected. The value to act as the default value. If the control is multi-select, more than one value can be selected.
New. Creates a new value.
Delete. Deletes a supplied value from the list.
Move Up. Moves the selected value up in the list.
Move Down. Moves the selected value down in the list.
The Properties and settings dialog box appears when selecting a bound parameter on the Parameters tab.
The Properties and settings dialog box for a parameter is read-only and displays the values for the bound control.
The following image is the Properties and settings dialog box that appears when selecting a bound static parameter.
The Properties and settings dialog box contains the following read-only values:
Shows the selected value for the static parameter data.
Shows the static parameter display value.
The steps below describe how to manually add a new static value.
You may create an unbound static parameter, an incoming static parameter (a parameter that is bound to a control), or a control that is bound to a static parameter.
The Properties and settings dialog box opens.
Single select is the default option when adding a new parameter.
If this field is left blank, it automatically applies the Alphanumeric format to the value field.
The Value, Display, and Selected columns appear.
Repeat these steps until the list contains all of the values you want to include.
An unbound static parameter is useful when passing a parameter value used on another page. You may also bind the new parameter to a control to create an incoming parameter, or bind a control to the parameter.
Binding a new parameter to a control creates an incoming parameter. An incoming parameter is a static parameter that is bound to a control. The parameter value will populate the control.
The Properties and settings dialog box appears for the control.
Close this dialog since you are populating the control with the parameter value, which has already been created in step 1.
The following image is an example of an incoming parameter. Notice the direction of the arrow.
Create a control with static values and bind the control to a parameter to populate the parameter with the control values.
The cursor changes into a crosshair.
The Properties and settings dialog box appears for the control.
Static is selected by default.
Repeat these steps until the list contains all of the values you want to include.
The image below is an example of a control that is bound to a parameter. Notice the direction of the arrow.
The options are Calendar, Check box, Drop down list, Hidden, List box, Radio button, Text Area, Text box, Single source Tree control, and Multi source Tree control.
Instead of adding new static values, you may also import static value parameters that you created from the Variable Editor. Parameter values can be data values to limit your data or field names to select the fields in your report. Both types of static lists can be created in Report Painter. This example details how to supply field values to a report through HTML Composer and Report Painter.
For the purposes of this example, use the CAR Master File (car.mas) that is supplied with Developer Studio.
The cursor changes into a crosshair.
The Open dialog box appears.
Report Painter opens.
The Variable Editor opens.
The fields are added to the Static Accept List.
The Variable Editor opens.
The fields are added to the Static Accept List.
The variables are added to the report.
Note: If the parameter is to be used as a By field in a report, it must be the single-select variable type.
You are returned to HTML Composer. Since you are adding a report with parameters, the New Parameters dialog box appears.
The report and associated parameters are added as static field values. You may rearrange or lengthen the controls in the layout.
Select the static field values (By field and the associated measures) and run the report.
The add ignore value option sends _FOC_NULL to the server at run time and is intended for use with complex applications. The add ignore value option is available for Multiselect OR and Multiselect AND static parameters.
A report with parameters requires that you to select values (at run time) in order to generate the output.
The parameters associated with each control can be controlled with the Parameters tab. The properties of a control can be controlled with the Properties tab.
The Properties and settings dialog box opens.
Note: Sending _FOC_NULL to a procedure will result in any clause of that procedure that uses that variable to be ignored.
The add everything value option uses JavaScript to send every value present in the parameter list to the server at run time. The add everything value option is available for Multiselect OR and Multiselect AND static parameters.
The add everything value option is not available for a Double List Control.
The Properties and settings dialog box opens.
This is the default option which populates the static list with field names predefined in the procedure. The use values from procedure option is available for Multiselect OR and Multiselect AND static parameters, and when adding static field values from Report Painter.
The Properties and settings dialog box opens.
The field names from the procedure appear in the Properties and settings dialog box.
This option enables you to use a local external file to provide values for the parameter. The import values from an external file option is available for Multiselect OR and Multiselect AND static parameters.
The Properties and settings dialog box opens.
The Open dialog box appears.
The external file can be a comma-delimited file with single values on each line, or two values per line.
For example, in the following text file, BOS is the data value and Boston is the display value.
The imported values are loaded into the Static values area of the Parameters tab.
If there is only one value on the line in the text file, the value will populate both the data value and the display values.
How to:
Reference: |
Dynamic values are available by default if a parameter used in the procedure is associated with the selected control. A dynamic list retrieves values from a specified data source when the request is run.
You may also create new dynamic parameters by adding a filter to a report or graph component in the layout. For details, see How to Create Dynamic Parameters by Adding a Filter.
The Properties and settings dialog box appears when creating or editing a dynamic parameter on the Parameters tab.
The following image is the Properties and settings dialog box with a Dynamic Data type.
The Properties and settings dialog box contains the following fields and options when Dynamic is selected as the Data type:
Determines whether values are obtained from a static or dynamic list, an active report, or TOC.
Dynamic uses a list of values retrieved from a selected data source when the request is executed. This is the default if you use an Accept clause in a Master File to create an amper variable parameter within a procedure. For more information, see How to Create a Dynamic Value.
Is the data source from which the values will be retrieved.
Is the existing procedure that will be called.
You may modify the external procedure directly from the Properties and settings dialog box on the Parameters tab. If you modify the request, you can save the external procedure and overwrite the original request.
Is the data source field from which the values will be retrieved.
Is the text that represents the parameter value in the control the user views.
There should be a relationship between the Value field and the Display field. The Display field is user-friendly text corresponding to the Value field.
Tip: You may manually edit the source code if you are familiar with WebFOCUS syntax. For example, you may right-click and choose Select a field from the data source to add to the request. Or right-click and choose to Use the default request.
The source code for an embedded procedure includes the line // TODO: Add your filters here to replace defaults, as a placeholder for you to enter filters, or WHERE clauses, for the request to resolve at run time. If entering filters, only dynamic filters can be specified.
The //TODO line must remain in the source code in order to resolve filters at run time. An example of this is when filters are based on chains that have conditions. If you want your own filters specified, then delete this line.
Tip: You may manually edit the source code if you are familiar with WebFOCUS syntax. For example, you may right-click and choose Select a field from the data source to add to the request. After editing the external procedure that is associated with a control, right-click and choose Reload external procedure to reload and display the new syntax in the Properties and settings dialog box. Or right-click and choose to Save external procedure. Saving the external procedure overwrites the original requests.
Adds the option to select ALL data source values to the control. Alternate text can be substituted for ALL using the text field to the right. For more information, see Parameter Value List Options.
Optimizes performance by populating a chain one control at a time, instead of all the controls when the page initially loads. Selecting the Add ‘No selection’ option enables you to populate controls when necessary.
When adding dynamic parameters to the HTML page, input controls retrieve data through procedures. Select this option to cache the run-time data for the selected input control. This setting is off by default.
This setting overrides the Default caching option from the HTML Page tab, which is located in the Developer Studio Options dialog box. For more information about the HTML Page tab, see HTML Page Tab.
Indicates that a specific number of field values will be retrieved from the data source. The specific number of fields is selected with the menu to the right.
Clicking Sort enables you to set the sort order for displaying values in dynamic list controls. This option is useful when you want to sort each control independently of the others.
By default, the request retrieves dynamic display values from the BY sort field in the request. The results display values based on the value field.
When Sort is enabled, you may sort the display value by the Value field or the Display field selected from the Properties and settings dialog box. The default is Value field.
When Sort is enabled, you may select the sort order as Ascending or Descending. The default sort order is Ascending.
Select this option to send the display value, rather than the actual data, to the parameter. For more information, see How to Send the Display Value for Static and Dynamic Controls.
Enter the value(s) to be selected as the default value whenever the procedure is run. For more information, see How to Use Selected Values as the Default Value.
When creating a dynamic list of values for a report, you may remove duplicate values from input controls. For more information, see How to Check for Duplicate Values.
The Properties and settings dialog box appears when selecting a bound parameter on the Parameters tab.
The Properties and settings dialog box for a parameter is read-only and displays the values for the bound control.
The following image is the Properties and settings dialog box that appears when selecting a bound dynamic parameter.
The Properties and settings dialog box contains the following read-only values:
Shows the selected Master File for the parameter data source.
Shows the value field for the dynamic parameter data.
Shows the dynamic parameter display field.
Shows OR or AND, if there is a Multiselect OR or Multiselect AND dynamic parameter.
Shows the selected value, if there is one assigned to the variable.
The steps below describe how to create a dynamic list of values.
You may need to create a dynamic control that is bound to a parameter. Creating a control with dynamic values and binding the control to a parameter will populate the parameter with the control values.
The dynamic value options appear.
The Get source file dialog box opens.
The Object Inspector opens with the field names from the selected Master File.
Tip: You may also use the Object Inspector icons to select a field and close the Object Inspector. The green icon is OK, the red icon is Cancel, double-clicking a value will select the value and close the dialog without using any button, and pressing the Esc key will cancel the dialog without using any button.
The selected field is automatically added to the Display field and the source code for the embedded procedure appears.
The //TODO line must remain in the source code in order to resolve filters at run time. One example of this is when filters are based on chains that have conditions. If you want your own filters specified, then delete this line.
The Get source file dialog box opens.
The parameter names from the procedure are automatically added to the Value field and Display field, and the source code for the external procedure appears. For details, see Automatically Populating Fields With Dynamic Values.
Tip: You may also use the Object Inspector icons to select a field and close the Object Inspector. The green icon is OK, the red icon is Cancel, double-clicking a value will select the value and close the dialog without using any button, and pressing the Esc key will cancel the dialog without using any button.
Only the parameter names from the external procedure will be available for selection.
Note: For more information about how a procedure can be used to populate a dynamic list of values, see Using Custom Procedures to Retrieve Dynamic Values.
The following image is an example of a control that is bound to a parameter. Notice the direction of the arrow.
The options are Calendar, Check box, Drop down list, Hidden, List box, Radio button, Text Area, Text box, Single source Tree control, and Multi source Tree control.
You may create new dynamic parameters by adding a filter to a report or graph component in the layout.
The Filter options dialog box opens.
The New Parameters dialog box appears.
You may select a control type for the parameter from this dialog box, or adjust them later using the Properties and settings dialog box on the Parameters tab.
If the New Parameters dialog box does not appear, ensure that Show New Parameters dialog is selected from the HTML Page tab. To access the HTML Page tab, select Options from the Window menu to open the Developer Studio Options dialog box. From the Developer Studio Options dialog box, select the HTML Page tab.
Repeat this procedure for each additional parameter for the report or graph.
This option is useful when you want to sort each control independently of the others.
Note: If sort options are not selected, the request retrieves dynamic display values from the BY sort field in the request, and the results display values based on the value field. Sort options are not selected by default.
The Properties and settings dialog box opens.
You may select the Sort by and Sort order options for the control.
The following image are the sort options that appear on the Properties and settings dialog box of the Parameters tab, when a dynamic control is selected.
Tip: You may repeat these steps and select sort options for each dynamic control on the HTML page.
When creating a dynamic list of values for a report, you may remove duplicate values from input controls. This is useful if you are using your own procedure that does not use a structured data source.
The Check for duplicate values option is turned off by default.
The Properties and settings dialog box opens for the input control.
The Check for duplicate values option is only available when creating a dynamic list of values for an input control.
The input control removes duplicate value entries.
The following example shows a list box with a list of city values. The first list box shows the list of values with duplicate entries. The second list box shows the list with duplicate values removed.
You have the option to allow customized retrieval of dynamic parameter values. By using a custom procedure, you can use the FOCUS language to utilize temporary HOLD files, filtering, and so on. This allows HTML Composer to better integrate with a multitude of large and/or proprietary data sources that may require unique retrieval methods. The procedure must meet the following criteria:
Note: Different parameters in the same procedure can use both this option and the data source method.
For chained controls, there are two options based on whether caching is enabled:
For details about enabling caching options for chained controls, see How to Enable Cache Processing for Chained Values.
The following example shows the same value being used for the submission value and display value.
TABLE FILE GGSALES PRINT DST.PRODUCT BY PRODUCT ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
The XML output is:
<?xml version="1.0" encoding="ISO-8859-1" ?> - <fxf version="1.0" data="hold"> - <report records="4317" lines="10" columns="2" rows="10"> <target format="" version="" type="" destination="HOLD" /> - <column_desc> <col colnum="c0" fieldname="PRODUCT" alias="E01" datatype="char" width="16" focus_format="A16" description="Product name" accept="" help_message="" title="Product" within="" property="" reference="" valign="left" /> <col colnum="c1" fieldname="PRODUCT" alias="E02" datatype="char" width="16" focus_format="A16" description="Product name" accept="" help_message="" title="Product" within="" property="" reference="" valign="left" /> </column_desc> - <table> - <tr linetype="data" linenum="1"> <td colnum="c0">Biscotti</td> <td colnum="c1">Biscotti</td> </tr> - <tr linetype="data" linenum="2"> <td colnum="c0">Capuccino</td> <td colnum="c1">Capuccino</td> </tr> - <tr linetype="data" linenum="3"> <td colnum="c0">Coffee Grinder</td> <td colnum="c1">Coffee Grinder</td> </tr> - <tr linetype="data" linenum="4"> <td colnum="c0">Coffee Pot</td> <td colnum="c1">Coffee Pot</td> </tr>
The following example shows two different field values being used for the submission value and display value. In this case, PRODUCT (Product Description) is used for the display value and PCD (Product Code) is used as the submission value.
TABLE FILE GGSALES PRINT DST.PRODUCT BY PCD ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
The XML output is:
<?xml version="1.0" encoding="ISO-8859-1" ?> - <fxf version="1.0" data="hold"> - <report records="4317" lines="10" columns="2" rows="10"> <target format="" version="" type="" destination="HOLD" /> - <column_desc> <col colnum="c0" fieldname="PCD" alias="E01" datatype="char" width="4" focus_format="A04" description="Product Identification code (for sale)" accept="" help_message="" title="Product ID" within="" property="" reference="" valign="left" /> <col colnum="c1" fieldname="PRODUCT" alias="E02" datatype="char" width="16" focus_format="A16" description="Product name" accept="" help_message="" title="Product" within="" property="" reference="" valign="left" /> </column_desc> - <table> - <tr linetype="data" linenum="1"> <td colnum="c0">C141</td> <td colnum="c1">Espresso</td> </tr> - <tr linetype="data" linenum="2"> <td colnum="c0">C142</td> <td colnum="c1">Latte</td> </tr> - <tr linetype="data" linenum="3"> <td colnum="c0">C144</td> <td colnum="c1">Capuccino</td> </tr>
Note: The procedure does not have to follow this FOCUS syntax exactly, but the end result must be two values per data line in XML format.
In the following procedures, there are three parameters (REGION, ST, CITY). Caching is disabled, so each parameter control must be mapped to its own procedures.
Procedure 1 (REGION)
TABLE FILE GGSALES PRINT DST.REGION BY REGION ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
Procedure 2 (ST)
TABLE FILE GGSALES PRINT DST.ST BY ST WHERE REGION EQ '®ION'; ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
Procedure 3 (CITY)
TABLE FILE GGSALES PRINT DST.CITY BY CITY WHERE REGION EQ '®ION'; WHERE ST EQ '&ST'; ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
In the following example, caching is enabled, so a single procedure is used to populate the controls. For details about caching options, see How to Enable Cache Processing for Chained Values.
TABLE FILE GGSALES PRINT DST.REGION DST.ST DST.CITY BY REGION BY ST BY CITY ON TABLE SET HOLDLIST PRINTONLY ON TABLE PCHOLD FORMAT XML END
The XML output is:
- <table> - <tr linetype="data" linenum="1"> <td colnum="c0">Midwest</td> <td colnum="c1">IL</td> <td colnum="c2">Chicago</td> <td colnum="c3">Midwest</td> <td colnum="c4">IL</td> <td colnum="c5">Chicago</td> </tr>
When the name of a dynamic parameter matches a corresponding field name in a data source, HTML Composer automatically populates the field name values for the parameter.
The data source is populated by a default based on the first data source specified by a TABLE FILE or GRAPH FILE command. The data source field is populated for the Value and Display fields in the Properties and settings dialog box of the Parameters tab (when Dynamic is selected as the Data type). This generates a layout report that is ready to run as long as the parameter names match the field names.
When the following report request is called from HTML Composer with a push button control, the Properties and settings dialog box for the PRODUCT parameter on the Parameters tab is automatically populated to dynamically retrieve the values of the PRODUCT field.
TABLE FILE GGSALES SUM UNITS BY PRODUCT WHERE ( PRODUCT EQ '&PRODUCT.Product:.' ); END
How to: |
When creating a static or dynamic list of values, you may add an ALL value to the list of values and/or send the display value in a parameter.
The ALL feature allows developers to automatically add an ALL value to a list of values. An ALL value does the following:
When using a Dynamic or active report Data type, you may enter the value(s) to be selected as the default value whenever the procedure is run. For more information, see How to Use Selected Values as the Default Value.
Note: You may also enter the selected value when adding a new unbound parameter on the Parameters tab. For more information, see Adding a New Unbound Parameter.
From HTML Composer, you may send the display value, rather than the actual data, to the parameter. The display value can also be used for headings and footings in the report output.
The Send display value option appears when creating an incoming static parameter (a parameter that is bound to a control), or an unbound control (a control that is not bound to a parameter). It is not available when creating an unbound static parameter.
When importing a report with parameters, the New Parameters dialog box appears prompting you to create the control type.
The report and control type is added to HTML Composer.
The Properties and settings dialog box opens.
Note: The options available in the Properties and settings dialog box vary, depending on the type of values (static or dynamic) you are creating.
Repeat this step until the list contains all of the values you want to include.
Tip: You may also update the display values from the Variable Editor in Report Painter.
For more information about static values, see Creating a Static List of Values.
Sending the display value for Dynamic values is only applicable if you are using a Data source that contains both an internal data value and a field that the internal data value maps to for display purposes.
The Get source file dialog box opens.
The Object Inspector opens with the field names from the selected Master File.
The selected field is automatically added to the Display field and the source code for the embedded procedure appears.
Send display value is selected by default.
The Get source file dialog box opens.
The parameter names from the procedure are automatically added to the Value and Display field, and the source code for the external procedure appears.
Note: Only the parameter names from the external procedure will be available for selection.
Send display value is selected by default.
The following image is an example of the Properties and settings dialog box with Send display value selected for a dynamic value.
Tip: For details about the //TODO line in the source code, see Creating a Dynamic List of Values.
For more information about dynamic values, see Creating a Dynamic List of Values.
The report opens in Report Painter.
Note: If the report procedure uses it, &Variable_TEXT will always be passed, regardless of if Send display value is selected.
For example, the image below shows the heading as Display Value: &STCD_TEXT, where Store Code (STCD) is the variable name.
Tip: This is different from adding the actual value from the data source, where clicking the variable name would add <STCD to the report heading.
When you create the Text variable (&Variable_TEXT), you are not prompted to set a control type for this variable when returning to HTML Composer, as no control type is needed.
The display value is shown in the report heading.
For example, in the image below, Gotham 40 is selected as the Store Code and shows the display value in the report heading. The actual value, R1040, is shown in the Store ID column.
Note: HTML Composer passes &var_TEXT if the report procedure uses it, regardless of whether the send display value check box is checked or unchecked.
The Values are procedures names option lets you populate a control with procedure names. When that procedure name is clicked, the procedure executes.
Note: In this procedure a list box is used. However, the following controls are also able to use the Values as procedures names option: double list, drop-down, radio button, and check box.
Note: If the Properties and settings dialog box does not open, select View and click Properties and settings.
Note: You can add multiple procedure names to the Properties and settings dialog box by multiselecting procedures while in the Get source file dialog box.
The following image shows the procedure values with new display names.
The source can be different if you use a different control. For example, combobox1, customselect1, radio1, or checkbox1.
You could also select New Window as the target if you wanted the procedure to open in a new window.
The created hyperlink is shown in the following image.
The report is run, as shown in the following image.
When using a Dynamic or active report Data type, you may enter the value(s) to be selected as the default value whenever the procedure is run.
If you import a procedure (.fex) that has a dynamic prompt value, then the input box is populated with values retrieved from the data source. If the selected value is available in the data source, the value(s) are selected by default. If the selected value is not available in the data source, then the value(s) that you entered are ignored and the first value retrieved from the data source is selected.
When importing a report with parameters, the New Parameters dialog box appears prompting you to create the control type.
The report and control type is added to HTML Composer.
The Properties and settings dialog box opens.
Note: The options available in the Properties and settings dialog box vary, depending on the type of values (static or dynamic) you are creating.
The Get source file dialog box opens.
The Object Inspector opens with the field names from the selected Master File.
The selected field is automatically added to the Display field and the source code for the embedded procedure appears.
Parameter values are case-sensitive.
You may enter selected values with a semicolon (;) or a comma (,). Additionally, you may also have embedded commas or semicolons in the data values. If you have these embedded characters, you must enclose all of the values in the input area in double quotation marks (" "). For example:
ENGLAND;ITALY
ENGLAND,ITALY
"ENGLAND","IT,ALY"
Note that even though one value in the last set has the embedded comma, both values need to be enclosed in double quotation marks.
The Get source file dialog box opens.
The parameter names from the procedure are automatically added to the Value field and Display field, and the source code for the external procedure appears.
Note: Only the parameter names from the external procedure will be available for selection.
Parameter values are case-sensitive.
You may enter selected values with a semicolon (;) or a comma (,). Additionally, you may also have embedded commas or semicolons in the data values. If you have these embedded characters, you must enclose all of the values in the input area in double quotation marks (" "). For example:
ENGLAND;ITALY
ENGLAND,ITALY
"ENGLAND","IT,ALY"
Note that even though one value in the last set has the embedded comma, both values need to be enclosed in double quotation marks.
For more information about dynamic values, see Creating a Dynamic List of Values.
The following image is an example of the Dynamic Data type Properties and settings dialog box, with parameter values in the Selected Value field.
When an active report is selected, Refresh for active reports is enabled by default.
Parameter values are case-sensitive.
You may enter selected values with a semicolon (;) or a comma (,). Additionally, you may also have embedded commas or semicolons in the data values. If you have these embedded characters, you must enclose all of the values in the input area in double quotation marks. For example:
ENGLAND;ITALY
ENGLAND,ITALY
"ENGLAND","IT,ALY"
Note that even though one value in the last set has the embedded comma, both values need to be enclosed in double quotation marks (" ").
For more information about active report values, see Creating Active Technologies Dashboards With HTML Composer.
The following image is an example of the active report Data type Properties and settings dialog box, with parameter values in the Selected Value field.
Parameter values are case-sensitive.
You may enter selected values with a semicolon (;) or a comma (,). Additionally, you may also have embedded commas or semicolons in the data values. If you have these embedded characters, you must enclose all of the values in the input area in double quotation marks (" "). For example:
ENGLAND;ITALY
ENGLAND,ITALY
"ENGLAND","IT,ALY"
Note that even though one value in the last set has the embedded comma, both values need to be enclosed in double quotation marks.
For more information about single-select parameters, see Adding a New Unbound Parameter.
The following image is an example of the Single select parameter Properties and settings dialog box, with parameter values in the Selected Value field.
Even though it is a Single select parameter, multiple values are specified and selected.
The selected value, if available from the data source, is automatically selected (highlighted) in the parameter list.
The example below shows CT, GA as the selected values in the State parameter list in the report output.
The report output appears.
If the selected value is not available in the report results, then the value that you entered is ignored and the first value retrieved from the data source is shown.
When using HTML Composer, if changes are made to parameter values in Report Painter, you may want to update the values in HTML Composer with those entered in Report Painter.
WebFOCUS |