Overview

Bespoke Tabs and Fields

Bespoke tabs and fields configured to store information particular to your business. Bespoke fields can be added and edited in patchQuote API.

Tabs

Three bespoke tabs available:

Clients / Other
Quotes / Other
Contracts / Other

Each tab named 'Other' by default and can be renamed to suit needs.

Each tab can be enabled separately.

Each tab further configured by role to be hidden or display-only.

Fields

Within each tab, fields organized using headings in desired sort order with different characteristics: Text, Text Area, Numeric, Date, Checkbox, Label, Blank.

Each field configured as hidden or display-only by role using role restriction settings.

Users enter data in bespoke fields. Data entered/edited recorded using standard Field Auditing feature with some differences in Edit History screen display.

Recorded data used in queries and scheduled jobs. By default, bespoke fields not used in system calculations or logic.

Set-up

Contact Account Manager to set-up bespoke tabs and fields. They work with you to set-up screens and fields wanted.

Original specification for feature available for download.

Tabs Configuration

Clients / Other

Clients / Other tab hidden by default.

Internal roles given access by updating Role Restriction bit-array entries.

No external roles given access.

Quotes / Other

Set [gb_controls] quotes_bespoke_fields_screen_flag to 'yes' to give all internal roles access.

No external roles given access.

Contracts / Other

Set [gb_controls] contracts_bespoke_fields_screen_flag to 'yes' to give all internal roles access.

No external roles given access.

Access to Bespoke Fields

Bespoke fields set-up available to internal users by default. Visit Bespoke Role Restrictions for details on restricting field access.

Data Tables

gb_bespoke_fields

Stores each bespoke field. Unique id: bespoke_field_id.

gb_bespoke_listboxes

If [gb_bespoke_fields] input_type is 'listbox', stores each available option in list.

[gb_bespoke_listboxes] bespoke_field_id joins each record to [gb_bespoke_fields] record.

Visit Bespoke Listboxes for sample data.

gb_bespoke_field_values

Stores recorded value of each bespoke field for each client, quote, or contract.

[gb_bespoke_field_values] bespoke_field_id joins to [gb_bespoke_fields] record.

[gb_bespoke_field_values] record_id joins to [fm_clients], [qt_quotes], or [fm_contracts] record.

If [gb_bespoke_fields] input_type not 'listbox', [gb_bespoke_field_values] value stores recorded field value.

If [gb_bespoke_fields] input_type is 'listbox', [gb_bespoke_field_values] value stores selected [gb_bespoke_listboxes] bespoke_listbox_id of chosen item.

Data Review and Updates

Use Export Table Data to download and review current bespoke field tables and records.

Use Import Table Data to upload additions or revisions to bespoke fields.

If creating bulk update for client, quote, or contract records where field is listbox, identify required bespoke_listbox_id and import into value field of records updating.

Field Names

[gb_bespoke_fields] field_name field holds field label as appears on screen unless relabelled using Screen Aliases.

Preferred entry in lower case with each word separated by underscore.

Other entry ways work but difficult in queries and scheduled reports, not recommended, cannot display on screen.

For field_name to appear on screen, must meet conditions:

All lowercase words
Words separated with underscore
Numbers acceptable

Field Name Examples

Field Name	Screen Display	Comments
insurance_per_year	Insurance Per Year	Only format that will display
insurance_per_Year		Will not display
sub-category		Will not display
Third Party Finance		Will not display
A mixture Of uppercase And Lowercase text		Will not display
An External contractenddate 04-2012		Will not display
m_l_a_date_04-2012		Will not display
m_l_a_date_04_2012	M L A Date 04 2012	Only format that will display

Hiding Fields

Two ways to hide certain fields from view:

Use non-compliant field_name
Use role restrictions (contact Catch-e Account Manager for assistance)

Columns and Sort Order

Fields sorted in any order on screens across 2 columns.

Managed by entering sort order in [gb_bespoke_fields] column_number and field_order fields.

Sort order of screens firstly by [gb_bespoke_fields] column_number, field_order, then bespoke_field_id.

Label Position

Determines position of label in context to field. Label can be either 'left' of field or 'above' it.

Default Values

Default value may be set using [gb_bespoke_fields] default_value field.

Data Entry Validation

Validation rule can be set for each bespoke field.

Enter rule in [gb_bespoke_fields] validation_regular_expression, or leave blank if no validation required.

Enter useful validation message in [gb_bespoke_fields] validation_error_message. Displays in alert box if validation fails.

Note: Data validation only occurs when both 'validation_regular_expression' and 'validation_error_message' fields populated.

Warning: Suggest error message contains Tab name and field name (as displayed on screen). If editing another tab and validation fails, assists users to identify field needing attention. If editing fields on Other tab, cursor placed in first field needing attention.

Regular Expression Patterns

Data validation rules constructed using Regular Expression technique. Regular Expression sequence of characters forming search pattern.

Pattern	Description
^[(A-Z)(a-z)]{0,77}$	Allows empty field, Upper Case A-Z, Lower Case a-z, maximum 77 characters
^[(A-Z)(a-z)(0-9)]{0,88}$	Allows empty field, Upper Case A-Z, Lower Case a-z, space and numeric 0-9, maximum 88 characters
^.{1,255}$	Allows any character, minimum 1 character, maximum 255 characters
^-?[0-9]\d*(.\d+)?$	Any positive or negative number (including decimals)
^[0-9]\d*(.\d+)?$	Any positive number (including decimals)
^[1-9][0-9]*$	Any positive whole number

Input Type

Nominate required input_type for each field. 8 options available:

Input Type	Description
text	Allow alpha, numeric, character text content
textarea	Allow alpha, numeric, character text content
date	Allow date content with date selector popup
checkbox	Checked = yes, unchecked = no
listbox	Allow selection from pre-populated list from [gb_bespoke_listboxes]
blank	Insert blank row on screen (aesthetics only)
number	Right justified numeric character entry
label	Contain section heading label

Input Size

Determines width of text box in edit mode. Used only where Input Type = 'text'.

Input Length

Determines maximum number of characters of text or number field in edit mode. Mandatory where Input Type = 'text' or 'number'.

Note: All bespoke fields limited to maximum 64kb size.

Input Rows

Determines number of rows of textarea box in display and edit mode. Used only where Input Type = 'textarea'.

Location

If field_name formatted correctly as outlined above, displayed on Other tab on Clients, Quotes, or Contracts depending on table_name field data value.

Use in Quote Placeholders

Bespoke fields for Quotes and Clients automatically created as quote placeholders if particular settings in place.

Screen Aliases

Create Screen Aliases record to rename bespoke tab or field.

Add entry into [gb_screen_aliases] table for preferred field name.

Sample data showing three bespoke tabs and one field renamed:

Screen Alias ID	Module	Page	Sub Page	Field	Alias
100002	fm	clients	Other		Alias for Clients
100003	fm	clients	Other	mla_date_04_2012	M.L.A. Date 04-2012
100000	qt	quotes	Other		Alias for Quotes
100001	fm	contracts	Other		Alias for Contracts

Alias field allows maximum 40 characters, but only maximum 14 characters display. Longer names disrupt screens at smaller resolutions.

Field name formatted correctly to appear on screen can be renamed using this table with alternative label. Example: bespoke fieldname mla_date_04_2012 appears on screen as M L A Date 04 2012 but could be renamed as m.l.a. date 04-2012.

Note: Edit History screen displays [gb_bespoke_field_values] bespoke_field_id as "Field". Recommend using aliases for field names only when necessary and keep them similar to field name so users understand Edit History better.

Edit History

When fields in bespoke tabs edited, audit history record written to [gb_audit_import] table.

[gb_audit_import] bespoke_field_id stores bespoke_field_id rather than character driven field name.

Accommodates future changes. Changes would break link to fields.

View Edit History screen displays [gb_audit_import] field_name and [gb_audit_import] user_name and respective field's Before and After values.

Edit History Filters

Filter	Type	Description
User Name	Drop List	Choose user to review only their entries
Table	Drop List	Choose specific table to review only entries for that table
Reference	Drop List	Choose specific reference to review only entries for reference. If no references used, displays '--All--'
Field	Drop List	Choose specific field to review only entries for field

Edit History Field Descriptions

Field	Type	Description
User Name	Text	Name of user who made change
Date	Timestamp	Date and Time of change
Table	Text	Table containing field
Reference	Text	Used if sub-data needs display. Example: Budget classes
Field	Text	Field name changed
Before	Any	Value of field before change
After	Any	Value of field after change
S	Text	If blank, update done by user from within Catch-e System. If displays 'x', record updated from bulk upload or external source. Example: Setup / Import Table Data / executeImportTableData / Insert or update record with auditing

Multiple Records

When screen displays multiple records, audit records separated and shown for records separately.

Record itself selected, then audit record viewed.

Case on following screens:

Contracts / Events
Users / Logins

Lookup Key Data for ID

Audit fields configured to display linked description rather than stored value if id refers to another table.

Example: Contracts / Order contains Order Status field displaying description on screen, but Audit History returns orderstatusid.

If lookup value configured, [gb_audit_fields] lookup_value displayed instead of [gb_audit_fields] value.

User sees screen value, rather than database number.

When lookup in use, Audit History tooltip displays lookup table, field, and value used to link.

Example: 'fm_order_statuses: order_status_id: 100006'

Note: Does not apply to bespoke records which use different display technique.

Encrypted Fields

Encrypted fields accessed using special syntax.

Example

To decrypt and report on encrypted field:

SELECT AES_DECRYPT(income_gross, 'AES_CRYPT_CIPHER_KEY') AS income_gross FROM fm_drivers WHERE driver_id = '100000';

Only works when query run by Scheduler or via Web Service call. Running in Query Browser / Workbench returns 'null' value.

Field Auditing

Visit Field Auditing for full description of feature.

Main navigation: Main Page → Good to know → View Edit History