A Starter Kit which provides many helpful tools, including a downloadable A2J Authoring Guide, is also available by following this link: A2J Author® Starter Kit.
WELCOME TO THE "ONLINE" A2J AUTHORING GUIDE!
The Online A2J Authoring Guide provides information, tutorials and video demonstrations on various features of the A2J Author® software. The Online A2J Authoring Guide is sorted by topic areas (see the index of links at the bottom of the page). Each topic area is then broken down into tutorials, downloadable training modules, and video demonstrations.
Please note that there is also an A2J Authoring Guide available as a downloadable pdf. The A2J Authoring Guide is not the same as the online version. The pdf and online versions are meant to complement one another. The A2J Authoring Guide provides instructions for installing the software. It also provides a detailed description of the entire process of interview creation, from downloading the software to uploading a completed interview to the National Public Automated Documents Online (NPADO)Server. You may download the A2J Authoring Guide separately here: A2J Authoring Guide. A Starter Kit, which includes the A2J Authoring Guide and much more, is also available by following this link: A2J Author® Starter Kit.
A Starter Kit which provides many helpful tools, including a downloadable A2J Authoring Guide, is also available by following this link: A2J Author® Starter Kit.
There are two steps in uploading your A2J Guided Interviews®. The first is to upload your HotDocs template to the Law Help Interactive Server (National Server). The final step is to upload your A2J Guided Interviews® to the National Server.
Setting Up HotDocs® for Uploading Templates
Obtaining the HotDocs® Template ID and URL on LHI
Note: The URL generated for the HotDocs template will not be used on your website in the event you will be associating the HotDocs template with an A2J Guided Interview. Once you upload the A2J Guided Interview, another URL will be generated which you will ultimately post on your website for access by end-users.
YOU ARE NOT DONE. SELECT 'NEXT' BELOW TO CONTINUE THE TUTORIAL AND LEARN HOW TO UPLOAD THE A2J GUIDED INTERVIEWS®.
Note: The A2J Author Interview Uploader is capable of uploading any number of files, each with a file size limit of 100MB. However, the LHI server currently limits interview uploads to a combined file size of 16MB. If you have questions regarding the file size limitation imposed by the LHI server or have an interview that exceeds this limitation, you may e-mail an inquiry to the managers of the server at npado@probono.net.
The LHI server has a set limit on the size of individual files that may be uploaded. Currently a file can be no larger than 16MB (subject to change in the future.)
Official Release.
REVISIONS FOR 1.6.1 (2007-08-10) (INTERNAL)
REVISIONS FOR 1.7 (2007-11-15) (INTERNAL)
REVISIONS FOR 1.7.5 (2007-11-19) (INTERNAL)
REVISIONS FOR 1.7.6 (2007-11-26) (INTERNAL)
REVISIONS FOR 1.7.7 (2007-11-28) (INTERNAL)
REVISIONS FOR 1.8 (2007-01-14) (INTERNAL)
2008-01-15 1.8.1 (INTERNAL)
2008-01-16 1.8.2 (INTERNAL)
2008-01-18 1.8.3 (INTERNAL)
2008-01-20 1.8.4 (INTERNAL)
2008-01-24 1.8.5 (INTERNAL)
2008-01-28 1.8.6 (INTERNAL)
See the links below for tutorials and demonstrations.
The Interview button, 
, will take you to a page that contains data about your interview. This screen allows you to set the interview's title, description, jurisdiction, author, version, history, end graphic, avatar and language. (NOTE: Parameters for the end graphic are as follows: 1) 900x250 pixels; 2) alpha transparency; and 3) .png or .swf file types only.)
INSTRUCTIONS: Screencasts demonstrating various features of A2J Author® are posted under various sections of the Online A2J Authoring Guide as downloadable windows media files (.wmv). If you have Windows Media Player, you can simply click on the desired link and 'open' the file automatically. Or, you may right click on the desired file to save or download it for later viewing.
NOTE: If you have not registered a username and password with this site, you will not be able to see any of the videos listed below.
See links below for tutorials, modules and demonstrations.
Should you start with creating your HotDocs template first, you can facilitate the subsequent design of your A2J Guided Interviews® by importing all of the variable names which you used in your corresponding HotDocs template. Select "Next" at the bottom of this screen for directions on Importing HotDocs variables.
Note: It is not necessary to start your document assembly project with designing the HotDocs template. You may, if you wish, design your A2J Guided Interviews® first. However, there is no reverse mechanism whereby variable names created in A2J Author® can be imported into HotDocs. But, if you do decide to create your A2J Guided Interviews® first, you can facilitate your HotDocs template work by printing a Full Report of your interview from the Report Screen which will provide a list of all of the variables you used in your A2J Guided Interviews®.
Follow these steps:
1) Go to Report Screen
2) Select Full Report
3) Print Report
Importing variables from your HotDocs template is easy to do in A2J Author®.
First, it is preferable to use standardized variables in your HotDocs template so that other HotDocs template and A2J Guided Interviews® developers can each leverage the work of others efficiently. For more on standardized variables see the Variable Standards document by Jeff Hogue, Legal Aid of Western New York, listed under Attachments below. (NOTE: If you have not registered a username and password with this site, you will not be able to 'see' attachments.)
Second, make sure you have saved your variable components file associated with your HotDocs template in an identifiable location.
Third, open A2J Author® and begin a new interview.
Fourth, select the Variables Tab to go to the Variables Screen.
Fifth, import the variables from the HotDocs component file by selecting the file folder icon at the bottom of the Variables Screen.
Finally, after selecting the folder icon, you will "browse" and select the component file containing the variables you wish to import.
You will quickly notice that the variables have been added to your Variables Table.
Once you have imported your HotDocs variable component file, you can easily access the variable names during A2J Guided Interview development. Simply select variable names from the Variable drop-down menu under the Field Tab in the Question Design Window. See instructions below.
After selecting the Question Screen from the main menu, highlight the last question in the list of questions and select add(
) to add a question.
Then, double click on the question to get to the Question Design Window and select the Fields Tab (
).
When you add a Field you will now be able to use the Variable drop-down menu to select a variable name.
Note: There may be times throughout the interview where you need to create A2J-specific variables (variables that will not apply directly to the corresponding HotDocs template). You can easily create these variables "on-the-fly" by simply typing the name of the variable in the Variable field, or by adding the variable to your Variables Table in the Variables Screen.
Variable field
Variables Table
Identifiers in expressions can be numbers, variables, text or dates.
| Identifiers | Info | Examples |
|---|---|---|
| Number | Number can include $, comma and period. | 10, $25,000, $199.99 |
| Variable | Variable can include spaces | INCOME, USER NAME, County |
| Text | Must be enclosed in double-quotes. | "Chicago", "Cook County" |
| Date | Must be enclosed in # symbol. | #12/31/1999#, #1/1/2010# |
Variable Screen
Variable Property Dialog Box
When referencing variables always enclose the variables in brackets, [User Variable]. This allows variables containing spaces to be property referenced.
You can use the values of a variable in the text of a question by referencing the variable. If the [User Name] variable contains Joan and the question's text was "Welcome %%[User Name]%%.", the question would display as Welcome Joan.
There are two special variables that the interview can set which change presentation to the user.
| Value | Result |
|---|---|
| blank | This is the default setting. The guide speaks facing the user. |
| male | Male gender chosen based on User_Avatar variable |
| female | Female gender chosen based on User_Avatar variable |
As you may have already noticed from the "Field Types" tutorial, each "Question" within an A2J Guided Interviews® can collect various sorts of data using an appropriate "Field" for each piece of data collected. Fields are broken down into "types" to correspond with a desired format for collecting the data.
In addition, each Field collects data using a "Variable". Variables are assigned "types" as well, according to how the data will be used within the A2J Guided Interviews® and the corresponding HotDocs template. (Variable type information can be found in the Variable Information "window" by double-clicking on a variable name on the variables table located under the Variables Tab.)
It is important to note that each Field Type in A2J Author® corresponds with a particular Variable Type, and that, if necessary, Variable Types can be modified in the Variables Table under the Variables Tab to correspond with the HotDocs variable type.
The Variable Type must match the Variable Type used in the corresponding HotDocs template in order for the data to appear correctly in the template.
Here are the Field Types and corresponding default Variable Types in A2J Author®:
This tutorial will demonstrate how the User Gender variable is used to not only set the gender of your avatar, but also to ensure that an avatar populates in the interview.
The variable "User Gender" must be used in order that the avatar appear in the browser.
If the author uses a different variable name to collect gender, then the avatar will not appear in the interview.
If your Hot Docs template uses a different variable to collect gender, don't panic. There is a simple way to set a default variable to ensure that the gender data collected in the interview will populate the gender variable you used in a Hot Docs document.
This is an example of what happens if you use a gender variable other than "User Gender."
A2J Author® does not read any variable other than "User Gender," so no avatar will populate in the interview if you do not change the condition.
First, A2J Author® only recognizes one variable for the purpose of setting the gender of the end-user's Avatar. That variable name is "User Gender". Thus, the gender variable is defaulted to "User Gender." The variable name should not be changed.
If you nevertheless need to collect a value for gender for a corresponding HotDocs template and have used an alternative variable name in the template, you can default the value of that variable as follows:
Under the Advanced Tab, set the expression in the condition field to 1=1. This expression ensures that the advanced condition will run each and every time the interview is played.
Then, set the variable name used in your HotDocs template equal to the value of the variable "User Gender." This defaults the value of the variable.
Syntax Note: Make sure to put %%[percentages and brackets]%% around User Gender.
This tutorial demonstrates how an author may recall the value of any variable collected in an earlier question for use in the text of a later question.
Once a user answers a question in an interview, the author may call back the user's information or variable value in a later question by placing the variable name inside of %%[percentages and brackets]%%, thus populating the associated variable value in that space.
In an interview, the author may choose to ask the user the following:
What is your name?
Let's assume that when the author created this question, he/she used "Client first name TE" as the variable for the first name field.
If the user types "John" as his response, A2J Author® collects this data as:
Client first name TE=John
In a later question, the author may want to collect additional information from John, e.g. birth date, address, etc.
To personalize the interview, the author may include the user's first name in the question.
For example, the author may ask:
%%[Client first name TE]%%, what is your date of birth?
The end user (John) will see the following:
John, what is your date of birth?
A2J Author® recalls the value of the variable "Client first name TE" when it is placed inside of %%[percentages and brackets]%%.
Instructions for A2J Author® Training Module for HASANSWERED: An A2J Author® Training Module is a tutorial designed within an A2J Guided Interviews®. To learn how to use Macros, you may download the A2J Author® Training Module for Variable Macros below. To download, right-click on the link below and save to a folder on your hard drive. (You will note that the file defaults to a ".xml" format. Both .xml and .a2j formats can be opened within A2J Author®.) Open the file within A2J Author® and run through the training module in Preview mode. Make sure to read the Learn More sections as you go. Be sure to toggle between Preview mode and the edit mode (by periodically selecting Resume Edit from the Preview mode). This will allow you to see how the interview was created.
INSTRUCTIONS: Screencasts demonstrating various features of A2J Author® are posted under various sections of the Online A2J Authoring Guide as downloadable windows media files (.wmv). If you have Windows Media Player, you can simply click on the desired link and 'open' the file automatically. Or, you may right click on the desired file to save or download it for later viewing.
NOTE: If you have not registered a username and password with this site, you will not be able to see any of the videos listed below.
See the links below for tutorials, trainings modules, and demonstrations.
You can create Steps under the Steps Tab by selecting the “Steps” navigation button. The Steps Tab includes a mechanism to select the number of steps, an editing function that allows you to name the steps, and a preview of the pathway at each step. The Steps Tab allows you to break up your interview into separate steps. An interview can have between 0 and 12 different steps. By selecting the up or down arrows next to the label entitled “Question steps”, you can remove any of the default Steps or add up to a total of 12 steps. After Questions under a particular Step are answered, the end-user moves one Step closer to the court house.
To access the steps screen seen below, click on the steps button.
Default Steps
The following are 4 default Steps in a new interview: (0) Access to Justice, (1) Do You Qualify?, (2) Do You Agree?, and (3) Your Information.
The Sign for Step “0” contains the default language “Access to Justice”. You can use this initial step to welcome the end-user and collect his or her name and gender. The default Sign for Step (1) is entitled “Do You Qualify?” Asking the end-user “qualifying” questions is usually the best choice for an initial step following the collection of name and gender. The default Signs for Steps (2) and (3) are entitled “Do You Agree?” and “Your Information,” respectively. These can be changed to correspond with how you have decided to organize the Questions.
The first stage in creating a question is setting the step to which a question belongs. By selecting the down arrow to the right of the “Step” label, you will reveal a drop-down menu from which any of the previously designed Steps can be selected.
To create a new step, an author can click on the up arrow in the question steps box 
on the steps screen.
Naming a Step
To change the name of the step, click on the template name provided in the step and a text box will appear. This allows an author to customize the steps to suit each individual interview.
To the right of the question list is the question flowchart map. This screen gives a graphical layout of an author's interview.
Each box on the flowchart represents a question. The color of the shaded background of a question correlates with the step to which the question belongs.
To view all the questions of only one step, an author can click on the filter button on the questions screen and scroll down to select which step she would like to view.
Arranging Your Flowchart
Many authors arrange their flowchart in columns according to the steps in their interview. Each column in the flowchart should have 1-2 steps. This allows the author to easily view the interview, check for problems, and correct any errors in the interview.
Questions can easily be arranged simply by clicking on the question and dragging it to the desired location within the flowchart. Note: moving the question in the flowchart does not change the order in which that question will appear in the interview. To modify its logical location you will need to change the desired next or previous question under the buttons tab 
or advanced tab 
scripting in the question dialog box.
There are no training modules for this section at this time.
INSTRUCTIONS: Screencasts demonstrating various features of A2J Author® are posted under various sections of the Online A2J Authoring Guide as downloadable windows media files (.wmv). If you have Windows Media Player, you can simply click on the desired link and 'open' the file automatically. Or, you may right click on the desired file to save or download it for later viewing.
NOTE: If you have not registered a username and password with this site, you will not be able to see any of the videos listed below.
See the links below for tutorials, training modules, and demonstrations.
This is the main development screen and consists of two main parts.
Question Tab
Blue "Start" circle. Indicates the first question in the interview. Can be changed by using the Starting Point dropdown list at the bottom of the screen.
Red "Exit" circles. Indicates the ending of an interview. When an interview is exited the browser closes and the user is redirected to a URL that is configurable.
Yellow "???" circle. Indicates that a button click has no destination assigned to it. A finished interview should not have any yellow ??? circles.
Green "Done!" circle. Indicates the end of a successful interview. When this circle is reached the user's input will be tranmitted to the server.
Purple "?" Diamond. Indicates that there is advanced logic occurring inside that question. The advanced logic can be either conditional branching or setting a variable to a value based upon a condition.
Purple Line coming out a button. Advanced button option used for Repeating Questions.
Black arrow that indicates that this is a repeating question.
You can also zoom in and out of the map as well as print the flowchart from the area on the bottom right of the Flowchart area.
button at the bottom of the question list. You can then edit a question by double clicking either on the question name in the question list or the question box in the question map.
Text in the question can be bolded or italicized by selecting and highlighting the desired text and then pressing the (B) or (I) button above the text entry box.
There are several features that allow the interview developer to deliver help to the use during an interview.
, and then type in the help text that you want to appear.
, followed by entering a url (web address) in the “Website address” field.
, to access this area.Each field has a specific type of data that it collects. A2J Author® has six basic types of fields. These fields have three properties in common:
Different types of properties may have more properties than these three.
The six basic types of fields in A2J Author® are:
Along with the three common properties a number field also has the following properties:
Along with the three common properties a number field also has the following properties:
Along with the three common properties a number field also has the following properties:
The other type is the generic radio button. The only other property besides the common three properties is:
NOTE: For a radio button to operate properly, i.e. only one button can be selected, all of the radio buttons must have the exact same value in the Variable field. If the variables are different you will see behavior like in this example:
When a checkbox is checked the value 'true' is placed into that check box's variable. If it is unchecked the value will be 'false'.
Each button has a label and a question destination. If the destination question is <none> then in the Flowchart of the interview you will see a yellow circle with three question marks in it.
For each button you can also have a variable set to a particular value when that button is pressed.
For now ignore the options drop down. This will be covered in the repeating questions section.
.
The condition properties screen will then be displayed.
Each condition has the following properties
NOTE: Conditions are tested in order. Once the first true condition is found whose action is to move to another question, the rest of the conditions will not be tested.
Operators which can be used to compare two values
| Symbol | Comparison | Example | Result |
|---|---|---|---|
| = | equals | 10 = 10 | true |
| <> | not equal | 10 <> 10 | false |
| > | greater than | 10 > 5 | true |
| < | less than | 10 < 5 | false |
| >= | greater than or equal to | 10 >= 10 | true |
| <= | less than or equal to | 10 <= 10 | true |
| is | synonym for equals | City is "Chicago" | true if the City variable contains Chicago |
You can also do simple mathematical expressions.
| Expression | Result |
|---|---|
| (15 - 15) > 10 | false |
A2J Author® also allows the use of AND and OR logic in your expressions.
| Expression | Result |
|---|---|
| 5 > 1 and 1 = 1 | false |
| 5 > 1 or 1 = 1 | true |
Dates are stored as the number of days since 1/1/1970. Because dates are stored as a number you need to use the Date function to convert back into a date if you are storing the result in a variable or displaying the date to the client.
| Expression | Value |
|---|---|
| Date(#1/1/2000#) | 1/1/2000 as a Date type, which can be stored in a Date variable |
A2J Author® has a number of built in functions which can be used in expressions.
| Name | Parameter | Purpose | sample | Result |
|---|---|---|---|---|
| AGE | any date | Converts date to age in year | AGE([User Birthday]) | 20 if User Birthday is 1/1/1980 and the current date is 1/1/2000 |
| DATE | date or days | Converts days into a mm/dd/yyyy date | DATE(TODAY+90) | the date 90 days from today |
| DOLLAR | number | Formats a number with commas and period | DOLLAR(38581.3) | 38,581.30 |
| HISHER | gender | Returns his or her depending on gender | HISHER(User Gender) | "her" if User Gender is Female |
| HESHE | gender | Returns he or she depending on gender | HESHE(User Gender) | "he" if User Gender is Male |
| ORDINAL | number | Returns ordinal form of number | ORDINAL(5) | 5th |
| SUM | repeating variable | Returns total of all the repeating variables | SUM([Asset Value]) | If you asked for 3 asset values which are stored in a repeating variable, this would return the sum of these 3 values |
| TODAY | none | Returns today's date | TODAY | Today's date as a Date variable |
| HASANSWERED | a variable | Returns true if the variable has a value | HASANSWERED([middle name]) | true if client typed in a middle name, false otherwise. |
The other main difference is how to access these variables. If a variable named [User First Name] is in a repeating question and the user enters 2 [User First Name] values of Bob, Cindy, the following table shows how to access these variables.
| Variable | Value |
|---|---|
| [User First Name] | Bob Cindy |
| [User First Name#1] | Bob |
| [User First Name#2] | Cindy |
Note: To access single values you use the # symbol and then the index number that you want. Also, the repeating variable that you used should be set to the number of times that the user went through the loop.
A2J Author® offers six different types of "fields," or places inside a question where a user may enter information. "Fields" function as placeholders for variables, which store the value the user enters into the fields.
Field types allow an author to control how a user may answer a question.
The six basic types of fields in A2J Author® are:
An author may choose his/her field type by either 
adding a field type under the field tab 
and selecting a type or selecting a template under the browse tab 
Text fields allow a user to type in lines of text in response to a question.
There are two types of text fields: long text fields and short text fields.
A long text field can be used when a question requires a user to type in multiple lines of text, for example:
A short text field can be used when a question requires a user to type only a single line of text, for example:
An author can use a number field when collecting numerical information. There are five different types of number fields from which an author may choose:
The number field and number dollar field also allow an author to limit the value a user may enter into a field. An author may do this by checking the "limit values" box in the fields dialog.
Then, the author can enter a minimum and a maximum value that a user may enter.
This property allows the author to prevent a user from making a mistake when entering number data into a field.Drop down lists allow an author to collect a user's data from a list of choices. A user selects his/her answer from a drop down menu provided by the author.
For example, an author may collect data from a text list:
A number list can be used to allow a user to choose a number from a list of numbers provided:
An author may use a set list of answer choices from an external file, such as:
http://www.a2jauthor.org/drupal/?q=system/files&file=usstates.txt
The following pre-formatted lists are included in the Sample A2J Guided Interviews® and More download.
Or the author may create a customized list of answer choices to be inserted in the interview:
A date field is a type of drop down list an author may use to collect a user's date data from a drop down list of day, month, and year.
Like the number field, an author may limit the date a user enters into a date field by setting a minimum and maximum month, day, and year the user may choose from in the drop down list.
For instance, in the example below the date value is limited to the dates January 1, 1900 through January 1, 2007.
The user will see the question as:
A radio button allows a user to select one answer from a multiple choice question. For example:
Since radio buttons limit the user from selecting more than one answer, each radio button must have the same value in the variable field. For example:
The value for this variable is 1. This value corresponds to the label or name given to the particular field or button. Here, the label is "Once a month."
Notice that the variable "Client how often paid MC" is the same for each radio button in this question; however, the value changes to correspond to the label. Here, the value for "2 times a month" is 2.
Unlike radio buttons, check boxes allow the user to select more than one answer from the choices listed.
Since the user is able to select more than one answer from the choices provided, the value for checkboxes is true/false. Once a user checks a box, the value "true" is placed into that box's variable. If the user does not check a box, the value of the box's variable is "false."
For example, for the answers selected in the question above, the user's values will be:
The user selected "research" and "education" as her answer choices, so the values for the variables "Client organ donation research TF" and "Client organ donation education TF" are "true." The values for the unchecked boxes are "false."
A2J Author® allows an author to set variables based on simple logical conditions so that if the condition is true a corresponding function will take place. Logical conditions can also be used for branching such that certain groups of questions can either be skipped or added to the flow of questions. This tutorial will provide an introduction to creating conditions as well as an introduction to each of the following predefined functions: AGE, DATE, DOLLAR, HASANSWERED, HESHE, HISHER, ORDINAL, SUM, and TODAY.
The screen under the Advanced Tab can be broken down into its functional parts: the Event, the Condition, the Action, and, finally, the Variable and corresponding Value. You must first, however, "add" a condition to get started.
To add a condition, click on the Advanced Tab in the Question Design Window and then click on the add button in the Advanced Screen.
= equals
<> not equal
> greater than
< less than
>= greater than or equal to
<= less than or equal to
is - synonym for equals
You may also use logic using AND and OR.
Note: Conditions are tested in the order they are listed in the conditions box.
Set Variable to Value: This setting allows a variable to be set to a value pursuant to the condition.
Go to Question: If the condition, once evaluated, is true based on the user's response to the preceding question, then the user will be navigated to the appropriate question, chosen by the author.
Set Variable to Value Example:
Go to Question Example:
Listed below are examples of syntax used to set the value of variables under the Advanced Tab:
1. A variable can be set to a sum of variables with numerical values in one of two ways - by using the SUM function for a repeating variable or by adding together the values of any number of variables.
SUM(Variable value NU)
[Variable value 1 NU] + [Variable value 2 NU]
2. A variable can be set to a value representing a concatenation of variables with text values by using percentage signs to wrap the statement, brackets for each variable name within the concatenation, and quotes around any text or spaces you want inserted, as follows:
%%[Client first name TE] + " " + [Client middle name TE] + " " + [Client last name TE]%%
3. To set a variable to particular text, simply use quotes, as follows:
"Not Applicable"
An author can use the AGE function to convert a date that the user enters into an interview into an age. For example, an interview may ask for the user's birth date.
To convert the user's birth date into a numeral representing their age, simply type:
AGE([Variable name for user's birthdate here])
Then complete the condition with an evaluation using less than, greater than, or equal to symbols (<,>,=) as appropriate.
For example:
Why use the DATE function? An author may want to tell the user that they must complete a certain task X days from the date they sign or file a document. It might be preferable in some circumstances to tell the user what that date is, saving them the effort of calculating it him/herself. Obviously, such a date is a moving target, specific to each instance the A2J Guided Interviews® are played on the web. Thus, the author can use the DATE function to represent a date that is a function of "TODAY's" date. See example below. (See also the TODAY function tutorial.)
The user would see "today's" date.
To represent a date X number of days prior to or after the current date, use the following syntax:
%%DATE(TODAY+/-X)%%
(Note: Be sure to use the appropriate evaluation - "+" for a date in the future and "-" for a date in the past. Then replace X with the appropriate numeral.)
In the text of a question:
The user will see:
Set another value equal to the value of another variable fixed by the DOLLAR function:
The new variable can be used in the HotDocs template to represent the correct style:
For example, when collecting the user's name, many interviews provide spaces for the user to enter his or her first, middle, and last name, but the authors do not validate the middle name as a required field. The author can use the HASANSWERED function to place the middle name in a concatenated name variable dependent upon whether the user entered a middle name.
Setting the event as "after user presses button", an author can type "HASANSWERED([Client middle name TE])=true into the conditions box under the Advanced Tab; set the action as "set variable to value" and the value as %%[Client first name TE]+" "+[Client middle name TE]+" "+[Client last name TE]%%. See example below.
If the user does not include her middle name in the name field, an author can ensure that the correct name is populated in the name variable by setting the condition to "HASANSWERED([Client middle name TE])=false" and the value can be set as %%[Client first name TE]+" "+[Client last name TE]%%. See examples below.
An author can also personalize questions by using pronouns to describe third parties identified in the interview (e.g., children, spouse, opposing party, landlord, etc...)
The pronouns he, she, his, and her can be used to replace the corresponding noun. This can be helpful in two ways. Use of pronouns breaks up the otherwise monotonous use of the corresponding noun, and, depending on the length of the noun, saves a bit space in the question text.
The pronoun functions derive their output from a gender variable value. Thus, a gender value must be collected for each person you wish to refer to using a pronoun. This can be simply done at the same time you gather the person's name, as follows:
The user would see the following:
The syntax for inserting a pronoun in the text of a question is essentially identical for the HESHE function and the HISHER function. The function is wrapped in percent signs and the gender variable is wrapped in brackets and parentheses.
Examples:
%%HESHE([Spouse gender])%%
%%HISHER([Landlord gender])%%
The user would see the following:
The correct syntax is: %%ORDINAL([Repeat count variable here])%%.
Note: If your repeat count variable contains no spaces (e.g., "RepeatCountVariable") then no brackets are required; syntax in that case = %%ORDINAL(RepeatCount)%%.
For further explanation regarding repeat dialogs and repeat count variables, play the Repeating Dialogs Module in A2J Author®, available in the following download: Sample A2J Guided Interviews® & More
The user will see the correct ordinal, which increments each time the user goes back through the loop.
A rounded number can be represented in the text of a question, or the rounded number can be set as the value of another variable.
In the event you want to represent the rounded figure in the text of a question, use the following syntax:
ROUND: %%ROUND([Variable here NU])%%
ROUND2: %%ROUND2([Variable here NU])%%
In the event you want to make a variable equal to the value of another variable which is fixed by the ROUND or ROUND2 function, use the following syntax:
ROUND: ROUND([Variable here NU])
ROUND2: ROUND2([Variable here NU])
For example, an interview may ask a user for the value of each of the user's assets, collecting the value as "Asset value NU". If the user inputs values for three different assets, an author may insert SUM([Asset value NU]) into the question text box to return the total value of the assets for the user's review. See below.
The user would see the following:
The value returned by the SUM function can also be used for purposes of an evaluation in an advanced condition. For example, the author may want to branch questioning or set another variable based on the difference between assets and expenses, e.g., if "SUM([Asset value NU])-SUM([Living expenses NU])>500", then goto question X or set variable Qualified TF to true (or false). See example scripting below.
Evaluation using SUM function:
Evaluation used to conduct branching:
For example, an author may ask a user what date the judgment was entered in their divorce. Then, assume that for purposes of the interview it is necessary to evalute whether that date was more than 90 days ago.
That evaluation can be accomplished with the following syntax:
TODAY-[Divorce date DA]>90
Notice how that evaluation can be used in an advanced condition:
The user will see the following. (Note the evaluation that takes place in the Variables and Script Pop-up windows.)
A truncated number can be represented in the text of a question, or the truncated number can be set as the value of another variable.
In the event you want to represent the truncated figure in the text of a question, use the following syntax:
TRUNC: %%TRUNC([Variable here NU])%%
TRUNC2: %%TRUNC2([Variable here NU])%%
In the event you want to make a variable equal to the value of another variable which is fixed by the TRUNC or TRUNC2 function, use the following syntax:
TRUNC: TRUNC([Variable here NU])
TRUNC2: TRUNC2([Variable here NU])
INSTRUCTIONS FOR A2J Author® Training Module for Drop Down Lists: An A2J Author® Training Module is a tutorial designed within A2J Guided Interviews®. To learn how to use Drop Down Lists, you may download the A2J Author® Training Module for Drop Down Lists below. To download, right-click on the link below and save to a folder on your hard drive. (You will note that the file defaults to a ".xml" format. Both .xml and .a2j formats can be opened within A2J Author®.) Open the file within A2J Author® and run through the training module in Preview mode. Make sure to read the Learn More sections as you go. Be sure to toggle between Preview mode and the edit mode (by periodically selecting Resume Edit from the Preview mode). This will allow you to see how the interview was created.
INSTRUCTIONS FOR A2J Author® Training Module for Drop Down Lists: An A2J Author® Training Module is a tutorial designed within A2J Guided Interviews®. To learn how the features of various Field Types, you may download the A2J Author® Training Module for Field Types below. To download, right-click on the link below and save to a folder on your hard drive. (You will note that the file defaults to a ".xml" format. Both .xml and .a2j formats can be opened within A2J Author®.) Open the file within A2J Author® and run through the training module in Preview mode. Make sure to read the Learn More sections as you go. Be sure to toggle between Preview mode and the edit mode (by periodically selecting Resume Edit from the Preview mode). This will allow you to see how the interview was created.
INSTRUCTIONS FOR A2J Author® Training Module for Hasanswered: An A2J Author® Training Module is a tutorial designed within A2J Guided Interviews®. To learn how to use the Hasanswered function, you may download the A2J Author® Training Module for Hasanswered below. To download, right-click on the link below and save to a folder on your hard drive. (You will note that the file defaults to a ".xml" format. Both .xml and .a2j formats can be opened within A2J Author®.) Open the file within A2J Author® and run through the training module in Preview mode. Make sure to read the Learn More sections as you go. Be sure to toggle between Preview mode and the edit mode (by periodically selecting Resume Edit from the Preview mode). This will allow you to see how the interview was created.
There are two methods for creating repeating dialogs (or loops) within A2J Guided Interviews®. One method predetermines the number of times the end user will be looped through the question or series of questions, and the other method allows the end user to choose when to leave the repeat dialog (by selecting "add another" or "continue"). For specific instructions on how to create repeating dialogs or loops please download the training module below. (Note: If you have not registered with a username and password, you may not be able to see the download listed below.)
INSTRUCTIONS FOR A2J Author® Training Module for Repeating Dialogs: An A2J Author® Training Module is a tutorial designed within A2J Guided Interviews®. To learn how to create a repeat dialog or loop, you may download the A2J Author® Training Module for Repeating Dialogs below. To download, right-click on the link below and save to a folder on your hard drive. (You will note that the file defaults to a ".xml" format. Both .xml and .a2j formats can be opened within A2J Author®.) Open the file within A2J Author® and run through the training module in Preview mode. Make sure to read the Learn More sections as you go. Be sure to toggle between Preview mode and the edit mode (by periodically selecting Resume Edit from the Preview mode). This will allow you to see how the interview was created.
INSTRUCTIONS: Screencasts demonstrating various features of A2J Author® are posted under various sections of the Online A2J Authoring Guide as downloadable windows media files (.wmv). If you have Windows Media Player, you can simply click on the desired link and 'open' the file automatically. Or, you may right click on the desired file to save or download it for later viewing.
NOTE: If you have not registered a username and password with this site, you will not be able to see any of the attachments listed below.
Please see the links below for tutorials, training modules, and video demonstrations.
Pictured below is an example of a Script report's format. To view an entire script, you may download the attachment listed at the bottom of this page.
There are no training modules for this section at this time.
There are no video demonstrations for this section.
See the links below for tutorials, training modules, and demonstrations.
This route allows you to Preview the interview, beginning with the Question which you are currently editing.
Note: A2J Author® remembers where you began your last preview session, so that if you later select the “Preview” navigation button from the main menu, you will begin a preview at the starting point of the last preview session, instead of at the beginning of the interview.
This screen allows you to inspect all of your interview's variables and their current values. You can also change the value of the variable by click on a variable's value.
This screen gives you access to a script interpreter. You will see the name of the question, the button you pressed, and the value of the variables as you progress through the interview. You can also inspect variables and run expressions on this screen. Just type in the expression and press the evaluate button. NOTE: pressing enter will not evaluate your expression but will press a button within the interview, you need to click on the evaluate button with the mouse.
This tutorial will demonstrate how to test whether A2J Guided Interviews® will properly populate a HotDocs template. Please note that it is not necessary to upload your A2J Guided Interviews® to the NPADO server in order to test the interview -- the testing process can be completed on your local PC or computer.
In order to test A2J Guided Interviews®, you must assemble the HotDocs template with an A2J Author®-created answer file. An A2J Author®-created answer file is created by answering interview questions and then saving the answer variables while in A2J Author® preview mode.
When you are finished with the testing process you will have validated the following: 1) that your A2J Guided Interviews® are collecting all of the necessary HotDocs template variables; and, 2) that the variables collected by your A2J Guided Interviews® will properly populate the HotDocs template.
First, you must open the A2J Guided Interviews® that you want to test.
Step Two: In order to test A2J Guided Interviews® with a template, you must create a test "Answer File".
An "Answer File" can be created by Previewing your A2J Guided Interviews® and answering the interview questions.
Step Four: In order to test assemble a document you must now open your saved document template in HotDocs.
Step Five: After clicking the Assemble button, you will need to browse for your answer file.
You will then select "Add" in order to add your saved answer file to your library.
Step Six: In order to add an answer file to your HotDocs library, you will need to click the browser button and search for the answer file.
Step Seven: Assemble the HotDocs template and A2J Author®-created answer file by choosing the answer file that you have just added to your library. If you would like to quickly assemble the document without viewing the HotDocs interview process, be sure to check Remember Selected Answer File and Bypass Assembly Window before clicking "OK".
There are no training modules for this section at this time.
INSTRUCTIONS: Screencasts demonstrating various features of A2J Author® are posted under various sections of the Online A2J Authoring Guide as downloadable windows media files (.wmv). If you have Windows Media Player, you can simply click on the desired link and 'open' the file automatically. Or, you may right click on the desired file to save or download it for later viewing.
NOTE: If you have not registered a username and password with this site, you will not be able to see any of the videos listed below.
, which allows you to choose an mp3 for that particular question.
Note: You must log in using your username and password in order to see the downloadable attachment listed below.
How to create audio (MP3) files for use within A2J Author (doc)
| Avatar | Guide facing the user | Guide speaking to male | Guide speaking to female |
|---|---|---|---|
blank |
 |
 |
 |
tan |
 |
 |
 |
A2J Author® was specifically designed for use by legal aid personnel, court clerks, etc. that do not have technical backgrounds. It is not necessary to be a computer programmer or have an IT background in order to program or write A2J Guided Interviews®. The scripting of the questions takes no more expertise than using a word processing program; and, the level of difficulty for writing various types of logical conditions is comparable to using a basic spreadsheet program.
Developer calls are held on a quarterly basis to address commonly asked questions and provide explanations of program features. In addition, we encourage all members of the growing A2J Author® developer community to place their questions in the discussion forums on this website so that knowledge and support can be shared.
A2J Guided Interviews® created in the A2J Author® tool are more efficient for filling out forms. They can provide guidance to the user where human guidance is not available.
A2J Guided Interviews® are more likely to be correctly filled out the first time so that the client is not going back and forth to gather information missed the first time. This also saves time for the court, judges, clerks, etc.
A2J Guided Interviews® can provide MORE INFORMATION than the form itself. It can ask questions to make sure that the client is filling out the right form thereby avoiding wasting their time on the wrong form and causing them frustration. This increases the client's overall satisfaction and lowers their level of upset while dealing with the bureaucracy of the courts.
A2J Guided Interviews® can provide supplemental information that educates the client regarding their issues. Just-in-time learning features can be used to point the user to other web resources that may be hard for the client to find on their own or outside the context of filling out the form.
A2J Author® is a tool that runs on Windows operating systems that is used to produce A2J Guided Interviews® that will run in any browser. Out of the box, A2J Author® allows authors (courts and legal services) to upload and host A2J Guided Interviews® on the National Public Automated Documents Online (NPADO) server. The NPADO server not only hosts the A2J Guided Interviews® so that they can be served to the public, but it also provides document assembly services via HotDocs by LexisNexis.
In very simple summary, A2J Author® is used to create customized A2J Guided Interviews®. The A2J Guided Interviews® collect the information from the interviewee over the web. The interviewee's information is assembled (merged) with a customized template using the HotDocs services on NPADO. The assembled template (court form, pleading, letter, etc.) is then presented to the interviewee over the web. The interviewee can then print the document which is ready for filing, etc.
Detailed information about the NPADO server including who operates it can be found by visiting the FAQ at www.npado.org.
Out of the box, A2J is compatible with HotDocs for document assembly purposes. However, it is possible to develop XSL transforms that will translate the data exported in A2J Guided Interviews® answer file (.anx) into an alternative XML format. One such XSLT has been written thus far for LSXML, which is used by Pika case management systems. For further information on this subject, please direct your system administrator to the following article: Local Server Setup & XML Transforms.
We provide a complementary online introductory and advanced training session to new users of A2J Author®. For further information send an inquiry to: a2j-author@kentlaw.edu
It is not necessary to use HotDocs with A2J Author®. That said, if you want to use A2J Author® for document assembly, you need to use A2J Author® in conjunction with either HotDocs or another document assembly program. Using A2J Author® with any other program, whether it is for the purpose of document assembly, case management system data collection, or e-filing, requires that the answer file generated by A2J Guided Interviews® be translated using an XSL transform. For more information, please direct your system administrator to the following article: Local Server Setup & XML Transforms.
A2J does not set or read any session cookies. That is the job of the
browser.
A2J Author® is primarily supported by grant-funded projects. A project is currently underway that will maintain the A2J Author® project through April 2008. Further projects that would support A2J Author® maintenance and development through April 2009 are currently pending authorization.
No specific database is required.
No.
A2J Guided Interviews® Development Tips - courtesy of Camille Cameron, Idaho Legal Aid Services, Inc.
1. Don't over plan, just get a general big picture idea in mind, start with laying out the Steps and get started.
2. Always keep your audience in mind when you are writing the interview questions. Consider all of the terms you are using to ask a question and either simplify them, or if you can offer a resource (Learn More), try to do so.
For example:
-Define technical words like plaintiff/defendant
-Give examples (but make it clear they are examples, not legal advice)
-Offer links to look up zip codes, counties, phone numbers, etc.
3. Whatever amount of time you spend developing your interview, plan on about twice that for collecting feedback/comments, testing and making revisions.
4. Before uploading, do not forget to clean up your variables and make sure all of the 'types' are set correctly -- especially for variables created "on-the-fly"
For example: 'check all that apply' type multiple choice questions should be True/False variables in HotDocs
No, the Spanish feature allows the user to change the static button labels displayed in the final, uploaded interview and save accented Spanish characters in the steps and questions of the interview. There is no automatic translation for this tool. Because of the subject matter of many interviews, automatic translation would be very difficult.
To err is human!
Many cases of "malfunctioning" conditions are due to inadvertent mistakes with syntax. Listed below are a few questions you should consider whenever you find a condition is not returning the result you expect.
1. Did I have the Interview Variables and Interview Script Windows open while I was previewing/testing my interview?
2. Did I check all references to variables for spelling errors?
3. If writing conditions within a repeat dialog ask, did I append all variables with the appropriate repeat variable (e.g., "#RepeatCount")?
4. Am I using the right syntax?
5. Did I write my AND and OR statements in the right order?
SYNTAX REMINDERS:
References to variables which include spaces must be enclosed within brackets, as follows: [Variable name TE]
References to variables within a function must be enclosed within parentheses (and brackets if the variable includes spaces), as follows: AGE([Variable name TE])
A few notes about quotations:
Quotes need to be placed around variable values previously set, where the value was set as
1) a default variable value;
2) a multiple choice variable value; or,
3) a "quasi" true/false variable used in the context of a button choice.
For instance, assume you set the following values for variables in a multiple choice selection:
For State MC, you provide several states as multiple choice options in a drop down list. If you want to write a condition based on a particular multiple choice selection, the condition would use the following syntax: IF State = "California" THEN.....
Also, consider the values set by a variable used in a button choice selection. A2J Author® allows an author to provide up to three buttons. So, naturally, the "Button" is not a true true/false mechanism, though you can set a variable behind a button choice to have a value of true or false. Assume you set the following values for a "quasi"-true/false variable used in the context of button clicks:
For the button labeled Married, you set Married TF to equal true.
For the button labeled Not Married, you set Married TF to equal false.
If you want to write a condition based on the button selection, the condition would use the following syntax:
IF [Married TF] = "true" THEN.....
However, if a true/false variable is set to true or false based on a checkbox selection then no quotes are needed when referencing the variable value in a condition.
So, for instance, if you provided a checkbox selection, instead of a button click, to set the variable Married TF, then quotes do not need to placed around the variable value true and false in a condition statement. The correct syntax is as follows:
IF [Married TF] = true THEN.....
Finally, remember the correct order and syntax for your AND's and OR's!
1. AND's should be placed ahead of the OR's
2. OR's statements should be wrapped within parentheses
Example: CONDITION: AGE([Child birth DA#ChildCount])<18 and ([Variable MC#ChildCount] = "Value1" or [Variable MC#ChildCount] = "Value2" or [Variable MC#ChildCount] = "Value3")
Note all variables with spaces are wrapped in brackets; the counting variable has been appended to each variable; the variable within the function is wrapped within parentheses; and, the entire set of OR statements is wrapped within parentheses.
If you have other helpful hints for troubleshooting please send them via A2J Author's Send Feedback button or post to this website. Thank you.
When a state is chosen through a Text drop down in A2J Author® shows up as "Il" instead of "IL" or does not show up at all check that the variable types match up between A2J and HotDocs. Specifically, look to see if the HotDocs variable is a multiple choice variable.
In a macro setting use the following:
%%[Variable name TE#CountingVariable]%%
In the event you are testing a condition, use the following:
[Variable name TE#CountingVariable]="valuehere"
If you have a True/False variable that appears to be set to true but when used in a condition is set to false. This can occur if your variable was set to true from a button press. When a button is pressed A2J does not determine what type of variable is being set and therefore defaults to using text. So your variable is getting set to true but it is the string "true" and not the boolean value. To work around this in your condition change [my var] = true to [my var] = "true"
Make sure the computer you are using is running Flash 8. If you are using Internet Explorer and Mozilla, make sure you have updated Flash for both programs.
This will occur if any of the number values are set to a blank value. When this is the case A2J Author® treats the variable as a string and starts to append the numbers instead of doing your calculation. To ensure that the values are numbers you can either require a value from the user and default the value to some acceptable number or after a button is pressed verify that each item has a number value and if not set it to a default value.
This occurs if A2J is trying to calculate a number that has not been set to a value by the user. To fix this issue, before the user sets any of the used variables set the variable to some acceptable default value.