Run the command add Scheduled Report. Run the command add Scheduled Report. Parameter | Description |
CENTRASITE-URL | (Optional). The URL of the CentraSite registry. For example, http://localhost:53307/CentraSite/CentraSite. |
USER-ID | The user ID of a registered CentraSite user who has the CentraSite Administrator role. For example, Administrator. |
PASSWORD | The password for the registered CentraSite user identified by the parameter USER-ID. |
CONFIG-FILE | Name of the configuration file which contains the report scheduled properties. |
Tag Name | Description | ||
Name | (Mandatory). The name of the scheduled report. | ||
Description | (Optional). Description for the scheduled report. | ||
Report | (Mandatory). The name of the report to execute. | ||
EmailAddress | (Mandatory). The email address of the consumer who should be informed of the result of the report execution. | ||
Locale | (Optional). The locale of the report to execute. If the locale is not set, the default locale is used. Note that the current version of CentraSite only supports the default locale. | ||
Occurrence | (Mandatory). The occurrence options with which you want to schedule a report to execute automatically. Possible values - daily, weekly, monthly. | ||
Frequency | (Optional). The frequency with which you want a report to execute automatically on a regular schedule. Example: If you specify Occurrence=daily, Frequency=10, then your report will execute every 10 days. | ||
DayOfMonth | (Optional). The exact day of the month when you want the scheduled report to execute automatically.
Example: If you specify Occurrence=monthly, Frequency=2, DayOfmonth=5, then your report will execute on day 5 of every 2 months. | ||
Days | (Optional). The exact days of the week when you want the scheduled report to execute automatically. Possible values - monday, tuesday, wednesday, thursday, friday, saturday, sunday
Example: If you specify Occurrence=weekly, Frequency=2, Days=[monday, friday] then your report will execute every 2 weeks on the specified days, that is, Monday and Friday. | ||
Ordinal | (Optional). The ordinal with which you want the scheduled report to execute automatically. Possible values - first, second, third, forth, last Example: If you specify Occurrence=monthly, Frequency=3, Days=[monday], Ordinal=first, then your report will execute the first Monday of every 3 months. |
If You Want the Schedule to Execute This Often | Occurrence | Frequency | Day of the Month | Weekdays | Ordinal |
Every day | Daily | 1 | n/a | n/a | n/a |
Every specific number of days (for example, every 7 days) | Daily | 7 | n/a | n/a | n/a |
Every week on a certain day (for example, every week on Wednesday) | Weekly | 1 | n/a | Wednesday | n/a |
Every specific number of weeks on a certain day (for example, every 2 weeks on Friday) | Weekly | 2 | n/a | Friday | n/a |
Every month on a specific date, (for example, the 10th of every month) | Monthly | 1 | 10 | n/a | n/a |
Every month on a certain day (for example, the third Monday of every month) | Monthly | 1 | n/a | Monday | third |
Every specific number of months on a certain day (for example, the last Friday of every 3rd month) | Monthly | 3 | n/a | Friday | last |
