Create dynamic conditions in JavaScript that you can configure as part of a report visualization's criteria instead of specified values.

To create a report using a dynamic conditional statement, you place a JavaScript URL in the conditional value statement of the filter. You can enter a JavaScript command directly into the field, but for a script longer than one statement, the script should be placed in its own record. You then call a function from that record in the value field of the report condition.

Add a dynamic JavaScript filter

Add a dynamic JavaScript statement for evaluation as part of a report visualization's filter criteria.

Before you begin

Role required: itil, report_user, report_group, report_global, report_admin, or admin. To create a meaningful report, you must have the right to access the data you want to report on.

About this task

JavaScript filters can be single-line statements, or longer scripts. For longer JavaScript statements, create a script include that returns the correct format and data type, conforms to the specific data that the report should filter for, and is client callable. For more information, see Script includes.

Procedure

  1. Navigate to All > Reports > View / Run.
  2. Open the report visualization that you want to add the dynamic filter to.
  3. Select the filter icon () to expand the condition builder.
  4. Construct your filter condition.
    These combinations of field types and operators allow you to specify a dynamic JavaScript statement.
    Note:
    • The "between" operator provides two fields that can support the same or different JavaScript URLs.
    • The "is" operator can return an array of data elements of the expected type. In this case the operator is treated as the "is one of" operator.
    Field type Allowed operators Expected return data type
    Sys ID (GUID) "is", "is not", "is one of", "starts with", "ends with", "contains", "does not contain", "between", "greater than or is", "less than or is". Textual representation of a complete or partial sys_id value.

    For the "is one of" operator, the expected return type would be either a comma-delimited list of sys_id values or an array containing each sys_id that should be included in the results.
    Free Text String "is", "is not", "is one of", "starts with", "ends with", "contains", "does not contain", "between", "greater than or is", "less than or is" One or more textual characters. For the "is one of" operator, the expected result would be either a comma-delimited list of string values or an array containing each of the values to include in the "is one of" search value field.
    Reference "starts with", "ends with", "contains", "does not contain" One or more textual characters that may represent some value or portion of a value found in this field in the table or data source.
    String (referencing another table) "contains", "starts with", "ends with", "does not contain" One or more textual characters that may represent some value or portion of a value found in this field in the table or data source.
    User Input "is", "is not" Textual characters that could represent the full value of some record for this field in the table or data source.
    Table Name "is", "is not", "is one of", "starts with", "ends with", "contains", "does not contain", "between", "greater than or is", "less than or is" Textual representation of a complete or partial Table Name in the system. For the "is one of" operator, the expected return type would be either a comma-delimited list of Table Name values or an array containing each Table Name that should be included in the results.
    Template Value "is", "is not" Textual characters that will fulfill the value as per a Template found on the instance.
    Domain ID "starts with", "ends with", "contains", "does not contain" One or more textual characters that may represent some value or portion of a value found in the domain field in the table or data source.
    User Roles "is", "is not" Textual representation of a user role string value.
    Domain Path "starts with", "ends with", "contains", "does not contain", "is", "is not", "is one of", "less than or is", "greater than or is", "between" One or more textual characters that may represent some value or portion of a value found in this field in the table or data source. For the "is one of" operator, either a comma-delimited list of textual values or an array object containing each value that should be included.
    Translated Text "is", "is not", "is one of", "starts with", "ends with", "contains", "does not contain", "between", "greater than or is", "less than or is" Textual value.

    For the "is one of" operator, the expected return type would be either a comma-delimited list of textual values or an array of textual values.
    Translated Field
    HTML "contains", "does not contain" Textual value which might correspond to data in the selected field in this report criteria.
    HTML Template
    Email Script "contains", "does not contain" Textual value representing a value that should (or should not) be in the Email Script field.
    Script (Plain) "contains", "does not contain" Textual value representing a value that should (or should not) be in the Script field.
    Script (server side)
    Script
    Short Table Name "is", "is not" Textual value (under 40 characters).

    For the "is one of" operator, the expected return type is either a comma-delimited list of textual values or an array containing each textual character that would represent a short table name.
    Field Name "is", "is not", "is one of", "starts with", "ends with", "contains", "does not contain", "between", "greater than or is", "less than or is" Textual representation of a complete or partial field name value.

    For the "is one of" operator, the expected return type would be either a comma-delimited list of field name values or an array containing each field name that should be included in the results.
  5. Choose a field type and operator and enter a JavaScript statement.
    • For a one-line JavaScript statement, use the format javascript:<JavaScript_Statement>;.
    • For a JavaScript statement that calls a script include, use the format javascript:new <Record_Name>().<Function_Name>(); in which Record_Name corresponds to the record name of the script include and Function_Name is the function in the script include that returns the value compared in the filter.
    Note: The Javascript URL can also include one or more parameters passed to the function which performs the calculation and returns a result. For example, a JavaScript function that passes two parameters to the script include record could be written as javascript:new TextJSFilter().getGroupIDs("Professional Services","Sales");.

What to do next

After you add the necessary JavaScript statements and conditions and configure the remainder of the report, test the report to ensure it returns and displays the expected results.