subscriptions
This configuration is optional when using the plugin Subscriptions.
-
Documentation
-
YAML Format
-
XML Format
| Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets. |
DEPRECATED: Replaced by publicCadenzaUrl in cadenzaweb-config.xml. If present, the option here will take precedence, though.
The base url of the target endpoint. Example: https://disy.net/trunk will result in https//disy.net/trunk/j/{JOBID} in the e-mail
Technical sender of the e-mail (e.g. reports@company.net). If no sender is configured, the e-mail address configured for the mail server is used.
Indication of whether the user can select usernames from the list of available users (username) when specifying e-mail recipients, or if usernames remain hidden and only e-mail addresses are allowed (none). Note: If configured (username), users will be suggested – even for users without the necessary system privilege.
Default: none
Enabling the direct entry of e-mail addresses.
"false" to prevent users from entering e-mail addresses and only allow them to select user names from the suggestion list.
If both recipientSuggestions and freeFormEmail are disabled, Cadenza falls back to "true" and allows entering e-mail addresses.
Default: true
One or more endings (endsWith) that a recipient's e-mail address must end with. This makes it possible to restrict the sending of e-mails to selected domains. Note: The endings specified here are only considered if users are allowed to directly enter e-mail addresses (see enabled). When selecting usernames, the associated e-mail address is not checked.
Restriction of the options available to users when setting frequencies in the subscription assistant (attribute enableEventDrivenReports). Depending on the frequency (yearly, monthly, weekly, daily, or hourly), the selection can be further limited to months, weekdays, or times.
“false” to deactivate the event-driven subscription of worksheets. In this case, step 2 “Condition” in the subscription wizard is omitted. Deactivation is intended for cases in which Cadenza is connected to a single sign-on system (e.g. SPNEGO, JSON Web Token (JWT) or OpenID Connect). It is not possible to check the condition in the context of the user with the systems mentioned. Note: Changing the attribute value has no effect on existing subscriptions.
Default: true
| This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. |
cadenzaconfig:
settings:
subscriptions:
defaultBaseResultUrl: "text"
email:
senderAddress: "text"
recipientSuggestions: "username"
freeFormEmail:
enabled: true
allowList:
- "text"
- "text"
whitelist:
- "text"
- "text"
footer: "text"
schedulingConfig:
enableEventDrivenReports: true
allowedFrequency:
- "YEARLY"
- "YEARLY"
allowedMonths:
- "JAN"
- "JAN"
allowedDays:
- "SUN"
- "SUN"
allowedTimestamps:
- "text"
- "text"Filename: subscriptions-config.xml
| This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptionsConfig>
<defaultBaseResultUrl>text</defaultBaseResultUrl>
<email>
<senderAddress>text</senderAddress>
<recipientSuggestions>username</recipientSuggestions>
<freeFormEmail>
<enabled>true</enabled>
<allowList>
<endsWith>text</endsWith>
<endsWith>text</endsWith>
</allowList>
</freeFormEmail>
<whitelist>
<endsWith>text</endsWith>
<endsWith>text</endsWith>
</whitelist>
<footer>text</footer>
</email>
<schedulingConfig enableEventDrivenReports="true">
<allowedFrequency>
<frequency>YEARLY</frequency>
<frequency>YEARLY</frequency>
</allowedFrequency>
<allowedMonths>
<month>JAN</month>
<month>JAN</month>
</allowedMonths>
<allowedDays>
<day>SUN</day>
<day>SUN</day>
</allowedDays>
<allowedTimestamps>
<timestamp>text</timestamp>
<timestamp>text</timestamp>
</allowedTimestamps>
</schedulingConfig>
</subscriptionsConfig>