The WSDL defines several types that are used by the parameters and operation result of the service. The types belong to the http://www.jasperforge.org/jasperserver/ws namespace. The namespace is only an identifier; it is not a valid URL.
This section provides a partial list of the types used for report scheduling; for the complete reference, refer to the WSDL document. The report scheduling types include:
|
Type |
Type Element |
Description |
|
Job |
Encapsulates all the attributes of a report job. This type is used when full report job details are passed to or returned by an operation. |
|
|
|
ID and version |
Required when updating a report job |
|
|
reportUnitURI |
URI of the report |
|
|
username |
Set automatically to the name of the calling user when a report job is created |
|
|
label |
Job label. |
|
|
simpleTrigger or calendarTrigger |
Job trigger, which can be either a simple (fixed interval) trigger or a calendar trigger |
|
|
parameters |
List of report parameter/input control values |
|
|
baseOutputFilename |
Base name for the job output |
|
|
outputFormats |
List of job output formats (as strings). JasperReports Server has built-in support for the following formats: PDF, HTML, XLS, RTF and CSV. |
|
|
outputLocale |
String representation of a java.util.Locale to be used as report locale |
|
|
repositoryDestination |
Location in the repository where the report output is saved |
|
|
mailNotification |
Information regarding the email notification that is sent when the job executes. Set this value to NULL to suppress notifications. Note: To use this feature, you must configure a mail server, as described in JasperReports Server Administrator Guide. |
|
JobSimpleTrigger |
Job trigger that fires at fixed intervals |
|
|
|
startDate and endDate |
Start and end dates of the job |
|
|
timezone |
Time zone of the start and end dates |
|
|
occurrenceCount |
How many times to run the job. If a single run job is wanted, use 1 as occurrence count; if the job is to be fired indefinitely or until the end date, use -1. |
|
|
recurrenceInterval and recurrenceIntervalUnit |
Interval at which the job should recur: MINUTE, HOUR, DAY, WEEK. |
|
JobCalendarTrigger |
Job trigger that fires at a time specified by a CRON-like expression |
|
|
|
startDate and endDate |
Start and end dates of the job |
|
|
timezone |
Time zone of the start and end dates |
|
|
minutes |
Minute or minutes of the day when the job is to run. |
|
|
hours |
Hour or hours of the day when the job is to run. |
|
|
daysType |
How days are specified. Possible values are ALL, WEEK, and MONTH. |
|
|
weekDays |
Used when daysType is WEEK; this indicates the days of the week from Saturday (1) to Sunday (7). |
|
|
monthDays |
Used when daysType is MONTH, this indicates the month days. |
|
|
months |
Months (from 0 to 11) on which the job should be triggered. |
|
JobRepositoryDestination |
Information about where to save the report job output in the repository. |
|
|
|
folderURI |
URI of the folder where the report output will be saved. |
|
|
sequentialFilenames |
Flag indicating whether to append timestamps to the base output name. |
|
JobMailNotification |
Encapsulates the attributes of the mail notification to send regarding the report job. |
|
|
|
toAddresses |
List of email addresses to which the notification will be sent. |
|
|
subject |
Subject of the email notification. |
|
|
resultSendType |
Indicates whether to attach the report output to the email; the value is either SEND (only the messages is sent) or SEND_ATTACHMENT (the report output is sent along as a message attachment). |
|
JobSummary |
Used when a list of report jobs is retrieved via the service. The full report job information can be retrieved individually for required jobs. |
|
|
|
id |
Unique identifier of the job. |
|
|
label |
Display label of the job. |
|
|
state |
State of the job. For example, NORMAL indicates that the job is waiting for next execution; EXECUTING means the job is running. |
|
|
previousFireTime |
Most recent run time. |
|
|
nextFireTime |
Next run time. |
