Configure BI Publisher Report with User Input Parameters as External URL Task

You can configure an external URL task to enable users to supply input parameters when accessing a BI publisher report. This allows the report to dynamically retrieve and display data based on values entered by the user at run time.

For example, consider a HR specialist who needs to review document records for employees in the organization. By configuring the report with user input parameters, such as person number, the HR specialist can enter the relevant data when opening the report. The application then filters and fetches only the corresponding document records, ensuring that the output is both targeted and relevant.

Create Data Model

  1. Go to Tools > Reports and Analytics.
  2. Click Browse Catalog.
  3. Click New > Data Model.
  4. Click New Data Set > SQL Query.
  5. Enter the name, select data source as ApplicationDB_HCM and type of SQL as Standard SQL.
  6. Enter this SQL query and click OK.
    select dor.document_number, dor.document_code, dor.document_name
    from hr_documents_of_record dor, per_all_people_f per
    where dor.person_id = per.person_id
    and per.person_number=:P_PERSON_NUMBER
    and trunc(sysdate) between per.effective_start_date and per.effective_end_date
  7. In the Add Parameter – ID SQL Query dialog box, select the P_PERSON_NUMBER checkbox and click OK.
  8. Click View Data.
  9. Enter the person number and click View.
  10. Click Save as Sample Data and click OK.
  11. Save the data model.
  12. Click Create Report and follow the steps to create the custom report based on your requirements.
  13. Save the report and make a note of the report name.

Enable Users to Access Report

Ensure that the report is enabled for the necessary roles.

  1. Go to the saved report.
  2. Click More > Permissions.
  3. Click the + icon to add users or roles.
  4. Select All in the List field.
  5. Search for the required roles to be given access.
  6. From the search results, select the role name and click the > icon to move the role under Selected Members.
  7. Click OK two times.

Create Task of Type External URL

  1. Go to My Client Groups > Journeys Setup > Journey Templates.
  2. Click Create and select the creation method.
  3. Enter the details for the journey template and click Create Draft.
  4. In the Tasks section, click Add > New Task and enter details for the task as shown in this table. For other fields, use the default values.
    Field Value
    Task Name Review document records
    Task Description Optional
    Status Active
    Sequence Retain default value
    Make this task mandatory Yes
    Performer Area of Responsibility
    Performer Responsibility Type Human resources representative
    Owner Area of Responsibility
    Owner Responsibility Type Human resources representative
    Task Type External URL
    Task URL {environment}/xmlpserver/{Report Path}/{Report_Name}?_xmode=2

    Example value: https://<server_host>/xmlpserver/Custom/Human Capital Management/Onboarding/DocRecordsReport.xdo?_xmode=2

    Note that the external URL needs to be suffixed with _xmode=2 for only the report to open, and not the entire BIP dashboard.

    Open URL on same page Unchecked
    When does the task expire? After assigned date
    After how many days? 7
  5. Click Save.

When users click the URL, the report opens in a new browser tab. They are prompted to enter the required parameter values, after which the report retrieves and displays data based on the inputs provided.