MicroStrategy ONE

Subscriptions

The subscriptions functionality in MicroStrategy Web involves subscribing to reports and delivering them using MicroStrategy Intelligence Server. The following interfaces are available for subscriptions functionality. These interfaces help you understand the code samples provided in the examples section. For detailed information on these interfaces, refer to the com.microstrategy.web.objects package in API Reference.

  • WebScheduleSource— Top-level interface responsible for scheduling. It serves as the entry point for the scheduling functionality in MicroStrategy Web. It also provides support for adding new schedules to Intelligence Server. It provides the following methods:

    • getSchedules()— Gets all the schedules that the current user has privileges to see.

    • getUserSchedules()— Gets only those schedules that were created by the current user.

    • getTriggers()— Gets the current triggers within the project.  

  • WebSchedule— Holds the information regarding a Web Schedule. A schedule object comprises of a schedule trigger object and a request object. The schedule trigger object (WebScheduleTrigger) defines when the schedule is triggered and the request object (WebRequest) defines the command the Intelligence Server executes.

  • WebScheduleTrigger— Represents a trigger on Intelligence Server. This trigger object can be time-based or event-based. 

  • WebRequest— Entry point to the statement (WebStatement) for a schedule (WebSchedule). 

  • WebStatement— Defines a statement which is used to identify an Intelligence Server command within a schedule (WebSchedule). This object cannot be directly instantiated; it can only be obtained indirectly from the other scheduling-related objects.