Block reference / General

Parameter Prompt

Stops the run part way through and asks for values in a form in the profile's browser.

In both appsWarpX BrowserWarpX Phone

Parameter Prompt pauses a run and asks the person watching for values, such as a one-time code that only arrives after sign-in. The form opens inside the profile's own browser page, the same form the Start block draws with Prefer input parameters in Profile. When someone clicks Run, each answer becomes a variable and the run carries on. If a value is known before the run starts, ask for it with the Start block's Parameters instead, so nobody has to wait by the browser.

The Parameter Prompt block's settings, filled in as in the example below.

Settings

Description

A note shown under the block's name on the canvas. It has no effect on the run.

ExampleAsk for the sign-in code
Timeout (millisecond) (0 to disable)

The longest the block waits for an answer, in milliseconds. New blocks start at 60000, one minute. When the time passes, the form is taken down and the run carries on with no values set. 0 waits until someone answers.

Example60000
Insert Parameters

Opens the same parameter builder as the Start block, without Prefer input parameters in Profile. Each input's Name is the variable its answer is stored in. Default value, Placeholder and the description accept {{references}}, filled in when the block runs.

ExampleloginCode | Input (string) |
Parameter requiredwhen a parameter is selected in the parameter builder

The form will not run while this field is empty, or, for a Checkbox, while it is not ticked. Clicking Run outlines the field, shows a message under it and moves the focus there.

ExampleChecked
Use input maskingwhen an Input (string) parameter is selected in the parameter builder

Shapes what is typed into an Input (string) field as it is typed. Write the mask under Masks, for example 000-000 for a six-digit code with a dash. Tick Is RegEx to write a regular expression instead.

ExampleChecked

Every block also has the shared block settings — a description, Disable block and what to do on an error. Fields that take text accept data from earlier blocks.

What it hands on

Each input becomes a variable named after its Name, for example {{variables.loginCode}}. Input (number) arrives as a number, Input (JSON) as parsed JSON, and Checkbox as true or false. After a timeout no variable is set. The block leaves by its single output.

Example: Ask for a one-time code during sign-in

  1. Start
  2. Open URL
  3. Forms
  4. Click element
  5. Parameter Prompt
  6. Forms
  7. Click element
Where Parameter Prompt sits in the example workflow.
  1. Add an Open URL block with https://shop.example.com/login, then a Forms block that types {{variables.email}} into #email, and a Click element block on #send-code.
  2. Add a Parameter Prompt block after it. Set Timeout (millisecond) (0 to disable) to 120000.
  3. Click Insert Parameters, click Input (string), and set Name to loginCode and Label to Code from the email. Tick Parameter required, turn on Use input masking and set the mask to 000000. Close the window.
  4. Add a Forms block that types {{variables.loginCode}} into #code, then a Click element block on button[type=submit].
  5. Run the workflow. When it reaches the prompt, the editor shows "Waiting for the parameters — the form is open in the profile's browser." Type the code into the form in the profile's browser and click Run. The field takes only digits, at most six, and Run waits until something is typed. The run signs in with the code.

On WarpX Phone

  • This block cannot ask anything on WarpX Phone. Its form is drawn in a profile's browser page, and a phone run has no page, so the block fails with The parameter form could not stay open — the profile's page closed or navigated away. Ask for the values with the Start block's parameters instead, which are asked for before the run starts.

Good to know

  • The form is drawn over the page the run is working in. If that page navigates away or closes while the form is open, the block fails with "The parameter form could not stay open — the profile's page closed or navigated away".
  • Clicking Cancel in the form fails the block with "Parameters were cancelled".
  • In a mask, 0 stands for a digit, a for a letter and * for any character. Every other character is fixed, and the form fills it in for you, like +1, the brackets and the dash in +1 (000) 000-0000. Put an optional part in []. Write !0 or \0 for a fixed 0.
  • A mask shows _ in the places still to fill. The variable gets what was typed, with the mask's fixed characters and without the _, for example +1 (555) 123-4567. A Default value is masked the same way when the form opens.
  • A mask does not make the field complete. +1 (555 is accepted. Parameter required only asks for something to be typed.
  • With Is RegEx, a typed character is kept only if the value still contains a match for the expression. ^\d{0,6}$ takes up to six digits.
  • The backtick in the mask help does nothing in this form, and {} only matters for an unmasked value, which the editor does not offer. A workflow imported with an unmasked value stores only the typed characters and any {} parts. One imported with several masks on a field uses whichever mask takes the most of what was typed.
  • A field left empty stores an empty value, not its Default value. The default is only what the field shows when the form opens. An empty Input (number) stores 0, and Input (JSON) that does not parse stores null.
  • After a timeout the variables keep whatever they held before. Check them with Conditions if a later block cannot work without them.
  • In a run over several profiles, each profile shows its own form in its own browser when it reaches this block, and waits for its own answer.

See also

  • Start — Where every workflow begins, and where you define the parameters a run asks for.
  • Clipboard — Reads text from your computer's clipboard, or puts text on it.
  • Get OTP — Work out the current 6-digit two-factor code from its secret.