Loading...
 

Get the code on GitHub

coreBOS advanced webform creation and validation

This project takes webforms to the next level.

 

coreBOS has a native webform creation and implementation feature that permits us to create a webform for a given module (accounts, contacts, leads, potentials, helpdesk,…) but in many cases, somebody filling in information on our website isn't just one entity in coreBOS. For example, somebody filling in a contact form may already be interested in some product and should be converted into a Contact AND an Opportunity, or when filling in a support form we should get a Contact AND a HelpDesk. That is what this project does, it is an easy way to convert fields captured from our webform into different entities in coreBOS.

While we were at it we added the typical validation of fields, so you can make sure a given field is not repeated or already exists before sending the information into the application.

Configuration and Usage

The general idea is to set up your web form with whatever tool best fits your website software and have the form data sent to a script that will set the configuration options and call the coreBOS Webservice Webform code. This script will validate the information, connect to the defined coreBOS system and create the configured entities.

You have to copy the coreBOS Webservice Webform code to some server you have access to. The WsWebform.php script must be accessible from your webform as when your user clicks on the send button the whole form must be redirected to this script.

In the same place you have copied the WsWebform.php script you must also create a directory cbwsclib and copy inside the PHP coreBOS Webservice Library. This library adds the functionality yo connect to your coreBOS to do the validations and inserts.

All the configuration options are contained in an array at the beginning of your script:

 

* $config = array(
      // Connection parameters
      'url' => 'http://localhost/corebos/',  // your coreBOS system URL
      'user' => 'admin',  // user that will be connecting via REST to create the entities and validate fields
      'password' => '',  // user's access key
      // Entity mapping to process form fields
      'map' => array(
          // WebServices module name
          'Contacts' => array(
              // Field mapping
             'fields' => array(
                  // [Entity field name] => [form field name]
                  'firstname' => 'firstname',
                  // Use just the field name if both are the same
                  'lastname',
                  'email',
              ),
              // Fields that should match to find a duplicate
              'matching' => array(
                  // we can specify an 'and' or 'or' key to group fields inside parenthesis with the given operator, nesting is possible
                  'or' => array(
                      'and' => array(
                          // [field name in the dabase] => [field name in the new entity]
                          'firstname' => 'firstname',
                          // When both are the same we can write just one
                          'lastname',
                      ),
                      'email',
                  ),
                  // The resulting condition is ( ( firstname=e.firstname and lastname=e.lastname ) or email=e.email )
              ),
              // Optionally, an entity can include other related entities
              'has' => array(
                  // We repeat here the structure for an Entity mapping
                  'Potentials' => array(
                      'fields' => array(
                          'related_to' => '[Contacts]',
                          'potentialname' => 'potential_name',
                          'closingdate' => 'potential_closingdate',
                          'sales_stage' => 'potential_sales_stage',
                      ),
                      'matching' => array(
                          // When no operator is specified, 'and' is used, so here all fields should match
                          'related_to',
                          'potentialname',
                      ),
                  ),
              ),
          ),
          // We could go on with other entity mappings
      ),
  );

 

The abstract idea is that you define two things:

  • access information to your coreBOS

  • list of modules to create in the coreBOS system

For each module you want to create you can define:

  • 'fields': list of fields in the coreBOS system that you want to save and which fields on the form are capturing that information

  • 'matching': a set of validation steps you want to verify against the coreBOS system, basically avoid duplicate records based on some fields

  • 'has': a list of modules, for each one we will create a new record related to the main module of this configuration option. The definition of each module has the exact same structure and functionality as the main module of this setting.

The GitHub repository has a test file that you can use as a starting point for your project.

Admin Manual
Developer Manual