(GET .../documents/<documentID>/schedules/<scheduleID>)
(POST .../documents/<documentID>/schedules)
<schedule> <id> <name> <format type="webi|pdf|xls|csv"/> <status id="0|1|3|8|9"> <destination> <error> recurrence_expression <serverGroup id="integer" required="Boolean"/> <parameters>
Element | Type or Value | Description |
---|---|---|
<id> | integer | The schedule identifier Note This element only appears in the
response of the GET schedule details
call.
|
<name> | string | The schedule name |
<format> | N/A | The document format. Attribute: type (webi|pdf|xls|csv). By default, the format is webi. See the next section for options specific to the csv format. |
<status> | string | The schedule status. Attribute: id Each id can help you to test the schedule independently of your language locale.
Note This element only appears in the response of the
GET schedule details call.
|
<destination keepInstanceInHistory="Boolean"> <useSpecificName fileExtension="Boolean"> |
N/A | The document destination, which can be the BI launch pad inbox,
an email address, a local file, or a file via FTP. Is optional. If
no destination is specified, then the destination is the default one
defined on the backend system. See the examples to learn how to set
up the destination. Attribute: keepInstanceInHistory (Boolean) keeps the instance of the schedule document in history if it is true (default)
|
<error> <error_code> <message> |
N/A | Error information added in case of failure (<status
id="3">Failed</status>). Note This element can
only appear in the response of the GET schedule
details call.
|
recurrence_expression | N/A | The scheduling recurrence expression. See the next section to learn how to set it up. |
<parameters> | N/A | The parameter used as prompt. See the Refreshing Documents for information on the <parameters> details. See Example - Inbox Destination for a Daily Schedule with a Prompt. |
<serverGroup id="integer" required="Boolean"/> |
N/A | The server group used to run the
schedule Attributes:
|
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 following table describes the possible recurrence expressions.
Recurrence Expression | Schedule Time |
---|---|
No recurrence expression |
Now |
<once retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> |
Once, run at <startdate>.
|
<daily retriesAllowed="2" retryIntervalInSeconds= "60"> <startdate> <enddate> <dayinterval> |
Daily. <dayinterval> is the day interval to repeat the schedule (integer). |
<hourly retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> <hour> <minute> |
Hourly. <hour> (integer, [0, 24]) and <minute> (integer, [0,59]) define the time interval to repeat the schedule. |
<weekly retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> <monday/> <tuesday/> <wednesday/> <thursday/> <friday/> <saturday/> <sunday/> |
Weekly. The schedule is run only the
mentioned days. <monday/>, <tuesday/>, <wednesday/>, <thursday/>, <friday/>, <saturday/>, and <sunday/> are all optional. They must be mentioned in the specified order. |
<monthly retriesAllowed="2"retryIntervalInSeconds= "60"> <startdate> <enddate> <month> |
Monthly. <month> defines the month interval to repeat the schedule (integer, [1, 12]). |
<nthDayOfMonth retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> <day> |
Only the specified day of each
month. <day> defines the day of the month as a number between 1 and 31. |
<firstMondayOfMonth retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> |
The first Monday of each month. |
<lastDayOfMonth retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> |
The last day of each month. |
<xDayOfNthWeekOfTheMonth retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> <day> <week> |
The specified day of the specified week of each
month. <day> defines the day of the month as a number between 1 and 31. <week> defines the week of the month as a number between 1 and 4. |
<calendar retriesAllowed="2" retryIntervalInSeconds="60"> <startdate> <enddate> <id> |
The schedule runs according to the recurrence defined in the
calendar that the end-user has created on the
CMC. <id> is the calendar object identifier in the CMS. |