Column Definition Section

Create columns in a table.

This section also allows you to:

• Define the column name (SQL, parent system, and data element label).

• Select the column type.

• Define new column as an alias and select the alias column (optional).
  Aliasing fields is not a best practice. It is recommended that you only alias fields when necessary. Alternatives to aliasing fields are reports and QuickLinks. Data elements found in other forms or tables can be linked for reporting purposes. QuickLinks can be added to a modeled form to access other forms.

• Map dictionary columns to pre-existing dictionaries.

• Lock user-defined dictionaries.

• Set column dictionary modification security level.

Table Definition can be used to prevent tables from exporting with dictionaries, which would override the import destination's dictionaries.

In Multiple Server Environments, table columns which exist in the UAT or LIVE environments, cannot be deleted in the BUILD environment version of this form.

1. In the Column Definition table, click Add New Item.
   Columns that contain data cannot be deleted. 

2. In the Column Name field, enter the column name.

3. In the Column Description field, enter the column description. This field requires at least one alphanumeric character.

4. In the Column Label field, enter the column label. This field requires at least one alphanumeric character.

5. In the Is This Column an Alias to Another Column field, select Yes to populate information from another area into this column. When a column is aliased to another column, the value from the original column is defaulted forward into the aliased column. For dictionary data elements, the dictionary of the data element selected in the Alias Column field is included in the new column.
   Avatar allows you to alias both sacred and non-sacred fields.

   • Sacred fields - Specific fields, such as Client Name, Date Of Birth, and Sex are considered sacred. If aliased, sacred fields are view only. These are only useful for contextual reference while in your form and the value does not save to your table.

   • Non-scared fields - Non-sacred fields will save to your table, and may allow you to change their value.
     A changed value will not transfer back to the original form. It is recommended to use this judiciously as it may result in a continuity issue.

6. In the Alias Type field, select the file containing the data element to alias.

7. In the Alias Column field, enter the data element, click Enter.

8. In the Type of Column field, select the column type.
   See Table Column Types for a description of available table columns.
   The type of column selected enables associated fields on this section.
   This field is display-only for aliased columns.

   This field cannot be changed after the form is filed. 
   Once a Draft/Final or Draft/Pending Approval/Final column is added to a table, it cannot be removed from that table or any associated options. A new envelope must be remodeled, omitting the column. 

9. In the Entity field, select the entity lookup data element. This field is display-only, except when Other Entity Lookup is selected (Type of Column field).

10. In the Non Scrolling Text Width field, enter the maximum number of characters allowed for a non-scrolling text field.

11. If appropriate, in the Column Annotation field, enter notes associated with the table column.

12. The following fields are enabled based on the selection in the Type of Column field.

• Display future date warning - Select Yes to display a message when a future date is entered in the Date field.

• Does Dictionary Map To A Different Entity

  • Select Yes to use the dictionary value of the dictionary (Dictionary field).
  • Select No to create a new dictionary.

• Automatically Synchronize Dictionary Across Facilities - Select Yes to synchronize the dictionary with all system codes. Dictionary synchronization provides the following functionality:

  • Dictionaries in the table?s build environment - Modifications to the dictionary are updated in systems codes containing the dictionary table.
  • Dictionaries outside the table?s build environment - The dictionary cannot be modified.

• Lock Dictionary Values - Select Yes to lock the dictionary. Locking a dictionary prevents the dictionary from being modified. Single select dictionaries display as radio buttons. Multiple selection dictionaries display as check boxes.

• Security Level to Modify Dictionary Values - Select the security level needed to access the dictionary. The user must have this security level, or higher to have access the dictionary. Users are assigned security levels through the User Definition form.

• Entity Database - Select the file to map to the table column.

• Dictionary - Enter the data element name, click Enter to select. Click Ok.

• Include Mapped To Dictionary in Export - This field allows you to choose whether or not to retain the dictionary tables when exporting. When importing, dictionaries with retained mappings will override the destination's dictionaries.

  • Select Yes to include the mapped dictionary in the envelope when the envelope is exported (Export Envelope form), or imported (Import Envelope form).

  • Select No to prevent the program data from being exported.

• Is this table column required for form inclusion? - Select Yes to make the table column required.

• Always Required - Select Yes to require the table column for form submission. Table columns that are not required can be required through defined events (Form Definition form, Event Def. section).

• Always Enabled - Select Yes to enable the table column. Objects that are not enabled can be enabled through defined events (Form Definition form, Event Def. section).

• Requirement Type field:

  • Select Always Required to create a required table column for selections made in Draft/Final or Draft/Pending Approval/ Final objects.
  • Select Pending Approval/Final Only to create a table column required when Pending Approval or Final is selected in a Draft/Final or Draft/Pending Approval/Final object.

• Include Program Usage Type(s) - select a program to filter the program types that can be selected on the form.

• This field is enabled when the Enable 'Admission vs. Service Program' Functionality registry setting is set to Y, and the selected column is mapped to the core dictionary for the program..

• Filter By Practitioner Lookup - This field is enabled when the myAvatar Cal-PM registry setting Restrict Practitioner Search By Program is enabled, and the selected column is mapped to the core dictionary for the program.
  When the practitioner lookup is filled out, the selected program dictionary will populate with programs that have been selected in the Program Association field on the Practitioner Enrollment form.
  This functionality is available for user modeled tables created in either myAvatar PM, myAvatar Cal-PM, or myAvatar CWS.

• Signature Command Button Caption - Enter the label to display on the Signature button. This field is displayed when signature pad support is enabled (User Definition form). This is only enabled for a column type of Signature.

• 'Signature Line' fields - Enter information to display on the Signature Pad screen. This field is displayed when signature pad support is enabled (User Definition form). This is only enabled for a column type of Signature.

13. In the Referral Group field, select whether or not this column is a required display-only field that restricts the form to use with internal referrals. This is only enabled for a column type of Non Scrolling Free Text.

14. If the current column is a Dictionary - Single Response type, in the field Is this a Priority field?, select whether or not to include a Priority field in To-Dos sent as part of a workflow. For priority to be included in a To-Do, this table must also have workflow. Priority is information only and does not affect the order in which To-Dos are delivered. Priority fields contain the three values: Low, Medium, and High.

15. Click Submit.

If you add a Workflow Controlling Notification type column to your Table Definition, once you add that column to your form in Form Definition, it cannot be removed. If you try to remove the column in Form Definition, you will receive the following error message when submitting: "The following table columns are required for form inclusion and are not defined within the form: (column_name_here). You will need to delete the form, then remove the column in Table Definition, then re-create the form."