Checkbox Version 7 stores most of its configuration details in a few key XML files.
These files define how the web application, background service, and API communicate with your database, email system, and one another.
Understanding these files can help you identify connection or delivery issues, and know when it’s appropriate to share them with Checkbox Support.
1. Web Application Configuration (web.config)
Location:
C:\\inetpub\\wwwroot\\checkbox\\
Purpose:
- Controls how the Checkbox web portal (admin and respondent sites) runs under IIS.
- Stores connection strings, feature flags, and application behavior settings.
Example:
<connectionStrings>
<add name="DefaultConnection"
connectionString="Data Source=SQLSERVER;Initial Catalog=CheckboxDB;User ID=checkbox;Password=******" />
</connectionStrings>
<appSettings>
<add key="AllowReportDelivery" value="true" />
<add key="BaseApiUrl" value="<https://checkbox-api.company.com/>" />
</appSettings>Used by:
- The Checkbox web interface and admin console.
2. Service Configuration (Checkbox.Service.Host.exe.config)
Location:
C:\\inetpub\\wwwroot\\checkbox-service\\
Purpose:
- Defines how the Checkbox Service (Windows background process) operates.
- Handles background jobs such as:
- Sending notification or scheduled emails
- Running survey delivery or report tasks
Example (SMTP configuration):
<checkbox.messaging>
<smtpSettings>
<smtpSender smtpServer="smtp.company.com" smtpServerPort="25" enableSmtpSsl="false"
enableAuth="false" smtpUserName="" smtpPassword=""
verifiedFromAddresses="no-reply@company.com" />
</smtpSettings>
</checkbox.messaging>Example (AWS SES configuration):
<checkbox.messaging>
<amazon accessKey="AKIA..." secretKey="..." region="us-east-1"
sqsName="MyQueue" verifiedAddress="no-reply@company.com" />
</checkbox.messaging>Used by:
- The Checkbox Windows Service, responsible for notifications and scheduled tasks.
🔹 3. Optional API Configuration (Checkbox.Api.Host.exe.config)
Location:
C:\\inetpub\\wwwroot\\checkbox-api\\
Purpose:
- Used if the Checkbox API is hosted separately.
- Contains API keys, authentication settings, and CORS rules.
🧭 Summary Table
| File | Typical Path | Used By | Purpose |
|---|---|---|---|
web.config | C:\\inetpub\\wwwroot\\checkbox\\ | Web App | Front-end config, database, features |
Checkbox.Service.Host.exe.config | C:\\inetpub\\wwwroot\\checkbox-service\\ | Service | Background operations, email |
Checkbox.Api.Host.exe.config | C:\\inetpub\\wwwroot\\checkbox-api\\ | API | API settings (if separate) |
When to Share Config Files with Support
Checkbox Support may request these files to diagnose configuration or connectivity issues.
| Scenario | Files to Share | Why |
|---|---|---|
| Database or login errors | web.config | To confirm database connection settings |
| Email not being sent | Checkbox.Service.Host.exe.config | To review SMTP or AWS SES settings |
| Scheduled reports not running | Checkbox.Service.Host.exe.config | To confirm service configuration |
| API connection or permissions error | Checkbox.Api.Host.exe.config | To verify API configuration |
| Upgrade or migration checks | All relevant configs | To ensure consistency between environments |
🛡️ Security Reminder
Make sure to always mask passwords or API keys before sharing configuration files.
0 Comments