Supported Bean: SubscriptionEditorBean
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanSubscriptionsEditor (39)
Events
| apply | ||||
| Event to execute the main action of the ReportEditor |
17003 | |||
| cancel | ||||
| Equivalent to close. |
17005 | |||
| closeEditor | ||||
| Event to close the ReportEditor |
17002 | |||
| ok | ||||
| Event corresponding to apply and close. |
17004 | |||
| openEditor | ||||
| Event to open the ReportEditor |
17001 | |||
| setTopLeft | ||||
| Event for setting the top left position of the component |
73001 | |||
|
*left | Event argument to define the left (x) position of the component |
73002 | ||
|
*top | Event argument to define the top (y) position of the component |
73001 | ||
| subscribe | ||||
| Event to process the Subscription editor form. This event is used for web subscriptions, email subscriptions and send now subscriptions. |
39001 |
EnumSubscriptionEditorEvents.WebEventSubscriptionEditorApply |
||
|
*addressId | Argument to specify the Address id for the subscription. |
39002 | ||
|
*addressValues | Argument to specify the list of address names for the subscription. This is a list of comma seperated address values. |
39003 | ||
|
*triggerId | Argument to specify the Trigger id for the subscription. |
39001 | ||
|
_subject | Argument to specify the subject of the email subscription. |
39004 | ||
|
allowChangeDelSettings |
39037 |
EnumSubscriptionEditorEvents.WebEventArgumentAllowChangingDeliverySettings |
||
|
allowChangePers |
39038 |
EnumSubscriptionEditorEvents.WebEventArgumentAllowChangingPersonalization |
||
|
allowUnsub |
39039 |
EnumSubscriptionEditorEvents.WebEventArgumentAllowUnsubscribe |
||
|
compressContents | 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. |
39012 |
EnumSubscriptionEditorEvents.WebEventArgumentCompressContents |
|
|
compressedFileName | Argument to indicate the compressed file name |
39030 |
EnumSubscriptionEditorEvents.WebEventArgumentCompressedFileName |
|
|
copies | Argument to indicate the file name for the scheduled file export. |
39015 | ||
|
currentFormat | 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. |
39011 | ||
|
customMessage | Argument to indicate the text messsage to go with the email subscription. |
39010 | ||
|
deviceId | 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. |
39006 | ||
|
execFlags | Argument to indicate to execution flags when creating Schedule subscription. |
39029 |
EnumSubscriptionEditorEvents.WebEventArgumentScheduleExecutionFlags |
|
|
expandPageBy | 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. |
39027 | ||
|
expDate | Argument to indicate the expiration date |
39035 | ||
|
extendedLocation | 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. |
39014 |
EnumSubscriptionEditorEvents.WebEventArgumentExtendedLocation |
|
|
incData | Argument to for including data |
39033 | ||
|
incLink | Argument to include link |
39031 | ||
|
isCollated | Argument to indicate whether copies are collated for scheduled print. |
39018 |
EnumSubscriptionEditorEvents.WebEventArgumentPrintIsCollated |
|
|
isPortrait | Argument to indicate whether the orientation is portrait for scheduled print. |
39017 |
EnumSubscriptionEditorEvents.WebEventArgumentPrintIsPortrait |
|
|
locationId | Argument to indicate location ID for the print or file delivery. |
39013 | ||
|
mobile |
39040 | |||
|
NCaddType | Argument to indicate whether to use the address id or the address values. |
39007 | ||
|
notify | 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. |
39026 | ||
|
notifyAddressID | Argument to specify the notification Address id for the subscription. |
39022 |
EnumSubscriptionEditorEvents.WebEventArgumentNotifyAddressId |
|
|
notifyAddressMode | 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. |
39025 |
EnumSubscriptionEditorEvents.WebEventArgumentNotifyAddressMode |
|
|
notifyAddressValue | Argument to specify the notification address name for the subscription. |
39023 |
EnumSubscriptionEditorEvents.WebEventArgumentNotifyAddressValue |
|
|
notifyDeviceID | 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. |
39024 | ||
|
overwrite | Argument to indicate to overwrite any existing schedules when creating Schedule subscription. |
39009 |
EnumSubscriptionEditorEvents.WebEventArgumentOverwriteSchedule |
|
|
protectZipFile | Indicates whether to protect the zip file. |
39036 | ||
|
rangeAll | Argument to indicate the all pages option for scheduled print. |
39021 | ||
|
rangeEnd | Argument to indicate the end page for scheduled print. |
39020 | ||
|
rangeStart | Argument to indicate the start page for scheduled print. |
39019 |
EnumSubscriptionEditorEvents.WebEventArgumentPrintRangeStart |
|
|
reuseMsg | 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. |
39008 | ||
|
sendNow | Argument to specify if we need a preview of an email subscription immediately. A value of "1" signifies that we need an immediate preview. |
39005 | ||
|
sendToInbox | Argument to send data to inbox |
39032 | ||
|
useSeparateSheets | Argument to specify whether to use separate sheets when expanding the page by elements. |
39028 |
EnumSubscriptionEditorEvents.WebEventArgumentExpandUseSeparateSheets |
|
|
zipPwd | Argument to indicate the zip file password |
39034 |
EnumSubscriptionEditorEvents.WebEventArgumentZipFilePassword |
|
Notes
* denotes required field.