---
title: Prompt
slug: neurons-for-itsm/admin-user-help/enu/latest/prompt
createdAt: 2026-07-14T19:16:41.487Z
---
Displays a text box for the user to enter text and returns the text that the user entered.
## Syntax
Prompt(message, pickList, fieldAreaWidth, fieldAreaHeight, password, required, defaultValue)
## Enabled For
For a description of the business object categories, see [Notes on "Enabled For"](docId\:u26v9feCFs6iLwA0-PVJd).
| Business Object Category | Yes/No |
| ------------------------------------------------------------------------------------------------------------------------ | ------ |
| Business Rules: Before-Save Rules | Yes1 |
| Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) | Yes |
| Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) | Yes1 |
| Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) | Yes |
| Business Rules: Editing Rules | Yes2 |
| Business Rules: Initialization Rules | Yes1 |
| Business Rules: Read Only Rules | No |
| Business Rules: Required Rules | Yes2 |
| Business Rules: Validation Rules | Yes1 |
| Client Expressions | No |
| Object Permissions | No |
| Services | Yes |
| LDAP | Yes |
| Mobile | Yes |
| Quick Actions (except UI Quick Actions) | Yes1 |
| UI Quick Actions | No |
| Reports | Yes1 |
| Search/Dashboard without field references | Yes1 |
| Search/Dashboard with field references | No |
| 1. Except in services.
2. Except in services and when this field appears on a form or is triggered by such a field. | |
## Parameters
:::Paragraph{indent="1"}
This function takes at least one parameter and can take up to seven parameters. To enter a parameter without entering a value for a parameter before it, enter "" for the parameter for which you do not have a value. For example, to enter the **message**, **pickList**, and **fieldAreaHeight** parameters, but no **fieldAreaWidth** parameter, enter **$(Prompt(message, pickList, "", 25))**. In this example, the application uses 25 as the value of the **fieldAreaHeight** parameter and not the value of the **fieldAreaWidth** parameter.
:::
| Parameter | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| message | The message that shows as a prompt. |
| pickList | (Optional) The name of a pick list that provides values for the user to select from.
If this parameter is null or empty, the function does not specify a list but displays a text box instead. |
| fieldAreaWidth | (Optional) The width of the text area in pixels. |
| fieldAreaHeight | (Optional) The height of the text area in pixels. |
| password | (Optional) Can be either true or false.
If true, the application treats the entered text as a password and displays it as asterisks when entered. |
| required | (Optional) Can be either true or false.
If true, the user must enter or pick a value. |
| defaultValue | (Optional) The text value to return if the user does not enter anything or select a value. |
## Return Value
:::Paragraph{indent="1"}
Text value.
:::
## Examples
:::Paragraph{indent="1"}
The following is an example of using this function in a quick action:
:::
`$(Prompt("Select Cause Code", "Incident Cause Code", 400, 200, false, true))`
:::Paragraph{indent="1"}
In this example, the **required** parameter is set to true, because the application prompts the user for a value that is required. This is to ensure that the user specifically chooses a proper value before the quick action is executed. In this example, there is no default value provided so there is no **defaultValue** parameter and therefore the function only has six parameters.
:::
:::Paragraph{indent="1"}
Add the following expression to the **Resolution** field of the **Update Object** quick action for an incident:
:::
`$(Prompt("Please enter resolution", "", 400, 200))`
:::Paragraph{indent="1"}
This returns a prompt for a resolution note with an empty text area that is 400 pixels in width and 200 pixels in height.
:::
:::Paragraph{indent="1"}
Another example is in the Social Board where a quick action creates a business object.
:::
`$(Prompt("Summary", "", 350, 25, "", "", "_ConversationTitle_"))`
`$(Prompt("Description", "", 400, 200, "", "", "_ConversationContent_"))`
:::Paragraph{indent="1"}
In the first instance, the original post is included in the **Summary** field. In the second instance, the original post and the comments are included in the **Description** field.
:::
:::Paragraph{indent="1"}
You also can use this function in a saved search, to prompt an employee team when the search is being run.
:::
:::Paragraph{indent="1"}
You can use the Prompt() function in the context of the **Update Object** quick action to ask the user to fill out a value for a field in the business object. This is typically used when the underlying field is also validated.
:::
`$(Prompt(TitleInPrompt, ""))`
`$(Prompt(TitleInPrompt, NamedValidationList))`
:::Paragraph{indent="1"}
There are two variations of the Prompt() function:
:::
:::Paragraph{indent="1"}
If the second parameter is an empty string, you can enter any value for the field.
:::
:::Paragraph{indent="1"}
If the second parameter is a text value, the application assumes that this value is a named validation list and uses it to constrain the allowable values that you can enter for the field.
:::
:::Paragraph{indent="1"}
The following Prompt() function updates the owner team for an incident:
:::
`$(Prompt("Incident Owner Team", "Team of StandardUserTeam used in Incident"))`
:::Paragraph{indent="1"}
The following example shows the syntax in the existing **Reassign Owner Team** quick action in for an incident:
:::
*Prompting for a Value in a Quick Action Example*
::Image[]{src="https://api.archbee.com/api/optimize/parib0MC3hVoUNdfQdnac/g0ZvyQMofPwm2wyQygYuJ_expressionownerteamqa.jpg" position="flex-start" size="40" initialPath="../../Resources/Images/help-images/expression_owner_team_qa.jpg" githubPath="Content/Resources/Images/help-images/expression_owner_team_qa.jpg" showCaption="false" width="696" height="458" darkWidth="696" darkHeight="458" indent="1"}