Setup node

The Setup node stores various configuration settings for the Rhythm for Civics site. The Setup node has these attributes:

Attribute Description
Add Applicant Indicates whether users can add additional applicants to their applications. The value can be set to Show or Hide. If set to Show, an Add Applicants button will be displayed in the Additional Applicants section of the Add Instrument widget. For existing applications, an Add More link will be displayed under Additional Applicants in the Instrument Detail widget.

This attribute is not used for the Billing portal.

Auto-Complete Enabled Indicates whether AutoComplete is enabled for the Rhythm for Civics site.

See AutoComplete.

Cashiering Register ID ID of the cash register that is used for payment processing.
Note: This attribute is only used for CDR fee payments. To configure a cash register for the Billing portal, use the Cashiering Register ID attribute on the Billing node.

See Billing node.

Days to Expire Invitation Number of days before an invitation to an additional applicant will expire. The default is 14 days. Specify 0 if you don't want invitations to expire.

This attribute is not used for the Billing portal.

Default Map Open Indicates whether the map will open by default.

This attribute is not used for the Billing portal.

Inspection Request Date Indicates whether the Request Date field is shown when users request inspections in the Request Inspection widget. You can specify one of these values:
  • Show: The Request Date field is shown, but it is not required.
  • Hide: The Request Date field is not shown.
  • Required: The Request Date field is required.
  • DisplayOnly: The Request Date field is display-only.

This attribute is not used for the Billing portal.

Invite Applicant Indicates whether users can invite additional applicants to be added to their applications. The value can be set to Show or Hide. If set to Show, an Invite Applicants button will be displayed in the Additional Applicants section of the Add Instrument widget. For existing applications, an Invite More link will be displayed under Additional Applicants in the Instrument Detail widget.

This attribute is not used for the Billing portal.

Local Cache Enabled Indicates whether responses from the Rest Services are cached in the local browser session for improved search performance.

This attribute is not used for the Billing portal.

Local Cache Max Response Size Maximum size in KB for a single response to be cached if local caching is enabled. The default is 120.

This attribute is not used for the Billing portal.

Local Cache Max # of Response Number of responses that will be cached in the browser session if local caching is enabled. The default is 30, and the maximum value is 40.

This attribute is not used for the Billing portal.

Local Cache TTL Amount of time responses will be cached if local caching is enabled.

This attribute is not used for the Billing portal.

Page Size Maximum number of records to show on each page.
Simplified Notification Set to True to enable the simplified notification functionality for Rhythm for Civics.

This attribute is not used for the Billing portal.

Use Applicant Capacity Indicates whether a Capacity field is displayed when users enter applicants in the portal site. You can specify one of three values: Show, Hide, or Required. Hide is the default.

This attribute is not used for the Billing portal.

Use Applicant Type Indicates whether an Applicant Type field is displayed when users enter applicants in the portal site. You can specify Hide or Show. Show is the default.

This attribute is not used for the Billing portal.

Use Notifications Indicates whether notifications are shown in the Rhythm for Civics site. Can be set to Show or Hide.
Use Service Providers Indicates whether the portal site uses service providers. Service providers are contacts who have been approved to complete inspections and reviews on behalf of the agency.

This attribute is not used for the Billing portal.

Use State/Province for Contacts Can be set to Show, Hide, or Required.
Void Reason Code on Failure Reason code to be used when voiding a cash register transaction.

The Setup node can have these children:

  • Attachments
  • Billing
  • Building
  • Case
  • Cashiering Transactions
  • Contact Matching
  • Contact Types
  • Customer Service
  • Electronic Plan
  • GIS
  • License
  • Login
  • Login Redirect Page
  • Planning
  • Project
  • Reports
  • States
  • Trade License
  • Use