Skip to main content

Envelope Definition

Modeling starts with the envelope, which is a folder for holding all tables and forms associated with the DCI (Data Collection Instrument) and is the first step in the modeling process.

Prerequisites:

  • When editing an envelope, the user must be logged into the build environment (system code) where the envelope was created. It is recommended that the BUILD system code be used. 
Create an Envelope
  1. Go to RADplus Utilities > Modeling > Envelope Definition.
  2. Select the Envelope Definition form. The Select myAvatar PM Envelope screen displays. Enter the envelope name, and click OK, or click New to create a new envelope.
  3. In the Envelope Description field, enter the envelope name. Use underscores (_) to separate words. Do not use spaces.
  4. In the SQL Schema field, enter the SQL table schema. Enter the schema name followed by a period. The default schema is SYSTEM.
  5. In the Entity Database field, select the entity database. This field cannot be changed once this form is filed.
  6. The entity database determines how the data will be stored. All audits run based on entity.
    • Client - Manages data based on client records. These forms will have a Select Client predisplay.
    • Family - Manages data based on family records (defined in Family Registration). These forms will have a Select Family predisplay.
    • Incident - Manages data based on incident records (if Avatar Incident Tracking is installed). These forms will have a Select Incident predisplay.
    • Payor - Manages data based on guarantor/payor records (defined in Guarantors/Payors). These forms will have a Select Payor predisplay.
    • Program Maintenance - Manages data based on program records (defined in Program Maintenance). These forms will have a Select Program predisplay.
    • Referral Source - Manages data based on referral source records (defined in Referral Source Maintenance). These forms will have a Select Referral Source predisplay.
    • Staff - Manages data based on staff records. These forms will have a Select Staff predisplay.
    • User - Manages data based on system user records (defined in User Definition). These forms will have a Select User predisplay.
  7. In the Is Envelope Eligible for Export field:
    • Select Yes to allow the envelope to be exported.
    • Select No to make the Envelope Version Number field display only.
      If an envelope has been edited it cannot be exported. File the envelope again to export it.
  8. In the Envelope Version Number field, enter the version number. This number tracks changes made to the envelope, and increases by .01 for each change.
  9. In the Envelope Table Row Sharing Between Forms field:
    • Select Yes to enable table row sharing between forms in the same envelope. All forms will be able to edit table rows created by other forms in the same envelope. Table row sharing cannot be enabled for forms with a "Draft/Final" or "Draft/Pending Approval/Final" table column.
      • If a form includes a "Draft/Final" or "Draft/Pending Approval/Final" table column, table row sharing cannot be enabled. Once the Envelope Definition form is submitted, this field can be changed to No if no forms have been defined in the envelope. 
    • Select No to prevent table row sharing between forms in the same envelope.
  10. In the Always Allow Export field, select Yes to flag the selected envelope to always remain available for export, eliminating the need to re-designate the envelope for export after changes are made.
  11. Click Submit.
Create an Envelope for Facilities with CDR Enabled

This applies to child myAvatar applications only. The CDR provides a single log on for reporting purposes by making these tables available through a single ODBC setting.

  1. In the Include Envelope Within CDR field, select Yes to include all tables in the envelope in the CDR. Tables are accessed through the parent application's ODBC connection.
  2. In the Override Default CDR SQL Schema field:
    • Select Yes to override the default CDR table schema (CDR SQL Schema field). If the table is exported to another namespace the CDR schema is maintained.
    • Select No to create the default CDR SQL schema using the Caché Namespace SQL schema.
  3. If appropriate, in the CDR Schema field, enter the schema using alphabetic characters. 

 

  • Was this article helpful?