Prompter - Template
Summary
This is a copy-only template for clients to use to set up prompter messages.
Sample Run
This script is not intended to be run; it is intended to be a template that can be copied to any script where a prompter message is desired.
Use Case
Recommended steps to use the Prompter:
- Open the Prompter - Template in ConnectWise Automate.
- Select all lines in the ELSE section of that script.
- Paste these lines into any script where a Prompter message is desired.
- Enable any required lines and set the desired values; at a minimum, the
@Message@variable must be set. - Enable the RUN SCRIPT line (Line 13 in the Template ELSE section) in your new script.
NOTE: The Then section of this script is intentionally left blank.
Dependencies
Variables
These variables are used in the prompter script. They should be set in any script calling Prompter - Template.
| Name | Description |
|---|---|
| Message | Holds the desired message for Prompter. |
| DateTimeSelector | Toggles a date/time selection in the Prompter pop-up (True or False). |
| Icon | Holds the local path and file or URL to a desired pop-up icon. |
| HeaderImage | Holds the local path and file or URL to a desired pop-up header image. This should be the name of the file in the /Transfer/App directory of the LTShare when @LTShareDownload@ is set to 1. For example: header-image.jpg |
| Title | Holds the desired title text for the Prompter pop-up. |
| Buttons | Holds the desired button options for the Prompter pop-up (space-separated values, quotes around multi-word buttons). |
| Timeout | The duration of time you wish the Prompter pop-up to remain on the user's screen before auto-closing. |
| PrompterResults | The user-returned results after executing Prompter. |
| LTShareDownload | Use the LTShare to download Prompter and header images. Requires the Prompter.exe and desired header images to be in the /Transfer/App directory of the LTShare. |
| TwelveHour | Changes the display of time in the Date/Time selector to 12-hour format. |
| Theme | Sets the theme for Prompter. If omitted, the theme will use the default Windows theme. Options are "Dark" and "Light". |
| DateTimeFromHours | Stores the number of hours to add to the current time in order to set the starting point for the Date/Time selector. |
| DateTimeToHours | Stores the number of hours to add to the initial time in the Date/Time selector in order to display the last available option to select. |
| HTMLMessage | Set this to true to enable HTML decoding of the message. |
| UserInput | Set this to true to enable the user input field. |
| userinputtext | Set initial/help text for the user input field. |
| selectedButton | Button selected by the user. |
| dateTimeSelection | Date and time selected by the user. |
| userResponse | Input/feedback provided by the user in the user input field. |