Skip to content

Commit 45b13bd

Browse files
committed
Updated docs
1 parent 5d7a33d commit 45b13bd

30 files changed

Lines changed: 744 additions & 12 deletions

File tree

docs/b1-admin/attendance/check-in.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,41 @@ Only Brother label printers are compatible with the B1 Checkin app. Other printe
6565
Follow your printer's setup instructions to connect it to the same WiFi network as your tablet. You can find Brother printer drivers and setup guides on the [Brother support site](https://support.brother.com).
6666
:::
6767

68+
## Customizing the Kiosk Appearance
69+
70+
You can customize the look and feel of the B1 Checkin app to match your church's branding. In B1 Admin, go to **Attendance > Kiosk Theme** to configure:
71+
72+
### Colors
73+
74+
Customize eight color settings to match your church branding:
75+
76+
- **Primary** and **Primary Contrast** -- Main brand color and its text color.
77+
- **Secondary** and **Secondary Contrast** -- Accent color and its text color.
78+
- **Header Background** and **Subheader Background** -- Colors for the kiosk header areas.
79+
- **Button Background** and **Button Text** -- Colors for interactive buttons.
80+
81+
### Background Image
82+
83+
Upload an optional background image for the kiosk welcome and lookup screens. Recommended size is 1920x1080 pixels.
84+
85+
### Idle Screen / Screensaver
86+
87+
Configure a screensaver that activates after a period of inactivity:
88+
89+
1. Toggle the idle screen **on** or **off**.
90+
2. Set the **timeout** (how many seconds of inactivity before the screensaver starts, minimum 10 seconds).
91+
3. Add one or more **slides** -- each slide has an image and a display duration (minimum 3 seconds).
92+
93+
:::tip
94+
Use the idle screen to display announcements, upcoming events, or welcome messages when the kiosk is not actively being used.
95+
:::
96+
97+
## Guest Registration via QR Code
98+
99+
The check-in kiosk can display a QR code that visitors scan to register themselves and their family on their own phone. This speeds up the check-in process for first-time guests.
100+
101+
When a guest scans the QR code, they are taken to a [guest registration page](../../b1-church/checkin/guest-registration) where they enter their name, email, and family members. A volunteer can then look them up on the kiosk and check them in.
102+
68103
## What Gets Recorded
69104

70105
Every check-in creates an attendance record in B1 Admin. You can view these records on the [Attendance](tracking-attendance.md) and [Groups](../groups/group-members.md) tabs just like manually entered attendance. There is no difference in how the data appears — both methods feed into the same reports.

docs/b1-admin/calendars/creating-calendars.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,39 @@ Connecting groups to your calendar is a powerful way to automatically aggregate
5656
If you want to create a single calendar that pulls events from many groups across your church, see [Curated Calendar](curated-calendar) for a streamlined approach.
5757
:::
5858

59+
## Enabling Event Registration
60+
61+
You can enable registration for any calendar event so members can sign up through the B1 website or mobile app.
62+
63+
1. Click on an existing event or create a new one.
64+
2. In the event editor, toggle **Registration** to enable it.
65+
3. Configure the registration settings:
66+
- **Capacity** (optional) -- Set a maximum number of registrations. Leave blank for unlimited.
67+
- **Registration Opens** -- The date and time when registration becomes available.
68+
- **Registration Closes** -- The date and time when registration closes.
69+
- **Tags** -- Comma-separated labels (e.g., "youth, retreat, vbs") to help categorize registerable events.
70+
4. Save the event.
71+
72+
Once registration is enabled, members will see a **Register for this Event** button when they view the event on the [B1 website](../../b1-church/events/registering) or [B1 Mobile app](../../b1-mobile/events/registering).
73+
74+
### Managing Registrations
75+
76+
To view and manage registrations for your events:
77+
78+
1. Navigate to the **Registrations** page in B1 Admin.
79+
2. You will see a table of all events with registration enabled, showing the event title, date, current registration count vs. capacity, and tags.
80+
3. Click on an event to see the full list of registrations, including names, member count, status, and registration date.
81+
4. From the detail page, you can:
82+
- **Cancel** individual registrations
83+
- **Delete** registrations permanently
84+
- **Export** all registrations to CSV
85+
86+
:::tip
87+
Use the capacity progress bar to monitor how quickly events are filling up. The bar turns red when an event is at or over capacity.
88+
:::
89+
5990
## Next Steps
6091

6192
- [Curated Calendar](curated-calendar) -- Create a calendar that pulls from multiple groups
93+
- [Event Registration Guide](../guides/event-registration) -- Step-by-step guide for setting up event registration
6294
- [Calendars Overview](./) -- Return to the calendars overview

docs/b1-admin/donations/donation-reports.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,23 @@ B1 Admin gives you several ways to view and analyze your church's giving data. T
1818

1919
</div>
2020

21+
## Giving Dashboard
22+
23+
The **Giving Dashboard** is the first thing you see when you click **Donations** in the sidebar. It provides a high-level view of your giving activity with key performance indicators.
24+
25+
1. Navigate to **Donations** in the sidebar to open the dashboard.
26+
2. At the top, four **KPI cards** display your giving metrics at a glance:
27+
- **Total Giving** -- The total amount donated in the selected period.
28+
- **Average Gift** -- The average donation amount.
29+
- **Unique Donors** -- The number of distinct people who gave.
30+
- **Total Donations** -- The total number of individual donations.
31+
3. Use the **period toggle** to switch between **Weekly**, **Monthly**, and **Quarterly** views.
32+
4. Below the KPIs, a chart displays giving trends for the selected period.
33+
5. Click **Download** to export a CSV file with giving totals.
34+
2135
## Donations Summary Page
2236

23-
The **Summary** page is the first thing you see when you click **Donations** in the sidebar. It provides a high-level view of your giving activity.
37+
The **Summary** page provides more detailed aggregate giving data.
2438

2539
1. Navigate to **Donations** in the sidebar to open the Summary page.
2640
2. Use the **date range filter** to select the time period you want to review. Set the earlier date on top and the more recent date on the bottom.

docs/b1-admin/groups/group-members.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,22 @@ You can communicate with all members of a group directly from B1 Admin:
5454

5555
Your message will be delivered to all members of the group.
5656

57+
## Emailing Group Members
58+
59+
You can send formatted emails to all members of a group:
60+
61+
1. From the group detail page, click the **email icon**.
62+
2. The Send Email dialog opens, showing how many members will receive the email and how many have no email address on file.
63+
3. Optionally select an **email template** from the dropdown, or compose a message from scratch. Click **Manage Templates** to create or edit templates.
64+
4. Enter a **subject line**. You can insert merge fields by clicking the field chips: `{{firstName}}`, `{{lastName}}`, `{{displayName}}`, `{{email}}`, `{{churchName}}`.
65+
5. Compose the **email body** using the HTML editor. The same merge fields are available here.
66+
6. Click **Send**.
67+
7. A summary shows how many emails were sent successfully and how many members were skipped (no email on file).
68+
69+
:::tip
70+
Create reusable email templates for recurring communications like weekly updates, event announcements, or prayer requests. Templates save time and ensure consistent messaging.
71+
:::
72+
5773
## Exporting Group Data
5874

5975
To download the group member list as a file:

docs/b1-admin/guides/event-registration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Create an event registration form, collect attendee information and optional pay
1010

1111
</div>
1212

13+
:::info
14+
**Two ways to handle event registration:** This guide covers **forms-based registration**, which gives you full control over custom fields and payment collection. For simpler events where you just need to track who is coming, use **native event registration** built into the calendar -- see [Creating Calendars](../calendars/creating-calendars.md#enabling-event-registration) for setup instructions. Native registration lets members sign up directly from the [B1 website](../../b1-church/events/registering) and [mobile app](../../b1-mobile/events/registering) with capacity tracking, date windows, and email confirmations.
15+
:::
16+
1317
<div class="prereqs">
1418
<h4>Before You Begin</h4>
1519

docs/b1-admin/guides/sunday-volunteers.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,30 @@ Follow the [Tasks](../serving/tasks.md) and [Automations](../serving/automations
8585
Set automations to Inactive during holiday breaks or special seasons, then reactivate when you're ready. No need to delete and recreate.
8686
:::
8787

88-
## Step 6: Let Volunteers Know
88+
## Step 6: Enable Self-Service Signup (Optional)
89+
90+
Let volunteers sign up for positions themselves instead of waiting for admin assignments.
91+
92+
1. When editing a plan, set a **Signup Deadline** (hours before service) to control when self-signup closes. Leave blank for no deadline.
93+
2. Optionally toggle **Show volunteer names on signup page** to let volunteers see who else is signed up.
94+
3. For each position, check the **Allow Self-Signup** checkbox to make it available for self-service.
95+
4. Add a **Description** to each position so volunteers know what the role involves.
96+
97+
Once self-signup positions are created, they automatically appear on the volunteer signup pages on [B1.church](../../b1-church/serving/volunteer-signup) and the [B1 Mobile app](../../b1-mobile/serving/volunteer-signup). Members can browse open positions, see how many spots remain, and sign up with one click.
98+
99+
:::tip
100+
Mix admin-assigned and self-signup positions in the same plan. For example, assign your worship leader directly but let greeters and coffee servers self-select.
101+
:::
102+
103+
## Step 7: Let Volunteers Know
89104

90105
Assigned volunteers automatically see their plans and can respond.
91106

92107
1. Volunteers see their plans on [B1.church](../../b1-church/plans/viewing-plans.md) and the [B1 Mobile app](../../b1-mobile/serving/viewing-plans.md)
93108
2. They can accept or decline assignments directly from either platform
94109
3. They can set blockout dates for weeks they're unavailable
95110
4. Plans can be printed for rehearsals or posted backstage
111+
5. Volunteers can browse and sign up for open positions via the [volunteer signup page](../../b1-church/serving/volunteer-signup)
96112

97113
:::tip
98114
Push notifications on the mobile app alert volunteers when they receive new assignments or when plans change.
@@ -113,3 +129,5 @@ Your volunteer management system is set up. Each week, create a new plan, assign
113129
- [Automations](../serving/automations.md) — automate recurring tasks
114130
- [Viewing Plans (Web)](../../b1-church/plans/viewing-plans.md) — how volunteers see plans online
115131
- [Viewing Plans (Mobile)](../../b1-mobile/serving/viewing-plans.md) — how volunteers see plans on mobile
132+
- [Volunteer Signup (Web)](../../b1-church/serving/volunteer-signup) — how members self-select volunteer positions
133+
- [Volunteer Signup (Mobile)](../../b1-mobile/serving/volunteer-signup) — volunteer self-signup on mobile

docs/b1-admin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ B1 Admin is your church management dashboard. It provides tools to manage every
1414

1515
1. Open your browser and go to [admin.b1.church](https://admin.b1.church)
1616
2. Sign in with your username and password
17-
3. You'll land on the **Dashboard**, which gives you quick access to all major features
17+
3. You'll land on the **Dashboard**, which provides an overview of your church data along with **Quick Actions** for common tasks like adding people, creating groups, recording donations, and more
1818

1919
:::tip
2020
New to B1 Admin? Start with the [Introduction](./introduction) for a video walkthrough, then visit [Settings](./settings/) to configure your church information and invite your team.

docs/b1-admin/reports/audit-log.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "Audit Log"
3+
---
4+
5+
# Audit Log
6+
7+
<div class="article-intro">
8+
9+
The audit log tracks all significant actions and changes across your church management system. Use it to review login activity, track who made changes to people records, monitor permission updates, and maintain accountability across your team.
10+
11+
</div>
12+
13+
<div class="prereqs">
14+
<h4>Before You Begin</h4>
15+
16+
- B1 Admin account with server admin access
17+
- Navigate to **Settings** to find the Audit Log
18+
19+
</div>
20+
21+
## Viewing the Audit Log
22+
23+
1. Go to **Settings** in B1 Admin.
24+
2. Select **Audit Log**.
25+
3. The log displays recent entries in a table with the following columns:
26+
- **Date** -- When the action occurred.
27+
- **Category** -- The type of action (color-coded for quick scanning).
28+
- **Action** -- What was done (e.g., create, update, delete, login_success).
29+
- **Entity** -- The type and ID of the record that was affected.
30+
- **IP Address** -- The IP address of the user who performed the action.
31+
- **Details** -- A summary of the specific changes made.
32+
33+
## Filtering the Log
34+
35+
Use the filters at the top of the page to narrow down the results:
36+
37+
- **Category** -- Filter by action type:
38+
- **All Categories** -- Show everything.
39+
- **Login** -- Login successes and failures.
40+
- **People** -- Creating, updating, or deleting person records.
41+
- **Permissions** -- Permission grants and revocations.
42+
- **Donations** -- Donation record changes.
43+
- **Groups** -- Group management actions.
44+
- **Forms** -- Form submission activity.
45+
- **Settings** -- Configuration changes.
46+
- **Start Date** -- Show entries from this date forward.
47+
- **End Date** -- Show entries up to this date.
48+
49+
Click **Search** after setting your filters to update the results.
50+
51+
## Understanding Categories
52+
53+
Each category is color-coded for quick identification:
54+
55+
- **Login** -- Blue chip. Tracks successful and failed login attempts.
56+
- **People** -- Purple chip. Tracks person record creates, updates, and deletes.
57+
- **Permissions** -- Red chip. Tracks when access rights are granted or revoked.
58+
- **Donations** -- Green chip. Tracks donation record changes.
59+
- **Groups** -- Gray chip. Tracks group management operations.
60+
- **Forms** -- Orange chip. Tracks form submission activity.
61+
- **Settings** -- Yellow chip. Tracks configuration changes.
62+
63+
## Exporting the Log
64+
65+
When log entries are displayed, a **CSV download** button appears. Click it to export the current filtered results to a spreadsheet for offline review or record-keeping.
66+
67+
## Pagination
68+
69+
Use the pagination controls at the bottom of the table to navigate through results. You can display 25, 50, or 100 entries per page.
70+
71+
:::info
72+
Audit log entries are automatically retained for one year. Entries older than 365 days are removed to keep the system performant.
73+
:::
74+
75+
:::tip
76+
Review the audit log regularly, especially after onboarding new team members or making significant configuration changes. It helps identify unexpected activity early.
77+
:::
78+
79+
## Related Articles
80+
81+
- [Roles & Permissions](../settings/roles-permissions) -- Manage who has access to what
82+
- [Data Security](../settings/data-security) -- Understand how your data is protected
83+
- [Reports Overview](./index) -- See all available reports

docs/b1-admin/reports/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ The Reports page gives you quick access to pre-built reports that help you under
1212

1313
## Available Reports
1414

15-
The Reports page displays five report cards. Click any card to open the report with its filters.
15+
The Reports page displays report cards for each available report. Click any card to open the report with its filters.
1616

1717
- **[Birthday Report](./birthday-report)** -- View upcoming birthdays for your congregation members.
1818
- **[Attendance Trend](./attendance-reports)** -- See how attendance patterns change over time across your services.
1919
- **[Group Attendance](./attendance-reports)** -- View attendance totals by group for a selected date range.
2020
- **[Daily Group Attendance](./attendance-reports)** -- Get a day-by-day breakdown of group attendance data.
2121
- **[Donation Summary](./donation-summary)** -- Review giving totals and trends for financial planning.
22+
- **[Audit Log](./audit-log)** -- Track all changes and actions across your church management system (found under Settings > Audit Log).
2223

2324
## Using Reports
2425

@@ -40,3 +41,4 @@ Report data depends on consistent data entry. Make sure your team is [tracking a
4041
- [Birthday Report](./birthday-report) -- Finding and using birthday data.
4142
- [Attendance Reports](./attendance-reports) -- Understanding the three attendance reports.
4243
- [Donation Summary](./donation-summary) -- Reviewing giving data and financial summaries.
44+
- [Audit Log](./audit-log) -- Tracking system activity and changes.

docs/b1-checkin/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Place an Android tablet in your lobby or welcome area. Members walk up, search f
2020
- **Household review** -- See all family members with photos and current group assignments at a glance.
2121
- **Group assignment** -- Assign each family member to the right class or group for the selected service time.
2222
- **Guest check-in** -- Add a guest to your household on the spot with a first and last name.
23+
- **QR guest registration** -- Display a QR code that visitors can scan to [register themselves](../b1-church/checkin/guest-registration) on their own phone before checking in.
2324
- **Label printing** -- Print name labels for children and parent pickup slips with unique security codes.
2425
- **Network printer support** -- Discover and configure network printers directly from the app.
2526
- **Auto-login** -- After the first login, the app remembers your credentials and goes straight to the services screen on future launches.

0 commit comments

Comments
 (0)