A2J Author ® Macros, Functions & Exiting

Self-Help Web Center

A2J AuthorMacros, Functions & Exiting

Dina C. NikitaidesProgram CoordinatorCenter for Access to Justice & Technology, Chicago-Kent College of Law

1A2J Author

Variable Macros2Variable MacrosAgenda

What is a Variable Macro?Where to use Variable MacrosInterview Customization with Variable Macros

What is a Variable Macro?DefinitionA variable macro calls the value of the variable

FormatThe macro format is: %%[Variable name TE]%%

Where to use Variable MacrosA variable macro can be used to display the value of a variable to the end-user in: Text of a questionText of a Learn More answer

Where to use Variable MacrosA variable macro can be used to display the value of a variable to the end-user in: Radio button & Checkbox labelsOther field labels (i.e. in front of drop down menu)

Where to use Variable MacrosA variable macro can be used to display the value of a variable to the end-user in: Step signposts

Wherenotto use Variable MacrosA variable macro cannot be used to display the value of a variable in:Learn More questionUnknown number of variables collected in a loop (i.e. names of children collected in a loop)

^Interview Customization with Variable MacrosYou can do more than simply use a variable macro to insert the end-users name in to the interview!In a loop for personal information in a loop, collect the name first and follow up with Enter Janes address if the end-user is entering multiple people it will help them remember who they are onDisplay information collected in a loop to the end-user in the Learn More, i.e. list of assets so they know what was enteredInstead of using child/children, asset(s), is/are, etc. in the interview, determine which word should be used, store that in a variable and call it out in text with a macroUse macros in multiple choice question for the end-user to make a selection from, for example end-user enters two people as agents, then ask them to pick which one is the primary agent in a MC question.Helpful ResourcesFind more information on Variable Macros

The A2J Authoring Guide: Chapter 5: Variables Tab Pg. 46 Question Text Macro Pg. 47 Macro to Set Variables ValuePg. 47-48 Macro to Set a Label Variable Macro Training Module A2J Guided Interview demonstrating the different ways to use macros Included in the A2J Author Starter Kit or download from a2jauthor.org Download the A2J Authoring Guide & Starter Kitfrom www.a2jauthor.org.A2J Author

Functions11FunctionsAgenda

AgeDateTodayHasAnsweredOrdinalWhat are Functions?DefinitionBuilt in actions performed to alter data collected.

FormatThe function format is: FUNCTION([Variable name TE])Where to use FunctionsUse functions in two places: Question Text Conditional Statements

Function: AGEAGE: Converts a date to age in years.

Example: A form might require the date of birth and the statute might limit use of the form to people over the age of 18 years. Collect only the date of birth and convert it into years using the AGE function instead of asking the user to enter both.

Syntax: AGE([Client birth date DA])

Function: DATEDATE: Converts days into mm/dd/yy date.

Example: Determine a deadline for an answer 30 days from notice date.

Syntax: DATE([Notice date DA]+30)

Function: TODAYTODAY: Returns todays date.

Example: Determine if a user is within a 90 day statute of limitations.

Syntax: (TODAY - 90)Function: ORDINALORDINAL: Returns the ordinal form of number.

Example: In an interview with a repeat loop where the user enters 3 as the number of assets they have first, use ORDINAL function to ask the follow up questions about the first, second and third assets.

Syntax: ORDINAL(AssetCount)

Function: HASANSWEREDHASANSWERED: Returns a true/false value if a variable has a value.

Example: Before condensing three-part name (first, middle & last) into one full name, test to determine whether a user has entered a middle name.

Syntax: HASANSWERED([Client middle name TE])

Syntax RemindersThe function names DOLLAR, ORDINAL, SUM, etc. are applied to the variable with (parentheses)Example: DOLLAR([Client total asset value NU])

Variable names with spaces must be wrapped in [brackets]Example: [Client total asset value NU]

To show the value of a variable or function applied to the variable in question text, wrap the phrase in %%double percentage signs%%Example: %%DOLLAR([Client total asset value NU])%%A2J Author New User Training

Exiting21Buttons with Functions & ExitingAgenda

Success Process FormExit-User does not qualifyExit to SaveExit-Save Incomplete FormExit-Resume Interview

Button: Success Process FormThe [Success - Process Form] button function takes a users to LHI to get the completed document.Use this button function only once in an interview.

Button: Exit-User Does Not QualifyThe [Exit - User does not qualify] button function closes the A2J Guided Interview.

Button: Exit-User Does Not QualifyThe [Exit - User does not qualify] function can take users to a website upon exiting the interview.

Exit To SaveGive users the option to exit an incomplete interview at any time and save their answers on LHI.

Exit To SaveCreate one question that is not linked to any other questions in the interview.

Exit To SaveIdentify the single question as the Exit question below the question list. That question will then appear when the Exit button is selected by users.

Button: Exit Save Incomplete FormThe [Exit Save Incomplete Form] button function takes users to LHI to save answers.

Button: Exit Resume InterviewThe [Exit Resume Interview] button function takes users back to the question they were on when they clicked Exit from the top grey menu bar.

Button: Exit Resume Interview[Exit Resume Interview] and [Back to prior question] sound like they do the same thing, but they are NOT interchangeable.Once a user clicks Exit from the top grey menu bar, the exit process is triggered removing the user from the main interview and [Back to prior question] will not work.Additional ResourcesA2J Authoring Guide Chapter 7 Creating Questions Pgs. 105-108 Setting a Questions Destination (with buttons)Online A2J Authoring Guide on www.a2jauthor.org Interview Questions Tutorials Creating Questions Buttons Trainings & Presentations on www.a2jauthor.org Recorded trainings & presentations of various topicsQuestions? Feedback?

Dina C. NikitaidesProgram CoordinatorCenter for Access to Justice & Technology, Chicago-Kent College of Lawdnikitaides@kentlaw.edu312-906-5331

33