Interface EnumSubscriptionEditorEvents

    • Field Detail

      • WebEventSubscriptionEditorApply

        static final int WebEventSubscriptionEditorApply
        Event to process the Subscription editor form. This event is used for web subscriptions, email subscriptions and send now subscriptions.
        See Also:
        Constant Field Values
      • WebEventArgumentTriggerId

        static final int WebEventArgumentTriggerId
        Argument to specify the Trigger id for the subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentAddressId

        static final int WebEventArgumentAddressId
        Argument to specify the Address id for the subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentAddressValues

        static final int WebEventArgumentAddressValues
        Argument to specify the list of address names for the subscription. This is a list of comma seperated address values.
        See Also:
        Constant Field Values
      • WebEventArgumentSubject

        static final int WebEventArgumentSubject
        Argument to specify the subject of the email subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentSendNow

        static final int WebEventArgumentSendNow
        Argument to specify if we need a preview of an email subscription immediately. A value of "1" signifies that we need an immediate preview.
        See Also:
        Constant Field Values
      • WebEventArgumentDeviceId

        static final int WebEventArgumentDeviceId
        Argument to specify the Device ID of the address used in the email subscription. The Device Id is specified only in the case of creating new addresses while creating a new subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentAddressType

        static final int WebEventArgumentAddressType
        Argument to indicate whether to use the address id or the address values.
        See Also:
        Constant Field Values
      • WebEventArgumentReuseMessage

        static final int WebEventArgumentReuseMessage
        Argument to indicate whether to use the same message id everytime the report is run or not. This argument is used only for web subscriptions and not for email subscriptions. When this argument is not sent, scheduled reports will generate a new message in the History List each time the schedule executes.
        See Also:
        Constant Field Values
      • WebEventArgumentOverwriteSchedule

        static final int WebEventArgumentOverwriteSchedule
        Argument to indicate to overwrite any existing schedules when creating Schedule subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentCustomMessage

        static final int WebEventArgumentCustomMessage
        Argument to indicate the text messsage to go with the email subscription.
        See Also:
        Constant Field Values
      • WebEventArgumentCurrentFormat

        static final int WebEventArgumentCurrentFormat
        Argument to indicate the format for the email subscription. The available formats could be HTML or EXCEL or PDF or any other format supported by the system. This is available only for email subscriptions.
        See Also:
        Constant Field Values
      • WebEventArgumentCompressContents

        static final int WebEventArgumentCompressContents
        Argument to indicate if the subscription is to be compressed for delivery. A value of "1" will indicate a compressed delivery. This is available only for email subscriptions.
        See Also:
        Constant Field Values
      • WebEventArgumentLocationID

        static final int WebEventArgumentLocationID
        Argument to indicate location ID for the print or file delivery.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentExtendedLocation

        static final int WebEventArgumentExtendedLocation
        Argument to indicate extended location for the print or file delivery. This is required when the selected location requires the user to type in extra information about the path for the location.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentFileName

        static final int WebEventArgumentFileName
        Argument to indicate the file name for the scheduled file export.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintCopies

        static final int WebEventArgumentPrintCopies
        Argument to indicate the number of copies for scheduled print.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintIsPortrait

        static final int WebEventArgumentPrintIsPortrait
        Argument to indicate whether the orientation is portrait for scheduled print.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintIsCollated

        static final int WebEventArgumentPrintIsCollated
        Argument to indicate whether copies are collated for scheduled print.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintRangeStart

        static final int WebEventArgumentPrintRangeStart
        Argument to indicate the start page for scheduled print.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintRangeEnd

        static final int WebEventArgumentPrintRangeEnd
        Argument to indicate the end page for scheduled print.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values
      • WebEventArgumentPrintRangeAll

        static final int WebEventArgumentPrintRangeAll
        Argument to indicate the all pages option for scheduled print.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentNotifyAddressId

        static final int WebEventArgumentNotifyAddressId
        Argument to specify the notification Address id for the subscription.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentNotifyAddressValue

        static final int WebEventArgumentNotifyAddressValue
        Argument to specify the notification address name for the subscription.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentNotifyDeviceId

        static final int WebEventArgumentNotifyDeviceId
        Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentNotifyAddressMode

        static final int WebEventArgumentNotifyAddressMode
        Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentNotify

        static final int WebEventArgumentNotify
        Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentExpandPageBy

        static final int WebEventArgumentExpandPageBy
        Argument to specify the notification Device ID of the address used in the subscription. The notification device Id is specified only in the case of creating new notification addresses.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentExpandUseSeparateSheets

        static final int WebEventArgumentExpandUseSeparateSheets
        Argument to specify whether to use separate sheets when expanding the page by elements.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • WebEventArgumentScheduleExecutionFlags

        static final int WebEventArgumentScheduleExecutionFlags
        Argument to indicate to execution flags when creating Schedule subscription.
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • WebEventArgumentCompressedFileName

        static final int WebEventArgumentCompressedFileName
        Argument to indicate the compressed file name
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentIncludeLink

        static final int WebEventArgumentIncludeLink
        Argument to include link
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentSendToInbox

        static final int WebEventArgumentSendToInbox
        Argument to send data to inbox
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentIncludeData

        static final int WebEventArgumentIncludeData
        Argument to for including data
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentZipFilePassword

        static final int WebEventArgumentZipFilePassword
        Argument to indicate the zip file password
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentExpirationDate

        static final int WebEventArgumentExpirationDate
        Argument to indicate the expiration date
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • WebEventArgumentProtectZipFile

        static final int WebEventArgumentProtectZipFile
        Indicates whether to protect the zip file.
        See Also:
        Constant Field Values
      • WebEventArgumentAllowChangingDeliverySettings

        static final int WebEventArgumentAllowChangingDeliverySettings
        See Also:
        Constant Field Values
      • WebEventArgumentAllowChangingPersonalization

        static final int WebEventArgumentAllowChangingPersonalization
        See Also:
        Constant Field Values
      • WebEventArgumentAllowUnsubscribe

        static final int WebEventArgumentAllowUnsubscribe
        See Also:
        Constant Field Values
      • WebEventArgumentMobile

        static final int WebEventArgumentMobile
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values
      • ADDRESS_CONTACT

        static final int ADDRESS_CONTACT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • ADDRESS_EXISTING

        static final int ADDRESS_EXISTING
        Constant to indicate an existing address
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • ADDRESS_NEW

        static final int ADDRESS_NEW
        Constant to indicate new address
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • ADDRESS_RECIPIENTS_DEFAULT

        static final int ADDRESS_RECIPIENTS_DEFAULT
        Constant to indicate recipient default email address
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values