Sending an e‑mail notification using UpdateJobSchedule
To modify a job’s notification settings, set one or more of the following elements of UpdateJobSchedule:
SetUserNotificationByName
SetUserNotificationById
SetGroupNotificationByName
SetGroupNotificationById
The following UpdateJobSchedule operation uses SetUserNotificationByName and SetGroupNotificationByName to add three users and a group to the notification list. This operation is a transaction, which means that all updates must succeed for the operation to succeed.
<SOAP-ENV:Body>
<Administrate>
<Transaction>
<TransactionOperation>
<UpdateJobSchedule>
<UpdateJobScheduleOperationGroup>
<UpdateJobScheduleOperation>
<SetAttributes>
<RunLatestVersion>false</RunLatestVersion>
<InputFileName>
/Regional Forecasts 2008
/forecast.rptdesign
</InputFileName>
</SetAttributes>
<SetParameters>
<OverrideRecipientPref>true
</OverrideRecipientPref>
<AttachReportInEmail>true
</AttachReportInEmail>
<SendEmailForSuccess>true
</SendEmailForSuccess>
<SendEmailForFailure>true
</SendEmailForFailure>
<EmailFormat>PDF</EmailFormat>
<SendSuccessNotice>true
</SendSuccessNotice>
<SendFailureNotice>true </SendFailureNotice>
</SetParameters>
<SetUserNotificationByName>
<String>Claude Lacroix</String>
<String>Heinrich Richter</String>
<String>Ying Leung</String>
</SetUserNotificationByName>
<SetGroupNotificationByName>
<String>Sales Managers</String>
</SetGroupNotificationByName>
</UpdateJobScheduleOperation>
</UpdateJobScheduleOperationGroup>
<Id>1</Id>
</UpdateJobSchedule>
</TransactionOperation>
</Transaction>
</Administrate>
</SOAP-ENV:Body>
In this example:
SendFailureNotice and SendSuccessNotice are True, so BIRT iHub sends e‑mail for success and for failure.
OverrideRecipientPref is True, so BIRT iHub overrides recipient preferences about whether to receive the attachment.
EmailFormat requests the output in PDF format. You can request output in Excel, PDF, PostScript, Word, or PowerPoint format.
As with many administration operations, this request returns an empty response.