PrintReport

Prints a document. PrintReport requests are always executed in asynchronous mode.

The document prints to the specified printer. If a printer is not specified, the document prints to the user default printer.

Both PrintReport and SubmitJob support printing. Use PrintReport to print an existing document. Use SubmitJob to schedule execution and printing from a design executable.

Request elements

JobName

String. The job name.

Priority

Int. The job priority. Limited by the user Max job priority setting.

InputFileName

String. The name of the file to print. Specify either InputFileName or InputFileId.

InputFileId

String. The ID of the file to print. Specify either InputFileId or InputFileName.

Schedules

JobSchedule. The schedule for the print job. If not specified, the print request is sent immediately.

PrinterOptions

JobPrinterOptions. The job printer settings. The printer settings have the following precedence:

Job printer settings

User printer settings

System printer settings

NotifyUsersByName

ArrayOfString. The names of users to receive job completion notice. Specify either NotifyUsersByName or NotifyUsersById.

NotifyGroupsByName

ArrayOfString. The names of groups to receive the job completion notice. Specify either NotifyGroupsByName or NotifyGroupsById.

NotifyChannelsByName

ArrayOfString. The names of channels to receive the job completion notice. Specify either NotifyChannelsByName or NotifyChannelsById.

NotifyUsersById

ArrayOfString. The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.

NotifyGroupsById

ArrayOfString. The IDs of groups to receive the job completion notice. Specify either NotifyGroupsById or NotifyGroupsByName.

NotifyChannelsById

ArrayOfString. The IDs of channels to receive job completion notice. Specify either NotifyChannelsById or NotifyUsersByName.

SendSuccessNotice

Boolean. Specifies whether notices are sent if report printing succeeds.

SendFailureNotice

Boolean. Specifies whether notices are sent if report printing fails.

SendEmailForSuccess

Boolean. Specifies whether an e‑mail is sent when report printing succeeds.

SendEmailForFailure

Boolean. Specifies whether an e‑mail is sent when report printing fails.

OverrideRecipientPref

Boolean. Specifies whether recipient preferences are overridden.

RecordSuccessStatus

Boolean. Specifies whether the job status is kept if report printing succeeds.

RecordFailureStatus

Boolean. Specifies whether the job status is kept if report printing fails.

RetryOptions

RetryOptions. Specifies how to retry printing if the previous attempt failed. Used only if Retryable is specified.

Response element

JobId

String. The ID of the print job. Returned after the job is created.