Civica Integration

Set up your Civica Authority Integration

Integration Menu

1. Open the integrations menu in your account
2. Select Edit Integration and add your
   • Base URL
   • Username
   • Password
3. Optionally you can also add additional environments
   • If added you will also need to include a label for each environment

Civica Elements 

Now that you have configured your Civica Authority integration you can start building or modifying your form. 

All Civica categories must contain a Name Record and Street Name record. To account for this we have added specific form elements to capture these. 

Civica Street Name

The street name record is a simple autocomplete element, that allows you to start typing and filters your search based on the available street name records within your configured Civica Authority instance. 

Civica Name Record

The name record is slightly more complicated and made up of a number of other elements. 

At a minimum, the name record is required to have a title, family name and one street address. 

All other name record fields are optional by default. These can be configured to be required or hidden. The labels can also be customised to suit your form needs. 

Submission Event

Now that your form elements are set up you can configure your submission event. 

1. Open the submission event tab
2. Select Civica Authority - CRM 
3. Select the Customer Contact Method from the drop-down
4. Type in the Category 
5. Map Category Items to the form elements you created

If any form elements are missing that are in the Category, they will show up highlighted in red. 

These will need to be added to the form to complete the submission event configuration. 

PDF Configuration

• Exclude Elements
  • This allows you to remove elements from the PDF that may not be relevant to this recipient.
    
• PDF File Name 
  • The name of the PDF can also be changed to more easily conform to any existing processes.
• Display Submission ID in PDF
  • Turning this on will ensure the submission ID is added as a footer to each page of the PDF.
• Display External ID
  • Turning this on will ensure the external ID is added as a footer to each page of the PDF.
• Include calendar booking details
  • This option is only shown if you have a calendar booking event configured. It will include the details of the calendar booking on a new page at the bottom of the PDF.
• Include payment details
  • This option is only shown if you have a payment event configured. It will include the details of the payment on a new page at the bottom of the PDF.
• Include approval form content
  • This option is only shown if you have an approval flow configured. It will include the details of any approval forms on a new page at the bottom of the PDF.
• Page break on form pages
  • Turning this on will create a page break in the PDF that reflects the page breaks in the form itself.

Retry on failure 

If this switch is enabled then the submission will be automatically retried 5 times. If all 5 of the retries fail then a notification email will be sent to the app sending email address.

Get Help

If you have any question or would like assistance with setting up your Civica Authority integration please contact us via this support portal or email [email protected]. We are happy to assist in any way we can.