SubmitJob

Generates and prints a report or information object in asynchronous mode. BIRT iHub sends a response after completing the request.

After generating a document in asynchronous mode, you can convert the document to one of the following formats:

When converting a document, the properties of the converted file are the same as the original document properties.

BIRT iHub only supports converting document output for asynchronous generation. Conversion is not supported for the following types of document output:

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

String. The name of the job.

String. The job headline.

Int. The job priority. Job priority is limited by the user Max job priority setting. Valid values are 0–1,000, where 1,000 is the highest priority.

String. The resource group to which to assign the job. Available only to an Encyclopedia volume administrator or a user with the Administrator role.

String. The full path, name, and version number of the file to use as input. If RunLatestVersion is specified, the version number is ignored.

String. The ID of the file to use as input.

Boolean. Specifies whether to run or print the most recent version of the executable file. If True, the latest version of the file is used. If True, the version number in InputFileName is ignored.The default value is True.

NewFile. The file name and extension for the output.

String. Specifies the type of task to perform, RunReport, RunAndPrintReport, ConvertReport, or PrintReport.

ArrayOfParameterValue. A list of parameter values to use. Specify either ParameterValues, ParameterValueFileId, ParameterValueFileName.

String. The name of the parameter value file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

String. The ID of the report object values file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

JobSchedule. Specifies the schedule on which to run the report. If not specified, the job runs immediately.

ArrayOfPrinterOptions. If the job is to be printed, specifies the job printer settings. If the job is not to be printed, PrinterOptions is ignored. The printer settings have the following precedence:

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

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

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

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

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

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

Boolean. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendSuccessNotice is True, notices are sent.

Boolean. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True. If SendFailureNotice is True, failure notices are sent to specified users and groups if the job fails.

Boolean. Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If True, e-mail notifications are sent to specified users and groups if the job succeeds. The default value is False.

Boolean. Specifies whether e-mail notifications are sent to specified users and groups if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e-mail notifications are sent. The default value is False.

Boolean. Specifies whether to attach a report to an e-mail completion notice. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e-mail notification if the job succeeds. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat parameter. The default value is False.

Boolean. Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e-mail notifications and output attachments are sent according to job settings. If False, e-mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:

String. Specifies the output format of the report attached to the e-mail notification.The following formats are supported:

Boolean. Specifies whether to keep the job status for successful jobs. If True, the job status is kept if job execution succeeds.

Boolean. Specifies whether to keep the job status for failed jobs. If True, the job status is kept if job execution fails.

Boolean. Specifies whether a report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

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

Specifies whether the workspace directory is removed after the job completes.

The time interval for the open server to get status messages. The minimum value is 10 seconds.

Boolean. Specifies whether the generated output file remains in the Encyclopedia volume if the generation request succeeds but the printing request fails. Used if Operation is RunAndPrintReport. If True, the output file remains in the Encyclopedia volume if the printing request fails. If False, the output file is deleted if the printing request fails. The default value is False.

Event. An event that must be completed before the response is processed.

ArrayOfString. Specifies the access control list (ACL) restricting data privileges.

String. The job ID. Use the job ID to refer to the job in subsequent requests during the current session.