Notification Templates

Overview

This guide provides step-by-step instructions for configuring automated notifications in timveroOS. Notifications enable timely communication with applicants, borrowers, and internal teams throughout the lending process. Proper configuration ensures stakeholders receive relevant information through their preferred communication channels without manual intervention.

Notification configuration builds on SDK-level notification events created by your development team. This guide focuses on the administrator tasks: verifying SDK prerequisites, configuring delivery gateways, creating notification templates, and testing notification delivery.

Business Context

Effective notification management provides:

Applicant Experience: Timely status updates, document requests, and payment reminders improve transparency and reduce support inquiries

Operational Efficiency: Automated alerts for manual reviews, escalations, and exceptions enable staff to focus on high-priority tasks

Compliance Support: Documented communication trails with timestamps and delivery confirmations support regulatory requirements

Team Coordination: Role-based notifications ensure relevant staff members are informed without unnecessary message volume

Prerequisites Check

CRITICAL: Before configuring notification templates, verify that SDK setup is complete. Notification templates require notification events to be created in code by your development team.

Required SDK Setup

Your development team must complete these SDK tasks before you can configure notifications:

1. NotificationEvent Classes Created: Java classes defining when notifications can trigger (e.g., LoanApprovedEvent, PaymentReminderEvent)

2. Event Types Registered: Each NotificationEvent has a unique event type identifier (e.g., "LOAN_APPROVED", "PAYMENT_REMINDER")

3. NotificationModel Classes: Data models exposing entity information to templates (application details, client information, payment data)

4. Recipient Types Defined: Specification of who can receive notifications (BORROWER, GUARANTOR, internal roles)

For complete SDK implementation requirements, contact your development team.

How to Verify Prerequisites

Follow these steps to confirm SDK setup is complete:

Step 1: Check Event Type Availability

1. Navigate to Admin Panel → Notifications

2. Click "Create New"

3. Examine the "Event Type" dropdown

4. Verify that expected event types appear in the list

Event type dropdown populated from SDK NotificationEvent classes

Step 2: Verify Recipient Types

1. In template creation form, check "Recipient Type" dropdown

2. Confirm required recipient types are available

3. Note: BORROWER is the only recipient type critical for business logic out-of-box. All other recipient types (GUARANTOR, AGENT, etc.) are custom and must be defined in SDK

Step 3: Test Variable Availability

1. Create a test template for an available event type

2. Access the variable hints or documentation

3. Verify that expected data fields are available for use in templates

What to Do If Prerequisites Are Incomplete

If Event Type Is Missing:

• Contact your development team

• Provide the event type name and triggering conditions needed

• Development team must create NotificationEvent class and deploy to your environment

• After deployment, the event type will appear in the admin panel

If Recipient Type Is Missing:

• Verify the recipient type is needed for your use case

• Contact development team to add recipient type to NotificationEvent configuration

• Only BORROWER is available by default - other types require SDK configuration

If Variables Are Missing:

• Check SDK NotificationModel class for the event type

• Development team must add properties to the model class to expose data

• After SDK update and deployment, new variables become available in templates

Configuration Process

Step 1: Verify SDK Event Types

Before creating templates, confirm that the event types you need are available.

Navigation Path: Admin Panel → Notifications → Create New

Verification Actions:

1. Click the "Event Type" dropdown in template creation form

2. Review the list of available event types

3. Each event type corresponds to a NotificationEvent class created in the SDK

Standard Event Types (Out-of-Box):

• USER_CREATED: Triggers when new user account is created

• PASSWORD_CHANGED: Triggers when user changes password

• PASSWORD_RESET: Triggers when user resets password

Note: Only the above password/user-related events are available out-of-box. All lending-specific events (APPLICATION_STATUS_CHANGE, LOAN_APPROVED, PAYMENT_REMINDER, DOCUMENT_REQUIRED, PAYMENT_RECEIVED, etc.) must be implemented in SDK by your development team.

If your required event type is not listed, SDK setup is incomplete - contact your development team before proceeding.

Step 2: Configure Notification Gateway

Before creating templates, configure the delivery channels (gateways) you'll use to send notifications.

Email Gateway (SMTP) Configuration

Navigation Path: Settings → Notifications → New Notification → Email Gateway

Required Settings:

1. SMTP Server Configuration

   • SMTP Host: mail.yourcompany.com

   • SMTP Port: 587 (TLS) or 465 (SSL)

   • Connection Security: TLS or SSL

   • Authentication: Username and password

2. Sender Information

   • From Email Address: [email protected]

   • From Name: Your Company Name

   • Reply-To Address (optional): [email protected]

3. Advanced Settings

   • Connection Timeout: 30 seconds

   • Max Recipients per Message: 50

   • Enable SMTP Debug Logging (for troubleshooting)

Testing SMTP Configuration:

1. Create a test notification template using an available event

2. Trigger the event (e.g., create a test user)

3. Verify notification email is received

4. Check spam folder if not received in inbox

5. Review server logs if delivery fails

Note: There is no "Test Connection" button in the Admin Panel. Testing is done by triggering actual notification events.

Common SMTP Issues:

Connection Refused: Verify SMTP host and port are correct; check firewall rules allowing outbound connections

Authentication Failed: Confirm username and password; some providers require app-specific passwords

TLS/SSL Errors: Ensure correct security setting (TLS vs SSL) matches your SMTP server requirements

SMS Gateway Configuration

Navigation Path: Settings → Notifications → New Notification → SMS Gateway

Important: SMS gateway integration requires custom SDK implementation. There are no pre-integrated SMS providers out-of-box. All SMS gateway options (Twilio, AWS SNS, or other providers) must be implemented at the SDK level by your development team.

Gateway Options (require SDK implementation):

• Twilio (custom integration)

• AWS SNS (custom integration)

• Other SMS providers via custom API integration

Required Settings:

1. Provider Selection: Choose your SMS gateway provider

2. API Credentials:

   • Account SID / API Key

   • Auth Token / API Secret

   • Sender Phone Number or Sender ID

3. Regional Settings:

   • Default Country Code

   • Character Encoding (UTF-8 for multi-language)

   • Message Length Limit (typically 160 characters)

Testing SMS Configuration:

1. Click "Send Test SMS" button

2. Enter test phone number with country code

3. Verify SMS is received on test device

4. Check provider dashboard for delivery status if not received

Messenger Gateway Configuration

Navigation Path: Settings → Notifications → New Notification → Messenger Gateway

Important: Messenger gateway integration requires custom SDK implementation. There are no pre-integrated messenger platforms out-of-box. All messenger integrations must be implemented at the SDK level by your development team.

Platform Options (require custom SDK integration):

• WhatsApp Business API (custom integration required)

• Telegram Bot API (custom integration required)

• Slack Webhooks (custom integration required)

Note: Once custom messenger integration is implemented in SDK, the Admin Panel configuration will depend on the specific implementation. Contact your development team for configuration requirements.

Typical Configuration Parameters (varies by implementation):

WhatsApp Business API (if implemented):

• Business Account ID

• API Access Token

• Phone Number ID

• Webhook Verification Token

Telegram Bot API (if implemented):

• Bot Token (from @BotFather)

• Bot Username

• Allowed Chat IDs or Groups

Slack Webhooks (if implemented):

• Webhook URL

• Default Channel

• Bot Username and Icon

Step 3: Create Notification Template

With gateways configured and SDK prerequisites verified, create notification templates that define message content and delivery rules.

Navigation Path: Admin Panel → Notifications → Create New

Template creation form with event type selection

Template Configuration Fields

1. Template Name (Required)

• Descriptive identifier for internal use

• Example: "Loan Approval - Email to Borrower"

• Use naming convention: [Event] - [Channel] - [Recipient]

2. Event Type (Required)

• Select from dropdown of available event types

• Dropdown populated from SDK NotificationEvent classes

• If event type is missing → SDK setup incomplete

3. Recipient Type (Required)

• Who receives this notification

• Options depend on SDK configuration - BORROWER is the standard option

• Other recipient types (GUARANTOR, PLEDGOR, AGENT, Organization Employees) are custom and must be defined in SDK

• Some event types may limit available recipient types

4. Gateway Type (Required)

• Delivery channel for notification

• Options: EMAIL, SMS (and other custom gateways implemented in SDK)

• Note: VOICE and LETTER gateway types may appear in dropdown but are placeholders only - they require custom SDK implementation to function

• Must have corresponding gateway configured in Step 2

5. Active Status

• Check to enable notification sending

• Uncheck to disable without deleting template

• Useful for seasonal or conditional notifications

6. Subject Line (For EMAIL and LETTER only)

• Message subject or title

• Supports variable substitution

• Example: "Loan Application {{application.id}} Approved"

7. Late Send Available

• Allow notifications to send outside business hours

• Relevant for 24/7 operations

• Note: Business hours are configured in SDK, not Admin Panel

• Unchecked = notifications queue until business hours (as defined in SDK)

8. Prevent Duplicate

• Prevent sending same notification multiple times to same recipient

• Enabled by default for most notification types

• Disable for recurring reminders or periodic updates

Template Content Creation

Use the WYSIWYG editor to design notification content with dynamic variables.

Template editor with variable hints panel showing available data fields

Editor Features:

Rich Text Formatting (EMAIL, LETTER):

• Bold, italic, underline text styling

• Font selection and sizing

• Text color and highlighting

• Bullet and numbered lists

• Hyperlinks and buttons

Variable Insertion:

• Click variable from hints panel to insert

• Syntax: {{ variableName }}

• Nested properties: {{ application.client.individualInfo.firstName }}

• Variable hints show available fields based on event type

Conditional Content:

{% if application.requestedAmount > 100000 %}
This is a high-value loan requiring additional review.
{% endif %}

Loops (for collections):

{% for document in requiredDocuments %}
- {{ document.name }}
{% endfor %}

Formatting Filters:

{{ application.requestedAmount | currency }}
{{ payment.dueDate | date('MM/dd/yyyy') }}
{{ application.condition.interestRate | numberformat('#,##0.00%') }}

Example Template Content

Email Template - Loan Approval:

Subject: Congratulations! Your Loan Application is Approved

<h2>Dear {{ application.client.individualInfo.firstName }},</h2>

<p>We're pleased to inform you that your loan application 
<strong>{{ application.id | slice(0, 8) | upper }}</strong> has been approved!</p>

<h3>Loan Details:</h3>
<ul>
  <li><strong>Approved Amount:</strong> {{ application.requestedAmount | currency }}</li>
  <li><strong>Interest Rate:</strong> {{ application.condition.interestRate | numberformat('#,##0.00%') }}</li>
  <li><strong>Term:</strong> {{ application.condition.termInMonths }} months</li>
</ul>

<h3>Next Steps:</h3>
<p>Your loan documents will be ready for signature within 2 business days. 
You'll receive another notification when documents are available.</p>

<p>Questions? Contact us at [email protected] or [phone].</p>

<p>Best regards,<br>
Your Lending Team</p>

SMS Template - Payment Reminder:

Payment due {{ payment.dueDate | date('MM/dd') }}: {{ payment.amount | currency }}
Account: {{ credit.id | slice(0, 8) | upper }}
Pay online or call [phone]

Saving and Activating Templates

Save Template:

1. Click "Save" button to save template configuration

2. Template is saved but inactive by default

3. Review template content and settings

Test Template:

1. Click "Test" button before activating

2. Select test entity (application, credit, etc.)

3. Enter test recipient email/phone

4. Verify notification sends correctly and content renders properly

Activate Template:

1. Check "Active" checkbox

2. Click "Save" to enable automatic notification sending

3. Template will now trigger on configured events

Step 4: Configure Event Parameters (If Applicable)

Some notification events support configurable parameters that control when notifications send. This allows administrators to adjust notification timing without code changes.

When to Use Event Parameters

Event parameters are available when the SDK NotificationEvent class defines them. Common use cases:

Payment Reminders: Configure how many days before due date to send reminder

• Event: PAYMENT_REMINDER

• Parameter: daysCount = 3

• Result: Notification sends 3 days before payment due

Status-Based Notifications: Specify which status changes trigger notifications

• Event: APPLICATION_STATUS_CHANGE

• Parameter: status = MANUAL_REVIEW

• Result: Notification only sends when status changes to MANUAL_REVIEW

Time-Based Thresholds: Set timing for escalation or follow-up notifications

• Event: APPLICATION_AGING

• Parameter: daysInactive = 7

• Result: Notification sends if application inactive for 7 days

Configuring Parameters

Step-by-Step:

1. Create Template: Start creating template for parameterized event type

2. Parameter Fields Appear: Additional fields display below standard template fields

3. Set Parameter Values:

   • Field name and type determined by SDK event definition

   • Enter appropriate value (integer, string, boolean, etc.)

   • Refer to parameter description for valid values

4. Save Template: Parameter values are saved with template configuration

5. Template Behavior: Notification only sends when event occurs AND parameter conditions match

Parameter Example: Payment Reminder

Scenario: Send payment reminders 3 days before due date

Configuration:

• Event Type: PAYMENT_REMINDER

• Parameter: daysCount = 3

• Recipient: BORROWER

• Gateway: SMS

• Content: "Payment due in 3 days: {{ payment.amount | currency }}"

Behavior:

• System checks daily for upcoming payments

• When payment is exactly 3 days away, notification triggers

• Borrower receives SMS reminder

Creating Multiple Templates for Same Event:

• Create second template with daysCount = 1 for 1-day reminder

• Both templates operate independently

• Borrower receives reminders at both 3 days and 1 day before due

Step 5: Test Notification

Always test notifications before relying on them in production.

Testing Approach:

1. Test Template Function

• Use "Check" button in template editor

• Select suitable test entity

• Enter test recipient contact information

• Verify notification sends and content renders correctly

2. Verify Variable Population

• Check that all variables show actual data (not {{ variable }} syntax)

• Confirm conditional logic displays appropriate content

• Test with different entity states to verify conditional rendering

3. Test Gateway Delivery

• Confirm notification arrives at test recipient

• Check delivery time (immediate vs delayed)

• Verify formatting in recipient's client (email app, SMS, etc.)

4. Validate Event Triggering (Staging Environment)

• Perform action that should trigger event

• Confirm notification sends automatically

• Check notification log for delivery status

5. Test Error Handling

• Test with missing contact information

• Verify appropriate error logging

• Confirm retry logic for failed deliveries

Troubleshooting

Event Type Missing from Dropdown

Problem: Expected event type doesn't appear in the event type dropdown when creating templates

Solution: SDK setup is incomplete. Contact development team with event type requirements.

Template Not Triggering

Problem: Template is configured and active, but notifications are not being sent when events occur

Solution Checklist:

• Template is Active

• Event is actually occurring

• Recipient has contact information

• Gateway is configured and tested

• Event parameters match conditions

• No errors in notification logs

Variables Not Displaying Correctly

Problem: Notification content shows {{ variable }} syntax instead of actual data

Solution: Check variable name spelling and capitalization (case-sensitive), verify property path is correct for nested objects.

Gateway Connection Failures

Problem: Gateway configuration test fails or notifications fail to deliver

Solution: Verify credentials, check firewall settings, confirm network connectivity to gateway servers.

Related Operations

Once configured, see how notifications are used in operations:

• Notifications (OPS - Origination) - Viewing notification history during origination

• Notifications (OPS - Servicing) - Viewing notification history for loans

Next Steps

With notifications configured, proceed to related system configuration:

• User Management - Configure employee notification subscriptions

• Document Templates - Set up document-related notification triggers

• Workflow Fundamentals - Configure workflow status notifications

• Product Architecture - Set up product-specific notification rules

---

For additional notification configuration support, contact your implementation team.