Servicely Configuration
Form Layouts
Table and Field Properties
7 min
the configuration of tables, fields, relationships and renderers have specific properties that can be set to control behaviours, appearance, etc tables properties the following properties can can be configured against the table itself this is done from the key/value section on the properties tab for the table definition property example comments i18n name table work name the i18nkey of the localised name of the table note this generated automatically on table creation, along with the default localised value, and normally not needing to be altered default displayvalue name the field that is used to represent as the displayed value when this table when referenced elsewhere (such as from a reference field on another table) default requiredfield true a boolean value (default false if not present) of whether this field is always required to be provided for this table audited true a boolean value (default false if not present) of whether the various write/write operations on the records of this table are audited dropdown displayfields number 6,shortdescription 6 used for what fields are displayed in drop down lists in the ui when references to this table are being selected the format is \<fieldname> \<relative size>, \<fieldname> \<relative size>, the relative sizes should add up to 12 e g with two fields and 6 and 6, each field will occupy half the layout similarly, 3 and 9 would be one quarter and three quarters examples table dropdown displayfields user name 4,email 8 if you are using this on a large table, it is recommended you use the searchfields property as well to allow you to still show the field in the dropdown, but to only use certain fields as part of the search / query dropdown selectiondisplayfields name typically the same as the single valued default displayvalue property, but can be used when multiple fields are required dropdown searchfields (new in later 1 8 releases) number,shortdescrpition comma separated list of fields to search if this has been added, this will be used to search the table instead of display fields allowing you to have separate fields to search on and show on the dropdown workflow\ action journal (new in 1 9) clientjournal used to determine where the approval message / status is given upon a user approving / rejecting an approval lookup field key if set, will allow lookup by this value as well as by id this field should be marked as unique note you may see some other properties in tables, which are valid, but have been replaced by a field on the table configuration field and relationship properties the following properties can can be configured against the fields and relationships on an table this is done from the key/value section on the properties tab for the field definition and the relationship settings for the relationship definition property example comments i18n name work requestor name the i18nkey of the localised name of the field/relationship note this generated automatically on field/relationship creation, along with the default localised value, and normally not needing to be altered css script\ workserverutil getnumberfieldstyle(current) this property will style the field on a list view of a table based on an array of css class the selected function returns in this example, the property is used for the number field on the work table workserverutil is an out of box script library and the function “getnumberfieldstyle” returns the nominated css class determined by the current record’s information for other fields and other css classes, you can create your own script library functions and then call that function from the css property value for the field/relationship field of your own choosing example of the styling showing blue circles on the number field for the inc records that require attention due to requested for reply back to it default requiredfield true a boolean value (default false if not present) of whether this field is always required to be provided for this table default value true the default value for the field when a record is created default fieldinstructiontext myfield instruction text the i18nkey of the localised text for the default instruction text for the fields/relationships on forms specific views (aspects) may have different text, configured in the view default tooltiptext myfield tooltip text the i18nkey of the localised text for the default tooltip for the fields/relationships on forms specific views (aspects) may have different text, configured in the view dependent on classification this is used for a choice field whose available values is dependent on another field / filtered depending on the other field’s value the property value needs to be the name of a field that the choice field is dependent on displayunit seconds this is the display unit that is shown on a duration field values can be one of the following seconds minutes hours days configuration data true add and set to true on a relationship property of a many to many reference (created by a multi reference field), to automatically capture the changes to the many to many records into a change set, without needing to change the change set’s mode to “tracking all changes” renderer properties renderer properties are field/relationship properties specific to a specific view, rather than generally for the field/relationship they are accessed via the the form configuration form (via "configure layout" under the tool icon in the upper right of a form), then the small "cog wheel" above a field on the form the following properties can be configured against the fields and relationships renderers this is done from the key/value section on the renderer section field renderer properties property example for (field type/layout element type) comments dependent table field targettable condition used for fields such as conditions, that are dependent on the table they associated with basic toolbar false html html fields by default have limited controls on editing, so as not to crowd the screens where they are commonly used this makes them practical for fields such as client journals, etc however, some fields require more sophisticated editing, as well as toggle for html editing setting this property to false enables the full control inline editor false html html fields can have in line controls when you click into the field this will mean when you click into the field, it will provide certain options this is typically how our journal fields work out the box enablecreatebutton true related list this determines whether or not the “new” button will show up for related lists note that this does not overwrite permissions that are user may have to the field or target table however starting in version 1 10, you can also use this for custom related lists enablequickentrybutton true related list this determines whether or not the “add/remove” button will show up for related lists note that this does not overwrite permissions that are user may have to the field or target table however enablepreview false reference this determines whether or not the eye/preview button will appear for reference fields by default this is true for all reference fields accounting currency r decimal this prefix’s an account field with a type of currency this is for use with the accounting renderer accounting currency font size 14px decimal the size of the prefix this is for use with the accounting renderer accounting currency name rand decimal the name of the currency name this is for use with the accounting renderer expanded false collapsible panel used for collapsible panel layout element if set to false, the collapsible panel will be collapsed by default and true for the opposite note that if this renderer property isn’t added to the layout element, the collapsible panel will be expanded by default columnlist number,shortdescription,workflowstatus related list this allows you define the specific fields a related list can show, if it needs to be different to other views of that list sortorder shortdescription related list this allows you define the specific sort order a related list can show, if it needs to be different to other views of that list if you want to order it in descending order you can do the field with \ desc, such as shortdescription\ desc table list renderer properties property example comments accounting currency r used to prefix a field with a currency symbol relative time units “days, hours” to use this functionality, you need to be on version 1 10 or later which units to display in the field relative time unit display “long” to use this functionality, you need to be on version 1 10 or later should the units be short or long relative time format display “date”, “relative”, ”both” to use this functionality, you need to be on version 1 10 or later should the date be displayed as well as the relative time relative time format future key relative time future remaining to use this functionality, you need to be on version 1 10 or later i18key for future relative times relative time format past key relative time past overdue to use this functionality, you need to be on version 1 10 or later i18nkey for past relative times catalog question rendered properties property example comments reversed true set to true so the label of the catalog question will appear to the right of the question use case will be having a checkbox question with the label to the right of the checkbox