Detailed documentation about all features and settings of CFF.
From the dashboard/configuration area the process is as follows:
From the end user (visitor) point of view, the process is as follows:
To install the WordPress plugin follow these steps:
Using the WordPress Classic Editor
Using the Gutenberg Editor
Using Elementor
Using Page Builder by SiteOrigin
Using Beaver Builder
Using DIVI Builder
The "CFF" is completely functional even without be registered. But after registering the plugin, the updates are received directly into WordPress.
For registering the plugin follows the steps below:
After registering the plugin the updates are notified in the "Updates" section of WordPress.
After going to the WordPress administration menu >> Settings >> Calculated Fields Form you will see the list of forms like in the following image:
For each form you will see the following options:
After clicking the "Settings" button you will jump to a new page with the form builder a other configuration options as explained below.
Press the "Messages" button, corresponding to the form. The messages screen displays the list of submissions, and a filtering section to reduce the submissions by form, a time interval, or a text in the data
From the messages screen it is possible remove a submission, or submissions group, change its status to paid/unpaid, editing the entry data, but from this screen is possible export all submissions to a CSV file
For editing the information associated to an entry in the list press the corresponding "Edit" button. The action will load a form with the fields in raw mode, not associated to the form's structure, to modify them freely.
For exporting the submitted information to a CSV file, press the "Messages" button corresponding to the form, and press the "Export to CSV" button, select the location where will be saved the CSV and that's all. The first row of CSV file allows identify each of fields, the text used to identify the field will be the short label, defined in the field, or the label in case that the short label is not defined.
The "Calculated Fields Form" allows exporting the forms created in a WordPress website to be imported in other websites(*). The feature is really thankfully for owners or developers of multiple websites to avoid implementing the same form once and once again.
Note(*): Both websites must be using the same version of the plugin to have a compatible exported file.
To export a form:
To import a form:
The new form will appear in the list of forms. To modify it use the related "Settings" button.
The Form Builder lets you to add/edit/remove fields into the form and also to specify the validation rules for your form (required fields, email fields, etc...).
The "Form Settings" tab allows define the form's title and description, as the placement of labels with respect the fields (at top, at left, aligned to the right).
In the "Form Settings" tab is possible to enable the autocompletion of fields, evaluate dynamically the equations (or evaluate the equations through a "Calculate" button). In case of evaluate the equations dynamically it is possible configure the form to evaluate the equations in the onchange events, or in the onchange and keyup events.
Furthermore in the forms settings tab it is possible configure the form's design. The plugin includes multiple predefined designs.
If the browser's persistence option is ticked the plugin will store the data entered by the users, locally in their browsers (only compatible with the browsers with support for the localStorage object) until the form be submitted. So, if an user that is filling the form closes the tab, the next time the user visit the webpage the form's fields will be prefilled with the data stored in his browser.
Through the "Customize Form Design" attribute in the "Form Settings" tab, it is possile to enter the CSS rules to apply to the form and customize its appearance. The list of class applied to the different fields and section of forms is available in the FAQ entry: How can I apply CSS styles to the form fields?
The form builder includes some container controls. The container controls allow to insert another controls in them:
Developer Version Platinum Version
In addition to the above, the following fields are available only in the Developer and Platinum versions of the plugin:
When you click a field already added, you can edit its details and validation rules. The following properties are useful:
When clicking over a calculated field in the form builder the following settings will appear:
In addition to the general fields settings there are three additional settings:
If you are implementing a complex equation, you can press the "ADVANCED EQUATION'S EDITOR" button in the field's settings, to load a javascript editor with auto-completion, colors code for reserved words, errors detection and more:
Note for advanced users: The JavaScript ternary operator is also supported: (condition ? value_if_true : value_if_false). See the "Ideal Weight Calculator" for a sample.
Developer Version Platinum Version
This is a step by step about the use of datasource controls
There are different datasources: MySQL Database, CSV file, Recordset, Post Type, Taxonomy, and User Data.
Note: Depending of control selected will be available all available datasources, or not.
So, suppose we want populate the field with the data stored in a database table.
Note: If the database is the same used by WordPress, leave empty the fields above.
Now its time to define the query to database
If your query is very complex, and you prefer create it manually; selects the option "Custom Query", but in this case you should type all the query. Pay attention because you should use alias in the "SELECT" clause, to indicate the colum used to get the values, and the column used to get the texts. For example, a hypothetical query:
SELECT column1 AS value, column2 AS text FROM tablename WHERE column3 > 5 ORDER BY column2 ASC LIMIT 5
The use of database as datasource, allows filtering the information to populate the fields with the values on other fields in the form, or javascript variable. The use of variables are only accepted in the "Condition" section ("WHERE" clause), and requires the format: <%varname%>. For example, to get the title of a post, filtering by its ID, if the id is defined through the fieldname3 field, the "Condition" attribute of the query would be: ID=<%fieldname3%>
Besides the variables, the plugin allows the use of some constants in the queries. The constants must be enclosed between curly brackets, for example: {user.id}
Assuming you want to insert a "DropDown DS" field where the texts of the choices are the posts' titles, and the values of choices are their IDs, but only for the posts belonging to the logged user, in this case the query to associate with the "DropDown DS" field would be:
SELECT ID as value, post_title as text FROM {wpdb.posts} WHERE post_author={user.id}
In the previous query the constants: wpdb.posts corresponds to the name of the posts table in your WordPress, and user.id to the id of logged user.
The complete list of constants:
blog.id, the id of the current blog (useful in multisite WordPress installations)
wpdb.prefix, prefix used by WordPress in the name of database's tables, for example, the text "wp_" into the table's name "wp_posts"
wpdb.comments, the name of Comments table
wpdb.commentmeta, the name of Comment Metadata table
wpdb.links, the name of Links table
wpdb.options, the name of Options table
wpdb.postmeta, the name of Post Metadata table
wpdb.posts, the name of Posts table
wpdb.terms, the name of Terms table
wpdb.term_relationships, the name of Term Relationships table
wpdb.term_taxonomy, the name of Term Taxonomy table
wpdb.termmeta, the name of Term Meta table
wpdb.usermeta, name of User Metadata table
wpdb.users, the name of Users table
wpdb.blogs, the name of Multisite Blogs table
wpdb.blog_versions, the name of Multisite Blog Versions table
wpdb.site, the name of Multisite Sites table
wpdb.sitecategories, the name of Multisite Sitewide Terms table
wpdb.sitemeta, the name of Multisite Site Metadata table
user.id, the id of the current user
user.login, the username of the current user
user.nicename, the URL-friendly name for the current user
user.email, the email address of the current user
user.url, the URL associated to the current user
user.display_name, the user's name that is shown on the site for the current user
user.first_name, the first name of current user
user.last_name, the last name of current user
The CSV files can be used as data sources for fields with multiple choices (DropDown DS, Radio Btns DS, Checkboxes DS). The initial steps are similar to the previous section, but selecting the "CSV" option as data-source instead of selecting "Database".
A comma-separated values (CSV) file stores tabular data (numbers and text) in plain text. Each line of the file is a data record. Each record consists of one or more fields, separated by commas. The use of the comma as a field separator is the source of the name for this file format.
For CSV files, the plugin includes the attributes:
Select CSV file: allows to select between a local or online file. For local files, the field displays a file field for selecting the CSV file. For online files the field displays a text field for entering the URL to the CSV file.
Use headline: tick the checkbox if the first line of CSV file is a headline to identify the data in the next records.
Delimiter: enter the delimiter symbol used as the field separator on each record.
Press the "Import CSV" button to import the records into the form. This action will feed the lists "Select column for texts" and "Select column for values", that are used for selecting which fields will be used texts and values of the choices in the DS field.
Where the value is equal to: allows filtering the rows to include in the field. The value entered in the attribute must be equal to the value in the column selected for the field's values. It is possible to use the values in other fields in the form, or variables, for filtering the rows, similar to the "Database" datasource.
Enter the conditions for filtering.
This clause require additional instructions, that are explained with an example:
Assuming the values in the "RecordSet DS" fields, selected as datasource, is a list of records with the structure:
{
'First Name' : 'John',
'Last Name' : 'Smith',
'Birth Date' : '1th Jan, 2001'
}
and you want populate a "Line Text DS" field with the "Birth Name" of the user "John Smith"
Type the property name: Birth Date in the "value" attribute.
Enter the properties for filtering in the condition field (pay attention to the use of the reserved word "record" in the conditions):
record['First Name']=='John'&&record['Last Name']=='Smith'
Tips: Javascript is casesensitive, please, be careful with the properties names.
In the conditions can be used the following comparison operators:
equal to: ==
non equal to: !=
less than: <
less than or equal to: <=
bigger than: >=
bigger than or equal to: >=
And the logical operators:
and: &&
or: ||
Some fields, like radio groups, checkboxes and drop-down menu, allow dependencies in function to the option selected.
For example, suppose your form includes a radio-group control with multiple choices: - House, - Car, - Electrodomestics, and each of them, uses different attributes. The house requires fields for address, number of rooms, etc; the car requires a field for trademark, model, etc. and finally the electrodomestics, will need type of electrodomestic,and more. So, if you want display the fields, depending of choice selected:
The calculated fields allow dependencies too, but in function to its value. For example, if you are designing a form for selling electrodomestics, and you want display additional fields for finance the purchase, if the amount is bigger than or equal to $1000usd. In this case:
Create dependencies with other fields. It is possible create dependencies with Dropdown fields, checkboxes, radio buttons, and calculated fields. To define dependencies with other fields, would be necessary to use Calculated Fields as auxiliary fields. Simply, should to use the field as part of the equation associated with the calculated field, and create dependencies rules in function to the equation's result. The auxiliary fields are not relevant in the form's interface, to hide them, tick the checkbox: "Hide Field From Public Page"
For each form you will be able to edit the following settings:
Form Builder: Already explained in the previous sections (see above).
Area were define the texts for the general elements in the form
This area contains the "texts" used for the validations. You can easily translate them to other languages.
Professional Version Developer Version Platinum Version
Professional Version Developer Version Platinum Version
For recurring payments it is possible define a first payment different to the recurring payments, and delay the first payment to offer a trial period.
Professional Version Developer Version Platinum Version
It is strongly recommended the use of an email address in the website's domain. The main emails services (as Gmail, Hotmail, Yahoo, MSN, etc.) check the correspondence between the email address in the "Sender" header on emails, and the domains that send the emails. If the correspondence fails, the emails can be managed as Spam or as a "Phishing" email, in whose case would be deleted for security reasons.
Professional Version Developer Version Platinum Version
Professional Version Developer Version Platinum Version
Professional Version Developer Version Platinum Version
The shortcode to insert in the thanks page allows a total control over the content to display with it.
In case to display all fields submitted with the form, is as simple as insert the shortcode: [CP_CALCULATED_FIELDS_RESULT]. But what to do if you want include in the thanks page only some of submitted fields, and not all?
The shortcode allows define the "fields" attribute, to select the fields names to include in the thanks page, separated by the comma symbol. For example, suppose the form has three fields: fieldname1, fieldname2, and fieldname3, but we want include only the fieldname1, and fieldname3, and exclude the fieldname2, in this case the shortcode would be:
[CP_CALCULATED_FIELDS_RESULT fields="fieldname1,fieldname3"]
But in some cases, we need more control over the content to display. By default, the shortcode is replaced by pairs of label-value for each field included in the thanks page. But what happen if you want display the label of fieldname1 in bold, or use a different label for the fieldname2, that the label used in the form?. In this case you should use the shortcode like a tag: [CP_CALCULATED_FIELDS_RESULT]...[/CP_CALCULATED_FIELDS_RESULT], and its content would be common HTML tags, with the field names using the same format that in the notification emails: <%fieldname#%>, to display only the label <%fieldname#_label%>, and to display only the value <%fieldname#_value%>. So, in this case the shortcode would be:
[CP_CALCULATED_FIELDS_RESULT]
<p><%fieldname1_label%>:<%fieldname1_value%></p>
<p>New Label: <%fieldname2_value%></p>
<p><%fieldname3%></p>
[/CP_CALCULATED_FIELDS_RESULT]To get the complete list of tags to include in the thank you page, read the "SPECIAL TAGS IN THE NOTIFICATION EMAILS" section .
The shortcode accepts too the if_latest attribute, whose accepted values are: 0 or 1 (0 by default) to replace the shortcode, only if it corresponds to the latest submitted form. This attribute should be used in combination with the formid attribute described in the next section.
[CP_CALCULATED_FIELDS_RESULT formid="3" if_latest="1"]
The forms' structures can be very different, and an unique shortcode wouldn't be sufficient to represent all forms. An option would be insert a different summary shortcode for each form, defining the attribute: "formid" indicating the form's id, in each of shortcodes, in whose case the plugin will replace only the shortcode corresponding to the form that has been submitted:
[CP_CALCULATED_FIELDS_RESULT fields="fieldname1,fieldname3" formid="1"]
[CP_CALCULATED_FIELDS_RESULT fields="fieldname8,fieldname9,fieldname14" formid="2"]
[CP_CALCULATED_FIELDS_RESULT formid="4"]
[CP_CALCULATED_FIELDS_RESULT formid="5"] <p><%fieldname1_label%>:<%fieldname1_value%></p> <p>New Label: <%fieldname2_value%></p> <p><%fieldname3%></p> [/CP_CALCULATED_FIELDS_RESULT]
Professional Version Developer Version Platinum Version
This shortcode is similar to [CP_CALCULATED_FIELDS_RESULT]. With this shortcode it is possible to display all submitted fields or controlling the fields and format of the summary.
However the [CP_CALCULATED_FIELDS_RESULT_LIST] requires the formid attribute with the form's id. For example: [CP_CALCULATED_FIELDS_RESULT_LIST formid="1"]
Or at least a submission's id: [CP_CALCULATED_FIELDS_RESULT_LIST submission="123"]
There are other attributes supported by the [CP_CALCULATED_FIELDS_RESULT_LIST] shortcode, but these are optional:
To display the submissions list only to users with specific roles, it is possible to use the role attribute in the shortcode with one or multiple roles names separated by comma. [CP_CALCULATED_FIELDS_RESULT_LIST formid="1" role="administrator"]
For controlling the format of submissions' summaries it is possible to insert the shortcodes with a content, similar to:
[CP_CALCULATED_FIELDS_RESULT_LIST formid="1"]
<p><%fieldname1_label%>:<%fieldname1_value%></p>
<p>New Label: <%fieldname2_value%></p>
<p><%fieldname3%></p>
[/CP_CALCULATED_FIELDS_RESULT_LIST]The complete list of tags to include in the shortcode is avalialbe in the "SPECIAL TAGS IN THE NOTIFICATION EMAILS" section .
To display the submissions list using datatable are required some specific attributes:
layout with the table value
table_head with the list of columns' labels, separated by comma symbols
table_fields with the list of forms' fields, separated by comma symbols
Ex.
[CP_CALCULATED_FIELDS_RESULT_LIST formid="1" layout="table" table_head="id, Column A, Column B, Column C" table_fields="itemnumber,fieldname1,fieldname2,fieldname3"]The controls of datatable are in English by default, to translate the controls' texts to another language, create a .js file with an object as its content similar to the following one (of course, with the texts translated)
{
"decimal": "",
"emptyTable": "No data available in table",
"info": "Showing _START_ to _END_ of _TOTAL_ entries",
"infoEmpty": "Showing 0 to 0 of 0 entries",
"infoFiltered": "(filtered from _MAX_ total entries)",
"infoPostFix": "",
"thousands": ",",
"lengthMenu": "Show _MENU_ entries",
"loadingRecords": "Loading...",
"processing": "Processing...",
"search": "Search:",
"zeroRecords": "No matching records found",
"paginate": {
"first": "First",
"last": "Last",
"next": "Next",
"previous": "Previous"
},
"aria": {
"sortAscending": ": activate to sort column ascending",
"sortDescending": ": activate to sort column descending"
}
}
And finally, pass the file's URL as the table_language_url attribute of [CP_CALCULATED_FIELDS_RESULT_LIST] shortcode
Ex.
[CP_CALCULATED_FIELDS_RESULT_LIST formid="1" layout="table" table_head="id, Column A, Column B, Column C" table_fields="itemnumber,fieldname1,fieldname2,fieldname3" table_language_url="https://wwww.website.com/path/lang.js"]All Versions of the Plugin
The icon with the "X" symbol, that appears when editing the contents of pages or posts, inserts a shortcode in the content with the structure:
[CP_CALCULATED_FIELDS_VAR name="..."]
The ... symbol should be replaced by the parameter or variable name, and will be the same name of the javascript variable. For example: [CP_CALCULATED_FIELDS_VAR name="varname"]
To restrict the source of variable, define the attribute "from" in the shortcode with any of following values: get, post, session, or cookie. For example, to create the javascript variable: varname, only if exist a session variable with the same name, insert the shortcode: [CP_CALCULATED_FIELDS_VAR name="varname" from="session"]
The shortcode: [CP_CALCULATED_FIELDS_VAR] accepts two other attributes:
The "default_value" attribute allows to define the value used by default if there is not a parameter with the specified name, or session variable or cookie:
[CP_CALCULATED_FIELDS_VAR name="varname" default_value="mydefault"]
If there is not a parameter, or session variable, or cookie, with the name "varname", the plugin will create a global javascript variable with the name: "varname", and value: "mydefault".
The attribute: "value", allows to create a javascript variable with the name defined as attribute, and the value in the attribute: "value".
[CP_CALCULATED_FIELDS_VAR name="varname" value="myvalue"]
After insert the shortcode to create the javascript variable, a valid equation would be: fieldname1*varname
There is another way to create global variables to be used in the equations, directly from the form's shortcode. All attributes in the shortcode, except the "id" that identifies the form, are converted in javascript variables with global scope, whose names correspond to the variable name, and their values, the attributes' values:
[CP_CALCULATED_FIELDS id="1" varname="varvalue"]
It is possible create multiple variables, defining multiple attributes.
The variables created through the form's shortcode have a particularity, for each global variable will be created another one with the structure: <variable name>_arr, for example: if the shortcode is:
[CP_CALCULATED_FIELDS id="1" varname="varvalue"]
The plugin will create two varaibles, the global variable: varname whose value would be varvalue, and the varname_arr variable, whose value is a hash with the varvalue as one of their items.
How to access to the value of the varname_arr?
Simply should be called the varname_arr variable, using as the index, the form_identifier constant: fieldname1*varname_arr[ form_identifier]
Pay attention to this way to access to the variables generated through the form shortcode. If there are multiple shortcodes inserted in the same page, and all of them define a same variable, accessing to the variable name through the scheme: <variable name>_arr[ form_identifier], each form will have its own value for the variable, because the global variable <variable name> will have only the latest value defined.
The list of add-ons available in the plugin, appear in the "Add-ons area" of settings page of the plugin. For enabling the add-ons, simply should tick the corresponding checkboxes, and press the "Activate/Deactivate Addons" button.
Developer Version Platinum Version
The Server Side Equations add-on allows to define equations in the server side to protect the business logic, and call them with AJAX from the public form.
The server side equations are defined from the settings page of the plugin, through the "Server Side Equations section".
The server side equations are shared by all forms in the website, reducing the development time.
The server side equations are implemented with PHP programming language. The equations should be entered below the line of comment: INCLUDE YOUR CODE FROM HERE.
The equations should be defined into the GLOBAL array: "SERVER_SIDE_EQUATIONS", where the items' indexes are the names of the equations, and the items values are functions definitions with the code of the equations.
For example, assuming you want to implement an equation that calculate the square root of a number, a possible equation would be:
$GLOBALS['SERVER_SIDE_EQUATIONS']['square_root_equation'] = function($number){return sqrt($number);};
The add-on includes a new operations module with the operation: SERVER_SIDE for calling the server side equations using AJAX.
The "SERVER_SIDE" operation requires at least one parameter, the name of the server side equation (following with the previous example, the first parameter would be: 'square_root_equation') and the other parameters would be the parameters required by the server side equation.
SERVER_SIDE('square_root_equations',4)
the result would be 2
To get the square root of a field in the form, for example, the fieldname1, the equation would be:
SERVER_SIDE('square_root_equations',fieldname1)
The Server Side Equations add-on includes a new section in the form's settings to allow calculate the final price through a server side equation, after the form be submitted.
To calculated the final price with a server side equation:
Tick the checkbox: "Evaluate the final cost with a server side equation, once the form be submitted"
Enter the server side equation call with the format: equation_name(fieldname1, fieldname2, fieldname3)
Developer Version Platinum Version
The new add-on: "Users Permissions", allows restrict the access to the forms, and associate the submitted information to the submitter.
The options to restrict the access to the form are: Only for registered users, for registered users with specific roles, or allow the access to the form only to specific users.
With the "Users Permissions" add-on it is possible restrict the number of submissions to only one by user.
The add-on includes a new shortcode: [CP_CALCULATED_FIELDS_USER_SUBMISSIONS_LIST], to display the list of submissions belonging to an user. If the shortcode is inserted without attributes, the list of submissions will include those entries associated to the logged user. This shortcode accepts the attributes: id, for the user's id, and login, for the username (the id attribute has precedence over the login), in whose case the addon will list the submissions of the user selected, furthermore it is possible restrict the list to a specific form using the attribute: formid="#", where # should be replaced by the form's id. Additionally, it is possible to decide the number of items per page (10 by default), defining the "events_per_page" attribute through the shortcode, ex: [CP_CALCULATED_FIELDS_USER_SUBMISSIONS_LIST events_per_page="20"]
Other attributes supported by the [CP_CALCULATED_FIELDS_USER_SUBMISSIONS_LIST] shortcode:
The add-on allows to define the summary of the submitted data that will displayed in the list of submissions. Enter the summary's structure in the "Summary" attribute. In the summary can be use all the special tags, available for the notification emails, and the thank you pages.
Note, that it is possible to define the structure of data directly through the shortcode, and this takes precedence over the "Summary" attribute. Ex:
[CP_CALCULATED_FIELDS_USER_SUBMISSIONS_LIST]
<p><b><%fieldname1_label%></b>: <i><%fieldname1_value%></i></p>
[/CP_CALCULATED_FIELDS_USER_SUBMISSIONS_LIST]
The add-on allows to assign permissions for "edit" or "delete" the entries. Actually, the submissions are not deleted, or its data modified from these actions, the real control over the data is only for the website's administrator. In the first case, the submission will be disabled, and will be hidden from the list of user's submissions, but the submission is always accessed by the website administrator through the messages section, and if the data are edited, the original entry will be disabled, and a new entry is generated and associated to the user.
There are other features included by this add-on, the "Messages" section is modified to include in the list of submissions the name of the submitter, furthermore, includes a new input field for filtering the events by users.
Developer Version Platinum Version
The new add-on: "User Registration Form", allows allows register new users through a form created with the Calculated Fields Form plugin.
The add ons allows even create the users' metadata required by other plugins.
Enabled: Allows to enable/disable the users registration through the form.
Notification: Send a notification email to the new user, the website's administrator, both, or to none of them.
User email field(required): name of field in the form for the user's email.
User login field(required): name of field in the form for the user's login.
User password field: name of field in the form for the user's password. If there is not a field for password it is generated dynamically.
User nicename field: name of field in the form for the user's nicename.
Display name field: name of field in the form for the user's display name.
User url field: name of field in the form for the URL to the user's webpage.
User role: select the role to apply the new users.
User metadata section. Allows to add pairs of input boxes for entering the metadata name, and the field's name corresponding to the user's metadata.
Login required: Error message to display if the login is empty.
Login exists: Error message to display if there is an user with the same login.
Login too long: Error message to display if the login is longer than 60 characters.
Email required: Error message to display if the email is empty.
Email invalid: Error message to display if the value entered by the user has no valid email format.
Email exists: Error message to display if there is an user with the same email.
Nicename too long: Error message to display if the nicename is longer than 50 characters.
Platinum Version
The "Upload Files" add-on allows to add the uploaded files through the forms to the Media Library, and access to them from the pages and posts of website.
Furthermore, it allows to include the support of new mime types, than files format supported by default by WordPress.
To add the uploaded files to the "Media Library" ticks the checkbox: "Add the uploaded files to the media library".
WordPress supports some specific mime types, for supporting new mime types, you simply should enter the files' extensions separated by comma.
Platinum Version
(Platinum version of the plugin)
The add-on converts the form fields selected in "Signature" fields, allowing the users to sign with the mouse or directly in the touchscreens.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Signature", and press the "Update" button.
From the form's settings, selects the fields to convert in Signature fields. It is possible convert multiple fields in the form in signature fields.
Signature settings:
Color: the color code for signatures. For example: #000000
Line thickness: an integer number defining the line thickness of the signature.
Show guideline: checkbox to include or not a guideline in the signature fields.
Guideline color: the color code for guideline. For example: #000000
Platinum Version
With the iCal addon the users will receive an iCal file as part of the confirmation email after the form submission. The iCal file allows to be imported into most popular calendars like Outlook and Google Calendar.
To activate the new iCal attachment add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF - iCal Export Attached", and press the "Activate/Deactivate addons" button.
With the add-on activated go to the form settings page and at the bottom of that page you can configure the iCal file that will be attached into the emails. You will need to specify the ID of the field that contains the date and you can modify the iCal content and time conversion settings if needed.
In the settings area the following information is needed to activate and setup the addon:
When enabled, after clicking the Calculated Fields Form submit button, an iCal file will be generated and attached to the emails.
Platinum Version
The CSV Generator add-on allows to export dynamically the information collected by the form to a CSV file, and send it as attachment in the notification emails.
To activate the CSV Generator add-on, visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF - CSV Generator", and press the "Activate/Deactivate addons" button.
After activated the add-on go to the form settings, pressing the "Settings" button associated to the form, and configure the add-on as follows:
Platinum Version
The PDF Generator is an experimental addon based on the dompdf api that allows to generate PDF files with the information collected by the forms, and send them as attachment of notification emails.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-PDF Generator", and press the "Activate/Deactivate Addons" button
The PDF Generator add on shown a new section in the form's settings for entering the HTML code with the file's structure, and input box for entering the file name.
Note: into the file's structure you can use the same special tags supported by the thank you pages and notification emails.
Developer Version Platinum Version
The developer version of the plugin includes the WooCommerce add-on, to integrate the forms created by the "Calculated Fields Form" with the WooCommerce products. The add-on inserts an additional metabox in the WooCommerce products, with multiple settings fields:
Note: If you want calculate the price of products through the form, will be required that you select the field of the price in the attribute: "Request cost" in the form's settings.
Note 2: The fields for weight, length, width, and height, can be required to calculate the shipping cost by the "WooCommerce Table Rate Shipping" plugin.
The add-on generates two global variables, for the id and price of the product where the form is inserted, called: woocommerce_cpcff_product and woocommerce_cpcff_product_price respectively.
For example, to duplicate the regular price of the product, insert a calculated field in the form with the following code as its equation:
woocommerce_cpcff_product_price*2
Platinum Version
The Platinum version of the plugin includes the Easy Digital Downloads add-on, to integrate the forms created by the "Calculated Fields Form" with the Easy Digital Downloads products. The add-on inserts an additional metabox in the EDD products, with multiple settings fields:
Note: If you want calculate the price of products through the form, will be required that you select the field of the price in the attribute: "Request cost" in the form's settings.
Some considerations:
Platinum Version
The platinum version of the plugin includes the "MailPoet" add-on. It allows to add new subscribers to the MailPoet Mailing Lists (MailPoet Version 2 and MailPoet Version 3) with the information collected by the forms. The add-on adds a new metabox in the form's settings, to create the relationship between the form's fields and the data required by MailPoet:
Platinum Version
The platinum version of the plugin includes the "AffiliateWP" add-on. AffiliateWP is a WordPress plugin that gives the affiliate marketing tool needed to grow a business and make more money.
The add-on is enabled through the settings page of the plugin, ticking the "CFF - Affiliate WP" checkbox and pressing the "Activate/Deactivate addons" button.
The add-on allows to integrate the forms with the AffiliateWP plugin. It adds a new metabox in the form's settings, to activate the integration and define the description to use with referrals:
Platinum Version
* Google Analytics is a third party service not related to our company.
The platinum version of the plugin includes the "Google Analytics" add-on to generate the usage reports in "Google Analytics" about the interactions of users with the form. The add-on adds a new metabox in the forms settings, to configure the events and exceptions that are sent to "Google Analytics" and when:
Sends a hit of "Event" type for every onfocus event triggered by the field. The hits can include the field's label, and it is possible to decide if send only one hit by field, or for each "onfocus" event in the field. The hits are sent with the event's category: "form", and the event action: "focus", the label of the event includes the form's id, the field's name, and the field's label, if the corresponding option was ticked.
Sends a hit of "Event" type if the form is loaded, or for every action: "Next Page", "Previous Page", or "Submit". The hits are sent with the event's category: "form", and the events' actions: "load", "next page", "previous page", and "submit", respectively. Each event includes a label with the form's id, and in case of next and previous page events, the page number. The events "next page" and "previous page" allow to know the pages that are reached by the users, and identify problems in the form's structure. The "submit" event allows to know how many users complete the form, comparing the amount of "submit" events with the "load" events.
Sends a hit of "Exception" type in every failed submission by an incorrect "CAPTCHA" code. It allows to know if the "CAPTCHA" images are difficult to read, and modify its settings to solve the issue.
Platinum Version
The add-on integrates the input fields in the form with the Google Places API to autocomplete the address entered by the users. The user only need to start typing the address, and the add-on displays a list of addresses matching with the typed text.
* Google Places is a third party service not related to our company. Google Places may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Google Places", and press the "Update" button...
...the plugin displays a new dialog for entering the Google API Key.
From the form's settings, selects the fields to associate with the Google Places API. It is possible apply the Google Places API to multiple fields in the form.
Furthermore it is possible restrict the search to one or multiple countries (maximum 5). The countries must be passed as as a two-character code, separated by comma.
Platinum Version
The add-on integrates the input fields in the form with the Photon API to autocomplete the address entered by the users. The user only need to start typing the address, and the add-on displays a list of addresses matching with the typed text.
* If you are using the default URL photon.komoot, it is a third party service not related to our company, and they decide the terms and conditions for the use of the API.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Autocomplete Places Integration", and press the "Activate/Deactivate Addons" button...
...the plugin uses by default the photon.komoot api, however if you prefer to use your own photon installation, enter its URL in this section.
From the form's settings, selects the fields to associate with the Autocomplete Places. It is possible apply the Autocomplete Places to multiple fields in the form.
Developer Version Platinum Version
The add-on allows to protect the forms using the Google reCAPTCHA instead of the captcha distributed with the plugin. reCAPTCHA is more visual and intuitive than the traditional captcha, with just a single click the users confirm they are not a robot.
reCAPTCHA (its official name is No CAPTCHA reCAPTCHA) as they define themselves:
reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive CAPTCHAs to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease.
reCAPTCHA offers more than just spam protection. Every time our CAPTCHAs are solved, that human effort helps digitize text, annotate images, and build machine learning datasets. This in turn helps preserve books, improve maps, and solve hard AI problems.
To use reCAPTCHA in your forms, activate the add-on in the the settings page of the plugin, through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF - reCAPTCHA", and press the "Update" button.
* Google reCaptcha is a third party service not related to our company.
The activation of reCAPTCHA displays a new section for entering the site key, and the secret key, two keys provided by Google reCAPTCHA to protect the website, and validate the forms submissions respectively.
If the site key and secret key were generated for an invisible reCAPTCHA, it si possible to tick the "Is it a key for invisible reCAPTCHA?" checkbox in the add-on settings to insert reCAPTCHA as invisible.
...through the form's settings it is possible to select the language to apply (English by default).
Developer Version Platinum Version
The add-on allows create new leads in the SalesForce account with the data submitted by the forms (https://www.salesforce.com).
* SalesForce is a third party service not related to our company. SalesForce may charge for their service.
To create new leads in SalesForce with the data submitted by a form, be sure that the SalesForce account has enabled the Web-to-lead option, and then go to the form's settings:
Note: The Add-on includes the list of predefined attributes of Leads, but it is possible to enter custom attributes too.
Developer Version Platinum Version
The add-on allows posting the submitted information by the forms to WebHooks URLs. With the WebHook add-on it is possible integrate the forms created by the plugin with services like Zapier, Microsoft Flow, or IFTTT. Zapier, Microsoft Flow, and IFTTT connect services as important and popular as Zoho CRM, Dropbox, Mailchimp, Evernote, Google Drive, Facebook, Twitter, and more than 300 services(Zapier apps, Microsoft Flow, IFTTT)
Use this add-on is as simple as entering the WebHooks URLs, through the CFF-WebHook section in the forms settings, and tick the checkbox for sending to the webhook all fields submitted by the form, or define only some of fields. To associate multiple WebHooks to the form, simply press the "Add new url" button, and define the data for the new webhooks.
Note: Concerning to Zapier service, select Webhook as the Trigger app, and "Catch Hook" as the trigger for this app. For Microsoft Flow, select Request
* Zapier is a third party service not related to our company. Zapier may charge for their services.
* Microsoft Flow is a third party service not related to our company. Microsoft Flow may charge for their services.
* IFTTT is a third party service not related to our company. IFTTT may charge for their services.
Additional details reading a case of use in the following blog post: WebHook Add On
Platinum Version
The add-on sends the information collected by the form to the FormStack documents service (formerly WebMerge) to generate a PDF file or Office document at runtime. Furthermore the generated document can be send to the user (https://www.webmerge.me/)
* FormStack documents is a third party service not related to our company. FormStack documents may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-WebMerge", and press the "Update" button...
After activate the WebMerge add on, the form settings will include a new section for entering the URL to the FormStack document, and the correspondence between the variables in the document, and fields in the form.
Pressing the "Add a New Document" button it is possible to associate multiple documents to a same form, and pressing the "Add Field" button it is possible associate multiple variables and form fields to a document.
Each document in FormStack has its own URL with the corresponding ID and Key code.
Additional details reading a case of use in the following blog post: Generating PDF files at runtime with the information collected by the form
In Silverpop (SP), build and publish a landing page form with all fields you want to use.
From the web form properties, find the block of code labeled "External form post"
If the form tag has a structure similar to:
<form method="post" action="http://mycompany.mkt9999.com/subgroup/myform" pageId="12345678" siteId="123456" parentPageId="12345678">
Enter as the WebMerge (FormStack) document the URL (or the WebHook URL in the case of WebHook add-on): http://mycompany.mkt9999.com/myform?pageId=12345678&siteId=123456&parentPageId=12345678
Copy the "name" attributes of every field in the form, including the "hide" fields, to create the correspondence between the fields in the Silverpop form, and the name of fields in the form created with our plugin.
For example, in the tag:
<input type="text" name="Last Name" id="control_COLUMN4" class="textInput defaultText" style="margin: 0 3px 5px 3px; height: 20px; width: 294px;">
the field's name would be: Las Name
Platinum Version
The add-on integrates the form with the PrintFriendly API to generate a PDF file after the form be submitted, and attach the resulting file to the notification emails (https://www.printfriendly.com/)
* PrintFriendly is a third party service not related to our company. PrintFriendly may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-PrintFriendly", and press the "Activate/Deactivate Addons" button...
After activate the add-on will be shown a new section in the settings page of the plugin for entering the PrintFriendly API Key.
The PrintFriendly add on shown a new section in the form's settings for entering the HTML code with the file's structure, and input box for entering the text to display as header, and another input box for entering the URL to the CSS file to define the file's design.
Note: into the file's structure you can use the same special tags supported by the thank you pages and notification emails.
Platinum Version
The "DropBox Integration" add-on allows to copy or move the uploaded files through the forms to a DropBox.
* DropBox is a third party service not related to our company.
Enter the Token Access to access the DropBox account.
To remove the copies of files from the WordPress website, tick the checkbox: "Delete the local copy of file".
Note: To copy the files to the DropBox account is required create a DropBox App, and generate a token access.
Access your account, to the reserved area where configure an App: https://www.dropbox.com/developers/apps/create
In the next screen press the "Generate" button to generate an access token
Finally, copy the generated access token to be used with the add-on.
Platinum Version
The add on integrates the Calculated Fields Form with the ip2location databases to identify additional information of users based on their IP, as: Country, City Name, Coordinates, Weather Station, Time Zone, ZIP Code, etc...
* ip2location is a third party service not related to our company. ip2location may charge for their databases.
Note: Requires PHP 5.3 and over.
Uplods the ip2location database's files to the correct location in the webserver (/wp-content/uploads/), and then, enters the files' names in the add on settings
Tick the checkboxes of the information you want get of users.
If has been selected the option to include the users information in the notification emails, and the add-on is enabled, the notification email will include all extracted data.
Platinum Version
The add-on creates new members in the MailChimp service with the information collected by the forms in the website: www.mailchimp.com.
MailChimp is an online email marketing solution to manage subscribers, send emails, and track results.
* MailChimp is a third party service not related to our company. MailChimp may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-MailChimp", and press the "Update" button...
After activate the MailChimp add-on, the form settings will include a new section to create the correspondence between the signup form associated to a list in MailChimp, and the form fields in the form created with the "Calculated Fields Form" plugin.
Platinum Version
The add-on creates new contacts (or update the existent ones) in the Mautic website with the information collected by the forms in the website.
Mautic offers the first open marketing cloud, enabling companies to connect all their digital properties and channels into a seamless customer experience.
* Mautic is a third party service not related to our company. Mautic may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Mautic", and press the "Activate/Deactivate addons" button...
After activate the Mautic add-on, the form settings will include a new section to create the relationship between the fields in the Mautic form and the fields in the form created with the "Calculated Fields Form" plugin.
Platinum Version
The add-on creates/updates contacts in the HubSpot website with the information collected by the forms on the website.
HubSpot is a developer and marketer of software products for inbound marketing and sales.
* HubSpot is a third party service not related to our company. HubSpot may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-HubSpot", and press the "Activate/Deactivate addons" button...
After activate the HubSpot add-on, the form settings will include a new section to create the relationship between the HubSpot attributes and the fields in the form created with the "Calculated Fields Form" plugin.
Platinum Version
Emma's digital marketing platform makes it easy to create beautifully designed emails that drive results. It helps to plan, execute, and optimize campaigns to hit the business goals faster.The add-on adds new members to the Emma's digital marketing platform with the information collected by the forms in the website.
* Emma is a third party service not related to our company. Emma may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Emma", and press the "Update" button...
After activate the Emma add-on, would be available a new section for entering the "Account ID", "Public API Key", and "Private API Key" associated to the Emma account.
The Emma add-on includes a new section in the form's settings to create the relationship between the Emma fields and form's fields (press the "Get Fields" button to get the complete fields list), and select the Emma groups where to add the new members (press the "Get Groups" button to get the complete list of groups).
Platinum Version
The Twilio service allows sending messages (SMS) to mobile phones around the world.The add-on integrates the forms with the Twilio service for sending notification messages (SMS) after submit the forms.
* Twilio is a third party service not related to our company. Twilio may charge for their service.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Twilio", and press the "Activate/Deactivate addons" button...
After activate the Twilio add-on, would be available a new section section in the form's settings for entering the required data.
The add-on settings are:
Twilio enabled: for enabling/disabling the integration with the form.
Account SID: enter the Account SID provided by Twilio.
Authentication Token: enter the Authentication Token provided by Twilio.
From Phone Number: enter the phone number used as the "Origin" of SMS (enter a valid phone number including the country code).
To Phone Number: enter the phone numbers (separated by comma symbols) where to send the SMS (enter a valid phone number including the country code).
Message: enter SMS content (it is possible to use the same special tags than in the notification emails).
To Phone fields: enter the names of phone fields inserted in the form (fieldname#, separated by comma symbols).
Message: enter SMS content (it is possible to use the same special tags than in the notification emails).
Platinum Version
With Payment Form for PayPal Pro you can insert a form into a WordPress website and use it to process credit card payments directly into your website without navigating to an external payment page.
You can check the differences betwen PayPal Pro and PayPal Standard at https://www.paypal.com/webapps/mpp/compare-business-products
For integrating PayPal Pro you must have a PayPal Pro account. In addition to that a SSL connection is also needed, the SSL connection isn't a technical requirement since the plugin can work without it but anyway it is strongly recommended for accepting credit cards into your website, otherwise the transactions won't be secure.
In the settings area the following information is needed to activate and link the PayPal Pro account to the form:
When enabled, the form on the public website will display an additional set of fields to request the data needed to process the payment, like for example the billing address, credit card details. This info is only for the payment processing, as mentioned it won't be stored into the website for security reasons.
After the submission Once the payment is processed and the posted data (excluding the credit card related information) is saved into the WordPress database.
Platinum Version
The Authorize.net Server Server Integration Method (Authorize.net SIM) is a hosted payment processing solution that handles all of the steps in processing a transaction, including:
Authorize.net SIM is an ideal integration solution because merchants are not required to collect, transmit, or store sensitive cardholder information to process transactions. Additionally, Authorize.net SIM does not require merchants to purchase and install a SSL or TLS digital certificate, reducing the complexity of securely handling and storing cardholder information, simplifying compliance with the Payment Card Industry (PCI) Data Security Standard. For more information go to www.authorize.net
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Authorize.net Server Integration Method", and press the "Activate/Deactivate addons" button
In the settings area the following information is needed to activate and link the Authorize.net Server Integration Method account to the form:
Enable Authorize.net SIM?: Select "Yes" to enable the Authorize.net Server Integration Method payment.
Mode: Change the mode between "test" for testing purposes and "production" for accepting real payments.
API Username: Change this value with API Username received from Authorize.net.
API Key: Change this value with API Key received from Authorize.net.
Receipt URL: User will return here after a successfull payment.
Cancel URL: User will return here if payment fails.
In addition to the above required setting fields there are other fields to link the form fields to the Authorize.net payment form, like for example the client name, address, phone, email, ... These fields are optional. To link the fields you can indicate the ID of the field on the form that contains the related info. Sample values: fieldname1, fieldname2, ..
When enabled, the customer will be redirected to the Authorize.net Server Integration Method payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The Stripe Payments addon provides a way to accept all major cards from customers around the world on web. This addon requires SSL on your website to be able to carry the transaction in a secure way. Credit card data is entered directly in the website without navigating to an external page.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Stripe Payment Integration", and press the "Activate/Deactivate add-ons" button...
In the settings area the following information is needed to activate and link the stripe account to the form:
When enabled, after clicking the Calculated Fields Form submit button, a Stripe floating panel will be displayed to ask for the credit card data and process the transaction and after that the form submission will continue as usual keeping the customer all the time into your website.
Platinum Version
The Skrill Payments addon provides a secure interface for accepting payments through a secure page. You can accept cards, more than 20 local payment methods and over 80 direct bank transfer connections with a single integration. Form more information go to https://www.skrill.com/en/merchants/
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-Skrill Payment Integration", and press the "Activate/Deactivate addons" button.
In the settings area the following information is needed to activate and link the Skrill account to the form:
Enable Skrill Payments?: Select "Yes" to enable the Skrill Payments Integration.
Skrill Email?: Emai linked to the Skrill merchant account, this will be the account that will receive the payments.
Receipt URL: User will return here after a successfull payment.
Cancel URL: User will return here if payment fails.
Currency: Currency code for the received payment. example: USD, EUR, CAD, GBP ....
When enabled, the customer will be redirected to the Skrill hosted payment form payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The TargetPay addon provides integration with iDeal, the most popular Dutch payment method. The integration is made via TargetPay: https://www.targetpay.com/info/ideal?setlang=en
With TargetPay you can set up iDEAL payments for your website easily. Acting as a "Payment Service Provider" it aggregates payments for a large number of webstores. The iDEAL platform combines the online banking systems of 10 of the largest Dutch banks (ABN AMRO, ASN Bank, Bunq, ING, Knab, Rabobank, RegioBank, SNS Bank, Triodos Bank and van Lanschot) into one payment method.
After the consumer selects the iDEAL payment method the consumer's bank is selected. The actual payment then takes place in the bank's trusted online banking environment for which security is guaranteed by the bank. Through iDEAL buyer and seller are guaranteed a transparent transaction without hidden fees or other unpleasant surprises.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-iDeal TargetPay", and press the "Activate/Deactivate Addons" button.
In the settings area the following information is needed to activate and link the iDeal-TargetPay account to the form:
Enable iDeal-TargetPay?: Select "Yes" to enable the iDeal-TargetPay payment option for the form.
RTLO Subaccount ID: Change this value with the account ID received from iDeal-TargetPay.
If payment fails return to this page: Return page if the payment fails or is cancelled before completing it.
Payments Mode: Change the mode between "test" for testing purposes and "production" for accepting real payments.
When enabled, the customer will be redirected to the iDeal-TargetPay payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The Mollie addon provides integration with iDeal, the most popular Dutch payment method. The integration is made via Mollie: www.mollie.com.
You're easily connected to iDEAL through Mollie without the dreaded technical and administrative hassle. The iDEAL platform combines the online banking systems of 10 of the largest Dutch banks (ABN AMRO, ASN Bank, Bunq, ING, Knab, Rabobank, RegioBank, SNS Bank, Triodos Bank and van Lanschot) into one payment method.
After the consumer selects the iDEAL payment method the consumer's bank is selected. The actual payment then takes place in the bank's trusted online banking environment for which security is guaranteed by the bank. Through iDEAL buyer and seller are guaranteed a transparent transaction without hidden fees or other unpleasant surprises.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-iDeal Mollie", and press the "Update" button...
In the settings area the following information is needed to activate and link the Mollie - iDeal account to the form:
Enable iDeal-Mollie?: Select "Yes" to enable the Mollie - iDeal addon.
Mollie API Key: The API Username provided by Mollie for your account, it may be the test key or the production key.
If payment fails return to this page: If the payment fails the customer is redirected to the page indicated in this field.
When enabled, the customer will be redirected to the Mollie - iDeal payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The RedSys / Servired / Sermepa addon provides a secure interface for accepting credit card payments through most banks in Spain (Sabadell, Banco Popular, BBVA, Santander, Bankia, Caixa, Bankinter, etc...). You can read more about RedSys at www.redsys.es.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-RedSys TPV", and press the "Update" button...
In the settings area the following information is needed to activate and link the RedSys account to the form:
Enable TPV: Select "Yes" to enable the RedSys TPV. If "Pay Later" or "PayPal" are also selected in this option, a radiobutton will appear in the form to select if the payment will be made with RedSys, with PayPal or if the form will be submitted without payment.
CÓDIGO COMERCIO: The API Username provided by RedSys or your bank.
CLAVE SECRETA: The API Password provided by RedSys or your bank.
Mode: Select "Sandbox" for testing purposes and "Production" for charging real payments.
When enabled, the customer will be redirected to the RedSys payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The SagePay addon provides a secure interface for accepting payments through SagePay. You can read more about SagePay at www.sagepay.co.uk.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-SagePay", and press the "Update" button...
In the settings area the following information is needed to activate and link the SagePay account to the form:
Enable SagePay?: Select "Yes" to enable the SagePay payment gateway.
Vendor ID: The Vendor ID provided by SagePay.
SagePay Encrypt Password: The SagePay Encrypt Password provided by PayTM.
Mode: Select "Sandbox" for testing purposes and "Production" for charging real payments.
When enabled, the customer will be redirected to the SagePay payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The SagePayments addon provides a secure interface for accepting payments through a secure SSL checkout system for both bankcard and virtual check transactions. All authorized and approved transactions will be delivered into your current bankcard and/or virtual check batches viewable within the Virtual Terminal for order processing and settlement. You can read more about Sage Payment Solutions at http://www.sage.com/us/sage-payment-solutions/accept-payments. The integration implemented in this addon is for Sage Payment Solutions >> Shopping ExpressPay
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", "CFF-SagePayments Payment Gateway", and press the "Update" button.
In the settings area the following information is needed to activate and link the Sage Payment Solutions >> Shopping ExpressPay account to the form:
Enable SagePayments?: Select "Yes" to enable the SagePayments TPV.
Merchant ID (M_id): Change this value with M_id received from SagePayments.
In addition to the mentioned two required setting field there are other fields to link the form fields to the Sage Payment Solutions payment form, like for example the client name, address, phone, email, tax and shipping cost. These fields are optionals and to link the fields you can indicate the ID of the field on the form that contains the related info. Sample values: fieldname1, fieldname2, ...
When enabled, the customer will be redirected to the Sage Payment Solutions payment form after the submision. The process will be similar to the way PayPal Standard works.
Platinum Version
The PayTM addon provides a secure interface for accepting payments through credit card, debir cards, net banking, wallet and EMI. With over 100mn Paytm users in India, your customers will love the option to pay with their trusted Paytm Wallet. You can read more about PayTM at paywithpaytm.com.
To activate the add-on, simply visit the plugin page through the menu option: "Settings/Calculated Fields Form", tick the checkbox: "CFF-PayTM", and press the "Update" button...
In the settings area the following information is needed to activate and link the PayTM account to the form:
Enable PayTM?: Select "Yes" to enable the PayTM payment gateway.
Merchant ID: The Merchant ID provided by PayTM.
Merchant Key: The Merchant Key provided by PayTM.
Website Name: The Website Name provided by PayTM.
Industry Type ID: The Industry Type ID provided by PayTM.
Mode: Select "Sandbox" for testing purposes and "Production" for charging real payments.
When enabled, the customer will be redirected to the PayTM payment form after the submision. The process will be similar to the way PayPal Standard works.
The equations allowed by the plugin "Calculated Fields Form" are really powerful tools.
Need more controls or operations?It is possible create simple equations like follow:
All Versions of the Plugin
fieldname1+fieldname2
fieldname1*fieldname2
fieldname1/fieldname2
fieldname1-fieldname2
or mathematical equations with multiple fields and fields grouping included.
fieldname1*(fieldname2+fieldname3)
some of them available as buttons in the plugin's interface, the other operations should be typed manually in the equation's editor:
| Operation | Description | Demo |
|---|---|---|
| sum(x,y,z,....) | Returns the sum of values passed by parameter | sum(3,10,11) returns 24 |
| concatenate(x,y,z,....) | Returns a text with all parameters concatenated | concatenate(1, 2, 3) returns 123 |
| abs(x) | Returns the absolute value of x | If the value of fieldname1 is -7.25, the result of: abs(fieldname1) would be 7.25 |
| acos(x) | Returns the arccosine of x, in radians | If the value of fieldname1 is 0.5, the result of: acos(fieldname1) would be 1.0471975511965979 |
| asin(x) | Returns the arcsine of x, in radians | If the value of fieldname1 is 0.5, the result of: asin(fieldname1) would be 0.5235987755982989 |
| atan(x) | Returns the arctangent of x as a numeric value between -PI/2 and PI/2 radians | If the value of fieldname1 is 2, the result of: atan(fieldname1) would be 1.1071487177940904 |
| atan2(x,y) | Returns the arctangent of the quotient of its arguments | If the value of fieldname1 is 8 and fieldname2 is 4, the result of: atan2(fieldname1,fieldname2) would be 1.1071487177940904 |
| ceil(x) | Returns x, rounded upwards to the nearest integer. The ceil operation accepts a second parameter, that is optional, for rounding upwards the main number to the nearest multiple of this parameter. |
If the value of fieldname1 is 1.4, the result of: ceil(fieldname1) would be 2 ceil(2.3, 0.5) = 2.5 |
| cos(x) | Returns the cosine of x (x is in radians) | If the value of fieldname1 is 3, the result of: cos(fieldname1) would be -0.9899924966004454 |
| radians(x) | Converts an angle in degrees to radians (x is in degrees) | If the value of fieldname1 is 90, the result of: radians(fieldname1) would be 1.5707963267948966 |
| degrees(x) | Converts an angle in radians to degrees (x is in radians) | If the value of fieldname1 is 1.5707963267948966, the result of: degrees(fieldname1) would be 90 |
| exp(x) | Returns the value of E^x | If the value of fieldname1 is 1, the result of: exp(fieldname1) would be 2.718281828459045 |
| floor(x) | Returns x, rounded downwards to the nearest integer. The floor operation accepts a second parameter, that is optional, for rounding downwards the main number to the nearest multiple of this parameter. |
If the value of fieldname1 is 1.6, the result of: floor(fieldname1) would be 1 floor(2.6, 0.5) = 2.5 |
| log(x) | Returns the natural logarithm (base E) of x | If the value of fieldname1 is 2, the result of: log(fieldname1) would be 0.6931471805599453 |
| logab(x,y) | Returns the logarithm of x base y | If the value of fieldname1 is 2, and the value of fieldname2 is 10, the result of: logab(fieldname1,fieldname2) would be 0.30102999566398114 |
| max(x,y,z,...,n) | Returns the number with the highest value | If the value of fieldname1 is 5 and fieldname2 is 10, the result of: max(fieldname1, fieldname2) would be 10 |
| min(x,y,z,...,n) | Returns the number with the lowest value | If the value of fieldname1 is 5 and fieldname2 is 10, the result of: min(fieldname1, fieldname2) would be 5 |
| pow(x,y) | Returns the value of x to the power of y | If the value of fieldname1 is 4 and fieldname2 is 3, the result of: pow(fieldname1, fieldname2) would be 64 |
| random() | Returns a random number between 0 and 1 | |
| round(x) | Rounds x to the nearest integer. The round operation accepts a second parameter, that is optional, for rounding the main number to the nearest multiple of this parameter. |
If the value of fieldname1 is 2.5, the result of: round(fieldname1) would be 3 round(2.3, 0.5) = 2.5 |
| sin(x) | Returns the sine of x (x is in radians) | If the value of fieldname1 is 3, the result of: sin(fieldname1) would be 0.1411200080598672 |
| sqrt(x) | Returns the square root of x | If the value of fieldname1 is 9, the result of: sqrt(fieldname1) would be 3 |
| tan(x) | Returns the tangent of an angle | If the value of fieldname1 is 90, the result of: tan(fieldname1) would be -1.995200412208242 |
| gcd(x,y) | Returns the greatest common divisor between x and y | If the value of fieldname1 is 16, and the value of the fieldname2 is 12 the result of: gcd(fieldname1,fieldname2) would be 4 |
| lcm(x,y) | Returns the least common multiple between two numbers | If the value of fieldname1 is 3, and the value of the fieldname2 is 5 the result of: lcm(fieldname1,fieldname2) would be 15 |
Pay special attention to the next two operations. The first of them, very extended its use in equations for calculations the cost of products and services, and the other one to obtain a date.
To calculate the monthly payment in a lease calculator:
The fields implied are:
Load amount: fieldname1
Residual value: fieldname2
Interest rate %: fieldname3
Number of months: fieldname4
The corresponding equation for monthly payment is:
prec((fieldname1*fieldname3/1200*pow(1+fieldname3/1200,fieldname4)-fieldname2*fieldname3/1200)/(pow(1+fieldname3/1200,fieldname8)-1),2)
There is a huge number of equations that can't be recreated with simple mathematical operators, or the operations listed above.
| Operation | Description | Demo |
|---|---|---|
Pay attention to the following sample:
In your form there are four fields: fieldname1, fieldname2, fieldname3 and the calculated field: fieldname4, but the value of fieldname4 is dependent of fieldname3 value, that is:
The value of fieldname4 will be: fieldname1+fieldname2, if the value of fieldname3 is greater than 100, or will be: fieldname1*fieldname2, if the value of fieldname3 is less than or equal to 100. Neither of previous operations, by itself, can calculate the value of fieldname4.
To solve complex cases like this, the "Calculated Fields Form" plugin allows entering javascript code directly in the equation editor, like the following sample:
(function(){
if(fieldname3 > 100) return fieldname1+fieldname2;
if(fieldname3 <= 100) return fieldname1*fieldname2;
})();
For complex equations where is required to define blocks of javascript code, you must use the following format:
(function(){
//Your code here
})();
and the return the value of that function will be the value assigned to the calculated field:
return fieldname1+fieldname2;
Pay attention, the plugin removes the changes of lines from the equations at runtime. So, if the equation is defined with the "function" format:
(function(){
//Your code here
})();
It is really important to include the semicolon symbols (;) at the end of the code lines, furthermore, if the equation is really complex, and you want to include comments for future references, should be used the format for multiple lines comments: /* comment here */, but never the format for single line of comments: // comment here
All Versions of the Plugin
The logical module includes the following operations:
| Function | Description | Demo |
|---|---|---|
| IF(condition, value if true, value if false) | Checks whether a condition is met, and returns one value if true, and another if false.IF(logical_test, value_if_true, value_if_false) | If the value of fieldname1 is 10 and the value of fieldname2 is 20, the result of: IF(fieldname1 < fieldname2, fieldname1, fieldname2) |
| AND(x,y,z,....) | Checks whether all arguments are true, and return true if all values are true, and false in another way. AND(logical1,logical2,...) | Suppose there are three fields, fieldname1, fieldname2 and fieldname3, with values: 10, 20 and 30 respectively, so: AND( fieldname1<100, fieldname2<100, fieldname3<100) but AND( fieldname1<100, fieldname2<100, fieldname3<25) |
| OR(x,y,z,....) | Checks whether any of arguments is true, and return true if any of values is true, and false if all values are false. OR(logical1,logical2,...) | Suppose there are three fields, fieldname1, fieldname2 and fieldname3, with values: 10, 20 and 30 respectively, so: OR( fieldname1<100, fieldname2<100, fieldname3<25) but OR( fieldname1<5, fieldname2<5, fieldname3<25) |
| NOT(x) | Changes false to true, or true to false.NOT(logical) | NOT(true) NOT(false) |
| IN(x,[x,y,z,....]) | Checks whether the term is included in the second argument, the second argument may be a string or strings array. IN(term, string/array) | IN(10,[10,20,30,40]) IN('world', 'hello world') |
Developer Version Platinum Version
The module includes a pack of functions to improve the implementation of financial equations. Distributed with the Developer or Platinum versions of the plugin.
The CALCULATEAMORTIZATION is the operation with most complexity in the "Calculated Fields Form" and requires its own section.
The CALCULATEAMORTIZATION operation returns a list of objects. For example:
CALCULATEAMORTIZATION(25000, 60, 5.25, new Date(2011,11,20) )
Result: [ { principle: 24634.725 interest: 109.375 payment: 474.65 paymentToPrinciple: 365.275 paymentToInterest: 109.375 date: Tue Dec 20 2011 00:00:00 GMT+0100 (Romance Daylight Time) }, { principle: 24267.851921874997 interest: 217.151921875 payment: 474.65 paymentToPrinciple: 366.873078125 paymentToInterest: 107.776921875 date: Fri Jan 20 2012 00:00:00 GMT+0100 (Romance Daylight Time) }, ... ]
In the following example, we explain the use of the CALCULATEAMORTIZATION operation: the fieldname1 represents the principle amount, fieldname3 the number of months, and the fieldname2 the interest rate.
So, the value returned by CALCULATEAMORTIZATION(fieldname1,fieldname3,fieldname2) cannot by assigned directly to the calculated field, or will be displayed a text like: [object],[object],...... Therefore, we'll need to create a formatted string, with HTML tags, to display the CALCULATEAMORTIZATION results in an understandable format.
(function(){
var r = CALCULATEAMORTIZATION(fieldname1,fieldname3,fieldname2),
str = '';
if(r.length)
{
str = '<table cellpadding=" 10" >';
str += '<tr>';
str += '<td>Date</td>';
str += '<td>Interest</td>';
str += '<td>Payment</td>';
str += '<td>Payment to Interest</td>';
str += '<td>Payment to Principle</td>';
str += '<td>Principle</td>';
str += '</tr>';
for(var i = 0, h = r.length; i < h; i++)
{
str += '<tr>';
str += '<td>'+GETDATETIMESTRING( new Date(r[i]['date']), 'yyyy-mm-dd')+'</td>';
str += '<td>'+PREC(r[i]['interest'],2)+'</td>';
str += '<td>'+PREC(r[i]['payment'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToInterest'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToPrinciple'],2)+'</td>';
str += '<td>'+PREC(r[i]['principle'],2)+'</td>';
str += '</tr>';
}
str += '</table>';
}
jQuery('.result-here').html( str );
})()
The first step will be store the list of objects returned by the CALCULATEAMORTIZATION operation, in a local variable, and create another variable to store the amortization data, but with an HTML format:
var r = CALCULATEAMORTIZATION(fieldname1,fieldname3,fieldname2), str = '';
The equation validates if the previous operation returns a value, because if the CALCULATEAMORTIZATION was called with wrong values can return an empty array:
if(r.length)
{
...
}
I've decided display the results of CALCULATEAMORTIZATION operation in a tabular format because is easier to understand. The first element in the result is the tag to open the table: <table>, and the row with the column names:
str = '<table cellpadding=" 10" >'; str += '<tr>'; str += '<td>Date</td>'; str += '<td>Interest</td>'; str += '<td>Payment</td>'; str += '<td>Payment to Interest</td>'; str += '<td>Payment to Principle</td>'; str += '<td>Principle</td>'; str += '</tr>';
Now, it is the moment to create each row of the table with the values of monthly amortization.
for(var i = 0, h = r.length; i < h; i++)
{
str += '<tr>';
str += '<td>'+GETDATETIMESTRING( new Date(r[i]['date']), 'yyyy-mm-dd')+'</td>';
str += '<td>'+PREC(r[i]['interest'],2)+'</td>';
str += '<td>'+PREC(r[i]['payment'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToInterest'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToPrinciple'],2)+'</td>';
str += '<td>'+PREC(r[i]['principle'],2)+'</td>';
str += '</tr>';
}
The previous code has its particularities. By default the dates returned by the CALCULATEAMORTIZATION operation have the complete format including hours and seconds, In this form the information about hours and seconds is not relevant, so, it is preferred to use a short date format: yyyy-mm-dd. The date string will be formatted with the GETDATETIMESTRING operation, included in the Date module of developers version of the plugin (the second parameter is the format to use):
str += '<td>'+GETDATETIMESTRING( new Date(r[i]['date']), 'yyyy-mm-dd')+'</td>';
Another particularity is the use of the PREC operation. By default the CALCULATEAMORTIZATION returns the numeric values with all its decimals digits, for example: 366.873078125, but for humans it is common to identify the money representation with two decimal digits. So, I've used the PREC operation with the number 2 as the second parameter.
str += '<td>'+PREC(r[i]['interest'],2)+'</td>';
After creating all table rows, it is time to close the table, and print the results:
str += '</table>';
If you display the result directly in the calculated field, you will see a weird text (or very hard to understand) because the input fields in HTML are not able to display tables, in this case I've preferred to show the result in an "HTML Content" field. I've inserted an "HTML Content" field in the form, and entered a DIV tag as its content with the class name: result-here <div class="result-here"></div>. Then, using jQuery to display the table with the results into the DIV tag:
jQuery('.result-here').html( str );
The complete equation is:
(function(){
var r = CALCULATEAMORTIZATION(fieldname1,fieldname3,fieldname2),
str = '';
if(r.length)
{
str = '<table cellpadding=" 10" >';
str += '<tr>';
str += '<td>Date</td>';
str += '<td>Interest</td>';
str += '<td>Payment</td>';
str += '<td>Payment to Interest</td>';
str += '<td>Payment to Principle</td>';
str += '<td>Principle</td>';
str += '</tr>';
for(var i = 0, h = r.length; i < h; i++)
{
str += '<tr>';
str += '<td>'+GETDATETIMESTRING( new Date(r[i]['date']), 'yyyy-mm-dd')+'</td>';
str += '<td>'+PREC(r[i]['interest'],2)+'</td>';
str += '<td>'+PREC(r[i]['payment'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToInterest'],2)+'</td>';
str += '<td>'+PREC(r[i]['paymentToPrinciple'],2)+'</td>';
str += '<td>'+PREC(r[i]['principle'],2)+'</td>';
str += '</tr>';
}
str += '</table>';
}
jQuery('.result-here').html( str );
})()
| Operation | Description | Demo |
|---|---|---|
| PRESENTVALUE(x,y,z) | Returns the present value of an investment |
Ex: PRESENTVALUE(0.08,5,100) |
| FUTUREVALUE(v,w,x,y,z) | Returns an investment based on an interest rate and a constant payment schedule. Five parameters: The interest rate for the investment, the number of payments for the annuity, the amount of the payment made each period, the present value of the payments (if this parameter is omitted, it assumes to be 0), parameter that indicates when the payments are due (if this parameter is omitted, it assumes to be 0. The possible values are: 0 - Payments are due at the end of the period, 1 - Payments are due at the beginning of the period) |
Ex: FUTUREVALUE(7.5/12,24,-250,-5000,1) |
| PMT(Rate,NPer,PV,FV,TYPE) | Returns the periodic payment for an annuity with constant interest rates Rate is the periodic interest rate. |
Ex: PMT(1.99/12,36,25000) Result: -715.96 |
| IPMT(Rate,Period,NPer,PV,FV,TYPE) | Calculates the periodic amortizement for an investment with regular payments and a constant interest rate Rate is the periodic interest rate (%). |
Ex: IPMT(5,5,7,15000) Result: -352.9735 |
| PPMT(Rate,Period,NPer,PV,FV,TYPE) | Returns for a given period the payment on the principal for an investment that is based on periodic and constant payments and a constant interest rate Rate is the periodic interest rate (%). |
Ex: PPMT(8.75/12,1,36,5000,8000,1) Result: -350.99 |
| PVIF(Rate,Periods) | Calculates the today value per currency received at a future date Rate is interest rate per period (%). |
Ex: PVIF(5,10) Result: 0.6139 |
| FVIFA(Rate,Periods) | Calculates the future value interest factor of annuity Rate is interest rate per period (%). |
Ex: FVIFA(5,17) Result: 25.8404 |
| NPV(Rate,Values) | Calculates the net present value of an investment based on a discount rate and a series of periodic cash flows. Rate is the discount rate of the investment over one period (%). |
Ex: NPV(10,[-10000,3000,4200,6800]) Result: 1188.44 |
| XNPV(Rate,Values,Dates) | Calculates the capital value (net present value)for a list of payments which take place on different dates Rate is the internal rate of return for the payments (%). |
Ex: XNPV(9,[-10000,2750,4250,3250,2750],['1/1/2008', '3/1/2008', '10/30/2008', '2/15/2009', '4/1/2009']) Result: 2068.65 |
| XIRR(Values,Dates,Guess) | Calculates the internal rate of return for a list of payments which take place on different dates The calculation is based on a 365 days per year basis, ignoring leap years. Values and Dates refer to a series of payments and the series of associated date values. The first pair of dates defines the start of the payment plan. All other date values must be later, but need not be in any order. The series of values must contain at least one negative and one positive value (receipts and deposits). |
Ex: XIRR([-10000,2000,2500,5000,1000],['01/01/2001', '01/02/2001', '03/15/2001', '05/12/2001', '08/10/2001'],10) Result: 0.1948184751 |
| MIRR(Values,Dates,Guess) | Calculates the modified internal rate of return on an investment based on a series of periodic cash flows and the difference between the interest rate paid on financing versus the return received on reinvested income. Values is the array of values containing the income or payments associated with the investment. |
Ex: MIRR([-120000, 39000, 30000, 21000, 37000, 46000], 10, 12) Result: 12.61 |
Formats a Number One parameters: number Ex:NUMBERFORMAT(-2530023420269.123456) Ex: NUMBERFORMAT(25000.123456, {precision:2}) Format Currency Formats a number to a certain currency. Two parameters: number, settings (optional). If settings option is a string it is treated as a currency name. If it is an object it is used as currency settings. Ex: NUMBERFORMAT(25000.123456, 'USD') The settings of format can be overridden with the "options" parameter. Ex: NUMBERFORMAT(-25000.123456, 'GBP', { negative: '()', precision: 3, thousand: '' }) Format a Percent Formats a number with a certain precision. Two parameters: number, settings ("percent" is a format) Ex: NUMBERFORMAT(25000.123456, 'percent') |
||
Create a Currency You may create a currency. The library comes with "USD", "GBP", and "EUR" currency formats and "number" and "percent" numeric formats. Two parameters: key, settings Ex: ADDFORMAT('Dollars', { before: '', after: ' Dollars', precision: 0, thousand: ',', group: 3, decimal: '.', negative: '-' }) Ex: NUMBERFORMAT(25000.123456, 'Dollars') |
||
| REMOVEFORMAT(x) | Removes a Currency |
Ex: REMOVEFORMAT('Dollars') |
Developer Version Platinum Version
The Date Time module includes a group of operations to manage dates and times. Distributed with the Developer or Platinum versions of the plugin.
| Operation | Description | Demo |
|---|---|---|
| DATEOBJ(x,y) | Gets the date object from a string representation of date. DATEOBJ( date_string, format ) |
DATEOBJ('2013-05-21', 'yyyy-mm-dd') |
| YEAR(x,y) | Gets the year from an string representation of date. YEAR( date_string, format ) |
YEAR('2013-05-21', 'yyyy-mm-dd') |
| MONTH(x,y) | Gets the month from a string representation of date. MONTH( date_string, format ) |
MONTH('2013-05-21', 'yyyy-mm-dd') |
| DAY(x,y) | Gets the days from a string representation of date. DAY( date_string, format ) |
DAY('2013-05-21', 'yyyy-mm-dd') |
| WEEKDAY(x,y) | Gets the week day from a string representation of date. WEEKDAY( date_string, format ) |
WEEKDAY('2013-10-27', 'yyyy-mm-dd') |
| WEEKNUM(x,y) | Gets the week number from a string representation of date, a year has 53 weeks.WEEKNUM( date_string, format ) |
WEEKNUM('2013-10-27', 'yyyy-mm-dd') |
| HOURS(x,y) | Gets hours from a string representation of datetime. HOURS( datetime_string, format ) |
HOURS('2013-10-27 01:21', 'yyyy-mm-dd hh:ii') |
| MINUTES(x,y) | Gets minutes from a string representation of datetime. MINUTES( datetime_string, format ) |
MINUTES('2013-10-27 01:22', 'yyyy-mm-dd hh:ii') |
| SECONDS(x,y) | Gets seconds from a string representation of datetime. SECONDS( datetime_string, format ) |
SECONDS('2013-10-27 01:22:56', 'yyyy-mm-dd hh:ii:ss') |
| NOW() | Gets a date object with the current day-time information. NOW() |
NOW() |
| TODAY() | Gets a date object with the current day information, without the time part.TODAY() |
|
| DATEDIFF(date_one, date_two, date_format, return) | Gets the difference between two dates strings representation DATEDIFF(date_one, date_two, date_format, return) The function returns an object, whose value depends on the 'return' argument Possible values of return argument: |
DATEDIFF('2013-10-27', '2012-06-22', 'yyyy-mm-dd', 'y')['months'] |
| DATETIMESUM(date_string, format, number, to_increase) | Increases the date-time string representation in the number of seconds, minutes, hours, days, months, or years, passed as parameter. DATETIMESUM( date_string, format, number, to_increase ) |
DATETIMESUM('2013-10-27', 'yyyy-mm-dd', 5, 'd') Result: The date object representation of 2013/11/01 |
| GETDATETIMESTRING(datetime_object, format) | Returns the string representation of a date object GETDATETIMESTRING( datetime_object, format ) |
GETDATETIMESTRING(TODAY(), 'yyyy-mm-dd') |
Developer Version Platinum Version
The distance module integrates the Calculated Fields Form with the Google Maps (Distributed with the Developer or Platinum versions of the plugin):
| Operation | Description | Demo |
|---|---|---|
| DISTANCE(Address A, Address B, Unit System, Travel Mode) | Returns the distance between two addresses, in the unit system passed as parameter, and with the travel mode selected. Returns the FAIL text if at least one of addresses is invalid, or it is not possible access to Google. The addresses A and B are posts addresses, or post codes. The allowed values for Unit System are: km for kilometters, or mi for miles, km is the value by default. The allowed values for Travel Mode are: DRIVING, BICYCLING, TRANSIT, WALKING, or STRAIGHT. DRIVING is the value by default, and STRAIGHT determines the straight line between the addresses. |
DISTANCE( '33122', '32801', 'mi', 'DRIVING') would be 240 |
| TRAVELTIME( Address A, Address B, Return as Text, Travel Mode, Avoid Highways, Avoid Tolls ) | Returns the distance between two addresses, in the unit system passed as parameter, and with the travel mode selected. Returns the FAIL text if at least one of addresses is invalid, or it is not possible access to Google. The addresses A and B are posts addresses, or post codes. The allowed values for Return as Text are: 1 to get values in text format as 11 min, or 0 to get the value in seconds, zero is the default value. The allowed values for Travel Mode are: DRIVING, BICYCLING, TRANSIT, or WALKING, DRIVING is the value by default. The allowed values for Avoid Highways and Avoid Tolls are: 1 or 0, zero as the default value. |
TRAVELTIME('Murray BMCC, 70 Murray St, New York, NY 10007, USA', '384-386 Broadway, New York, NY 10013, USA',1,'WALKING') Result: 13 min |
| DMSTODD( value in degrees, minutes and seconds format ) | Converts degrees, minutes and seconds to decimal degrees. |
If value of v is 40°40'58.1"N DMSTODD(v) would be: 40.682806 |
Tip: To use your personal key for Google API, insert a shortcode for the variable: "google_api_key" in the webpage as: [CP_CALCULATED_FIELDS_VAR name="google_api_key" value="<your key>"]
The API Key can be defined directly in the form's shortcode, as follows: [CP_CALCULATED_FIELDS id="1" google_api_key="<your key>"]
All Versions of the Plugin
The managing fields module allows to process the fields objects:
| Operation | Description | Demo |
|---|---|---|
| getField( # or fieldname# ) |
Returns the internal representation of a field object. The getField operation can be used only in the context of the equations. |
For example, if there is the slider field: fieldname1, to assing it a value, for example:50, enter as part of the equation associated to the calculated field the piece of code: getField(1).setVal(50); If you want pass the field's name with the format: fieldname#, the correct would be use: getField('fieldname'+'1').setVal(50); |
Need more controls or operations?All Versions of the Plugin
The Third-party Connection module allows the integration with third-party functions.
| Operation | Description | Demo |
|---|---|---|
| cffProxy(Function, First parameter, Second parameter, ...) | Works as proxy for calling the function passed as the first parameter, and the remaining parameters are passed as parameters of third-party function. The first parameter is the third-party function (it is required). The cffProxy operation pass to this third-party function a callback as the last parameter. This callback should be called from the code of the third-party function, and receives as parameter the value generated by the third-party function. |
cffProxy( function(a, b, callback){callback(a+b);}, 4, 5) the result is 9 |
Demos and Tutorial in the plugin's blog: Third-Party Connection Module
Developer Version Platinum Version
This operations module is distributed with the "Server Side Equations add-on" and includes the SERVER_SIDE operation for calling the server side equations with AJAX:
| Operation | Description | Demo |
|---|---|---|
| SERVER_SIDE(Equation Name, First parameter, Second parameter, ...) | Returns the result of the server side equation. The first parameter is required, it is a text with the equation's name, for example: 'square_root_equation'. The rest of parameters in the operation are passed as parameters of the server side equation. |
SERVER_SIDE( 'square_root_equation', 4) is equal to 2 |
Developer Version Platinum Version
The Chart.js module allwos to includes charts generated with the Chart.js API in the forms (Distributed with the Developer or Platinum versions of the plugin):
| Operation | Description | Demo |
|---|---|---|
| CFFCHART(canvas tag id, object with the data and options) | It is a proxy for the Chart method in the Chart.js API. The functions accepts the same parameters in the Chart function. The first parameter is the id of the canvas tag where the chart would be generated. The second parameter is a plain object with the labes, datasets, and options, required by Chart.js. Click here for the API Documentation. |
CFFCHART('canvas_id', {type:'bar', data:{labels:['Label A', 'Label B'], datasets:[{data:[fieldname1, fieldname2]}]}}) |
The process would be as follows:
* Insert a "HTML Content" field in the form with the canvas tag as its content:
<canvas id="canvas_id"></canvas>
* Uses the CFFCHART operation as part of the equation:
('canvas_id', {type:'bar', labels:['Label A', 'Label B'], datasets:[{data:[fieldname1, fieldname2]}]})
More information with a detailed description of parameters and practical demos in the post of the plugin's blog: Chart Generation
All Versions of the Plugin
The URL module includes the following operations:
| Function | Description | Demo |
|---|---|---|
| getURL | Returns the current page's URL | getURL() |
| getBaseURL | Returns the base URL of the current page | getBaseURL() |
| getURLHash | Returns # followed by the fragment identifier of the current page URL, or empty text. getURLHash accepts an optional parameter to removes the hash (#) symbol | Ex. https://www.website.com/page#position |
| getURLPath | Returns the initial / symbol followed by the path of the current page URL, or empty text. getURLPath accepts an optional parameter to removes the leading and trailing slash (/) symbols | Ex. https://www.website.com/pages/page1/ |
| getURLParameters(url) | Returns a plain object with the URLs parameters. The operation accepts an URL as optional parameter | getURLParameters() |
| getURLParameter(parameter_name, default_value) | Returns the value of an URL parameter. The operation accepts two parameters: the parameter name and the dafault value. The default value would be returned if the URL parameter does not exist. If not default value is passed as parameter, and the URL parameter does not exist, the operation returns null |
If the page's url is: http://www.website.com/?username=john |
| generateURL(url, parameters, hash) | Generates an URL given their components. The operation accepts three parameters: the base URL (required parameter), a plain object for the URL parameters (optional parameter), a text with the hash (optional parameter). | generateURL("http://www.website.com", {"param1":"value1", "param2":"value2"}, "bookmark") |
| redirectToURL(url, object) | Redirects the user. The operation accepts two parameters: the URL and a plain object for the parameters | redirectToURL('http://www.website.com/',{username: 'john'}) |
The "Troubleshoot Area & General Settings" section, allows correct some possible issues, or conflicts with third party plugins, and define the general settings.
The plugin calls the following list of filters and actions:
<SCRIPT>
function setSliderValue( clss, value )
{
var id = fbuilderjQuery('.'+clss+' input').attr( 'id' );
var fId = id.match(/_\d+$/);
fbuilderjQuery.fbuilder.forms[fId].getItem(id).setVal(value);
}
</SCRIPT>
(function(){
var v = fieldname1+fieldname2;
setSliderValue('my-field', v);
return v;
})()
(*) With the "Managing Fields" operations module the process is very simple, assuming the slider field is the fieldname1 and you want assign it the value: 50, include as part of the equation the piece of code:
getField(1).setVal(50);
Assuming there are two date fields: fieldname1, and fieldname2
To define as the "min" attribute of of the fieldname2 field the date selected in the fieldname1 field:
Insert a "HTML Content" field in the form with the following piece of code as its content:
<script>
fbuilderjQuery(document).on(
'change',
'[id*="fieldname1_"].hasDatepicker',
function (){ fbuilderjQuery('[id*="fieldname2_"].hasDatepicker').datepicker('option','minDate',this.value); });
</script>
To define as the "max" attribute of of the fieldname2 field the date selected in the fieldname1 field:
Insert a "HTML Content" field in the form with the following piece of code as its content:
<script>
fbuilderjQuery(document).on(
'change',
'[id*="fieldname1_"].hasDatepicker',
function (){ fbuilderjQuery('[id*="fieldname2_"].hasDatepicker').datepicker('option','maxDate',this.value); });
</script>
For selecting in the fieldname2 field, the date selected in the fieldname1 field plus a number of days (in the code below, 3 days after):
Insert a "HTML Content" field in the form with the following piece of code as its content:
<script>
fbuilderjQuery(document).on(
'change',
'[id*="fieldname1_"].hasDatepicker',
function (){
var d = fbuilderjQuery(this).datepicker('getDate');
d.setDate(d.getDate()+3);
fbuilderjQuery('[id*="fieldname2_"].hasDatepicker').datepicker('setDate',d); });
</script>
In some situations is required that the fields values have a specif format, or maybe allow to enter only a list of values. In these cases the current validation rules (digits, numbers, max value, min value, text length, required) are not sufficient, and would be needed new rules. This section describes how to create a new validation rule, and assing it to a field.
Assuming you need restricts the values of the fieldname1 field as US Zipcode, with the formats: #####-#### or #########, the regular expression used to validate the field's value is: /^\d{5}([\-]?\d{4})?$/
Insert a "HTML Content" field in the form, with the piece of code below as its content:
<SCRIPT>
fbuilderjQuery(document).one('showHideDepEvent', function(){
fbuilderjQuery
.validator
.addMethod(
"zipcode",
function(v,e)
{
return this.optional(e) || /^\d{5}([\-]?\d{4})?$/.test(v);
}
);
fbuilderjQuery.validator.messages['zipcode'] = 'The zipcode is invalid';
fbuilderjQuery('[id*="fieldname1_"]').addClass('zipcode');
});
</SCRIPT>
The previous code adds a new method to the "validator" object, applied to all input fields with the class name "zipcode", the method returns true if the input field is optional, or its value satisfies the format of an US zipcode. With the instruction: fbuilderjQuery.validator.messages['zipcode'] = 'The zipcode is invalid'; is defined the error message to display when the validation rule fails. The last instruction assign the class name: zipcode to the fieldname1 field, to apply on it the new validation rule.
The Developers version of the "Calculated Fields Form" plugin, allows storing the data submitted in a database different to the own plugin database.
To use this feature are required some basic skills, because should be edited the "cp_calculatedfieldsf_insert_in_database.php" file included in the code of plugin.
This file is a mockup to integrate the plugin with other MySQL database. The file should be modified manually because each database has its own structure, and gives to the users a total control on the process.
The file's edition:
Open the file with the text editor your choice. There are some text editors, widely recommended for code editing, like: Notepad++, Sublime Text, Vim, Atom, UEditor.
The first section of file allows defining the constants needed for connecting with the database, and its authentication:
define( 'DATABASE_HOST', '' ); define( 'DATABASE_USER', '' ); define( 'DATABASE_PASS', '' ); define( 'DATABASE_NAME', '' ); define( 'DATABASE_TABLE', '' );
The name of constants are auto-descriptives:
The plugin checks if the constants have been defined, before for running the insertion queries.
The second section to be edited by the developers, is the creation of the variables to use in the queries. The file includes some variables as a guide of section:
$field1 = mysqli_escape_string( $db_link, $params[ 'fieldname%' ] ); $field2 = mysqli_escape_string( $db_link, $params[ 'fieldname%' ] ); $field3 = mysqli_escape_string( $db_link, $params[ 'fieldname%' ] );
I'll explain this section with an example. Suppose you want store in the "my_users" table, the firstname, lastname, and email of the user, submitted through the form, and the corresponding fields in the form for these information are: fieldname1, fieldname2, and fieldname3, respectively. So, the variables are created like follow:
$field1 = mysqli_escape_string( $db_link, $params[ 'fieldname1' ] ); $field2 = mysqli_escape_string( $db_link, $params[ 'fieldname2' ] ); $field3 = mysqli_escape_string( $db_link, $params[ 'fieldname3' ] );
In the previous code has been created a varaible for each field in the form. All fields are included in the $params array.
After create the variables, is time to generate the insertion queries. The plugin includes a mockup for a hypotetical insertion query, that must be replaced with the structure of your database and the fields created previously.
mysqli_query( $db_link, "INSERT INTO `".DATABASE_TABLE."` (field1, field2, field3) VALUES ('$field1', '$field2', '$field3');" );
Returning to the previous example. If the columns of the table are: firstname, lastname, and email, respectively, the query should be modified like follow:
mysqli_query( $db_link, "INSERT INTO `".DATABASE_TABLE."` (firstname, lastname, email) VALUES ('$field1', '$field2', '$field3');" );
Pay attention, if the type of data in a column of table is a numeric value, should be removed the quotes around the variable name. For example, suppose the form includes a DropDown field for the year of birth, that evidently is a numeric value, I will assume this is the fieldname4. So, you should create a new variable for the new field:
$field4 = mysqli_escape_string( $db_link, $params[ 'fieldname4' ] );
and modify the insertion query too:
mysqli_query( $db_link, "INSERT INTO `".DATABASE_TABLE."` (firstname, lastname, email, year) VALUES ('$field1', '$field2', '$field3',$field4);" );
The $field4 variable is not closed between quotes.
A last tip: It is possible create as many insertion queries as needed, even can use the table name directly without use the constant defined in the first section.
The plugin adds a consecutive number to each form inserted in a webpage to prevent conflicts between different copies of a same form, starting in "1". The process will be explained in an example. I will suppose your form includes only one form created with the "Caculated Fields Form", and the form includes three fields: - a numeric field (fieldname1), a DropDown field (fieldname2), a checkbox field (fieldname3), and a single text field (fieldname4). Furthermore, the form fields should be prefilled with the values: 3 for the fieldname1, the choice with the value 4 in the fieldname2, tick the choices with the values: 1, and 2 for the fieldname3, and the "qwerty" text in the fieldname4, follows the steps below:
<SCRIPT>
cpcff_default = { 1 : {} };
cpcff_default[1][ 'fieldname1' ] = 3;
cpcff_default[1][ 'fieldname2' ] = 4;
cpcff_default[1][ 'fieldname3' ] = [1,2];
cpcff_default[1][ 'fieldname4' ] = "qwerty";
</SCRIPT>
Pay attention to the values of the fieldname3 and fieldname4. The fieldname3 is a checkbox, as it is possible select multiple choices, should be assigned an array of values. For the fieldname4, whose value is a text, it should be closed with quotes or double quotes.
The process will be explained with an example. Assuming will be populated the fields: fieldname3, and fieldname7 in the form B with the values of the fields: fieldname1, and fieldname2 submitted by the form A:
Note: I'm assuming here the form B is the unique form inserted in the thank you page, or at least the first one. For this reason in the next code the index or attribute in the cpcff_default variable is 1 (cpcff_default = { 1 : {} };)
[CP_CALCULATED_FIELDS_RESULT]
<PRE style="display:none;"><SCRIPT>
cpcff_default = { 1 : {} };
cpcff_default[1][ 'fieldname3' ] = '<%fieldname1_value%>';
cpcff_default[1][ 'fieldname7' ] = '<%fieldname2_value%>';
</SCRIPT></PRE>
[/CP_CALCULATED_FIELDS_RESULT]
A particular case: If there are two forms in the thank you page, and you want populate the fields: fieldname3, and fieldname7 of the first form in the page, and the fields: fieldname2, and fieldname3 in the second form, the piece of code to use would be:
[CP_CALCULATED_FIELDS_RESULT]
<SCRIPT>
cpcff_default = { 1 : {},2 : {} };
cpcff_default[1][ 'fieldname3' ] = '<%fieldname1_value%>';
cpcff_default[1][ 'fieldname7' ] = '<%fieldname2_value%>';
cpcff_default[2][ 'fieldname2' ] = '<%fieldname1_value%>';
cpcff_default[2][ 'fieldname3' ] = '<%fieldname2_value%>';
</SCRIPT>
[/CP_CALCULATED_FIELDS_RESULT]
As you can see in the previous examples, the indices (or attributes) in the cpcff_default variable don't have relationship with the forms' ids. These indices (or attributes) indicate the possition of the form in the page, the first form, index 1, second form, index 2, and so on.
The "Caculated Fields Form" plugin includes multiple predefined templates to be used in the forms. The template is selected from the "Form Settings" tab, in the toolbar of the form builder, but can occur that the predefined templates are not sufficient to create a form with the look and feel you want.
The template's module in our plugin, can be extended easily to create new designs, to be used in the forms of website.
Into the "/wp-content/plugins/calculated-fields-form/templates" directory there are multiple folders, a folder for each template. The folders names have not restrictions, you simply should create a new folder for the custom template, with the name you want.
The only one required file in a template is the "config.ini" file, whose structure is:
prefix="cp_cff_custom" file="style.css" title="Custom Template" thumbnail="thumbnail.jpg" description="This is my custom template"
The description of attributes:
To implement a specific design to your forms, creates a CSS file, in the template directory (uses the file's name you prefers, but assings the file name to the file attribute in the config.ini file)
The stylepublic.css file defines the default appearance to all forms on website. The classes definitions start with #fbuilder, the ID value assigned to the form, to prevent conflicts with styles defined by other plugins or themes in the website. For extending and modify the styles from the custom template, should redefine the styles in your own CSS file, but prefixing the styles definitions, with the value entered in the prefix attribute of config.ini file.
I'll explain the process with an example. Suppose you want apply to the forms titles, the style rule font-size:1.5em, and you have defined the text: cp_cff_custom as the value of the prefix attribute, in this case the style's definition in the CSS file would be:
.cp_cff_custom #fbuilder .fform h1{font-size:1.5em;}
Apply this logic for the rest of classes in the CSS file.
After complete the template, you simply should select it from the settings page of the forms.
For printing only the form, but not the rest of page, please, follows the steps below:
<SCRIPT>
function printForm(){
var w = window.open(null, 'Print_Page', 'scrollbars=yes');
jQuery('#fbuilder input').each(function () {
var e = jQuery(this);
e.text(e.val()).attr('value', e.val());
if (e.hasClass('large'))
e.css('width', '100%');
if (typeof e.prop('checked') != 'undefined' && e.prop('checked'))
e.attr('CHECKED', e.prop('checked'));
});
var html = jQuery('#fbuilder').html();
jQuery('#fbuilder TEXTAREA').each(function () {
var e = jQuery(this).parent().html();
html = html.replace(e, jQuery(this).val());
});
jQuery('#fbuilder SELECT').each(function () {
var e = jQuery(this).parent().html();
html = html.replace(e, jQuery(this).find('option:selected')[0].text);
});
w.document.write(html);
w.document.close();
w.print();
}
</SCRIPT>
printForm();