Administration Guide

Templates and Defaults

On this page

A data template supplies the initial field values for a new object. A Create Action uses its own template when it creates a record. A Create Object operation also has a template for the object it creates; see Operations Reference.

A Create Action's availability does not depend on a record's status or type, and the organizational part of its role grant does not restrict it. For configuring Create Actions, see Actions.

You edit templates in the Settings App (see Admin Center and Settings App).

In the Settings App

Open a class's templates

A class's templates are managed on the Templates node of its workflow tree. Open the class's Workflow node, under the class in its business area; the tree's Components folder holds Templates.

  • New opens an empty Template window, and Edit, a double-click, or Enter opens the selected template's window.
  • Copy Item copies the selected template and opens the copy.
  • Delete deletes the selected template; see Delete a template.

The window's title shows the template's name in brackets, with an asterisk in front while it has unsaved changes. OK saves the changed window and closes it.

Choose a template for an item

An item's Template: list offers the reusable templates of the item's class. Two commands switch between a reusable template and a template of the item's own:

  • Make Custom detaches the template into a new private definition for this item, keeping its field values.
  • Make Reusable asks for a name in the Reuse Template prompt, at Template Name:, up to 50 characters. A name another template of the same class already has is refused and you are asked again. The current fields are then saved as a new reusable template, which appears in the Template: list of that class's items.

Switching the Template: list away from a custom definition that already has field rows asks you to confirm before those values are discarded.

When you copy a workflow item with Copy Item, a template of the item's own is copied with it. A reusable template is not copied: the copy uses the same template as the original.

Edit a template's fields

The Template window has two pages:

  • General shows the object class (read-only), Name:, Description:, and a Fields group with the field grid.
  • Usage lists the workflow items and functions that use the template, and its caption shows how many there are. Open opens the editor of the selected item or function.

The field grid has the columns Field Name and Value:

  1. Click New (or press Insert). An empty row is added.
  2. In Field Name, pick one of the class's fields.
  3. In Value, enter the value. The editor depends on the field's type; see Value editors.
  4. To remove a row, select it and click Delete (or press Delete).

A template has no display order, so the grid offers no Move Up or Move Down. The template cannot be saved while any row's value is empty: saving is refused with "Field values can't be blank." and that row is selected. The name must not be in use by another template of the same class, whatever its capitalization; a duplicate is refused with "This Name is already in use. Please use a different one."

Value editors

The Value cell takes the editor of the field's type:

Field type Value editor
Money A currency box
Float A calculator in the cell
Integer, Duration A spin box that refuses invalid input
Boolean A list with True and False
Lookup The lookup's own editor; for a lookup that has calculated values, a drop-down list with those values at its head
Multi-select A check list filled from the lookup
Encrypted A text box that masks the value with *
String and other plain fields A text box
Memo A text box with an ellipsis button that opens a text window with no length limit
HTML A read-only cell whose ellipsis button opens the HTML editor; the cell shows the plain text, and the row keeps the HTML
Date, Date/Time A read-only cell; its button, a double-click, or Backspace opens a date window titled with the field's caption

The date window offers:

Option What you enter
Today (Current Date) Nothing
Now (Current Date and Time) Nothing
Exact date and time A date
Is in the past (date), Is in the future (date) A number of days
Is in the past (date and time), Is in the future (date and time) Days, hours, and minutes

Except for Exact date and time, the value is stored as an offset from today or from now.

A lookup field can also take a calculated value, listed in angle brackets before the real records. A calculated value is resolved when the template is applied:

Calculated value Offered on Resolves to
<Current User> Person and Technician lookups The current user
<User's Organization> Organization lookups The current user's organization, from the user's person record
<User's Location> Location lookups The current user's location, from the user's person record

The text window of a Memo value is titled Edit text and has OK and Cancel. Its Edit toolbar has Cut (Ctrl+X), Copy (Ctrl+C), Paste (Ctrl+V), and Select All (Ctrl+A); Ctrl+F searches the text and F3 repeats the search. Cancel closes the window and discards your edits without asking you to confirm.

Delete a template

Deleting a template is refused while any workflow item refers to it, with "Unable to delete ... because one or more workflow items refer to it. Remove dependencies first."; the template's editor then opens on its Usage tab. A system template is refused as a system record.

The Create Object operation's Relationship: picker says how the created object is tied to the current one. It is a tree with a No relationship entry and up to two groups:

  • An attribute of the current object: the current class's own reference fields to the target class, limited to the fields marked as usable when the workflow creates an object. For a child class, the reference to its parent class is not listed.
  • A related object (shown on the Relationships tab): the class's workflow relation types. This group is not offered when the current class is a restricted class.

A group with no entries is not shown.

Choose what a reference points to

The Reference to picker chooses which lookup a Reference-type field or parameter points to. It is a two-level tree: the objects that can be referenced, and under each class its classifiers. The closed box shows a lookup that belongs to a workflow class as <class> -> <name>, for example a work order's priority, and any other lookup by its name alone.

Picking an entry that does not support references is refused with "Reference to this object is not supported." and the selection does not take. For an ordinary item parameter this check is off, so the parameter can also point to a lookup object that does not support references.

Define the values of a virtual lookup

The Lookup Values window defines the values of a virtual lookup field. Its Source: list offers:

  • For a single-value lookup: Dynamic list based on custom SQL, Static list of values (Radio Buttons), and Static list of values (Drop Down).
  • For a multi-valued lookup: Dynamic list based on custom SQL and Static list of values.

For a static list, the grid has the columns Value and Display Text:

  1. Click New (or press Insert) to open Add Lookup Value, or select an entry and click Edit (Enter or a double-click) to open Edit Lookup Value.
  2. Enter the Value. OK stays unavailable while Value is empty, and a value already in the list is refused with "This value already exists in the list. Please enter a different one."
  3. Enter the Display Text. It follows the value as you type until you enter a different text; left empty, it is saved as the value.
  4. Click OK.

Delete (Delete key) asks "Delete record?", or "Delete N records?" for several entries. Move Up and Move Down (Ctrl+Up and Ctrl+Down) move the whole selection. The window sets no limit on the number of entries in a multi-valued list.

For a dynamic list, enter a SQL query in the box. The page states the two shapes it accepts: "Enter a custom SQL query that returns two columns. The first column contains field values and the second column contains values that will be displayed in the drop-down list on the Action Form. If you want the drop-down list to display field values, enter a SQL query that returns one column. The first column must be of a character data type or uniqueidentifier (GUID)."

  • The box's expand button opens the query in a text window.
  • The Select Placeholder panel below the box, with Category:, Item:, and Placeholder: (and SubItem: and Description: where the placeholder has them), inserts a placeholder at the cursor through Insert, or by dragging. The same panes are described in Pick a placeholder.
  • OK runs the query and checks the first column's data type. A first column that is not a string or GUID type is refused; a memo-typed first column shows a warning first and is then refused as well.
  • The first column is the stored value and the second the text shown; with a one-column query, the values themselves are shown. A third column is not read.
  • A query that contains a placeholder makes the field a filtered lookup: its values are resolved again against the values already entered, and a stored value that no longer matches is cleared.

Set the person name and address templates

Two templates fill in fields of a new person record: the Full Name template fills in the Full Name field, and the Address template the Address field. Both are set on the Options node of Persons.

  1. In the navigation tree, select Workflow and Business Logic > Organization Management > Persons > Options.
  2. In the Full Name template group, choose a template in Current Template:, or type one. The list offers F L, L, F, and L, F M; the legend reads "F - first name, L - last name, M - middle name".
  3. To check the name template, click Preview... in the same group. The preview applies the template as it is typed, saved or not, to the sample name John M. Hutchens; with F L, it reads "John Hutchens".
  4. In the Address template group, edit the template. To go back to the default template, click Set Default and confirm "Replace the current template with the default one?". The default template has four lines:

    • [StreetAddress]
    • [PostOfficeBox]
    • [City], [State] [PostalCode]
    • [Country]

    Set Default only fills in the box; the default template is not saved until you apply it.

  5. To check the address template, click Preview... in the Address template group. The preview fills the template with the sample address 43 Stanhope St, PO Box 1022, Seattle, WA, 98107, USA.

  6. Click Apply.

Both previews open in a dialog captioned Preview.... Apply is available only while you have changed something and neither template is blank.

A new 2026.1 database created with the Default Workflow (see Default Workflow Configuration) stores no name template, so the template F L applies until you save another one. On such a database, Current Template: opens empty; choose a name template before you click Apply, even when you change only the address template.

In the Web App

The Web App builds each user's menu of classes and their Create Actions, and with them the templates those actions apply, from the user's Create permission on each class and from the actions' role grants: a Create Action reaches a user through its own role grants, and a Create Action with no role grant reaches everyone (see Security Roles).

  • Only ordinary Create Actions and Create Actions of the recurrence registration kind count, and only when they are enabled.
  • Each action's own condition narrows the list further. A condition that fails to compile is ignored rather than hiding the action.
  • The Service Requests entry is added when the Service Catalog holds anything to submit.

For how a technician starts a create action from a list, see Create a record with New.

  • Actions - set up the Create Actions that apply templates.