In certain situations, data points that are not natively stored in Athennian (eg. director remuneration), or information that varies each time you generate certain documents (eg. loan amount), can still be automated by using custom prompts.
Setting Up Custom Prompts
-
Go to the settings of the document you would like to add a custom prompt to and click “Prompt.”
- The Custom Prompt pop up will give you the option to choose a pre-existing custom prompt or to create a new one. Click “New” to create a new prompt.
-
Create a new variable name.
-
Follow the camel case naming convention. (e.g., camelCase)
-
Do not include spaces
-
- Type your question in the question box.
-
Choose a fill type.
Fill Types
Text Fill
Text Fill will provide the user with a multiple choice question. Use the choices tab to provide the choices.
The Answer box will be what the user sees while the Fill Text will be the output in the document.
User View at the time of document generation:
True/False
True/False provides the user with boolean choices. You can provide more than 2 choices, however the output will only be true or false.
User view at the time of document generation:
User Fill
User Fill will provide the user with a freetype text box. The output will be exactly what the user types into the box.
User view at the time of document generation:
Using Custom Prompts
Custom prompts can be used in a variety of different ways depending on the output of the prompt.
Variable
You can use the custom prompt as a simple variable.
Sample Custom Prompt Settings |
Variable name: {assemblerInitials} Fill type: User Fill Question: Please provide the assembler initials. |
User Response |
JPA |
Coded Document |
The assembler’s initials are {assemblerInitials}. |
Generated Output |
The assembler’s initials are JPA. |
Sample Custom Prompt Settings |
Variable name: {paymentType} Fill type: Text Fill Question: How will payment be made? Option 1 - Cash |
User Response |
Cash |
Coded Document |
The type of payment is {paymentType}. |
Generated Output |
The type of payment is cash. |
Logic
You can also use custom prompts in logic. See this article for more on logic: Conditions: IF statements
Below is an example of custom prompts in logic.
Sample Custom Prompt Settings |
Variable name: {assemblerExists} Fill type: True/False Question: Does an assembler exist? Option 1 - Yes (true) |
User Response |
Yes (true) |
Coded Document |
{#assemblerExists==true}This sentence will print if the assembler exists.{/}{#assemblerExists!=true}This sentence will print if the assembler does not exist.{/} |
Generated Output |
This sentence will print if the assembler exists. |