...
Configuration relevant to a specific organization is possible. This includes configuration options such as support/administrative email addresses or groups email accounts, mailing address, homepage links, the application title for search engines as well as the official and shortened name of the organization.
Setting | Definition |
app.name | Name of the system (e.g.: ePermitting, nFORM, etc.) |
app.title | Title of the Application |
app.headerImageLocation | Path to the header image used by the system |
app.home.url | URL target for the home button |
app.termsOfUseLink | Allows you to specify a page to serve as your terms and conditions and privacy policy |
app.footerClientAddressHtml | Physical address shown on the footer |
app.organization | Organization or Agency name |
app.organization.offical | Full name of the organization |
app.organization.site.url | URL target for the Home button |
app.organization.site.name | Name for the Home button |
app.date.format | Format to use for date displays |
app.timeZone | The time zone basis if different than the default server time zone. Options include: Hawaiian Standard Time Pacific Standard Time Mountain Standard Time Central Standard Time Eastern Standard Time Arizona and Indiana have different time zones. Time-zones are generic and will use localization to determine exact time. The full list of valid values can be generated by TimeZoneInfo.GetSystemTimeZones(). |
app.allowedNetworks | Limiting Access to certain networks can be set here by entering the IP address of the allowed networks. |
app.excludeRobots | Enable search engine robot exclusion |
app.secondaryPayment.addressLabel | The label for a secondary payment address (e.g., “Overnight Mail”), if a secondary payment address is desired. If all app.secondaryPayment properties are empty, no secondary address will be displayed. |
app.secondaryPayment.address | The mailing address for a secondary payment address, if a secondary payment address is desired. If all app.secondaryPayment properties are empty, no secondary address will be displayed. |
Database Settings
The Database settings stored in the configuration files are essential to operation of the system and must be properly configured for the system to run. The two components are the connection string and the configuration value that designates the correct connection string to utilize.
Setting | Definition |
app.connectionstringkey | Reference to the name of the connection string to utilize, from the connectionStrings.config file where all available connection strings are found. |
app.blankStringsToNulls | Determines whether the application will convert all blank strings to null prior to committing the data in the database. |
Email and Message Settings
...
By default, the base email templates will be utilized. If the intention is to create custom email content, the location of the organization specific email templates will need to be specified in the email.templateOverridePath variable. All system emails are set to use the same designated email address and sender name for the system. This server will need to be made accessible and configured for access prior to operation of the system, and the designated recipients of the internal emails will need to be established.
Setting | Definition |
email.isSendEnabled | Master switch" for email - turn it on or off by toggling this value. |
email.support.address | Support Email Address – listed as the email contact on the site. This can be an individual or email group. |
email.admin.address | All security and system emails will be sent to this address. |
email.fromAddress | Address used to send notifications to users |
email.fromAddressDisplayName | Display name that shows on emails to users |
email.templateBasePath | Path to the base template files |
email.templateOverridePath | Path to the active set of email templates |
email.smtpServerHost | IP address or DNS of the SMTP server |
email.smtpServerPort | Port used by SMPT mail. Default is 25 |
email.useSsl | Determines whether SSL is used to encrypt emails = Your SMTP server must support this feature. |
email.smtpServerUsername | Username for sending email if required - leave blank if it is not going to be used. |
email.smtpServerPassword | Password for sending email if required - leave blank if it is not going to be used. |
email.genericName | Generic Name for addressing emails if user name is not available |
In addition to specifying the settings used for identifying and authenticating sending messages with the email server, any emails sent out from by the system can be configured to have a custom email subject by overriding the default value.
...
The values that can be defaulted include the state and country code for the contact control and the default latitude or longitude of the location control.
Setting | Definition |
location.latitude | Default Latitude for the starting point for the location control |
location.longitude | Default Longitude for the starting point for the location control |
contact.state | State can be pre-populated for the contact control -leave blank if you do not want to utilize this feature. |
contact.country | Country can be pre-populated for the contact control - leave blank if you do not want to utilize this feature. |
attachments.allowConfidential | Determines if you want to allow confidential attachments |
attachments.largeFileMessage | A message displayed with the attachment control, intended to represent the recommended maximum file size allowed. |
Inline Help, Error Messages, Confirmation Messages
...
Please note that after tasks that are used to index the site have been run, the application will need to be reset. Windsor recommends that you schedule the application pool to reset 15 – 30 minutes after the last scheduled job.
Setting | Definition |
jobs.isEnabled | Global switch to enable/disable all jobs |
jobs.approachingTargetDate.schedule | Schedule of when to notify submission owners that their submission is APPROACHING the target completion date |
jobs.pastTargetDate.schedule | Schedule of when to notify submission owners that their submission is PAST the target completion date |
jobs.pendingDelete.schedule | Schedule of when to notify submission owners that their unchanged submission will soon be deleted |
jobs.deleteOldDrafts.schedule | Schedule of when to delete abandoned/unchanged draft submissions |
jobs.rebuildSearchIndex.schedule | Schedule of when to rebuild index of data that is used to populate new data templates |
jobs.exportControlValuesService.schedule | Schedule of when to export any new/updated submission control data to the export table |
jobs.buildCompanyLookup.shedule | Schedule of when to collect company information from the database to populate the autocomplete company name on registration |
Payment Processing
nFORM supports the use of 3rd Party Payment Processors to collect payments for form submissions, if desired.
Detailed Payment Processor setup is out of scope for this document, as they will be specific to the Agency’s needs. Please see the Integration Guide for further details.
Setting | Definition |
app.secondaryPayment.addressLabel | The label, if provided, for the secondary payment address |
app.secondaryPayment.address | The address, if provided, for the secondary payment address |
app.paymentInstruction.message | Displayed on the payment screen for both online and offline payments |
app.paymentVoucherInstruction.message | Payment instructions on the mail in voucher (offline only) |
Document Management
The system can archive files on a Document Management server (e.g., S3 for cloud applications, File System of SQL FileStream for on premises and nVIRO document management systems for nVIRO solutions) that is accessible by the system itself. When Document Management Integration is active, files will be published at the time of submission to the Document Management server, and an email will be sent to the system administrator email address if there was problem publishing. This also allows the user to publish an existing form by enabling a button on the submission details screen.
...
If you need to collect information about the submission for integration purposes with an existing system, you can define a field that is collected during the processing information step of the wizard that allows you to define the label of a simple text field that is 100 characters in length.
Setting | Definition |
app.submission.alternateidentifier.show | Determine whether an alternative identifier value is enabled |
app.submission.alternateidentifier.label | The label/name displayed with the alternative identifier field |
Notes
Notes are used by the internal users and the system to convey information to other internal users or submitters about a submission. Notes used to communicate with the application are considered external notes, while notes from the system or internal user generated notes are only viewable by users with internal access.
Note configuration properties allow you to define the label that appears on notes as well as the colors that define internal, external and completed notes.
Setting | Definition |
note.label.internal | Label for internal notes that the submitter cannot see |
note.label.external | Label for external notes that will be viewed by the submitter |
note.color.internal | Background color for internal notes |
note.color.external | Background color for external notes |
note.color.complete | The color of a note marked complete |
| Anchor | ||||
|---|---|---|---|---|
|
...