•••
 
Documentation   /   Actions   /   Question and input actions
 
 

Question and input actions

 

Input actions ask the user for something. The answer becomes the item's value, {{item_id}}, and filters can route the workflow on it.

All input actions accept the common directives, including ---optional, ---undoable, ---block and ---clearance_level.

Multiple choice question: question

Shows the question with one button per answer.

Directive Required Description
---options Yes The question text.
---answer1|text, ---answer2|text, ... Yes The answers, one per numbered directive.

The answer saved is the answer's text, so filters compare against the same text.

--#item:
---id:right_to_work
---title:Right to work
---action:question
---options:Has the candidate shown proof of their right to work in the UK?
---answer1|text:Yes
---answer2|text:No
---filter1|filter:answer EQUALS Yes
---filter1|outcome:upload_proof
---filter2|filter:answer EQUALS No
---filter2|outcome:stop_hiring

Text input: text_input

Directive Required Description
---input_type No text (default, one line), textarea (several lines) or amount (money).
---mini_label No Label above the field. Default: "Enter text".
---start_text No Placeholder text shown in the empty field.
---small_msg No A hint under the label.
---default_value No Value already filled in. Can be a {{variable}}.
---string_format No Checks the format. See String formats.
---button_text No Label of the save button.
--#item:
---id:salary
---title:Salary
---action:text_input
---input_type:amount
---mini_label:Annual salary
---string_format:currency
---small_msg:Enter the gross annual salary, e.g. £45,000

Dropdown: dropdown

Directive Required Description
---options Yes The choices, as "Option 1","Option 2","Option 3". To save a value different from the label, write "value[:]Label". You can also give an https:// URL returning JSON.
---mini_label No Label. Default: "Choose from the dropdown".
---small_msg, ---default_value, ---button_text No As for text input.
--#item:
---id:office
---title:Which office will they work from?
---action:dropdown
---options:"cardiff[:]Cardiff","london[:]London","remote[:]Remote"

Date: date

Directive Required Description
---mini_label No Label. Default: "Choose a date".
---small_msg, ---default_value, ---button_text No As for text input.

Format a date answer in later text with [[DATE]]. For example, [[DATE=D MMMM YYYY]]{{start_date}}[[ENDDATE]] gives "5 January 2027". See Logic statements.

Attach a file: attachment

Asks the user to attach a document or image file to the task. Attached files are stored with the task.

--#item:
---id:passport_scan
---title:Upload a copy of the passport
---action:attachment
---block:true

To-do: done

A simple step with a Done it! button. Use it for things done outside Plainly, such as "Order a laptop".

--#item:
---id:order_laptop
---task_stage:IT setup
---title:Order a laptop
---description:Use the IT portal. Choose the standard build.
---action:done
---clearance_level:it@example.com