- Creating Custom Fields
- Marketing Campaigns
- Upload Library
- Mail Shots
- Using HubSpot with Workbooks
- Introduction to Reporting
- Displaying Reports
- Creating Reports
- Reporting Explained
- Emailing Scheduled Reports
- Sharing Reports
- Using Formulae
- Introduction to Reporting
- Introduction to Transaction Documents
- Credit Notes
- Customer Orders
- Supplier Orders
- Contract Management
- Introduction to System Administration
- Users & Security
- Email & Integration
- PDF Configuration
- Custom Field Limits
- Mandatory fields within hidden sections on form layouts
- Creating a Nominal Code Custom Field on Products and Invoice Line Items
- Setting Up New Tab?
- How do I set a default value?
- Importing multi-select values - a tip
- How do I amend the list of values in the Campaign picklist?
- How do I add to Products / list of Line items?
- Picklist layouts
- How can I record commission as a percentage on an opportunity, but then use that to calculate the commission's value?
You should be aware that many records in Workbooks include fields which are initially hidden from view. It's bad practice (and will probably cause problems later) if you create custom fields which have the same field label as either another custom field on the same record type or with the same field label as an existing standard Workbooks field. For this reason, we recommend that before adding any custom fields you navigate to Start > Configuration > Customisation > Record Types. Open the type of record that you're considering customising, open the Form Layouts tab and click New Form Layout. The first tab on the screen that appears is the Fields tab. Scroll down to the bottom where you'll see a number of fields that are greyed out because they haven't been selected to show in the record type. The screenshot below (click to enlarge) shows the hidden fields for a Person record so, for example, if you want a field for the name of a Person's assistant, you don't need to create a new one, you simply need to show the Assistant Name field in your form.
If the field doesn't already exist you can create your own custom field. To add a custom field to a specific record type, click Start > Configuration > Customisation > Record Types. Select the record type to which you want to add the field from the list on the right. Now open the Custom Fields tab and click New Custom Field. (If you're adding a Custom Field to a Line Item on a transaction record, you should open the Line Item Custom Fields tab.)
Listed below are the different types of data you can apply to a custom field. There are some settings that are common to many of these fields, including:
Required - ticking this box makes completion of the field mandatory. If you make a custom field mandatory at this level it will be required on every form where the field appears. If you only want it to be mandatory on some layouts, you can control the behaviour there. REMEMBER: If you make the field mandatory and you are importing data or populating your database via the API, this field must be completed with valid data;
Read only - ticking this box makes the field read only (so can be useful for displaying important on-screen information). As with the required checkbox, if this checkbox is ticked, the field will be read-only in every layout that uses that field. It will not be possible to populate the field either through the user interface or through the API. If you want the API to be able to write to this field, do not tick this box but instead, make the field read-only on a specific layout. This way, users will not be able to populate the field but the API will be able to write to it;
Searchable - ticking this box means the value entered into the field can be found using Workbooks search functionality.
Indexed - ticking this box can speed up reports and filtered views that use the customised field as a criteria.
Default value - if you want records to be populated with a default value, enter it here.
Max Characters - simple text fields default to showing a maximum of 50 characters but you can amend this. The limit on maximum characters for text fields is 255.
NOTE: If the maximum number of characters or the Indexed checkbox are changed for an existing custom field, the change will be performed in the background and a notification will pop up when it's done. It is best practice to make these sorts of changes when your database is not being used, eg, at the very end of a working day.
If you customise your database using Custom Form Layouts you have greater control and flexibility over the positioning and order of fields, as well as being able to override whether or not the field has a default value, is mandatory or is read only.
A box which can be ticked to indicate that a particular parameter is met or left empty if the parameter isn't met.
Choosing a data type of currency will generate some new dialogue boxes where you can specify which currency should be displayed and whether or not users can change the currency code. The currency options available are those for which an exchange rate has already been defined and added to the foreign currencies available for your Own Organisation.
A date field (with the format dd/mm/yyyy).
A date/time field. Times are displayed using the 12-hour clock, eg 4:00 AM or 4:00 PM.
Decimals are displayed to two decimal places (rounded up).
A Dynamic Linked Item allows you to create a picklist compiled of values held elsewhere in Workbooks. The list of options in a Dynamic Linked Item's picklist is based on a report, so you can use the full power of reporting to select which values appear in the list. For example, you might want to create a field on an Opportunity record to show the primary contact for that Opportunity, which you can do using a Dynamic Linked Item field. Additionally, you can configure the field so that when you pick an option from the list other fields, such as Email, Phone Number and Address are automatically populated. When you've chosen a Linked Item from the picklist you can hyperlink to that record using the button next to the field. More information about creating a Dynamic Linked Item is available here.
A Dynamic Picklist is essentially the same as a Dynamic Linked Item. The only difference is that this picklist doesn't include a button that allows you to link to the linked record. More information about creating a Dynamic Linked Item/Dynamic Picklist is available here.
There is a button next to this field that (if clicked) lets you send an email to the address in the field.
Creating an iFrame custom field enables you to access information held in an external system via a Workbooks field. For example, you might want to create a field on an Organisation record that displays a Google map showing the location of the Organisation (based on the values entered in the postcode and country fields). You can control whether or not the iFrame appears on the main tab of the record or in a separate tab. You could, if you wanted, create several different iFrame tabs for links to different systems.
To create an iFrame for a Google map follow the steps below:
- Start > Configuration > Customisation > Record Types. Select the record type of Organisations and open the Custom Fields tab > New Custom Field.
- Give the field a name, eg, Google Map.
- Enter the following into the URL field: https://maps.google.co.uk/maps?q=@main_location[postcode]@,@main_location[country]@&t=m&z=14&view=map&hl=en&ie=UTF8&iwloc=&num=1&output=embed
By default the checkbox next to Show Link Button is ticked, which means that in addition to displaying the Google map on the Organisation record, you'll also see a button you can click to open the map in a new window. If you don't want the ability to open the record in the new window simply remove the tick.
Alternatively, if you want the map to display in a new tab (which will have the same name as you have given the custom field), tick the checkbox next to Show as Tab.
- Click Save & Close.
Now when you open an Organisation record you'll either see a field that displays the Google map for that Organisation's location (provided that both the Postcode and Country fields are populated with valid values) or you'll see a new tab which displays the map.
A field to store a whole number. Alpha characters cannot be entered in number fields. This field can be made searchable.
A field where you can enter multiple lines of text. This field can be made searchable. This field can hold up to 65,536 characters, although few users ever add this much data.
Use this if you want to create a picklist where the user can select more than one option.
Values here will be displayed with a % sign, you can also set the minimum and maximum values that can be entered in the field.
Similar to the button next to the email address field, there is a button next to the phone number which lets you directly call the number in the field if you've integrated Workbooks with a VOIP system such as Skype. This button also enables you to add a phone call Activity to the record automatically. Depending on your VOIP integration you may be able to record the call or take other actions. NOTE: Whilst Workbooks doesn't dictate the format for which phone numbers must be entered, your VOIP system might so we recommend you check the documentation for your system.
This data type generates a picklist where only one option can be selected.
Choosing this option will create a field where you can enter tex, which can be formatted using the toolbar that appears above the field. This also provides the ability to enter the value as HTML. This field can be made searchable. This field can hold up to 65,536 characters, although few users ever add this much data.
Use this option if you want to enter alphanumeric characters (up to a maximum of 255 with a default limit of 50). This field can be made searchable.
Times are displayed using the 12-hour clock, eg 4:00 AM or 4:00 PM.
A URL field can be used to hold a URL address so that at the click of a button the user can access a specific web page. The simplest way to use it is to give the custom field a Field Label and leave the URL field blank. This allows the user to enter a URL of their choice and then link to that destination.
Alternatively, you can enter a URL that when combined with the value that a user enters in the field, generates a whole URL. In a similar way to an iFrame, this enables you to link to an external destination (relevant to the Workbooks record you have open) without the user having to enter the whole URL. To do this, include @value within the URL. This indicates the point in the URL where the value entered by the user (in the form field) will appear and thus generate the whole URL to which they can link.
For example, if you entered www.bbc.co.uk/@value@ in the URL field, a user could enter news or radio4, which would enable them to link straight to the BBC News or BBC Radio 4 site respectively.
If you include a URL custom field in a Landing Page view you can click on the value in the grid to launch the relevant site.
It is also possible to have a URL custom field on Line Items.
NOTE: For URL links to work correctly, you should ensure that your browser is not blocking pop-ups.
For information on how to create custom fields that appear on more than one record type (such as a value on a Lead that appears on a Person when the Lead is converted or on a Product that appears on a Line Item), see the instructions on the next page.