If you have an external form on your website, the form can be be intercepted and tracked in ROI. ROI Analytics can work with your external form and cookie form submissions as Identified Visits, which allows ROI Analytics to track website activities for the identified visitors moving forward. 


Please follow the guidelines below. You are required to make a few modifications to the code of your form. Consider learning more about ROI Forms so that you can avoid this external form process entirely -- and make the processes easier on you. If that is not possible, then please continue. 


Add the following lines of code to your form. Each line is explained. Red text represent values specific to your account or form.


1. The external form must include a hidden field called “ROIToken”. This is a system field. Do not change the value of this field.


<input type="hidden" id ="token" name="ROIToken" value="Client Token"/>


 

Please Note - the below example is not your ROI token. The token in red is different for every client, so navigate to your Admin tab in ROI > Preferences > ROISystem > Account Settings > and copy entire Client Token. For example:

 

<input type="hidden" id = "token" name="ROIToken" value="Z/ogCUam8oXn4A0wqlHHLJTjSQuxsbSgDF6A75PnaBQXrPEUB3W0OsWE0JovQZhEBbVqZH8OhwU="/>




 

2. Include a hidden field called “ROISource”. This is a system field. Do not change the value of this field.



<input type="hidden" id = "ROISource" name="ROISource" value="Third Party Web Capture"/>


 

3. Include a hidden field called “SourceCode”. The value of the field should reflect the name of the external form.


<input type="hidden" id="Contacts.SourceCode" name="Contacts.SourceCode" value="External Form Name"/>


Form name should be changed to reflect the external form that is being submitted. For example, “ContactUs” or “WhitepaperDownload”.


Example: <input type="hidden" id="Contacts.SourceCode" name="Contacts.SourceCode" value="ContactUs"/>

 

4. Include a hidden field called “ROIDeduplicateKeys”. This field is optional but you are strongly encouraged to include this field. This field determines if the submitted entry already exists in ROI such as email. The name of the fields in the form must match the name of the field in the Table, and must be preceded by the name of the Table itself. See example using the Email field as the key.

 

<input type="hidden" id = "ROIDeduplicateKeys" name="ROIDeduplicateKeys" value="Contacts.Email"/>



This is our code so far. The next lines of code are up to your preference or it is based on Java Script with your form submission process.

 



5. There are two acceptable form submission types: 


<input type="submit" name="submit">


<input type="image" name="submit">

 

  • If your form submission includes JavaScript, additional code is required. Below is a JavaScript example.

 

 <a href="javascript:DoSomethingWithJavaScript();">Submit</a>

 

For JavaScript, add "roicaptureformbutton" to the "class" attribute. See example below:

 

<a href="javascript:DoSomethingWithJavaScript();" class="roicaptureformbutton">Submit</a>

 

6. Include the following ROI Capture Code code at the bottom of your page, if it's not already there. You can find this ROI Capture Code in plain text attached.  


  

7. Create a Field Map in ROI by navigating to Admin > Field Maps and then click “Create new Field Map”.



a) Source = “Third Party Web Capture”



b) Destination = “WebCapture”



c) Click the “Add Mapping” button.


d) In the Source Column enter the names of your form fields exactly. In the Destination Column enter the name of the field in the ROI Table and select from the drop down. The form field must exist in an ROI table before it can be mapped to the Destination Column. Below is an example:



e) Continue mapping columns as needed and then click "Save".



Contact support@rightoninteractive.com for guidance or additional questions.