Portal Data List widget JSON parameters

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 4 minutes to read

    • JSON parameters define aspects of the Portal Data list widget on the portal page.

    Note:
    This information assumes that you’re familiar with the JSON code format.
    Table 1. JSON parameters
    Parameter Description
    categories Each category displays a set of records from the Customer Case View Case [sn_customerservice_case] table that meets the filter criteria.

    For each category, you can choose from pre_defined_filters and run_time_filters predefined filter tabs, set the columns for the list view, and determine the fields to be shown in the card view.
    ID A unique identifier that enables the categories condition script to determine whether to show or hide categories on the widget.
    category Name of the category that appears on the navigation pane.

    If a label isn’t entered, the category doesn't appear.
    table The table from which the records are shown on the widget when a category is selected.

    By default, this field is set to the Case [sn_customerservice_case] table.
    view The name of the view that defines the list of columns or fields to appear on the widget.

    For more information on these views, see Create and delete views.

    If no value is provided, all columns are shown.
    card_view_primary_column A field from the defined table to be displayed in the first column of a card. For example, you can show the case number in the first column.
    card_view_secondary_column A field from the defined table to be displayed in the second column of a card. For example, you can show short description of the case record.

    This parameter is optional.
    card_view_additional_columns":"column1|column2|column3|column4 Field pairs from the defined table to be displayed as additional columns of a card.

    You can add a maximum of four additional columns.

    This parameter is optional.
    filter":"active=true" Query to filter the records that display under the category.

    If no value is provided, all records are displayed.
    glyph":"glyph_name" The glyph to appear on the left of the category label in the navigation pane.
    The glyph name provided should be from the font-awesome library, which can be accessed at the following URL:
    https://fontawesome.com/versions/icons

    The currently supported version of the font-awesome library is v4.7. If you use a glyph name from a different version, the image will not appear correctly.

    Note:
    If both a glyph and an image are defined, the image is displayed.

    This parameter is optional.
    "image_name":"file_img" An image to appear on the left of the category.

    The image name should be selected from the Images [db_image] table.

    Note:
    If both a glyph and an image are defined, the image is displayed.

    This parameter is optional.
    target_page_id The portal page that displays the details of any record accessed in the widget.

    This parameter is optional.

    By default, this field is set to the Case (csm_ticket) page.
    sub_categories Display cases which are in New, Closed, Open, or Awaiting Info state in any selected category. These filters appear as tabs in the widget. Only Open and Closed case are included by default in the JSON code. You can change the names of these filters by changing the value of filter_name.

    This parameter is optional.
    run_time_filters Displays column and its fields from the defined table as runtime filters in a drop-down list. These runtime filters filter the case records displayed in the widget based on different fields from the defined table. For example, you can display Priority as a column and State, Contact, or Updated as fields. If the runtime filters values are not provided in the column and selection_type parameters, the filter icon will not appear for the category.

    This parameter is optional.
    column A field from the defined table to be displayed as a runtime filter in the widget. For example, you can choose to display case records according to their Priority, such as Critical, High, Moderate, or Low.
    selection_type Display the type of selection. The available options are:
    • Single select: Single selection for the filter column
    • Multi select: Multiple selection values for the filter columns
    values Defines the values from the defined table for the column parameter. The available values are:
    • Label: Name of a value
    • Value: Integer value of a field
    ranges Used to filter the records from the specified table using a query defined in label and query parameters. Ranges to define theFor example, you can display case records that have been updated in the last month, last 3 months, or last 6 months.
    The range configuration is:
    • Label: Name of the filter option
    • Query: Query that defines a set of values grouped under a label

    This parameter is optional.
    filter Used to apply filter on the data list.
    • Static: The value of the condition is provided in the query, for example, StateIN1.
    • Dynamic: The value of the condition is taken from the portal page URL by providing the URL keyword in curly braces, for example, product={sys_id}. The sys_id is taken from the URL and the replaced into the query.
    Note:
    If no keyword is found in the URL, the query becomes product=null.