{"id":509,"date":"2025-02-22T14:09:32","date_gmt":"2025-02-22T14:09:32","guid":{"rendered":"https:\/\/kb.ctse.nl\/?page_id=509"},"modified":"2025-08-29T14:19:48","modified_gmt":"2025-08-29T14:19:48","slug":"custom-inputs","status":"publish","type":"page","link":"https:\/\/kb.ctse.nl\/?page_id=509","title":{"rendered":"Custom Inputs"},"content":{"rendered":"\n

On the document action template you can define Custom Inputs, so the user can\/must fill in extra info for using in the document flow.<\/p>\n\n\n\n

Note: <\/strong>This feature is only supported for templates of types \u201cFlow Mailmerge\u2026\u201d and not supported for other templates types (yet).<\/p>\n\n\n\n

Custom Inputs can be defined with the following definition in JSON.<\/p>\n\n\n\n

<\/a><\/a><\/a>Fields<\/a><\/h2>\n\n\n\n

Each field contains an unique id (required), a type (required), a label (optional), helpText (optional), an indicator if a value is required (optional) or if a field is disabled (optional) and a default value (optional). Depending on the field type other properties may be required.<\/p>\n\n\n\n

Available types of fields: text, number, date, boolean, options, lookup, hidden and break.<\/p>\n\n\n\n

Property \u201clabel\u201d and \u201chelpText\u201d can be a single string or an object with the supported lcid\u2019s as property.<\/p>\n\n\n\n

These properties are required: “id” and “type”. Property “label” is recommended.<\/p>\n\n\n\n

{\n  \"fields\": [\n   {\n\n    \"id\": \"field1\",\n\n    \"type\": \"text\",\n\n    \"minLength\":10,\n\n    \"maxLength\":100,\n\n    \"required\": true,\n\n    \"disabled\": false,\n\n    \"label\": { \"1033\": \"Field 1\", \"1043\": \"Veld 1\" },\n\n    \"helpText\": { \"1033\": \"More info...\", \"1043\": \"Meer informatie...\" },\n\n    \"errorMessage\": { \"1033\": \"Required\", \"1043\": \"Verplicht\" },\n\n    \"value\": \"test\"\n\n  }\n ]\n}<\/code><\/pre>\n\n\n\n
 Text Field<\/a><\/h3>\n\n\n\n
Single line text<\/p>\n\n\n\n
{   “id”: “lastname”,   “type”: “text”,   “maxLength”:100,   “label”: { “1033”: “Last name”, “1043”: “Achternaam” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Multiline text<\/p>\n\n\n\n
{   “id”: “description”,   “type”: “text”,   “multiline”: true,   “rows”: 5,   “maxLength”:500,   “label”: { “1033”: “Description”, “1043”: “Omschrijving” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
 Number Field<\/a><\/h3>\n\n\n\n
Whole number<\/p>\n\n\n\n
{   “id”: “age”,   “type”: “number”,   “numType”: 0,   “min”: 0,   “max”: 150,    “label”: { “1033”: “Age”, “1043”: “Leeftijd” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Use optional property “format”: “slider” to show the number field as a slider.<\/p>\n\n\n\n
Decimal number<\/p>\n\n\n\n
{   “id”: “amount”,   “type”: “number”,   “numType”: 1,   “precision”: 2,   “min”: -9999999,   “max”: 9999999,    “label”: { “1033”: “Amount”, “1043”: “Bedrag” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/a><\/a><\/a>Date Field<\/a><\/h3>\n\n\n\n
{   “id”: “birthdate”,   “type”: “date”,   “firstWeekDay”: 1,  “allowTextInput”: true, “label”: { “1033”: “Birthdate”, “1043”: “Geboortedatum” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/a><\/a><\/a>Lookup Field<\/a><\/h3>\n\n\n\n
{   “id”: “accountid”,   “type”: “lookup”,   “entityType”: “account”,   “label”: { “1033”: “Account”, “1043”: “Organisatie” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
You can also set the optional property \u201cfilters\u201d if needed:<\/p>\n\n\n\n
  “filters”: “<filter type=’and’><condition attribute=’statecode’ operator=’eq’ value=’0′ \/><\/filter>”<\/p>\n\n\n\n
<\/a><\/a><\/a>Options Field<\/a><\/h3>\n\n\n\n
Custom options<\/p>\n\n\n\n
{   “id”: “myoptions”,   “type”: “options”,   “options”: [     { “value”: 1, “label”: { “1033”: “Option 1”, “1043”: “Optie 1” } },     { “value”: 2, “label”: { “1033”: “Option 2”, “1043”: “Optie 2” } },   ],   “label”: { “1033”: “Make a choice”, “1043”: “Maak uw keuze”} }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Property \u201clabel\u201d of an option can be a single string or an object with the supported lcid\u2019s as property.<\/p>\n\n\n\n
{   “id”: “myoptions”,   “type”: “options”,   “options”: [     { “value”: 1, “label”: “Option 1” },     { “value”: 2, “label”: “Option 2” },   ],   “label”: “Make a choice”<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Global optionset<\/p>\n\n\n\n
{<\/p>\n\n\n\n
  “id”: “language”,<\/p>\n\n\n\n
  “type”: “options”,<\/p>\n\n\n\n
  “options”: { “optionsetName”: “new_languagecode” },<\/p>\n\n\n\n
  “label”: { “1033”: “Language”, “1043”: “Taal” }<\/p>\n\n\n\n
}<\/p>\n\n\n\n
Entity field optionset<\/p>\n\n\n\n
{   “id”: “gender”,   “type”: “options”,   “options”: { “optionsetName”: “gendercode”, “entityType”: “contact” },   “label”: { “1033”: “Gender”, “1043”: “Geslacht” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Statuscode optionset<\/p>\n\n\n\n
{   “id”: “status”,   “type”: “options”,   “options”: {     “optionsetName”: “statuscode”, “entityType”: “contact”, “stateCode”: 1   },   “label”: { “1033”: “Deactivate reason”, “1043”: “Reden van deactiveren” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
An option field will display as a dropdown by default. Optional property \u201cformat\u201d with value \u201cradio\u201d will display the field as a radiobuttons.<\/p>\n\n\n\n
For multiple select use<\/p>\n\n\n\n
  “multiSelect”: true,<\/p>\n\n\n\n
The value for this field will be a comma separated string with the selected value(s).<\/p>\n\n\n\n
Default the field will be displayed as dropdown, to display as checkboxes use \u201cformat\u201d: \u201ccheckbox\u201d.<\/p>\n\n\n\n
<\/a><\/a><\/a>Boolean Field<\/a><\/a><\/h3>\n\n\n\n
{   “id”: “question”,   “type”: “boolean”,   “label”: { “1033”: “Question”, “1043”: “Vraag” } }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
This shows the field as a checkbox, to show the Boolean field as a toggle, use this:<\/p>\n\n\n\n
{<\/p>\n\n\n\n
  “id”: “question”,<\/p>\n\n\n\n
  “type”: “boolean”,<\/p>\n\n\n\n
  “format”: “toggle”,<\/p>\n\n\n\n
  “trueLabel”: { “1033”: “Yes”, “1043”: “Ja” },<\/p>\n\n\n\n
  “falseLabel”: { “1033”: “No”, “1043”: “Nee” },<\/p>\n\n\n\n
  “label”: { “1033”: “Question”, “1043”: “Vraag” }<\/p>\n\n\n\n
}<\/p>\n\n\n\n
Property \u201ctrueLabel\u201d and \u201cfalseLabel\u201d can be a single string or an object with the supported lcid\u2019s as property.<\/p>\n\n\n\n
Paragraph Field<\/a><\/h3>\n\n\n\n
A paragraph field holds textblock as readonly.<\/p>\n\n\n\n
{   “id”: “mysecret”,   “type”: “paragraph”,   “value”: “some text” }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/a><\/a><\/a>Hidden Field<\/a><\/h3>\n\n\n\n
A hidden field holds data without displaying it.<\/p>\n\n\n\n
{   “id”: “mysecret”,   “type”: “hidden”,   “value”: “test” }<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Break Field<\/a><\/h3>\n\n\n\n
{<\/p>\n\n\n\n
  “id”: “mybreak”,<\/p>\n\n\n\n
  “type”: “break”,<\/p>\n\n\n\n
  “lines”: 2<\/p>\n\n\n\n
}<\/p>\n\n\n\n
<\/a><\/a>Prefill Field Value<\/a><\/h3>\n\n\n\n
Text Field:<\/p>\n\n\n\n
  “value”: “test”<\/p>\n\n\n\n
Number Field value as whole number:<\/p>\n\n\n\n
  “value”: 1<\/p>\n\n\n\n
Number Field value as decimal<\/p>\n\n\n\n
  “value”: 2.95<\/p>\n\n\n\n
Options Field single select:<\/p>\n\n\n\n
  “value”: 1<\/p>\n\n\n\n
Or:<\/p>\n\n\n\n
  “value”: “item1”<\/p>\n\n\n\n
Options Field multi select:<\/p>\n\n\n\n
  “value”: “1,2,3”<\/p>\n\n\n\n
Or:<\/p>\n\n\n\n
  “value”: “item1,item2,item3”<\/p>\n\n\n\n
Note that the value must match with the value(s) of the options<\/p>\n\n\n\n
Boolean Field<\/p>\n\n\n\n
  “value”: true<\/p>\n\n\n\n
Lookup Field (value must be an array!):<\/p>\n\n\n\n
  “value”: [{ “id”: ” c75d505c-71c6-45f8-8b17-e8004d2275d3″, “entityType”: “account”, “name”: “Contoso” }]<\/p>\n\n\n\n
Or to prefill the lookup with the recordid (from the form where you started the dialog):<\/p>\n\n\n\n
  “value”: “${selectedEntityId}”<\/p>\n\n\n\n
Hidden Field:<\/p>\n\n\n\n
A value of an hidden field can hold any type of data (text, number, lookup, date).<\/p>\n\n\n\n
Date Field:<\/p>\n\n\n\n
To prefill the value with today\u2019s date, set property \u201cvalue\u201d to “${today}”:<\/p>\n\n\n\n
  “value”: “${today}”<\/p>\n\n\n\n
To prefill the value with today\u2019s date and time, set property \u201cvalue\u201d to “${now}”:<\/p>\n\n\n\n
  “value”: “${now}”<\/p>\n\n\n\n
To prefill fields with more complexity, use scripting at the onPageLoaded event (see paragraph \u201cScript Page Load\u201d).<\/p>\n\n\n\n
<\/a><\/a>Interfaces Definition<\/a><\/h2>\n\n\n\n
<\/a><\/a>IField<\/a><\/h3>\n\n\n\n
All fields have properties id and type. Except the Break Field all fields also have property value. Except Hidden Field all fields have property visible.<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
id<\/td>Required, string<\/td><\/tr>
type<\/td>Required, string, possible values: \u201ctext\u201d, \u201cnumber\u201d, \u201cdate\u201d, \u201cboolean\u201d, \u201coptions\u201d, \u201clookup\u201d, \u201cparagraph\u201d, \u201chidden\u201d or \u201cbreak\u201d<\/td><\/tr>
label<\/td>Optional, String or ILabel<\/td><\/tr>
helpText<\/td>Optional, String or ILabel<\/td><\/tr>
required<\/td>Optional, boolean (not applicable for hidden and paragraph fields)<\/td><\/tr>
disabled<\/td>Optional, boolean (not applicable for hidden and paragraph fields)<\/td><\/tr>
visible<\/td>Optional, boolean (not applicable for hidden fields)<\/td><\/tr>
value<\/td>Optional<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Text Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
minLength<\/td>Optional, number of minimum allowed characters<\/td><\/tr>
maxLength<\/td>Optional, number of maximum allowed characters<\/td><\/tr>
multiline<\/td>Optional, boolean<\/td><\/tr>
rows<\/td>Optional, whole number, only applicable if multiline is true<\/td><\/tr>
regEx<\/td>Optional, regular expression for validating the value<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Number Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
numType<\/td>Required, 0 = whole number, 1 = decimal<\/td><\/tr>
precision<\/td>Required if numType is decimal<\/td><\/tr>
min<\/td>Optional, minimum numeric value<\/td><\/tr>
max<\/td>Optional, maximum numeric value<\/td><\/tr>
format<\/td>Optional, string, possible values: \u201cslider\u201d<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Date Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
firstWeekDay<\/td>Optional, number (0 = Sunday, 1 = Monday, 2 = Tuesday, etc.), if not set then default is 1<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Boolean Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
format<\/td>Optional, string, possible values: \u201ccheckbox\u201d (default) or \u201ctoggle\u201d<\/td><\/tr>
trueLabel<\/td>Optional, string, only applicable if format is \u201ctoggle\u201d<\/td><\/tr>
falseLabel<\/td>Optional, string, only applicable if format is \u201ctoggle\u201d<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Options Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
options<\/td>Required, array of IOptionValue or IOptionSet<\/td><\/tr>
multiSelect<\/td>Optional, boolean (default false)<\/td><\/tr>
format<\/td>Optional, string, possible values: \u201cdropdown\u201d (default), \u201cradio\u201d (only when multiSelect = false), \u201ccheckbox\u201d (only when multiSelect = true).  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Lookup Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
entityType<\/td>Required, string, logical name of the entity<\/td><\/tr>
multiSelect<\/td>Optional, boolean (default is false)<\/td><\/tr>
viewId<\/td>Optional, string, id of the view<\/td><\/tr>
filters<\/td>Optional, string, for example: <filter type=’and’><condition attribute=’statecode’ operator=’eq’ value=’0′ \/><\/filter><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Break Field<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
lines<\/td>Optional, number<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
IOptionValue<\/p>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
value<\/td>Required, number or string<\/td><\/tr>
label<\/td>Required, string or ILabel<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/a><\/a>IOptionSet<\/a><\/h3>\n\n\n\n
Properties<\/strong><\/td>Description<\/strong><\/td><\/tr>
optionSetName<\/td>Name of the optionSet<\/td><\/tr>
entityType<\/td>Only applicable (and required) if the optionsetName does not refer to a global optionset<\/td><\/tr>
stateCode<\/td>Only applicable (and required) if optionSetName is \u201cstatuscode\u201d (to show only the statuscodes of this statecode)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
 ILabel<\/a><\/h3>\n\n\n\n
Object with one or more lcid\u2019s which hold the label text.<\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
On the document action template you can define Custom Inputs, so the user can\/must fill in extra info for using in the document flow. Note: This feature is only supported for templates of types \u201cFlow Mailmerge\u2026\u201d and not supported for other templates types (yet). Custom Inputs can be defined with the following definition in JSON. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":113,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-509","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/pages\/509","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=509"}],"version-history":[{"count":11,"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/pages\/509\/revisions"}],"predecessor-version":[{"id":577,"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/pages\/509\/revisions\/577"}],"up":[{"embeddable":true,"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=\/wp\/v2\/pages\/113"}],"wp:attachment":[{"href":"https:\/\/kb.ctse.nl\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=509"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}