Adds a new schedule to a Web Intelligence document.
The schedule can be sent in different formats to several destinations and set just for once, daily, hourly or monthly. You can also select a server group that the system uses to run the schedule. These settings are described in the body of the request.
For more information on scheduling, refer to the SAP Business Objects Business Intelligence Platform, BI Launch Pad User Guide.
POST <webiURL>/documents/{documentId}/schedules
Where:
Request body:
<schedule> <name> <format type="webi|pdf|xls|csv"> <destination> <recurrence_expression> <serverGroup id="..." required="true|false"/> </schedule>
Where:
If the format type is CSV, the following options are supported:
<format type="csv"> <properties> <property key="textQualifier">'</property> <!-- either ' or " --> <property key="columnDelimiter">,</property> <!-- either , or ; or tab --> <property key="charset">UTF-8</property> <!-- a valid server charset --> <property key="onePerDataProvider">false</property> </properties> </format>
The <destination> element accepts a series of parameters which are described in the next sections. The destination can also have the following attributes and child elements:
<destination keepInstanceInHistory="false"> <useSpecificName fileExtension="false">-customTest</useSpecificName> </destination>
Where:
The following table describes the possible recurrence expressions.
XML Recurrence Expression | Schedule Time |
---|---|
No recurrence expression |
Now |
<once retriesAllowed="2" retryIntervalInSeconds="60"> <startdate>...</startdate> <enddate>...</enddate> </once> |
Once, launched at <startdate>.
|
<daily retriesAllowed="2" retryIntervalInSeconds= "60"> <startdate>...</startdate> <enddate>...</enddate> <dayinterval>1</dayinterval> </daily> |
Daily. <dayinterval> is the day interval to repeat the schedule. |
<hourly retriesAllowed="2" retryIntervalInSeconds="60"> <startdate>...</startdate> <enddate>...</enddate> <hour>1</hour> <minute>30</minute> </hourly> |
Hourly. <hour> and <minute> define the time interval to repeat the schedule. |
<monthly retriesAllowed="2"retryIntervalInSeconds= "60"> <startdate>...</startdate> <enddate>...</enddate> <month>1</month> </monthly> |
Monthly. <month> defines the month interval to repeat the schedule. |
Response type: application/xml or application/json
The response is a message stating the success or failure of a request.