Working with jobs and reports

Table 3‑7 Operations for working with jobs and reports
Operation	Description
CancelJob	Stops generation of a scheduled or immediate job. Returns either the status of the cancellation or an error message. For synchronous reports, returns one of three states: Failed, meaning the cancellation did not succeed Succeeded, meaning the cancellation succeeded InActive, meaning the job completed before BIRT iHub received the cancellation request
CancelReport	Cancel synchronous report execution. CancelReport returns either the status of the cancellation or an error message.
CreateParameterValuesFile	Creates a report parameter values (.rov) file in an Encyclopedia volume. CreateParameterValuesFile contains a required ParameterValueList element.
CreateQuery	Generates a data object value (.dov) file. CreateQuery contains a required Query element, which provides details about the available columns, parameter definitions, sorting and filtering criteria, and other properties of the query.
DeleteJob	Deletes one or more jobs. The request must specify whether to delete a single job, a list of jobs, or jobs that match specific conditions. DeleteJob is accessed through the Administrate operation.
DeleteJobNotices	Deletes one or more job notices. The request must specify whether to delete a single job notice, a list of job notices, or job notices that match specific conditions. DeleteJobNotices is accessed through the Administrate operation.
ExecuteReport	Runs a synchronous report. The WaitTime element supports specifying the minimum time for BIRT iHub to wait before returning a response. For transient reports, the request can include an Attachment element to indicate that the executable file to use is attached to the request. ExecuteReportStatus returns the status of the request.
ExportParameter DefinitionsToFile	Converts parameter definitions to an attached file that the client application can use as a report’s parameter values file. The definitions can return as an attachment or an embedded object.
ExtractParameter DefinitionsFromFile	Extracts parameter definitions from a parameter values file.
GetContent	Retrieves the contents of a report for a specific component ID or component name and value. If the component ID is 0, returns the entire report.
GetCustomFormat	Extracts the results of calling the AcReport::GetCustomFormat method. For example, if the method creates an Excel file, GetCustomFormat retrieves the Excel file from an BIRT iHub node.
GetDocumentConversion Options	Retrieves a list of DocumentConversionOptions.
GetDynamicData	Retrieves a report’s dynamic data.
GetEmbeddedComponent	When BIRT iHub returns an embedded URL in the report page, the browser requests the component the URL identifies. The component can be static data, dynamic data, or a style sheet.
GetJavaReportEmbedded Component	Retrieves an embedded component such as an image or a graph in a Java report document.
GetJavaReportTOC	Retrieves the table of contents of a Java report document.
GetJobDetails	Retrieves properties of a job, such as job name and ID, schedule, printer settings, resource groups to which the job is assigned, and notification list. The GroupingEnabled element indicates whether an end user can group data in a report or information object. GetJobDetails retrieves report parameters from the parameter values file for the job. If a scheduled job’s RunLatestVersion element isTrue, GetJobDetails returns the combined parameters from the parameter values file and the latest report executable file. If a user requests details about a job the user did not submit, BIRT iHub returns a security error.
GetNoticeJobDetails	Retrieves details about a job notification. The response always includes a JobAttributes element, which lists general job properties such as the job name, ID, state, owner, job type, duration, and resource groups to which the job is assigned. The response also can include details about the input and output files, notification information, and schedules. GetNoticeJobDetails includes the GroupingEnabled element to indicate whether the end user can group data in a report or information object.
GetPageCount	Retrieves the number of pages in a report.
GetPageNumber	Retrieves the page number of a bookmark in a report.
GetParameterPickList	Retrieves the parameters names from a pick list in a report
GetReportParameters	Retrieves the parameter values file of a designated report. The designated report can be an Actuate or third-party file. The client can request parameter values using a JobId, a file ID, or file name.
GetStaticData	Retrieve the report’s static data
GetStyleSheet	Retrieve the report’s style sheet
GetSyncJobInfo	Retrieves information about a specific synchronous job, including the status of the report, an error description if the status is Failed, and details about pending or running jobs.
GetTOC	Retrieves the table of contents for a report. Returns the table of contents in XMLDisplay format.
GetUserPrinterOptions	Retrieves the user’s printer settings on BIRT iHub.
PrintReport	Prints a generated report. PrintReport can specify users, channels, or notification groups to notify at completion of printing.
SelectJavaReportPage	Returns a report page formatted in the specified display format indicated by the Page or Component element.
SelectJobNotices	Retrieves a single job notice or a list of job notices.
SelectJobs	Retrieves a list of jobs, jobs that match specific conditions, or a single job.
SelectJobSchedules	Selects all scheduled jobs matching the specified criteria.
SelectPage	Retrieves a page or range of pages to view. Pages are identified by number, page range, component ID, or other criteria.
SubmitJob	Submits a job request to run a report or run and print it in one operation. Jobs run synchronously or asynchronously. Printing occurs in asynchronous mode only. The job submitter can specify users, channels, or notification groups to notify at completion of the job. SubmitJob supports e‑mail notification of success and failure, attaching the output report to the e‑mail message, and choosing the format for the attachment. The job submitter also can override user preferences for the attachment format. If the request generates an information object, SubmitJob reads the executable file, generates a temporary query, and executes the request using the temporary file. SubmitJob supports choosing a resource group to process the job.
UpdateJobSchedule, UpdateJobScheduleOperation, UpdateJobSchedule OperationGroup	Updates scheduled jobs in an Encyclopedia volume. The request must specify the update activity to apply, such as changing printer settings, adding or removing schedules to a job, and changing notifications. It must also specify whether the activity applies to a single scheduled job, a list of scheduled jobs, or scheduled jobs that match specific conditions. UpdateJobSchedule supports e-mail notification of success and failure, attaching the output report to the e-mail, and choosing a format for the report attachment. Viewer preferences for the attachment format are overridable. If the scheduled job is a data object value (.dov) file, UpdateJobSchedule updates the DOV file using the latest query. Using UpdateJobSchedule, an Encyclopedia volume administrator or a user in the Administrator role can add the job to a resource group or change the resource group to which the job is assigned. UpdateJobSchedule is accessed through the Administrate operation.
WaitForExecuteReport	WaitForExecuteReport overrides the WaitTime setting of an ExecuteReport operation. For example, when an ExecuteReport request has a WaitTime of 2 seconds and the response indicates that the status is Pending, the client can send WaitForExecuteReport to keep waiting for report generation beyond 2 seconds.