Documentation
Note: This documentation is currently a work in progress.

Ways to give informations to the publishers

Open in Admin Area

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam in dui mauris.

General instructions Page

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam in dui mauris.

Messages for the users dashboard

This feature allows you to display a message on the users dashboard with the following options.


Basic Information

Text

What it does:

This field holds the main content of your news item. It allows you to provide announcements, instructions, or any essential information that publishers need to read. The field utilizes a rich text editor, enabling you to format the text with bolding, italics, lists, and links. It is a required field, meaning a news item cannot be saved without content.


Where it appears / Effect:

The formatted content of this field appears prominently on the main dashboard for all publishers when they log in, provided the news item is active according to its start and end dates. If the user dismisses the news (if permitted), it is moved from the immediate view to an archive or hidden section, depending on their personal reading state. The text is displayed exactly as formatted in the editor, ensuring all styling and links are preserved when shown to the reader.


Validity Settings

Start date

What it does:

This setting defines the earliest date on which the news item becomes active and visible to publishers. By default, it is set to the current date when creating a new item. This allows you to schedule announcements in advance. The system will automatically check this date against the current day to determine if the news should be shown.


Where it appears / Effect:

This setting is strictly an internal control mechanism and does not display the actual date text to the publishers reading the news. Its sole effect is determining whether the news item appears on the publisher's dashboard. Before this date, the news item remains completely hidden from all regular publishers. Starting at midnight on this date, the item will automatically become visible on the dashboard. In the administrative news list, this date is visible to help administrators track when items are scheduled to go live.

End date

What it does:

This setting establishes the final date that the news item will remain active and visible to publishers. It works in conjunction with the start date to create a window of visibility. The end date must be the same as or chronologically after the start date. Once this date has passed, the news item is automatically deactivated.


Where it appears / Effect:

Similar to the start date, the end date itself is not shown to publishers reading the news. Its effect is the automatic removal of the news item from the publisher's dashboard at the end of the specified day. After this date, publishers will no longer see the announcement when they log in. For administrators viewing the news management list, this date helps identify which announcements are currently active and which have expired.


Reader Interaction

Mark as read

What it does:

This optional checkbox determines whether publishers are allowed to dismiss the news item from their personal view once they have seen it. If enabled, the system tracks the read status of this specific news item for each individual publisher. This is useful for important information that needs to stay visible until the user explicitly acknowledges it.


Where it appears / Effect:

When this option is enabled, an interactive button or checkbox (typically labeled with the translated "Mark as read" text) will appear directly beneath the news content on the publisher's dashboard. Clicking this button immediately hides the news item from their view for all future logins, even if the end date has not yet passed. If this option is not checked during creation, the news item will persistently remain on the dashboard for every publisher until the end date is reached, without any option for them to remove it.

Hints for specific dates

This feature shows a message for specific items and/or dates. The hints can be shown:

  • On the public calendar view
  • In daily summary emails
  • In exported schedules or PDF printouts

Basic Information

Name of the event

What it does:

This setting defines the primary title or name of the hint. It acts as the main identifier for the event or notification you are creating, giving users immediate context about what the hint pertains to.


Where it appears / Effect:

The name of the event appears prominently in the administrative list of hints on the admin dashboard. It is also displayed as the main heading when a publisher clicks on a specific day on the public calendar view to see the day's details. Furthermore, this name is included in any exported schedules or PDF printouts that list hints for specific days.

Description

What it does:

This rich-text field allows administrators to provide comprehensive details, instructions, or additional context about the event. It supports formatting, allowing you to highlight important information, create lists, or structure the content to make it easily readable for publishers.


Where it appears / Effect:

The description is shown directly below the event name when a publisher views the specific day's details on the public calendar view. It provides the core message or instruction for the users checking the schedule for that day. It may also appear in the daily summary emails sent to coordinators or participants.

Location

What it does:

This option specifies the physical address, meeting point, or digital platform (like a video conference room name) where the event or activity is taking place.


Where it appears / Effect:

The location is displayed alongside the event name and description when viewing the daily details on the public calendar view. It helps publishers know exactly where they need to go. If an event is printed on the monthly PDF calendar schedule, the location text will be printed next to the event name.

URL for more information

What it does:

This field allows administrators to attach a clickable hyperlink to the hint. It is used to direct users to external resources, detailed documentation, online maps, or a dedicated webpage related to the event.


Where it appears / Effect:

The URL is rendered as a clickable link within the day's detailed view on the public calendar. When a publisher clicks on the specific day on the calendar, they will see this link and can follow it to external websites.


Schedule & Timing

Start date

What it does:

This configuration sets the initial date when the hint becomes active or the event begins. Combined with the end date and recurrence type, it determines the entire timeframe the hint covers.


Where it appears / Effect:

This setting determines on which specific days the hint icon or text appears on the monthly grid of the public calendar view. In the admin dashboard list of hints, this date is used to sort the items chronologically.

End date

What it does:

This setting defines the final date the hint is valid or the event concludes. The hint will not be shown on the calendar for any days past this date.


Where it appears / Effect:

Just like the start date, this directly controls the visibility of the hint on the public calendar view. The hint will stop appearing on the daily calendar slots after this date has passed.

Type

What it does:

This dropdown setting controls the recurrence pattern of the hint between the defined start and end dates.

  • does not repeat: Setting it to "Once" means the hint only applies to the specific selected dates.
  • Weekly: Setting it to "Weekly" means the hint will automatically duplicate itself every week on the specified weekdays until the end date is reached.
  • Annually: Setting it to "Annually" means the hint will repeat on the exact same date every year.

Where it appears / Effect:

This recurrence setting evaluates internally to generate the multiple calendar entries. On the public calendar view, users will see the hint repeating across different weeks or months according to the selected interval. It prevents administrators from having to manually create duplicate hints in the admin dashboard.

Weekdays (choice of "Mon, Tue, Wed, Thu, Fri, Sat, Sun", comma-separated)

On which weekdays will the event take place? Only relevant for weekly repeating events.

What it does:

When the event type is set to repeat "Weekly", this text input allows the administrator to specify exactly which days of the week the event occurs (e.g., "Mon,Tue,Wed"). It acts as a filter so that the weekly recurrence only populates on the desired days.


Where it appears / Effect:

This determines on which exact columns (days of the week) the hint will be injected on the public calendar view during its active period. For example, if "Wed" is entered, the hint will only show up on Wednesday calendar squares for the duration between the start and end dates.

Days

What it does:

This multi-select field allows administrators to hand-pick specific individual calendar dates for the hint, rather than relying on a structured recurrence rule.


Where it appears / Effect:

The hint will be explicitly displayed on the public calendar view only on the specific days selected in this list. When users click on these exact dates on the calendar, they will see the hint details.


Internal & Publisher Visibility Settings

Rating (1-5)

What it does:

This configuration categorizes the hint by its importance and intended audience. It helps in filtering and determining how prominently the event should be treated by the system and whether it should be actively promoted to standard users or kept for specific roles.

  • 1 - Planned actions: Marks the hint as a highly prioritized, officially planned campaign.
  • 2 - Publishers may use this at their own discretion.: Marks the hint as optional information that publishers can utilize if they choose to.
  • 3 - Unsuitable for information of the publishers: Marks the hint as internal administrative information that is not suitable or necessary for general publishers to read.

Where it appears / Effect:

The rating level dictates visual indicators on the public calendar view and within the administrative list. If set to highly prioritized (Rating 1), it may be highlighted with a specific color or icon on the public calendar day squares. If set to unsuitable for publishers (Rating 3), the hint is hidden from the standard public calendar view entirely and will only be visible to administrators or coordinators in the admin dashboard and specialized coordinator calendar views.

Send out newsletters

Open in Admin Area

This document provides a comprehensive guide to the Newsletter Management and Send-Out Workflow. It covers the creation, configuration, previewing, and reviewing of newsletters from the perspective of an administrator managing communications for the calendar.


Basic Information

These settings govern the primary content and identification of the email that will be sent.

Subject

What it does:

This setting determines the title of the newsletter. It provides the main contextual headline that tells the recipient what the communication is about before they even open the message.


Where it appears / Effect:

This text is combined with the system notification prefix and inserted into the subject line of the email delivered to the recipient's personal email inbox. It also serves as the primary identifier on the newsletter overview list in the admin dashboard and on the preview page before sending the newsletter.

Text

What it does:

This is the core content body of the newsletter. Using the provided text editor, an administrator can compose the message, applying standard formatting such as bolding, lists, and links. It contains the primary information meant to be conveyed to the selected audience.


Where it appears / Effect:

The formatted message is placed in the main body section of the actual email sent to the recipients. The content is wrapped within the standard email layout, ensuring it appears consistently above the standard system disclaimers (like the calendar link and unsubscribe instructions) at the bottom of the email.


Recipient Selection

These configuration options control exactly who receives the newsletter. The system allows precise targeting based on various user attributes.

Type (Recipient Selection Type)

What it does:

This dropdown setting dictates the overarching method used to filter the audience for the newsletter. Depending on the option chosen here, a corresponding secondary selection box will appear to further narrow down the exact target group.

Available Selection Types:

  • 1. All users: Targets every single person registered in the active calendar.
  • 2. Congregations: Reveals the "Congregation" multi-select field.
  • 3. Rights: Reveals the "Right" multi-select field.
  • 4. Roles: Reveals the "Role" multi-select field.
  • 5. Individual users: Reveals the "Publisher" multi-select field.

Where it appears / Effect:

This setting governs the behavior of the newsletter composition page. Changing this value immediately reveals specific secondary fields below it. It strictly determines which group of people will be loaded into the recipient list during the subsequent preview step.

Congregation

What it does:

When the recipient selection type is set to "Congregation", this setting allows the administrator to choose one or more specific congregations from a list. Only individuals who are assigned to the selected congregation(s) will be included in the mailing list.


Where it appears / Effect:

This field appears immediately below the "Type" dropdown on the newsletter composition page. The selections made here filter the total user base down to only the relevant congregation members when transitioning to the preview page.

Right

What it does:

When the recipient selection type is set to "Right", this setting enables the administrator to target users based on their assigned system privileges. For example, you can select specific rights to only message coordinators or those with specific administrative access. Note: The system-wide "Admin" right is excluded from this list.


Where it appears / Effect:

This multi-select box is displayed underneath the "Type" dropdown. The choices dictate the subset of users presented on the preview page, ensuring only individuals holding the chosen right(s) for the current calendar are contacted.

Role

What it does:

When the recipient selection type is set to "Role", this setting provides a list of specific functional roles defined within the calendar. An administrator can select one or multiple roles to restrict the newsletter distribution solely to individuals who have been assigned those roles.


Where it appears / Effect:

Located below the "Type" selector, selections here act as a strict filter. During the preview phase, the system cross-references all users against the chosen role IDs, adding only those with matching roles to the intended mailing list.

Publisher

What it does:

When the recipient selection type is set to "Individual users", this setting lists every single user registered in the calendar. The administrator can manually pick and choose exactly which distinct individuals should receive the message, bypassing broad grouping entirely.


Where it appears / Effect:

Visible under the "Type" dropdown upon selection. The specific names checked off in this list become the exclusive audience processed and displayed in the subsequent preview step prior to dispatch.


The Workflow: Sending and Reviewing

The newsletter module follows a distinct, multi-step process to ensure accuracy and prevent accidental broad communications.

1. Composition and Selection

The process begins on the newsletter creation page, where an administrator defines the core message (Subject and Text) and establishes the target audience using the Recipient Selection configurations detailed above. Upon saving, the newsletter enters a "draft" state, meaning it exists in the system but has not yet been dispatched.

2. Preview and Validation

After the draft is saved, the administrator is directed to a preview page. This page is a critical checkpoint. It evaluates the selected audience and splits them into two definitive groups:

  • Sendable Recipients: This list displays individuals from the chosen selection who have a valid email address configured and are eligible to receive emails. The system confirms their name, email, and congregation details.
  • Non-sendable Recipients: This list flags individuals from the selection who cannot receive the email. The system clearly indicates the reason for failure next to their name:
    • No Email: The individual has not provided an email address in their profile.
    • Bouncer: Previous attempts to email this person have failed (e.g., the address is invalid or rejecting mail), so the system automatically suppresses further sends.
    • Opt-out: The individual has specifically configured their profile or system settings to refuse email notifications.

The email can only be dispatched if there is at least one person in the "Sendable" list. Once confirmed, the system immediately queues the emails for delivery in the recipient's preferred language.

3. Review and History

Once dispatched, the newsletter transitions from a draft to a sent state, locked from further editing. On the main newsletter dashboard, administrators can review:

  • The original subject line.
  • A summary of the recipient selection criteria used.
  • The total count of emails successfully sent.
  • The exact timestamp of when the dispatch occurred.

Additionally, administrators can access a dedicated recipient list for any past newsletter, which provides a permanent, historical record of the specific email addresses that were targeted during that send.