Difference between revisions of "V2 Event Forms"

From docs
Jump to: navigation, search
(Created page with "Path: Callproof Support - New Website - Event Forms = Event Forms = Configurable activity forms under '''Home → Customizations → Event Forms'''. * '''URL pr...")
 
(Blanked the page)
(Tag: Blanking)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Path: [[Callproof Support]] - [[New Website]] - [[Event Forms]]
 
  
= Event Forms =
 
 
Configurable activity forms under '''Home → Customizations → Event Forms'''.
 
 
* '''URL prefix:''' <code>/eforms/</code>
 
* '''App:''' <code>event_forms/</code>
 
* Used by field reps to capture visit/call data on a contact (checklists, scores, notes, images).
 
* On submit: can award points, send emails, schedule a task, and post to a webhook.
 
 
== Main screens ==
 
 
=== Event Forms list ===
 
* '''URL:''' <code>/eforms/</code>
 
* Lists all company event forms.
 
* Shows: Name, notification emails, field count, entries count, points, actions.
 
* Actions: edit, copy, delete, hide, remove link, sort A–Z.
 
* '''Add Event Form''' → <code>/eforms/event_add_new_form/</code>
 
 
=== Add / Edit Event Form ===
 
* '''Add:''' <code>/eforms/event_add_new_form/</code>
 
* '''Edit:''' <code>/eforms/edit/&lt;event_form_id&gt;/</code>
 
 
==== Form settings ====
 
* '''Form Name''' (required)
 
* '''Notification Email''' — one address per line; emailed when a form is submitted
 
* '''Points''' — points awarded when the form is completed
 
* '''Treat Event Form As''' (required):
 
** Appointment
 
** Webinar
 
** None
 
* '''Additional options:'''
 
** Schedule Task — create a follow-up/task after submit
 
** Send Email Copy to Rep — copy the submitting rep
 
** Use Previous Event Form Custom Field Data if Available — prefill from last entry
 
* '''Limit Account Types''' — restrict which account types can use this form
 
 
=== Event Form fields ===
 
* Attach '''regular fields''' and '''custom fields''' to a form.
 
* Set required / optional.
 
* Manage dropdown/radio options (including auto options).
 
* Reorder fields; delete fields from the form.
 
* Key URLs:
 
** Custom field on form: <code>/eforms/&lt;pk&gt;/custom_field/&lt;custom_field_id&gt;/</code>
 
** Regular field: <code>/eforms/&lt;pk&gt;/regular_field/&lt;regular_field_id&gt;/</code>
 
** Add new field: <code>/eforms/add_new_custom_field/&lt;pk&gt;/</code>
 
** Field options: <code>/eforms/fields/&lt;pk&gt;/options/&lt;custom_field_id&gt;/</code>
 
 
=== Event Forms Entries ===
 
* '''All entries:''' <code>/eforms/entries/</code>
 
* '''Per form:''' <code>/eforms/&lt;event_form_id&gt;/details/</code>
 
* Search/filter submissions; mark completed / not completed.
 
* Edit entry: <code>/eforms/&lt;event_form_id&gt;/edit/&lt;contact_event_form_id&gt;/</code>
 
* Delete entry: <code>/eforms/&lt;event_form_id&gt;/delete/&lt;contact_event_form_id&gt;/</code>
 
* Fill new form on a contact: <code>/eforms/&lt;event_form_id&gt;/contact/&lt;contact_id&gt;/new/</code>
 
 
=== After-call forms ===
 
* Forms can be flagged as after-call forms (<code>is_after_call_form</code>).
 
* Configure via:
 
** <code>/eforms/after_call/</code>
 
** <code>/eforms/set_after_call/</code>
 
* Prompted after a call so the rep can log outcomes quickly.
 
 
=== Exports & schedules ===
 
* Export entries: <code>/eforms/export/</code>
 
* Scheduled exports: <code>/eforms/schedule_exports/</code>
 
* Create schedule: <code>/eforms/save_scheduled_eform/</code>
 
* Edit / delete / run now:
 
** <code>/eforms/edit_scheduled_exports/&lt;id&gt;/</code>
 
** <code>/eforms/schedule_delete/&lt;id&gt;/</code>
 
** <code>/eforms/run_now/&lt;id&gt;/</code>
 
 
== Quick Links (in UI) ==
 
* Add Event Form
 
* Event Forms
 
* Event Forms Entries
 
 
== What happens on submit ==
 
* Creates a '''ContactEventForm''' linked to company, user, contact, and form.
 
* Stores answers (custom/regular field values), optional GPS (lat/long), points.
 
* Can mark '''completed''' with a completed date.
 
* Can link to an appointment.
 
* Can attach personnel (people at the account).
 
* Can create a scheduled follow-up task.
 
* Can send notification emails (and optional copy to rep).
 
* Can POST to '''post_back_url''' (webhook) with secret/method if configured.
 
 
== Key data models ==
 
 
=== EventForm ===
 
* Form template for a company.
 
* Notable fields: name, position, points, post_back_url / secret / method, is_schedule_followup, send_email_to_rep, prefill_data, is_after_call_form, hide, is_clickable, event_form_treat_as.
 
* Table: <code>cp_eventform</code>
 
 
=== EventFormEMail ===
 
* Notification email addresses for a form.
 
* Table: <code>cp_eventformemail</code>
 
 
=== ContactEventForm ===
 
* One submitted entry on a contact.
 
* Notable fields: user, contact, event_form, created, points, latitude/longitude, completed, completed_date, appointment.
 
* Table: <code>cp_contacteventform</code>
 
 
=== ContactEventFormPersonnel ===
 
* People (personnel) linked to a submission.
 
* Table: <code>cp_contacteventformpersonnel</code>
 
 
=== EventFormContactType ===
 
* Limits which Account Types can use the form.
 
* Table: <code>cp_eventformcontacttype</code>
 
 
=== EventFormTreatAs ===
 
* Treatment type: Appointment / Webinar / None.
 
* Table: <code>cp_eventformtreatas</code>
 
 
=== EventFormCField ===
 
* Links custom/regular fields onto a form (order, required, etc.).
 
* Table: <code>cp_eventformcfield</code>
 
 
== Typical setup order ==
 
# Create Account Types and Custom Fields first (Home menu).
 
# Add Event Form (name, emails, points, treat-as, options).
 
# Limit Account Types if needed.
 
# Add / order form fields and options.
 
# (Optional) Set as after-call form.
 
# (Optional) Configure webhook post-back.
 
# Reps fill forms from a contact; managers review Entries / export.
 
 
== Related menus ==
 
* [[Home menu#Custom Fields|Custom Fields]] — field definitions reused on forms
 
* [[Home menu#Account Types|Account Types]] — used to limit who can use a form
 
* Contacts — fill / view forms on an account
 
* Reports — event form data can appear in reports/exports
 
 
== Notes ==
 
* Hide removes the form from normal use without deleting history.
 
* Remove Link controls whether the form appears as a clickable link in contact menus.
 
* Copy duplicates an existing form (including post-back and after-call settings).
 
* Points can roll into gamification / leaderboard-style scoring when awarded on completion.
 

Latest revision as of 11:34, 22 July 2026