Configuring the flashboard display using flashboard parameters


Apply the following rules when you enter flashboard parameters or values into workflow or the Custom Properties value for a Data Visualization field:

  • Type key names without regard to case sensitivity.
  • Enter dates in seconds since January 1, 1970 00:00:00 GMT for date/time related properties. You cannot use values from date/time fields.
  • Enter the parameters and values without using spaces, and use commas to separate the parameter=value pairs in the field values, for example:
    chartType=0,chartTitle=TestFB
  • Use the following escape characters:

    Active link value

    Escape character for value

    Example

    comma (, )

    comma

    chartTitle=FB,,Test,chartType=0

    double quote (" )

    double quote (" )

    chartTitle=FB""Mine"",chartType=0

    keyword

    backslash

    customqual='Submitter'=$\USER$

Configuring flashboard parameters

Field parameters are the property of Data Visualization (DVF) field that you use to modify the flashboard display.

You can change field parameters in the Data Visualization field that holds the flashboard. You can also use Set Field actions to modify flashboard fields at run time. Active links affect only the properties you modify, and the modifications you make apply only until you close the form.

For example, you might want to change the flashboard data display from a bar chart to a pie chart, or attach a different flashboard to the field. 

Warning

If the server does not support the modifications you make, you might get unexpected results if you override the existing parameter values. Test your modifications before you apply them.

To enter parameters in a Data Visualization field

  1. Create a Data Visualization field on a form.
  2. Select the field.
  3. In the Properties tab, click Custom Properties, and enter a parameter and value using the following format:
    parameter=value
  4. Save the form.

Example of entering parameters in a Data Visualization field

If you want to display the Chart1 flashboard in the Field1 Data Visualization field as a pie chart:

  1. Enter Field1 in the Field column. 
  2. Enter "flashboard=Chart1,chartType=5" in the value field OR Use the following field reference to dynamically select the flashboard name from the FlashboardName character field and chart type from the ChartType integer field:
    "flashboard="$FlashboardName$",chartType="+$ChartType$
  1. Create an active link.
  2. Add a Set Fields If action.
  3. From the Data Source list, select the location of the Data Visualization field that references the flashboard.
    If you enter an option other than Current Screen, complete the other fields above the Field/Value table as needed.
  4. In the Field column, enter the name of the Data Visualization field that references the flashboard.
    Hint: Click the ellipsis (...) button to select from the available fields.
  5. In the Value column, enter comma separated parameters and values to apply to the field in the following format:
    parameter=value.
    For example, "flashboard=Chart1,chartType=5"
  6. Save the active link.
    The active link uses aliases for selection fields, such as radio buttons and menus, rather than the enumerated values of the selection fields.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*