Supported Bean: SubscriptionBean

This bean represents a Narrowcast subscription. This helps you to manage subscriptions to reports and documents that will be delivered as The important functionality this bean provides is: This bean can be created using WebBeanFactory.newSubscriptionBean() Once created, the bean needs to associated with a content, a trigger and an address before it can be saved The content is defined using a valid report/document. This is set using SubscriptionBean.setContent(String, int). The trigger to be used with this subscription is defined using SubscriptionBean.setTriggerID(String). The address to be used with this subscription is defined by adding a new address ID to the list retrieved using SubscriptionBean.getAddresses().

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_SUBSCRIPTION (256)

Event handler that can be associated with a Subscription Bean.

Events

cancel, deleteSubscription, includePromptEditing, removeRecipient, saveCacheSubscription, saveEmailSubscription, saveFileSubscription, saveFTPSubscription, saveHistoryListSubscription, saveMobileSubscription, savePersonalViewSubscription, savePrintSubscription, setAlertingContent, setSubscriptionCacheProps, setSubscriptionEmailProps, setSubscriptionFileProps, setSubscriptionFTPProps, setSubscriptionHistoryListProps, setSubscriptionMobileProps, setSubscriptionPersonalViewProps, setSubscriptionPrintProps

cancel
Calls cancel on the SubscriptionBean.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_CANCEL

deleteSubscription
Deletes the current subscription

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_DELETE

*_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

includePromptEditing
include personalization in edit mode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_INCLUDE_PERSONALIZATION_EDITING

removeRecipient
remove a recipient using contact ID or/and address ID.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_REMOVE_RECIPIENT

addId

Argument specifying the address ID.

As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

256003

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

contactID

contact id

256060

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_ID

emailDestinationType

destination type

256061

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_DESTINATION_TYPE

locationKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

saveCacheSubscription
Event to save the cache subscription

256092

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_CACHE

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

bookmarkType

256111

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BOOKMARK_TYPE

cacheType

Use to take "Cache Type" value for RWD

256096

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CACHE_TYPE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyAllConsumers

256110

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY_ALL_CONSUMERS

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

recipients

256109

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RECIPIENTS

ReuseDataSetCache

Used to take "use valid dataset caches" value for RWD

256095

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_DATASET_CACHE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

shortcutCacheFormatMobile

256098

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_MOBILE

shortcutCacheFormatMobileSelectedType

Use to take "Shortcut Cache Format" valueq

256112

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_ANDROID_IOS_SELECTED_STATUS

shortcutCacheFormatWeb

Use to take "Shortcut Cache Format" value for RWD

256097

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_WEB

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

saveEmailSubscription
saves the current SUBSCRIPTION. This accepts all arguments that are accepted by EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_STATE.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE

addressID

Argument specifying the address ID.

As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

256003

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

addressValuesBCC

Address values created on the fly for BCC field

256058

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_BCC

addressValuesCC

Address values created on the fly for CC field

256057

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_CC

addressValuesTo

Address values created on the fly for To field

256056

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_TO

alertSendDiffContent

Argument that indicates whether to send a different report or document for the alert

256066

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_SEND_DIFFERENT_CONTENT

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

burst

Space Delimiter for Filename saved for scheduled file subscription.

256082

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST

burstAddressId

Email bursting - Address id include Attribute Id and Form Id that concatenated with delimiter '~'

256088

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_ADDRESS_ID

burstDeviceId

Email bursting - Device Id

256089

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_DEVICE_ID

burstLayoutKey

256113

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_LAYOUT_KEY

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

compressedFileName

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

dataLinkHistoryList

Argument that contains the EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK, EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX arguments concatenated using a "," separator. This is useful if the event wants to combine the above arguments into a set of options and send them all in using 1 argument.

256062

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DATA_LINK_HISTORY_LIST

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

deviceID

Argument specifying the ID of the device.

256009

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID

emailSubject

Argument specifying the email subject.

256010

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

filenameSpaceDelimiter

Space Delimiter for Filename saved for scheduled file subscription.

256081

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME_SPACE_DELIMITER

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

incData

Indicates if the data needs to be included in the subscription

256046

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

includeType

Argument for setting the include/destination type for email subscriptions. From EnumDSSXMLNCSEmailDestinationType

256071

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_TYPE

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

protectZipFile

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

sendToInbox

Indicates if the content should be sent to History List

256045

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

saveFileSubscription
Event to save a file subscription.

256010

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_FILE

*locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

burst

Space Delimiter for Filename saved for scheduled file subscription.

256082

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST

burstingLowerBound

Argument to specify the bursting segment lower bound

256078

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_LOWERBOUND

burstingUpperBound

Argument to specify the bursting segment upper bound

256079

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_UPPERBOUND

burstLayoutKey

256113

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_LAYOUT_KEY

burstSubFolder

File bursting - sub folder

256090

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_SUB_FOLDER

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

filenameSpaceDelimiter

Space Delimiter for Filename saved for scheduled file subscription.

256081

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME_SPACE_DELIMITER

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

isBursting

Argument to indicate if it's a bursting subscription

256077

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_BURSTING

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

protectZip

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipFilename

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

saveFTPSubscription
Event to save a FTP subscription.

256024

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_FTP

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

copies

Number of copies for in a scheduled print subscription.

256022

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COPIES

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

filenameSpaceDelimiter

Space Delimiter for Filename saved for scheduled file subscription.

256081

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME_SPACE_DELIMITER

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

protectZip

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipFilename

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

saveHistoryListSubscription
Event to save the history list subscription

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_HISTORY_LIST

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

saveMobileSubscription
Event to save a mobile subscrition

256019

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_MOBILE

alertSendDiffContent

Argument that indicates whether to send a different report or document for the alert

256066

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_SEND_DIFFERENT_CONTENT

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

badgeMetricId

Argument to specify the metric used for update badge

256083

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BADGE_METRIC_ID

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

isPushNotify

Argument to control will send push notification or not

256084

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_PUSH_NOTIFY

isUpdateBadge

Argument to control Is update badge or not

256085

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_UPDATE_BADGE

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mobileAppDeviceID

Argument for the mobile device ID

256087

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_APP_DEVICE_ID

mobileClientType

Argument to specify the client type for mobile subscriptions (from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType)

256076

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_CLIENT_TYPE

msgTitle

Argument specifying the email subject.

256010

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

savePersonalViewSubscription

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_PERSONAL_VIEW

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

isPVPublic

Argument to control whether a personal view subscription is private or public.

256086

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_PERSONAL_VIEW_PUBLIC

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

objectSubType

Integer argument to specify a content's subtype

256075

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

viewMode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

savePrintSubscription
Event to save a print subscription.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE_PRINT

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

copies

Number of copies for in a scheduled print subscription.

256022

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COPIES

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

isCollated

Whether printed pages should be collated.

256024

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_COLLATED

isPortrait

Whether printing is in portrait or landscape mode.

256023

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_PORTRAIT

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

printAll

Whether to print all pages.

256040

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PRINT_ALL

rangeEnd

Page number to print to (also see EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START).

256026

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END

rangeStart

Page number to begin printing (also see EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END).

256025

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

setAlertingContent
For an alerting subscription, you can send a different report or document. This event will set the alerting content on the subscription.

256018

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_ALERTING_CONTENT

*alertContentObjID

DSS ID of the report or document that is sent in the alert

256064

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_CONTENT_DSS_ID

*alertContentObjType

Type, from EnumDSSXMLObjectTypes, of the report or document.

256065

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_CONTENT_TYPE

setSubscriptionCacheProps
Event to set properties for a cache subscription

256091

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_CACHE_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

bookmarkType

256111

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BOOKMARK_TYPE

cacheType

Use to take "Cache Type" value for RWD

256096

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CACHE_TYPE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyAllConsumers

256110

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY_ALL_CONSUMERS

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectSubType

Integer argument to specify a content's subtype

256075

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

recipients

256109

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RECIPIENTS

ReuseDataSetCache

Used to take "use valid dataset caches" value for RWD

256095

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_DATASET_CACHE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

shortcutCacheFormatMobile

256098

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_MOBILE

shortcutCacheFormatMobileSelectedType

Use to take "Shortcut Cache Format" valueq

256112

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_ANDROID_IOS_SELECTED_STATUS

shortcutCacheFormatWeb

Use to take "Shortcut Cache Format" value for RWD

256097

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SHORTCUT_CACHE_FORMAT_WEB

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

setSubscriptionEmailProps
Initializes the state of the SubscriptionBean for email subscriptions. The content parameters are used only if the content is not already set. If the address input type is specified as 0, then the address values are ignored and only the addressID is used

256003

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_EMAIL_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

addressID

Argument specifying the address ID.

As of MicroStrategy Web 8.0.1, setting this argument will clear all other addresses in SubscriptionBean.getAddresses().

256003

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

addressValuesBCC

Address values created on the fly for BCC field

256058

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_BCC

addressValuesCC

Address values created on the fly for CC field

256057

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_CC

addressValuesTo

Address values created on the fly for To field

256056

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES_TO

alertSendDiffContent

Argument that indicates whether to send a different report or document for the alert

256066

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_SEND_DIFFERENT_CONTENT

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

burst

Space Delimiter for Filename saved for scheduled file subscription.

256082

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST

burstAddressId

Email bursting - Address id include Attribute Id and Form Id that concatenated with delimiter '~'

256088

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_ADDRESS_ID

burstDeviceId

Email bursting - Device Id

256089

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_DEVICE_ID

burstLayoutKey

256113

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_LAYOUT_KEY

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

compressedFileName

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

dataLinkHistoryList

Argument that contains the EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK, EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX arguments concatenated using a "," separator. This is useful if the event wants to combine the above arguments into a set of options and send them all in using 1 argument.

256062

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DATA_LINK_HISTORY_LIST

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

deviceID

Argument specifying the ID of the device.

256009

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DEVICE_ID

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

emailSubject

Argument specifying the email subject.

256010

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

incData

Indicates if the data needs to be included in the subscription

256046

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_DATA

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

includeType

Argument for setting the include/destination type for email subscriptions. From EnumDSSXMLNCSEmailDestinationType

256071

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_TYPE

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectSubType

Integer argument to specify a content's subtype

256075

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

protectZipFile

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

sendToInbox

Indicates if the content should be sent to History List

256045

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_TO_INBOX

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

setSubscriptionFileProps
Properties associated with a file subscription.

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_FILE_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

burst

Space Delimiter for Filename saved for scheduled file subscription.

256082

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST

burstingLowerBound

Argument to specify the bursting segment lower bound

256078

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_LOWERBOUND

burstingUpperBound

Argument to specify the bursting segment upper bound

256079

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURSTING_UPPERBOUND

burstLayoutKey

256113

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_LAYOUT_KEY

burstSubFolder

File bursting - sub folder

256090

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BURST_SUB_FOLDER

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

isBursting

Argument to indicate if it's a bursting subscription

256077

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_BURSTING

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

protectZip

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipFilename

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

setSubscriptionFTPProps
Properties associated with a FTP subscription.

256023

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_FTP_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

copies

Number of copies for in a scheduled print subscription.

256022

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COPIES

delimiter

delimiter for bulk export format

256059

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_DELIMITER

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

enableFooter

256105

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_FOOTER

enableHeader

256104

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HEADER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fileName

File name saved for scheduled file subscription.

256021

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FILE_NAME

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

htmlDelayTime

256107

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_HTMLCONTAINER_DELAY_TIME

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mode

256099

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_MODE

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

OtherDelimeter

user defined delimiter for bulk export format

256072

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_OTHER_DELIMITER

overviewViz

256106

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_OVERVIEW

pageOrientation

256103

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAGEORIENTATION

paperHeight

256101

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERHEIGHT

paperWidth

256102

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PAPERWIDTH

pdfPwd

256108

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_PDF_PWD

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

protectZip

Indicates whether to protect the zip file.

256049

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROTECT_ZIP_FILE

range

256100

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPORT_RANGE

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS

zipFilename

Indicates compression file name.

256069

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COMPRESSED_FILE_NAME

zipPwd

Indicates the password if the file needs to be compressed

256047

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_PASSWORD

setSubscriptionHistoryListProps
Event to set properties for a history list subscription

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_HISTORY_LIST_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

incLink

Indicates if we need to include a link to the content

256068

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_INCLUDE_LINK

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectSubType

Integer argument to specify a content's subtype

256075

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

setSubscriptionMobileProps
Event to set properties for a history list subscription

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_MOBILE_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

alertSendDiffContent

Argument that indicates whether to send a different report or document for the alert

256066

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALERT_SEND_DIFFERENT_CONTENT

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

badgeMetricId

Argument to specify the metric used for update badge

256083

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_BADGE_METRIC_ID

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

isPushNotify

Argument to control will send push notification or not

256084

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_PUSH_NOTIFY

isUpdateBadge

Argument to control Is update badge or not

256085

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_UPDATE_BADGE

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

mobileAppDeviceID

Argument for the mobile device ID

256087

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_APP_DEVICE_ID

mobileClientType

Argument to specify the client type for mobile subscriptions (from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType)

256076

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MOBILE_CLIENT_TYPE

msgTitle

Argument specifying the email subject.

256010

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EMAIL_SUBJECT

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

overwriteOlder

Argument for the overwrite older version of the History List message. Used for Subscriptions to history list.

256063

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_OVERWRITE_OLDER_VERSION

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

setSubscriptionPersonalViewProps

256022

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_PERSONAL_VIEW_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectSubType

Integer argument to specify a content's subtype

256075

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_SUBTYPE

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

setSubscriptionPrintProps
Properties associated with a print subscription.

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SET_PRINT_PROPERTIES

_subscriptionID

Argument specifying the subscription ID.

256001

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_ID

addressType

When set to 1, new subscriptions are created with addresses EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES. Otherwise, on a 0, existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID is used instead. If a value is not specified for this argument, then both EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES and EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_ID arguments are used

256013

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_INPUT_TYPE

addressValues

argument specifying a list of addresses.

256008

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ADDRESS_VALUES

allowDelSettings

Indicates the boolean to allow changing delivery settings.

256050

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_DELIVERY_SETTINGS

allowPers

Indicates the boolean to allow changing personalization.

256051

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_CHANGE_PERSONALIZATION

allowUnsub

Indicates the boolean to allow unsubscribing

256052

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ALLOW_UNSUBSCRIBE

cmsg

Message to be saved along with the email subscription.

256015

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CUSTOM_MESSAGE

contactSecurity

Argument to specify the contact security for each contact group member

256080

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTACT_SECURITY

copies

Number of copies for in a scheduled print subscription.

256022

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_COPIES

editMode

Denotes the edit mode. Should be a value from EnumWebSubscriptionEditModes

256012

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EDIT_MODE

elementsPromptAnswers

Plain element prompt answer.

256029

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_ELEMENT_PROMPT_ANSWER

expirationDate

Indicates the expiration date of the subscription

256048

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPIRATION_DATE

expLayouts

Argument to specific whether we need to delivery all layouts when the subscription is run

256074

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_EXPAND_LAYOUTS

fModeExAll

Denotes whether the only the current page, or all pages is applied to the subscription.

256041

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE

fModeSep

Denotes whether multiple pages should be separated (value of "1") on different worksheets - currently only applicable to Excel exports.

256042

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_FORMAT_MODE_SEPARATED_PAGES

fstate

The serialized state of the delivery format.

256016

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_FORMAT_STATE

isCollated

Whether printed pages should be collated.

256024

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_COLLATED

isPortrait

Whether printing is in portrait or landscape mode.

256023

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_IS_PORTRAIT

locKey

Location key for file and print scheduled subscriptions.

256020

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_LOCATION_KEY

messageID

Argument specifying the message ID.

256006

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_MESSAGE_ID

notify

When set to 0, notification is turned off, otherwise its turned on.

256039

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFY

notifyAddressID

Subscription notification is sent to this existing address.

256035

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID

notifyAddressMode

When set to 1 it indicates that the new address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE should be used for the new subscription, while 0 indicates an existing address EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_ID should be used instead. A value of 2 indicates notification be sent to default email addresses of child recipients.

256038

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_MODE

notifyAddressValue

Subscription notification is sent to this new address.

256036

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_ADDRESS_VALUE

notifyDeviceID

Notification device ID.

256037

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_NOTIFICATION_DEVICE_ID

objectID

Argument specifying the content object ID.

256004

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_ID

objectsPromptAnswers

Plain objects prompt answer.

256044

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_OBJECT_PROMPT_ANSWER

objectType

Argument specifying the content object type (see EnumDSSXMLObjectTypes).

256005

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_CONTENT_OBJECT_TYPE

originMessageID

Origin message ID.

256027

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_MESSAGE_ID

printAll

Whether to print all pages.

256040

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PRINT_ALL

promptAnswerMode

256114

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PROMPT_ANSWER_MODE_OPTION

promptsAnswerXML

Origin short answer XML.

256028

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ORIGIN_SHORT_ANSWER_XML

rangeEnd

Page number to print to (also see EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START).

256026

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END

rangeStart

Page number to begin printing (also see EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_END).

256025

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_RANGE_START

sendNow

Argument specifying whether send now should be set.

256011

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SEND_NOW

stateID

Argument specifying the state ID.

256007

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_STATE_ID

subName

Argument for specifying the name of the subscription

256070

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_SUBSCRIPTION_NAME

triggerID

Argument specifying the trigger ID.

256002

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_TRIGGER_ID

useExpDate

Argument to specify whether the subscription should be saved with an expiration date or not.

256073

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_USE_EXPIRATION_DATE

valuePromptAnswers

Plain value prompt answer.

256043

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_PLAIN_VALUE_PROMPT_ANSWER

vmode

Specifies the view mode for the report EnumWebReportViewMode.

256014

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_VIEW_MODE

zip

Indicates whether the format should be zipped.

256017

EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_ARGUMENT_ZIP_CONTENTS


Notes

* denotes required field.