This document will explain how to build a Posting Document in CAKE Basic.
Posting Documents are built from within the Vertical Card. If the designated Vertical hasn't been added already, you must first add a Vertical.
*Debt Settlement and Tax Settlement are defaulted in your CAKE Basic instance as examples - these can be renamed and reused.
To build a new Vertical:
- Click Setup
- Go to the Verticals Tab on the left-hand navigation bar
- From the Vertical Grid, Click 'Add Vertical' which will open the Add a New Vertical Wizard.
Every Vertical requires a Vertical Name and a Vertical Category.
Vertical Categories can be added in Setup > Other Lists.
Building the Posting Document
Once the Vertical has been added, your new Vertical Card will open automatically.
From there, click on the Fields Tab.
Every Vertical will contain Basic Fields. These are standard consumer fields - name, address, phone numbers, email, etc.
It is extremely important to understand that Basic Fields are shared across ALL Verticals. Deleting a Basic Field in 1 Vertical will delete the field from ALL Verticals. Similarly, editing the Basic Field name will change the name in ALL Verticals.
New fields, however, can be added and removed without any consequence to other Verticals.
To add a new Vertical field simply click “Add” and a line for the new field will appear at the top.
Label: The name of the field that will be visible throughout other areas of the system when referencing the field (filters, field mappings for Buyer posting). It CAN contain spaces.
Name: The exact syntax of how the parameter will be submitted to CAKE Basic in the post string either from a form or from your Affiliate’s server. It CAN NOT contain spaces. Instead, words are separated by an “_”. (Example: new_field)
Group Fields: A way of receiving 1 field that is being sent into CAKE Basic as multiple fields. Phone Number is usually collected in 3 separate fields but will ultimately build 1 field called “home_phone”. The Affiliate or form may post the fields into CAKE Basic as such: home_area,home_prefix,home_suffix. CAKE Basic will group the 3 fields and make 1 field. It can also be used to allow alternate field names for accepting the field from multiple different forms.
Cake supports 5 Data Types.
- String: A String will receive any text sent to CAKE Basic. You can apply a Maximum Length to a String.
- Date: Should be used when your form or Affiliate is posting a Date. The Date format includes the Date AND Time in this format: 1/8/2014 5:45:51 PM
- Number: A Number is similar to a string except CAKE Basic can create Validation or Filters using math.
- List: A List allows for a custom list of values to be built. Any value other than what is on the list will now be accepted into CAKE Basic. Values on a list can also be mapped to a specific value the Buyer requires.
- Bool: A Bool (or Boolean) will accept a value of 1 or 0. It will also accept Yes or No but will always post out TRUE or FALSE.
Maximum Length: allows you to place a cap on how many characters are being sent in either a String or List field.
Show In Reports: allows you to choose whether the new field should be in the Lead Detail reports in the Buyer Portal.
Hide From Buyer: will not show the new field to the Buyer in the Buyer Portal.
The next step of building a posting document is to add all the field validations - for example, marking the necessary fields as required.Making a field required is just 1 of many validations CAKE Basic can apply to a field.
To add Validation to a field, click on the Label of the field. The Validators Card will open.
The most common Validation Type is making a field Required and it is conveniently located at the top of the list.
If a required field is missing or empty, CAKE Basic will need to know how to handle that lead.
These decisions are controlled in the Client Post Decision and Server Post Decision drop downs. BOTH fields are required regardless of which type is being utilized. Since you can always choose to utilize either at any time, we require them both up front. You can see more about validations in this document.
- Client Post Decision provides 2 options. The Client Post Decision is related to a lead that is being browser posted. Again, selecting a Client Post Decision is required regardless if a lead is being Browser Posted or Server Posted.
- Force Client Review is specifically used when the HTTP AJAX Post method is used. This option allows CAKE Basic's validation to communicate with a hosted form when the provided AJAX library is on the form. Force Client Review will not allow a user to submit on the form until the field has been satisfied according to validation rules. (ie “Required Field/Valid Format)
- Throw Out is the other option. Selecting Throw Out will send a lead to the Scrub Queue if the Validation for this particular field fails.
- Server Post Decision provides only option to go to the Scrub Queue upon validation failure. Selecting a Server Post Decision is required regardless if the lead is being Browser Posted or Server Posted.
Once all fields have been added and are validated, the Posting Document is ready.
Simply click on the Home Tab of the Vertical Card (or any Hosted or Host-n-Post Offer within that Vertical) and click on the “Posting Doc” button.
A new browser window will open with the Posting Document once this button is clicked.
* Validation CAN be edited on a per Offer basis to differ from the Vertical level validation.