Widget Use
| Excerpt |
|---|
Provides Renders input field and button configurations for the Report Subscription feature. You can customise the widget to configure display field options and text to suit your website stylescreen. Field labels, headings and text can be edited. |
Example of Widget Use
The following is an example of the widget in use.
| Report Subscription Search and Search Results |
|---|
 Image Removed Image Added
|
Where can the Widget be placed?
...
- Report Subscription Template
Implementation guides
Widget Options
Note - some fields display only if in use
| Option | Use | Comments | Available from Version |
|---|
| Description | A short description of the widget's use. | We recommend this field be updated so the widget's purpose is clear at a glance from the template page. | All |
| Layer | The layer the widget is valid for. | The layering technology allows for the content to be shown to specific audiences. This is handy if the content is only valid for a certain type of user, or if the same widget is required for more than one audience, but different configuration is needed. The widget can be added to the zone more than once and the layer feature can determine which audience can see each widget. | All |
| Show Active And Inactive Reports Flags? | By default, the system selects active reports only for Search. If toggled ON, the 'Show Active Reports' and 'Show Inactive Reports' checkboxes appear in the Search Reports function. |
Image Removed Image Added
| Default: ON ON: Both checkboxes appear. This allows users to find both active and inactive reports, or just inactive reports. OFF: Checkboxes do not appear. Users cannot select inactive reports. | 4.23 |
| Page Size | This sets the maximum number of pages to display search results. | Default: 20 | 4.23 |
| Labels |
| Expand |
|---|
| title | Click to view where input from a field is displayed in Report |
|---|
|
|
Generator
Image Removed
Image Removed
Image Removed |  Image Added
 Image Added
 Image Added
|
|
|
1. Search Subtitle Label | The heading displayed for the Reports Search field. | | 4.23 |
2. Search Show Active Label | Label for the Active Reports checkbox. | Default: Show Active Reports | 4.23 |
| 3. Search Show Inactive Label | Label for the Inactive Reports checkbox |
. | Default: Show Inactive Reports | 4.23 |
| 4. Report Name Label | Heading for the report name in |
the section | Default: Report Name | 4.23 |
| 5. Report Description Label | Heading for the |
report description | Report Description column in |
the section | Default: Report Description | 4.23 |
| 6. Report |
Name Criterion report name field| Report ID column in Search Results | Default: Report |
NameReport Format Criterion | Subscription Recipient Email Address Label |
Heading report format dropdown list | recipient email address field | Default: |
Report Format| Recipient Email Address | 4.23 |
| 8. |
Notes Criterion | Subscription Start Date Label |
Heading Notes textbox| Subscription Start Date field | Default: |
NotesFirst Group By | Subscription End Date Label |
Text for first group by field (displayed only if 'group by' is used when report was created)| Label for the Subscription End Date field | Default: |
FirstSecond Group By | Subscription Frequency Label |
Text for second group by field (displayed only if 'group by' is used when report was created)| Label for the scheduling frequency dropdown list | Default: |
Second Third Group By LabelText for third group by field (displayed only if 'group by' is used when report was created) | Default: Third| Subscription Active Label | Text for the checkbox to make subscription active/inactive | Default: Active | 4.23 |
| 12. |
First Sort By | Subscription Last Run Date Label |
Text for first sort by field | Heading text for the last run date column in Manage Subscriptions section (displayed only if |
'sort by' is used when report was created| the report has a subscription) | Default: |
FirstSecond Sort By LabelText for second sort by field (displayed only if 'sort by' is used when report was created) | Default: Second| Subscription Log Recipient Email Address Label | Text for email recipient column in Subscription Log | Default: Recipient Email Address | 4.23 |
| 14. |
Third Sort By | Subscription Log Sent Date Time Label | Text for |
third sort by field (displayed only if 'sort by' is used when report was created)| date/time column in Subscription Log | Default: |
ThirdSort By Ascending | Subscription Log Status Label | Text for |
checkbox to display results from ascending/descending order | Log Status column in Subscription Log | Default: |
AscendingEdit Report Selection Criteria Button LabelText on button to open report selection criteria for editing | Default: Edit Report Selection Criteria| Subscription Log Cc Label | Text for Cc recipient column in Subscription Log | Default: Cc | 4.23 |
| 17. |
Hide Report Selection Criteria Button Label Text on button to hide report selection criteria (appears only when report search criteria is displaying) | Default: Hide Report Selection Criteria| Subscription Log Bcc Label | Text for Bcc recipient column in Subscription Log | Default: Bcc | 4.23 |
| 18. Clear Search Button Label | Text on button to clear current report search | Default: Clear | 4.23 |
| 19. Search Button Label | Text on button to initiate search for report | Default: Search |
4.23 | | 20. Generate Button Label | Text on button to initiate report generation | Default: Generate | 4.23 |
| 21. Subscribe Button Label | Text on button to subscribe to report. (Displays only after report generated and if report can be subscribed to) | Default: Subscribe | 4.23 |
22. Cancel Button Label | Text on button to cancel report generation | Default: Cancel| 23. Close Button Label | Text on button to close report selection criteria panel. (Displays only after report has been generated) | Default: Close | 4.23 |
| 24. Reset Button Label | Text on button to clear report selection criteria fields. Display only after report has been generated) | Default: Clear | 4.23 |
| Prompts |
| 1. Search Title Prompt | Report Search section heading | Default is: Search | 4.23 |
| 2. Search Results Title Prompt | Search Results section heading | Default: Search Results | 4.23 |
| 3. |
Report Selection Criteria Title | No Reports Available Prompt |
Report Selection Criteria heading| Text displayed when a Search finds no reports | Default: |
Report Selection Criteria| There were no reports found. | 4.23 |
| 4. No |
Reports | Subscriptions Available Prompt | Text |
to display when no reports are found| displayed when the user clicks the Subscribe button for a report and there are no current subscriptions | Default: |
There were no reports found.| There are currently no subscription log records for {0}. | 4.23 |
| Notifications |
Report Generated Subscription Message | Text that appears to alert user that report has been generated and can be subscribed to.  Image Removed
| Default is: A new report has been generated and ready to subscribe| 5. Delete Report Has Subscribers | Text displayed in popup message when a user tries to delete a report that has current subscriptions | Default: Cannot delete this report, still have some subscribers. | 4.23 |
Report Generated No Subscription Message | Text that appears to alert user that report has been generated but cannot be subscribed to. | Default is: A new report has been generated but not enabled to subscribe.| 6. Delete Report Confirmation Prompt | Text displayed when a user clicks the Delete Report button. | Default: Are you sure you want to delete this report? | 4.23 |
| 7. Delete Report Error Prompt | Text displayed when user-initiated deletion fails | Default: There was an error while deleting this report, please try again | 4.23 |
Related Help
| Content by Label |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| cql | label = "generating-reportsreporting" |
|---|
|
Related Widgets
| Content by Label |
|---|
| showLabels | false |
|---|
| spaces | KB |
|---|
| showSpace | false |
|---|
| sort | creation |
|---|
| excerpt | true |
|---|
| reverse | true | excerptType | simple |
|---|
| title | Related widgets |
|---|
| excludeCurrent | true |
|---|
| operator | AND |
|---|
| cql | label = "report-subscription-widget" and label space = "widgetKB" and space = "KBtitle ~ "Report Generator" |
|---|
| labels | widget cms |
|---|
|