Skip to main content

Form and Table Documentation

  1. Last updated
  2. Save as PDF

Generate a report for a form. The report includes information on: dictionary values, help messages, data elements, and data element cross references.

RADplus Utilities > Modeling

  • A version of this form is available for each myAvatar parent application (PM, CWS, MSO, and CFMS).
  • Although the Form Documentation section is a great compliment to myAvatar CDMs, it is not a replacement. Forms with grid data entry systems such as Appointment Scheduling and most billing options will not be documented via Form Documentation.
  • Only forms that are currently on a menu will display in Form and Table Documentation. For example, if a modeled form is not on the menu, it will be unavailable in both the Form and Table sections.
Forms
  1. In the Type of Documentation field, select Form.
  2. In the Individual or All Forms field:
    • Select All Forms to generate the report for all forms in the system.
    • This will be a large report that may take several minutes to process.
      • Select Individual Form to generate the report for a specific form.
  3. In the Form To Be Documented field, select the form. Forms bundles must be documented individually.
  4. In the Include Dictionary Values field, select Yes to include locked and unlocked dictionary values.
  5. In the Include User-Defined Help Messages field, select Yes to include the "light bulb" help messages associated with data elements (if any).
  6. In the Include Other Form(s) Data Element Cross Reference List field, select Yes to include data element cross references. This allows you to see where else in the system the data elements are collected and stored.
    • Data elements can be cross referenced to other forms containing that data element.
  7. Click Process to view the report.
Form Documentation Report Information

The report header displays the form's menu path, Option ID, and section name.

The report data displays the form fields in the order of data entry, and generates a new page for each section of the form.

  • Label - Data element name.  If appropriate, the associated SQL table displays.
  • Data Element Number - The field number of the data element.
  • Initially Required - Indicates if the field is required to submit the form.
  • Related Date - Indicates if the field has a related date file.
  • Data Element Type - The type of data element.
  • Text Box Format - The type of text box (for text box fields).
  • Text Box Width - The maximum number of characters supported by this field (for text box fields).
  • Updatable Dictionary - Indicates if the field can be updated in the Dictionary Update form)
  • Dictionary File - The file in the Dictionary Update form where this dictionary is stored.
  • Dictionary Data Element - The data element number and name.
  • Table Listing Section - Displays at the end of the report. Lists associated SQL tables and their columns (if appropriate).
Tables
  1. In the Type of Documentation field, select Table.
  2. Select the forms to use as filters in the Filter by Associated Form(s) field. These forms are listed alphabetically according to the menu. If no forms are selected, all tables in the system will be available.
  3. Select the tables to include in the report from the Table(s) to be Documented field. This field displays all tables associated with the forms selected in Filter by Associated Form(s).
  4. Tables noted with an asterisk (*) indicate those which Netsmart is in the process of updating to provide improved information on table columns, type and length.
  5. Click Process to view the report.
Table Documentation Report Information

The report header displays the table's Product, Schema, Table Name, Description, and Associated Forms. This is useful for determining the forms where the data is being collected.

The report data displays the table columns alphabetically with indexed columns first.

  • Column - The name of the information column.
  • Type - The type of information element.
  • Max Length - The maximum number of characters supported by this column.
  • Required - Indicates if the table data is based on this column.
  • Calculated - Indicates if system functionality or logic is used to populate the field.
  • Description - Indicates what information is stored by this column.
Viewing and Searching in the Report
  1. Click View to display the report. From here you can:
    • Navigate through the report by selecting the Page number, or by using the Previous and Next buttons.
    • Adjust the zoom size of the image.
    • Print the entire report (Print button) or only a single page (Current Page button).
    • Save the report to your chosen location (File button).
    • Close out of the report (Dismiss button).
  2. Click Search to look for text in the report.
  3. Generating a PDF - Click PDF Config to customize how a PDF will print.
    • Click PDF Viewer to associate an application to display the PDF.
    • Click Stop to return to Form Documentation.