How to define a custom property with a default value

Question:

We require an order indicator that allows the user to choose between two different pricing structures e.g "Scheduled Flight" and "General Aviation". We do not want to use the existing values for inbound and outbound flight type as these have other purposes, also we need to use this indicator on OTC orders as well as Handling orders.
How can this be achieved?

Answer:

FBO One allows for the creation of custom properties that can be assign to orders and be used to trigger pricing structures or displayed in reports. In this case we can name the custom property "Order Fare Type" and assign the two possible values of "Scheduled Flight" and "General Aviation". Once setup the "Order Fare Type" field will be presented to the user for selection in both the create order and edit order screens. We can, if required, also assign a default value so that users are not forced to manually enter a value each time.

Expected result

In the create order screen, and in the edit order screen, the newly defined custom property appears. In the create order screen the applicable default custom value is applied:

The section below provides a step by step guide to how to apply the following points:

  1. Create the custom property
  2. Define the list of allowed values for the property
  3. Define the the default value
  4. Make the custom property appear in the Create Order and Edit Order screens

In this example the new Custom property is called 'Order Fare Type'.

Choosing a name for your custom property

The custom properties defined for an order, can also be shown on reports and can also be included in email message templates. When choosing a name for your custom property, make sure that it does not clash with a name for a report column that already exists. In this case, Flight Rate would be a better name than Flight Type, as there is already a Flight Type column defined in the standard Order Reports for the inbound and outbound flights.


Step-by-step guide

  1. Create the Custom Property

To do this use the Menu search box to locate 'Custom Values'

Use the 'Add new' located at the bottom of the pre-existing custom properties

Define the relevant values as described below:

  • Name - The operation name of the value e.g Order Fare Type
  • Description - The general description of the value e.g Defines the type of fare to be applied 
  • Default custom value - Used to define a default value for the drop down box (not used upon initial creation of the custom property)
  • Applies to FBO Location group - Allows the use of this new field to be restricted to specific locations (if you have multiple FBO Locations)
  • Applies to front office workflow - Allows the use of this new field to be restricted to specific order types
  • Icon - Allows the assignment of an icon to the custom property
  • Icon colour- Assigns an specific colour to the icon (Hex Code) e.g #FF0000 (Red), #FFFF00 (Yellow)
  • Is free text field - This allows users to type in values rather than a dropdown lis of pre-defined values
  • Input box height (lines) - Defines the number of lines displayed during input (Does not apply to classic UI)
  • Display box max height (lines) - Defines the max number of lines displayed in the order screen (Does not apply to classic UI)
  • Validation expression - Used only for free test field, this allows the use of a regular expression to enforce an input rule e.g ^([01]?[0-9]|2[0-3]):[0-5][0-9] (Must be a time format HH:mm)
  • Validation error message - Used in combo with Validation expression. Allow you to stipulate an error message e.g Must be time format HH:mm 09:00
  • Is visible in order screen - Allows the values to be displayed or hidden from the order screen
  • Sort index - Defines in which order the custom properties are displayed

2. Define the values of the custom property

Use the 'Add new' button located in the custom values section of the page

Repeat the process until you have created all the required values

3. Assign the Default value to the custom property (optional)

Return and edit the custom property 'Order Fare Type'. Select the default value  followed by save.


. Assign the Default value to a specific Order workflow

The default custom value specified for the custom property applies to all Start transitions (that is to all order types and all start transitions). In this example there is currently only order start transition, but should we choose to add another such as 'Scheduled Flights', the default value would apply to the create order screen of that order type that as well. To set a different default value start transition, you can specify it in the Configuration String of the workflow transition. All this is outlined below.

Once the Custom value has been created, return to the search box on the left, and this time locate 'Order Workflows'

In the 'Order Workflows' Administration page, use the first Search box to narrow down the workflow you are working on, in this example the 'HandlingOrder'.

Then, under the 'Workflow start transitions' section, select the Workflow start transition to which you wish to apply the default custom value. In this example, we only have one start transition for a handling order, but there can be more, for example if there was a different workflow for Scheduled flights, or helicopters etc.

Use the 'edit' button to open up the start transition, this is where the Configuration String will be inserted in order to enable the default Custom Value:

The Configuration string field can hold multiple commands, in this case the current string will remain and we will add another. Each configuration string is to be separated by a semi-colon.

3. Formulating the Configuration string 

The Configuration string allowing you to set a Default custom value, is made up of three parts:

  • CustomValue   The Title
  • _Flight Type     The name we gave to the Custom Value (exactly as it appears on the Custom Value Page)
  • =Business        The Default value we want to appear during order creation

The Completed Configuration string therefore appears as follows:

Click 'save' to complete the process.

Related articles