15
Relius Documents ASP Checklist Entry Overview Checklist Entry is the main data entry interface for the Relius Documents ASP system. The data that is collected within this program is used primarily to build documents, but it can also be used to feed external systems for purposes other than document generation. This guide will provide details regarding the general functionality of the Checklist Entry program and the ways in which users can navigate through a standard data entry session.

ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

Relius Documents ASP Checklist Entry

Overview Checklist Entry is the main data entry interface for the Relius Documents ASP system. The data that is collected within this program is used primarily to build documents, but it can also be used to feed external systems for purposes other than document generation. This guide will provide details regarding the general functionality of the Checklist Entry program and the ways in which users can navigate through a standard data entry session.

Page 2: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

2

1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed within what will hereto be referred to as the Question Pane.

Figure 1

There are three different types of questions that can be displayed within the Question Pane:

o Single-select: Available responses will be represented by a radio button

o Multi-select: Available responses will be represented by a checkbox

o Insert only: Available responses will be represented by text box.

There are four different ways in which questions can be answered:

o Mouse-click: Position the cursor within the radio button or checkbox corresponding to the answer you wish to select and click to make the selection. In the case of a text box, click within the text box and type in the desired text. Click on the response again to deselect the answer. Any sub-selections that are tied to the deselected response will also be removed.

o Tab and spacebar: Use the tab key to place focus on the desired response and press the spacebar to select the corresponding radio button or checkbox. You may also use the tab key to place focus within a text box. To deselect an answer, place focus on the response and press the spacebar. Any sub-selections that are tied to the deselected response will also be removed. When using this selection method to answer single-select question types, the system will automatically bring you to the next enabled question in the checklist. For any other question type, press the Enter key to proceed to the next enabled question in the checklist.

o Letter and number keys: You can select radio buttons and checkboxes for the current question in focus by pressing the letter or number key corresponding to the desired response. For example, when viewing question 1.2 with available responses “y” and “z”, you can select the “z” response by

Page 3: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

3

pressing the Z key on your keyboard. When using this selection method to answer single-select question types, the system will automatically bring you to the next enabled question in the checklist. For any other question type, press the Enter key to proceed to the next enabled question in the checklist.

2. View Commentary & View Exclusion Logic Checklist Entry is equipped with a feature that allows you to view any pre-defined commentary or exclusion logic that may be associated with a particular question. Commentary can be defined as additional information that may help you answer the current question being viewed. Exclusion logic can be defined as the combination of checklist answers (or non-answers) that will disable responses for the current question being viewed. When either of these options are available, a button will be provided in the bottom right corner of the group box for the current question being viewed.

Figure 2

Buttons and Functions:

View Commentary Use this button to see the commentary that has been associated with the current question. Commentary is displayed within the Question Commentary dialog box.

Question Commentary dialog box This dialog box contains commentary that has been associated with the current question. You can review or print the commentary from this box.

Figure 3

View Exclusion Logic (if a response is disabled) Use this button to see what checklist selections are causing one or more responses to be disabled within the current question. The logic is displayed within the Exclusion Logic dialog box.

View Exclusion Logic (if a response can be disabled) Use this button to see what checklist selections will cause one or more responses to be disabled within the current question. The logic is displayed within the Exclusion Logic dialog box.

Page 4: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

4

Exclusion Logic dialog box The Exclusion Logic dialog box is displayed when the “View exclusion Logic” button is clicked. This box displays the specific checklist selections are causing, or will cause, one or more responses to be disabled within the current question. Note that each response is displayed as a hyperlink within the dialog box. You can click the hyperlink to bring focus to the selected question within the Question Pane.

Figure 4

3. Tree View The tree view allows you to see every section of the current checklist and the questions contained therein. It also displays indicators as to which sections and questions in the checklist have been completed and provides you with the ability to navigate directly to specific questions.

Figure 5

Show/Hide Tree View The tree view will be displayed by default each time a checklist is opened. The tree view may be hidden

and re-displayed by clicking the “Show/Hide Tree View” toolbar icon.

Page 5: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

5

Expanding/Contracting Individual Sections A Section can be expanded or contracted by clicking the arrow next to the section you wish to expand or contract. A down arrow ( ) will indicate that the Section is fully expanded. A right arrow ( ) will indicate that the Section is contracted.

Expand All/Contract All Hyperlink The “Expand All” hyperlink at the top of the tree view can be used to expand the Tree View to display all Section Titles and underlying questions. The hyperlink will change to “Contract All” once the Expand All hyperlink has been selected. Clicking the “Contract All” hyperlink will contract all Sections within the tree view.

Incomplete Icon An incomplete icon will be displayed next to each unanswered question as well as each section that contains at least one unanswered question. An unanswered question is any question that meets the following criteria:

o An enabled single-select question that has not been answered.

o An enabled multi-select question that has not been visited or visited and not answered.

o An enabled insert only field that has been flagged as requiring an answer.

Complete Icon A complete icon will be displayed next to each answered question as well as each section that contains no unanswered questions.

5. Toolbar The toolbar provides buttons that serve various purposes within the checklist entry process.

Figure 6

Buttons and Functions:

Go to Previous Section Use this button to go to the first question in the section that precedes the current section of the checklist you are viewing.

Go to Next Section Use this button to go to the first question in the section that follows the current section of the checklist you are viewing.

Go to Previous Question Use this button to go to the question that precedes the current question of the checklist you are viewing.

Page 6: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

6

Go to Next Question Use this button to go to the question that follows the current question of the checklist you are viewing.

Save Checklist Use this button to save the answers of the current checklist and continue working.

Submit Checklist Answers

Use this button to save the answers of the current checklist and submit them for document generation. As part of the submission process, the system will perform a review of your checklist answers to ensure completeness and accuracy. The results of the review are displayed in the Checklist Review dialog box (see the Checklist Review section of this document for further details).

Print Options

Use this button to display your options for printing the current checklist and other associated reports within the Print Options dialog box (see the Print Options section of this document for further details).

Show/Hide Tree View Use this button to show and hide the Tree View.

Search Checklist Use this button to display your options for searching various elements of the checklist within the Search Options dialog box (see the Search Options section of this document for further details).

Review Checklist Use this button to perform a review of your checklist for completion and accuracy. The checklist review feature will identify any unanswered required questions, possible advisory items and data formatting errors that may exist within your checklist. The results of the checklist review are displayed in the Checklist Review dialog box (see the Checklist Review section of this document for further details).

Close Checklist Use this button to close the current checklist. If you have not saved the work you have performed in the current session, the system will provide you with the option to do so prior to exiting from the checklist.

Help Use this button to view the Checklist Entry Quick Start Guide.

Page 7: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

7

6. Section Tabs Section tabs allow quick access to every section of the current checklist. It also displays indicators as to which sections in the current checklist have been completed and provides you with the ability to navigate directly to the specific sections.

Indicators

A section tab will display in Bold to indicate the current checklist section you are viewing.

A section tab will display in Green if the entire checklist section has been completed.

A section tab will display in Red if the checklist section is not completed.

Figure 7

7. Search Options

The Search Options window can be accessed by clicking the Search Checklist button on the toolbar. This will allow you to search the current checklist for key word(s) or phrases. Your results can be refined by filtering your search using the tools below. Once your preferences have been selected, the "Find Next" button can be used to search through the checklist for your entered text.

Figure 8

Find What Field Use this field to type the key word(s) or phrase (up to 3000 characters, including special characters and spaces) you are intending to search. A drop-down option allows you to select any of the text entered and searched for during the current checklist entry session. The text is displayed in the order in which the search was performed, starting with the most recent search item.

Page 8: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

8

Replace With (Insert Values Only) (NOTE: This option is currently unavailable, but will be enabled as part of a future update) Search Elements Each option below allows you to refine your search results to a specific part of the checklist. Note that each time the Search Options box is opened, the Search field is defaulted to "All".

All This selection will allow you to perform a query on all elements of the current checklist (section text, question number, question text, response text, insert values). Section Text This selection will limit your query results to the current checklist's section text, which includes the titles of each section. Question Number This selection will limit your query results to the current checklist's question numbers. You will need to use numerical format in the search field. Question Text This selection will limit your query results to the current checklist's question text. Response Text This selection will limit your query results to the current checklist's response text. Insert Values This selection will limit your query results to the current checklist's insert values under a response selection.

Search Type You can indicate whether the results contain or start with your search text using the "Type" options. This field will be defaulted to "Contained" when the Search Options box is initially opened.

Contained The search will find all instances of the entered search text for the defined search criteria.

Starts With The search will find only those instances where the entered search text is at the beginning of the found results. For example, if you typed “Contributions” in the Find What field, the search will only find those instances where the word “contributions” is not preceded by another character or space.

Page 9: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

9

Search Filter The Search Options box allows you to filter your results by "Whole Word Only" or "Match Case".

Whole Word Only Make this selection if you would like to limit your results to instances in which the entire key word(s) or phrase is found.

Match Case Make this selection if you would like to limit your results to instances in which each character of the search text has the same casing as that of the found text.

9. Checklist Review

The Checklist Review feature can be accessed by selecting the Review Checklist button on the toolbar or automatically via the Submit action. This feature will identify any unanswered required questions, possible advisory items and data formatting errors that may exist within your checklist.

Figure 9

Unanswered Questions This feature will report any unanswered questions in the current checklist. You can choose to review and/or print the report from this screen. Note that each checklist response is displayed as a hyperlink. Click the hyperlink to display the selected question in the Question Pane. An unanswered question is any question that meets the following criteria:

o An enabled single-select question that has not been answered.

o An enabled multi-select question that has not been visited or visited and not answered.

o An enabled insert only field that has been flagged as requiring an answer.

Figure 10

Page 10: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

10

Advisory Items This feature will report any advisory warnings (formerly known as Validation Warnings) that are applicable to the current checklist. Advisory warnings can best be described as pre-defined possible user errors or items worthy of review in your checklist. From the Checklist Advisories dialog box, you can choose to review and/or print the Advisory report output. Note that each checklist response is displayed as a hyperlink. Click the hyperlink to display the selected question in the Question Pane. Click the Refresh button to update the list at any time.

Figure 11

Data Format Errors Certain checklist fields have been programmed with validation logic to ensure proper data formatting. In all cases, these fields will be validated at the time you answer (and navigate away from) the associated question. If a data format error is found, you will be presented with an error message at that time. However, in some cases data may be applied to the checklist externally, such as via the Data Import process. The data format error feature of the Checklist Review function is intended to catch any invalid formats that may have been entered into certain designated fields in such a manner. Some examples of data format errors may include the improper formatting of an imported date value or characters imported into fields only intended for numeric values.

Figure 12

Page 11: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

11

7. Print Options

The Print Options dialog box is accessed by selecting the Print Options button on the toolbar. It allows you to print the current checklist and/or checklist reports.

Figure 13

Print What Function Print Options can be run by selecting a single option or choosing multiple options to print simultaneously. Multiple options can be selected by either the "Select All" option on the top right of the "Print What:" list box or simply clicking on each option. Note that the "Select All" option will toggle to "Deselect All" when all options in the list have been selected. A single option can be removed from your print selections by clicking on the option again.

Checklist Use this selection to view and print the current checklist. NOTE: Choosing this option with the Advisory, Exclusion Logic, and/or Data Format Error Report options will append the reports to the end of the checklist print out output instead of generating a separate report for each.

Checklist Formatting Options: NOTE: Formatting options are only available for printing a Checklist. Reports will not have these options available.

Page 12: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

12

Detailed, All Questions Use this selection to include all section names, question numbers and text, responses and insert data.

Figure 14

Detailed, Answered Questions Use this selection to include all section names, question numbers and text, responses and insert data for answered questions only.

Figure 15

Page 13: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

13

Detailed, Unanswered Questions Use this selection to include all section names, question numbers and text, responses and insert data for unanswered questions only. An unanswered question is any question that meets the following criteria:

o An enabled single-select question that has not been answered.

o An enabled multi-select question that has not been visited or visited and not answered.

o An enabled insert only field that has been flagged as requiring an answer.

Figure 16

Response Only Use this selection to include all section names with question and response numbers for answered questions only.

Figure 17

Page 14: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

14

Advisory Report Use this selection to print a report containing all found advisory warnings (formerly known as Validation warnings) for the current checklist.

Figure 18

Exclusion Logic Report Use this selection to print a report containing all questions for which at least one response has been excluded.

Figure 19

Page 15: ASP Checklist Entry QSG · 2010-06-23 · 2 1. Question and Answer Data is entered within the Checklist Entry program via a question and answer format. All questions are displayed

15

Data Format Error Report Use this selection to print a data format error report containing all questions for which at least one data format error has been found. See the Data Format Errors section at the end of this document for further information.

Figure 20

© 2008 SunGard Trademark Information: SunGard and the SunGard logo are trademarks or registered trademarks of SunGard Data Systems Inc. or its subsidiaries in the U.S. and other countries. All other trade names are trademarks or registered trademarks of their respective holders.