ScrivitoCrmFormWidget

A Scrivito widget for adding a form based on an Infopark CRM activity type to a page.

Installation

Add this line to your application's Gemfile:

gem 'scrivito_crm_form_widget'

Add this line to your stylsheet manifest:

*= require scrivito_crm_form_widget

Add this line to your JavaScript manifest:

//= require scrivito_crm_form_widget

Features

If the selected activity type has the fields email and last_name, a CRM contact based on this data is searched for, and, if it doesn't exist, is created.

The editor may also select an event on the details view of the widget. If the email and last_name fields exist, a corresponding CRM contact is be added to the event as an event contact.

Localization

The following code represents the default localization for English. Copy it to your en.yml and change it if necessary:

en:
  scrivito_crm_form_widget:
    thumbnail:
      title: CRM Form
      description: Add a formular to your page based on an activty from Infopark CRM
    details:
      activity_id:  Activity
      event_id: Event
      subject: Subject
      tags: Tags
      redirect_to: Redirect after submit
      submit_button_text: Text on Submit button
      dynamic_attribute: Attribute
      title: Title
      label: Label
      type: Type
      valid_values: Values
      maxlength: Max Length

You can loaclize your labels using i18n:

en:
  helpers:
    label:
      crm_form_presenter:
        custom_attribute_1: Foo
        custom_attribute_2: Bar
        custom_enum_attribute: Enum
        custom_enum_attribute_options:
          one: One
          two: Two
          three: Three

Customization

A field label is given the mandatory class if the field is marked as mandatory in the activity type. You can style this using CSS, for example:

label.mandatory:after {
  content: "*";
}

If the creation of a new activity fails, the flash[:alert] value is set. The message returned bythe CRM SDK is used as the flash message. It has the following format:

[
 {
   "attribute" => "gender",
   "code" => "inclusion",
   "message" => "gender is not included in the list: unknown, male, female"
 },
 {
   "attribute" => "language",
   "code" => "inclusion",
   "message" => "language is not included in the list"
 },
 {
   "attribute" => "last_name",
   "code" => "blank",
   "message" => "last_name can't be blank"
 }
]

You can use this to create a message for the user.

If you are maintaining the activities of severeal websites with a single Infopark CRM, you can add the 'self.crm_activity_filter' method to your obj.rb file to filter the activity types by your selection criteria.

def self.crm_activity_filter
  Crm::Type.all.select { |a| a.id.starts_with? 'page-' }
end

Attributes

Activity

Lets you select an activity type from the available ones.

Subject

This is used as the title of a created activity.

Tags

If the activity type has the fields named email and last_name, a CRM contact based on this data is searched for, and, if it doesn't exist, is created. If tags have been specified, they are added to the contact.

Redirect after submission

On the details view a redirection target, which becomes effective after submitting the form, can be specified.

Text on submission button

The text to display on the submission button. The default is send.