Link Search Menu Expand Document

Visualize Components

Modern components for your embedded reporting workflows.

Configuration

Name Type Default Description Required
server string URI of server where JasperReports Server is hosted. (For example, http://localhost:8080/jasperserver-pro) Yes
contextPath string Context path of JasperReports Server where it is host e.g. /jasperserver-pro Yes
resourceURI string URI of JasperReports Server resource that will be scheduled Yes
stepper object

Properties for the stepper.

For more details, see Stepper configuration section below.

 No
tabs object

Properties for tabs.

For more details, see Tabs configuration section below.

 No
events object {}

Callback function that is called when certain events occur.

For more details, see the Events page.

 No

Stepper configuration

Default 

stepper: {
    show: true
  }

Properties

Name Type Default Description Required Supported values
show boolean true If true, the stepper will be shown Yes

true

false

Tabs configuration

Default 

{
    "tabsOrder": ["schedule", "parameters", "notifications", "output"],
    "tabsData": {
      "schedule": {
          "label": { "show": true, "value": "" },
          "description": {
            "value": "",
            "show": true
          },
          "recurrenceInterval": { "show": true, "value": 1 },
          "recurrenceIntervalUnit": {
            "show": true,
            "value": "DAY"
          },
          "startTime": {
            "show": true,
            "value": "now"
          }
      },
      "output": {
          "baseOutputFilename": {
            "show": true,
            "value": ""
          },
          "outputDescription": {
            "show": true,
            "value": ""
          },
          "outputFormat": { "show": true, "value": ["pdf"] },
          "outputTimeZone": {
            "show": true,
            "value": ""
          }
      },
      "parameters": {
      },
      "notifications": {
          "address": { "show": true, "value": [] },
          "subject": { "show": true, "value": "" },
          "messageText": {
            "value": ""
          },
          "reportAccessType": {
            "show": true,
            "value": "SEND_ATTACHMENT"
          }
      }
    }
  }

Properties

Name Type Default Description Required Supported values
tabsOrder Array ["schedule", "parameters", "notifications", "output"] Order of appearance for the tabs. To hide a tab, leave it out of the array. No

'schedule'

'parameters'

'notifications'

'output'
schedule object

Properties for the schedule tab.

For more information, see Schedule tab configuration section below.

 No
parameters object Properties for the parameters tab. No
notifications object

Properties for the notifications tab.

For more information, see Notifications tab configuration section below.

 No
output object

Properties for the output tab.

For more information, see Output tab configuration section below.

 No

Schedule tab configuration

Name Type Default Description Required Supported values
label object {

show: true,

value: ""

} 		Visibility and default value of label field If show is false, a value is required. The maximum length of value is 100 characters.
description object {

show: true,

value: ""

} 		Visibility and default value of description field No The maximum length is 250 characters.
recurrenceInterval object {

show: true,

value: 1

} 		Visibility and default value of recurrenceInterval field No The recurrence interval must be an integer greater than 0.
recurrenceIntervalUnit object {

show: true,

value: "DAY"

} 		Visibility and default value of recurrenceIntervalUnit field No

'HOUR'

'DAY'

'WEEK'
startTime object {

show: true,

value: "now"

} 		Visibility and default value of startTime field No The value must be either 'now' or a valid start date and time. If the value is 'now', the 'Now' option will be selected. If the value is a start date and time, it cannot be empty and must be set in the future; in this case, the 'Specific date and time' option will be selected.

Notifications tab configuration

Name Type Default Description Required Supported values
address object {

show: true,

value: ""

} 		Visibility and default value of address field If show is false, a value is required. One or more email addresses should be valid.
subject object {

show: true,

value: ""

} 		Visibility and default value of subject field If show is false, a value is required. The maximum length is 100 characters.
messageText object {

show: true,

value: ""

} 		Visibility and default value of messageText field No The maximum length is 2000 characters.
resultSendType object {

show: true,

value: "SEND_ATTACHMENT"

} 		Visibility and default value of resultSendType field No The value must be either 'SEND_ATTACHMENT' or a valid JasperReports Server folder path. If the value is 'SEND_ATTACHMENT', the option to 'Include report/dashboard file as attachment' will be selected. If the value is a folder path, it must not include any invalid characters, and the option 'Include report/dashboard as repository link' will be selected.

Output tab configuration

Name Type Default Description Required Supported values
baseOutputFilename object {

show: true,

value: ""

} 		Visibility and default value of output file field No

The maximum length is 200 characters.

The output filename should not contains invalid characters.
outputDescription object {

show: true,

value: ""

} 		Visibility and default value of output description field No
outputFormat object {

show: true,

value: ["pdf"]

} 		Visibility and default value of output formats field No It should be supported output format by JasperReports Server.
outputTimeZone object {

show: true,

value: ""

} 		Visibility and default value of output timezone field No It should be supported timezone by JasperReports Server