General display part settings are described elsewhere. The following settings apply to Display Part Parameters:

Auto Reload - Check to cause the parameter to trigger a reload (parameter submission) when changed. Checking this box is similar to selecting Auto-reload as the reload options setting for a form field.


Bind to List - The List or Data Link that provides the items for a list. Similar to the Bind to List setting for a form field.


Caption - The caption for the parameter. Similar to the caption for a form field
.
Columns - The number of columns consumed by a Memo, Multi-select or Single-select parameter.


Default - The default value for the parameter. Similar to the default value for a form field. The default value can be a literal constant, a Token, or it can be a link to a variable, the value of which is supplied at runtime. To specify a variable or Token, the first character of the default value must be an exclamation point ("!"). To default a date value to a relative date, refer to this application note.

Here are some examples:
Default Value	Result
Sally Williams	The literal value "Sally Williams" is the default at all times.
~PartNumber	The value of the PartNumber field in the display part's containing record, configuration record, or in a Display Part Parameter named "PartNumber".
!{My Name}	The name of the current CATSWeb user is inserted as the default. Similar text tokens may be used to define other variable/relative values, just as they may be used in Queries.
!{Employee Names}	The first name found in the internal "{Employee Names}" list is inserted as the default. Similar text tokens may be used to define other variable/relative values, just as they may be used in Queries.
![My Custom Data Link]	The first value found in the user-specified "[My Custom Data Link]" Data Link is inserted as the default.
!My Own List	The first value found in the user-specified "My Own List" List is inserted as the default.
!LP|EN	The name of the current user is inserted as the default. This example uses the CATSWeb internal code for the employee name field of the current session record. When the form definition is edited again, it will automatically be replaced by "!{My Name}", which is equivalent and easier to interpret for administrators. Direct entry of internal codes such as this should only be attempted by experienced administrators, or at the direction of AssurX.com technical support personnel.
Request Signatures	The Signature Request Field defaults to "Request Signatures" when a new record is created, instead of the usual default of "Signatures Not Requested".
Note that if the Type is a list, the default value will only appear if the value is also included in the list.

Description - This setting is used to specify the text that is displayed to users when they float their mouse over the end of the parameter's caption to display the Tool Tip Help. The size and visibility of the tool tip help region may be configured for individual Employees (or Personalities). Also used to specify the alternate text for buttons.


Fill Specification - A Fill Specification is required for Option Group parameters. The fill specification must be entered in AssurX coded format. For example, an Option Group fill specification that can be used for signature request fields is "li|Signatures Not Requested=0|Signatures Requested=1|Signatures Completed=2". For more information on FIll Specifications, see the documentation for CWEB_SUFFIX_FILLSPEC in the Modifying Field Properties section of Technical Note - Implementing Dynamic Forms. This document is distributed with CATSWeb API, and may also be requested from CATSWeb Technical Support.


Graphics File - This setting specifies the graphics file used for a button parameter. The graphics file is expected to be in the CATSWeb graphics subdirectory, or other subdirectory as may be specified in the Graphics Subdirectory setting of the current Interface Preference. If not specified, CATSWeb will choose a default graphics file. The following files are especially appliable for parameter buttons:
Reset.gif - A "Reset" button.
ResetSmall.gif - A smaller "Reset" button.
rarrow.gif - An iconic submit (Go) button.
submit.gif - A "Submit" button.
reload.gif - A "Reload" button.


Link Text - If a button is being represented as a link, this is the text that is used as the link.


Max Length - The maximum length of the parameter.


Order - The order of the parameter among other parameters on the display part. Specify the value of 0 (zero) to eliminate a parameter from the display part.


Rows - The number of rows consumed by a Memo, Multi-select or Single-select parameter.


Spacer Type - The type of spacer that is placed before or after the parameter and its caption
.
Spacers (before/after parameter) - The number of spacers of the specified type that are placed before or after the parameter and its caption.


Type - Choose the parameter type, then click the iconic reload button to allow the form to adjust as needed. The parameter type is similar to the field type for a form field. These types behave in ways that are specific to display part parameters:
Option Group - See Fill Specification for information on how to configure the options.
Password - A password field is like a Text Box, but the characters in the box are masked from view.
Reload/Submit Button - This button submits changes to display part parameters and causes the page to reload with the new parameters in place.
Reset Button - This button resets all display part parameters back to their initial values. When multiple display parts exist on the page (e.g. in a dashboard), the reset action takes place for all parameters, even if they were established in a different display part.


Width (chars) - The width of the parameter's data entry box, in characters.

Back to Top

Step 1 - Create a Data Display Part

From the Manage page, click Display Parts in the Form and Workflow Design section.

In the Add Subcomponent Type list, select Display Part - Data. Click Add.

Enter the following information in the Display Part - Data form:

Display Part Name - Enter any name (ex: "Parameterized Task List").

Title - Enter any title, such as "Tasks".

Data Source Type - Select the Action Filter option and click the iconic reload button.

Action Filter - Select "Standard Personal Tasks".

Query Parameter Replacements - Enter "UserAssigned=MyNewParameter".

Click Submit to create the Display Part.


Step 2 - Create a Display Part Parameter

Open the new Display Part in edit mode.
Click the Add Parameter link.
Enter the following information in the Add Display Part Parameter form:
Parameter Name - "MyNewParameter".
Caption - "Employee Names".
Type - Select "Multi-select List" and click the iconic reload button.
Bind to List - Select the "{Employee Names}" data link.
Order - Enter "100".
Rows - Enter "5".
Columns - Enter "40".
Click Submit.


Step 3 - Create a Parameter Submit Button

Click the Add Parameter link.
Enter the following information in the Add Display Part Parameter form:
Parameter Name - "MySubmitButton"
Type - Select "Reload/Submit Button" and click the iconic reload button.
Order - Enter "200".
Click Submit.


Step 4 - Use Display Part in any Dashboard
Add the new display part to any dashboard.
Open the Dashboard in view mode.
Select one or more names in the Employee Names list and click the iconic submit button. The filter results show the Action tasks assigned to the selected employees.

Add a text parameter named "MyDueDateFilter".
Change the Query Parameter Replacements setting for the display part to"UserAssigned=MyNewParameter||UserDueDate=MyDueDateFilter".

Back to Top