On this page
Social proof via the Engage Progress bar
This is a tutorial on how to use the Engage Progress module to add a simple progress bar to your campaign page for displaying the current success of your campaign as Social Proof. The success of any campaign can greatly depend not only on how well you emphasise your issue, but also how well you empower your signatories with the knowledge that others are also participating and care about the same issue.
What is Engage Progress?
Engage Progress is a simple field formatter for an integer field that uses the integer value as a "goal" for a campaign and displays a progress bar as a percentage of how close the campaign is to achieving that goal. There is API integration for providing the counter total in that percentage calculation. Out of the box this comes with three methods for providing a total count:
- An integer field : Uses the value from another attached integer field as a static counter. You would manually update this field to change the progress bar.
- A registration field: Uses the total number of registrations associated with an attached Entity Registration registration field as the counter. As an example you would attach a registration field to a campaign content type for allowing people to "sign" your campaign. The counter total is derived from total registrations associated with a particular campaign node.
- A registration field with integer as a threshold: A combo of the two above where the integer is used as a static value added to the registration field counter.
Steps to using it
Follow these steps for adding an engage progress bar:
Step 1
If you are using the registration module to collect signatures for your campaigns as suggested in "Creating a campaign/petition with a registration form" then make sure you have your campaign content type with registration field set up according to the tutorial.
If you just want to use the progress bar for displaying your campaigns progress by updating it manually, then make sure you have your content type created for which you would like to add the progress bar and have an integer field attached to it for tracking the current signature count.
Step 2
Add an integer field to your campaign content type that will act as the goal in terms of signatures. Note: he label you give it will display above/inline with the progress bar. The value of the field will represent your campaign's target goal of signatures. The progress meter that will be displayed will show a percentage of that goal based on the criteria you set up in the following steps.
Step 3
Manage the display of your campaign content type. Drag the Integer field you created into the position where you would like the progress bar to be displayed. Select "Engage Progress bar" from the format drop down and click save.
Step 4
Configure the format settings for the field. Out of the box you have 3 choices for "counter source", each of which are described above in the What is Engage progress section. After selecting your counter source you will need to select the field(s) associated with the registration and/or the static counter.
Step 5
Create your campaign page and theme your progress bar.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion