How do I set up SolarAPP+ with Citizenserve permitting software?

How do I set up SolarAPP+ with Citizenserve Software?

This article describes how to set up SolarAPP+ for jurisdictions with citizenserve online permitting software.

After completing these setup steps, jurisdictions that use citizenserve can automatically issue a local permit after the contractor uploads the approved documents, approval codes, and pays the fee. The process works like this: The contractor submits an application through SolarAPP+ (which requests changes or generates approval documentation) and an approval code during their internal review. The contractor then applies for a local permit on the citizenserve online portal for their jurisdiction, including the approved documents and approval code in the online application. Once the contractor pays the online application fee, the system will automatically issue the jurisdiction’s solar permit. Here are the steps to configure citizenserve to process SolarAPP+ projects:

Contact [email protected] if you experience issues on the SolarAPP+ site related to your SolarAPP+ setup.

Contact citizenserve Support Center for questions about citizenserve configurations.

Citizenserve Setup Tasks:

You’ll need to set up a new Permit type in citizenserve. If you’d like to do your own setup, you can complete most of it with administrator access. You must still submit a Support Request to automate the issuance of the permit. Alternatively, you can also submit a single request to have all items configured by citizenserve Support Center staff; setting up a new permit is covered by your monthly subscription.

  1. Verify existing setup:

    a. These instructions assume your jurisdiction is currently using the latest citizenserve online portal with a payment processor configured to accept permit payments. If you have any questions about your existing setup, or need to add additional functionality, please submit a Support Request from your citizenserve account and we’ll help answer your questions.

  2. Set up a new Permit type (see example below)

    a. In Administration > Administration > Department: Select your Department > Lookups Type: Permit Types > Create New Permit


    i. Permit’s Lookup Value: the permit’s name.

    ii. Expires in (months): leave blank.

    iii. Permit Prefix: enter a new 1-3 character prefix. This prefix will be included as part of the permit number (e.g. SOL23-000001)

    iv. Permit Application Type: determines where citizens access these permits on the portal. Building Permits are accessible from the Permitting Application menu. Development Applications are accessible from the Development Projects Application menu.

    v. Status: Active

    vi. Scope: Typically, set to Department Only. If you have sub-departments set up and want the permit accessible, you can set to Shared for Sub-Departments

    vii. Save the new permit type. Once saved, open the lookup for the permit type to finish the configuration.


    i. Online Portal Option: Set to All options, apply and view once you are ready to accept applications on the portal.

    ii. Work Description Label: this is a long text field displayed to portal user when they first apply. This is typically used for a full description, short description, or project name. It defaults to “Work Description,” but it can be changed to another label or question. Leave blank to remove the field from the portal.

    iii. Address validation: set based on your jurisdiction’s permitting address rules.

    iv. Allow applications to be tied to existing files: Typically, set to No, unless you would like to allow users to tie their SolarAPP+ permit to a previously submitted permit/project

    d. SUBTYPE: Add a subtype for each solar project type you configured in your SolarAPP+ local settings.

    e. FEE STRUCTURE: Add the Solar Fees to be collected by your jurisdiction. Note: the Administration > Portal > Payments > Permit Payment Options for the department that “owns” the solar permit dictates how fees should be set up:

    i. Option 1: If the owning department’s FEE COLLECTION OPTIONS = “Application fees required,” – the solar fees must be marked as “Plan Check” fees on the fee table.

    ii. Option 2: If the owning department’s FEE COLLECTION OPTIONS = “Full payment required,” fees do not need to be marked “PlanCheck”.

    iii. This process requires one of these options to be selected. If the remaining option “No Payment Required” is selected, the system will not generate the solar permit automatically.

Figure 1. Example of new permit type

3) Set up the application by creating new Custom Table

a. In Administration > Administration > Department: Select your Department > Select the Custom Tables tab > Select Add Table icon in top right corner.

b. Configure Custom Field settings

i. Custom Table Description: add a unique name for this new table (common convention is “Permit” followed by your 1-3 permit prefix, e.g. PermitSOL).

ii. Status: Active

iii. Layout Type: Select your preferred option for One or Two custom fields per line. Recommended to select “Two custom fields”

iv. Scope: Typically, set to “Department Only”, unless users in a sub-department need to edit the table

v. Table Type: Permit

vi. Sub Type: select your new permit

c. Add SolarApp Required Custom Fields:

i. SolarAPP Approval ID in this format (SA202#####-###-#-#) (required)

ii. SolarApp Approval Document (required)

iii. SolarApp Spec Sheets (required)

d. Add any other custom fields your jurisdiction would use to report or track your solar projects.

Figure 2. Example of custom table configuration 

4) Create Permit Certificate Template

a. In Administration > Administration > Department: Select your Department > Lookups: Forms and Letters > Select the Add (document) icon in the top right.

b. Configure Form Information

i. Form Name: Name of the form

ii. Letter Type: Letter

iii. Letter Subtype: Permit/License + Permit

iv. Field Type: Set field types to select from in Fields – to add database fields to your letter.

v. Fields: displays fields depending on what is selected in Field Type.

vi. Status: Inactive prevents letter from displaying in letter generation menus.

vii. Scope: Department only

viii. Components: All components

ix. Save As: HTML

x. Note: You may copy the HTML from an existing letter or standard email template. If you have questions on how to do this, please submit a Support Request.

Figure 3. Example of letter template

  1. Configure Portal Payment Settings

    a. In Administration > Portal > Tab: Payments - portal setting must be updated to charge an application fee at submission – this is step C below.)

  2. Request Automation for Issuing the Solar Permit on payment.

    a. Submit a support request and ask citizenserve to copy over the [flp_285_issuepermit] process to issue a permit once it is paid.

    Instructions for Contractors

  3. Receive Automated Plan Review Through NREL/SolarAPP+

    a. Submit your solar permit application, plans, and payment at

    i. FAQ on how to submit a project through SolarAPP+:

    b. Receive NREL approval, which includes:

    i. A SolarAPP+ Approval ID

    ii. Approved Plan Set(s)

  4. Apply for Instant Jurisdictional Solar Permit:

    a. On your jurisdiction’s online portal, submit an application for a solar permit, upload your SolarAPP+ Approval ID and approved plan sets, and pay for your application through the online portal.

    b. Enter a payment when prompted.

    c. The system will email you the permit.

Still need help? Contact Us Contact Us