Skip to main content

Parameter Definition Section

  1. Last updated
  2. Save as PDF

Define report parameters.

Prerequisites:

Report Definition

  1. In the Report Parameters table, click Add New Item.

  2. The Parameter Order field displays the report parameter order.

  3. In the Parameter Label field, enter the label description exactly as it appears in your Crystal Report.
    A best practice is to make your Crystal parameters easily understandable to the end-users.

  4. In the Parameter Type field, select the type.
    Depending on the parameter selected, certain fields will be enabled.

  5. In the Required for Report Processing field, select Yes to make the data element required.
    If No is selected, and no value is entered in the data element, a 'null' is generated for the data element. If a parameter is conditional, make sure to add it as initially not required.
    Columns for dollar, integer, and decimal cannot be null values. A specific value will need to be set for processing. 

  6. The Send to Report Order field displays the parameter display order.
    Changing the display order number moves the parameter to a different position in the report.
    It is imperative that the order in which the parameters are sent to the report match the order processed within Crystal Reports. To double-check the order within Crystal Reports, right-click Parameter Fields and select Set Parameter Order.

  7. In the Object Width field, select Half Page to display two columns in the report form.
    Choose Full Page to display one column.

  8. In the Send Parameter To Report field, select Yes to display the parameter in the report.
    The following section describes functionality that applies to the parameter selected in the Parameter Type field.

Dictionary parameters

  1. In the Dictionary Entity Database field, select the entity.

  2. In the Dictionary field, enter the dictionary, click Enter.

  3. In the Send Dictionary Parameter as Code or Value field:

  • Select Code to display the dictionary code in the report.
  • Select Value to display the dictionary value.

  1. In the Expand Combo/List Box to Full Object Width field:

  • Select Yes to expand dictionary data elements to their full width on the report.
  • Select No to display part of the dictionary data element.

Single response dictionaries

  • If appropriate, in the Default Value (Dictionary — Single Response) field, select a value to populate the field.

Multiple response dictionaries

  • In the Number of Multiple Response List Box Rows field, type the number of list box rows to display in the report (3 to 15 rows).

  • If appropriate, in the Default Value (Dictionary — Multiple Response) field, select values to populate the field.

Label parameters

  1. In the Is the Label Associated with a Hypertext Link field, select Yes to associate the label with a hypertext link.

  2. In the Hypertext Link field, enter the link address.

  3. Click Test Hypertext Link to test the link.

  4. In the Label Appearance field, select the link display format.

Other Entity Lookup parameters

  1. In the Entity field, select the entity.

  2. In the 'Other Entity Lookup' Parameter Format field, select the parameter format.

  3. In the Specify specific alternate lookups for 'Other Entity Lookup' field, select Yes to include alternate lookups (Alternate Lookups field) in an Other Entity Lookup field.
    Select No to use the default selection.

  4. In the Alternate Lookups field, select the lookups.

Episode parameters

  1. In the Entity field, select the entity.

  2. In the Expand Combo/List Box to Full Object Width field:

  • Select Yes to expand dictionary data elements to their full width on the report.
  • Select No to display part of the dictionary data element.

  1. In the Active or Inactive Episodes field:

  • Select Active to allow active client episodes in the report.
    An episode with a discharge date equal to the report date is considered active.

  • Select Inactive to allow client episodes with discharge dates before the report date.

  • Select Active/Inactive to allow active and inactive client episodes.

  1. In the Type of Episode field, select the episode treatment program type that the report can be generated.
    Selecting a program restricts the report output to that program type.

​Date, and Date without future date warning parameters

  • In the Default Value (Date and Date without future warning) field, select the default value:

Non Scrolling Free Text parameters

  1. In the Non Scrolling Text Width field, enter the maximum number of characters allowed.

  2. In the Default Value (Non Scrolling Free Text) field, enter text that will populate the text field.

SQL Query parameters

  1. In the Parameter SQL Query Reference field:
    Enter a reference to another SQL query (use uppercase).
    Enter ':' followed by the SQL query reference.

  2. In the SQL Query field, enter the SQL query.

  1. Click Validate SQL Query to run a validation check on the SQL query.
    All SQL Query parameters must be validated for the report to work.
    See How to Create SQL Queries for more information.

Facilities with CDR enabled

Child applications only

  • In the Database to Process Query Against field:
    Select Yes to process the query against the parent CDR database.
    Select No to process the query against the child CDR database.

Page Breaks and Defaults

  1. Force New Page — Choose Yes to create a new sub-section for the parameter. Choose No to create new pages in the report form as data elements are added.

  2. In the Generate Subsection for New Page field, select Yes to create a bookmark for forced new sub-section. Bookmarks displays on each report sub-section.

  3. In the Include Page Number Within Subsection field, select Yes to include a page number in the subsection.

  4. In the Subsection field, enter subsection description.

  5. Click Submit.