CiviLead Module Setup 

CiviLead is Joomla 1.7 native, and requires CiviCRM installed as a Joomla component in order to function.

Note: The component page only works when "redirected to" from the module. Do not attempt to use the component page by itself in a stand-alone process. The instructions for component usage are provided separately.

Module Setup Instructions

The module and component are bundled together in one zip file. You must unzip this file first into order to show the two installation files.

The following is an explanation of the module configuration fields:

CiviCRM can reject duplicate emails. This is the text that will appear if the user registering has an email address that is already found in CiviCRM and you have chosen to reject duplicates. It is not advisable to do this if you are using CiviLead to encourage people to get information about products, events, or other uses in which the same person may contact you multiple times about different offerings.

2.

Enter the text in this field to display at the top of the CiviLead Module before the form. The image below illustrates how the text appears:

This verbiage can vary from one instance of the module to another.

3.

These are the literals which show in the CiviLead form. Enter them exactly as you wish them to appear above the form boxes.

4.

Enter the verbiage for the error messages if the user fails to enter the required elements of the form which are First Name and Email address. 

5.

Enter the desired width of the Email, First Name, and Last Name fields. Tailor these to match the module position(s) in which CiviLead will be published on your site. Enter the percentage of the module's width to use for the percentage of the "submit" button.

6.

The redirect URL is optional. If no URL is enter, then the user will be directed to the CiviLead Component in order to solicit more contact information after submitting the information in the module form.

If you would like to redirect to the CiviLead Component, enter a fully qualified URL as follows (replace "mysite.com" with your domain name): http://mysite.com/civilead

To route to a custom thank you page, just enter the complete URL.

7.

Select whether or not to use an Anti-spam question, and if so, provide the question and the answer. You can use any commonly known piece of information, a math question, or anything else. This kind of anti-spam system is very easy for users, but is difficult to compromise.

8.

To be registered in CiviCRM, a new Contact must be assigned to a CiviCRM Group. The Group can be used for either contact management or for newsletter mailings or both. Put the numeric value of the CiviCRM group to which new contacts created by this instance of the CiviLead Module should be added. The screen captures below show how to find the number of a CiviCRM Group to use in the module.

First access the "Manage Groups" item from the CiviCRM menu as shown:

On the list of Groups, you will see the numeric ID next to the name. In our illustration below, we have a "Newsletter" group and a "Leads" group.

9.

Enter any custom CSS suffix for styling purposes here. The availability of styling is controlled by your Joomla template.

10.

These fields are all optional. If you would like the CiviLead Module to send an email to the contact after the form has been filled out, then enter the Sender information and the text of the confirmation email.An example email is below:

Additionally, if you would like an internal resource to recieve an email notification that a new contact has requested more information, then enter the internal email fields. The internal email will contain the verbiage you set here and the Contact Name, Email Address, and Contact Number so that the internal resource can easily find the new contact in the CiviCRM system. You can set the literals above for the Contact Name. An example of an internal email is below:

Since these fields can vary from one module instance to another, you can use CiviLead for multiple different purposes on your site.

In addition, if you would like to automatically attach a file to emails going to new contacts, please include the relative pathway and filename in the "Attachment Path and Name" field. For example, if you would like to send an attachment named, "our_company.pdf" and it is stored in the following directory "http://www.mysite.com/files/emails/our_company.pdf" then in this filed you would enter the following value, "/files/emails/our_company.pdf" (The file path must always be relative to the root directory of your Joomla site!) Different attachments can be used for different instances of the CiviLead module. The attachment will be appended to the email going to the new contact as shown in the above example.

Module Example

The following screen capture illustrates a fully configured CiviLead Module used for contact purposes.

Module Example

NOTE: If you plan to redirect the user to the CiviLead Component page after submission of the CiviLead form, please view the Component Tab for set up instructions.

The CiviLead Component is required for the CiviLead Module to function, but it is optional for use when registering new contacts. The CiviLead component generates a page which can be used as a "thank you" page which also requests additional optional contact information. The CiviLead Componet installs as any other Joomla 1.7 component.

The following fields are available for use on the "thank you" page generated by the CiviLead component.

1.

Enter the literals to be used on the CiviLead page.

2.

Enter the text to be shown at the top of the CiviLead page. The fields on the page are optional. When the contact has reached this page, the Name and Email address have already been logged in CiviCRM. This information is optional, but can be helpful if you would like to get physical mailing address and/or telephone. Use this verbiage to thank the user for the contact request, set expectations for future contact, and request that the user provide more complete information.

3.

The CiviLead component page is NOT designed for use by itself. It is designed to be redirected to after a user submits a form in the CiviLead module. This error message will show if the user has somehow accessed the page directly.

4.

This is the header portion of the CiviLead Component page. See the example at the bottom of this page to see its relationship to the rest of the text entered above.

5.

Enter the text to be used for the submit button at the bottom of the CiviLead component page.

6.

If you would like to redirect a user submitting additional contact information to a thank you page, then put that complete URL here as shown above. This is optional. If left blank, a user submitting additional contact information will redirect to the homepage.

7.

Enter the literals for the Address, City, State, Zip Code (Postal Code) , Phone Number, and Country Code. Also designate the width of the input boxes in pixels, and deisgnate whether Phone Number is a required element.

The following screen capture illustrates a complete CiviLead component page: