1. User's Guide
  2. Setting Up and Administering TMS
  3. Upgrading to a New Dictionary Version
  4. Maintaining Predictionary Terms and Relationships

Maintaining Predictionary Terms and Relationships

The Maintain Predictionary VTAs/VTIs window shows verbatim terms and their relations in a particular Activation Group, domain, and dictionary that have been modified but not yet activated. They may have been modified manually in this window or by the Autoprocess VTAs/VTIs job or, in some cases, in the Maintain Repository window or using Maintain Repository APIs.

You do not see data loaded into the predictionary tables (as for a dictionary upgrade) but not modified after being loaded, and you do not see dictionary terms in levels higher than the coding level.

In this window you can work on virtual dictionaries as well as base dictionaries.

All the work you do in this window is in the predictionary tables. You must run Activation to move the terms and relations into production. You can run Activation by running the Activate Preliminary Data job from the Repository Maintenance window or the Repository Authoring window.

This section includes:

Parent topic: Upgrading to a New Dictionary Version

About the Maintain Predictionary VTAs/VTIs Tabs

In the Maintain Predictionary VTAs/VTIs window, terms and relations are grouped into tabs according to the type of modification they have undergone in the predictionary tables:

  • Classification. In the Classifications tab you see verbatim terms that have been in the predictionary tables. You can manually create verbatim terms and classify them to dictionary terms in the new dictionary version. You cannot query for unclassified verbatim terms in this tab; they are in the Invalid tab.

  • Reclassification. In the Reclassifications tab you can see terms that have already been reclassified in the predictionary tables in the Activation Group, domain, and dictionary you specify. These reclassifications may have been done by the Autoprocess VTAs/VTIs job, manually in this tab, manually in the Maintain Repository window, or using Maintain Repository APIs.

  • Declassification. In the Declassifications tab you can see terms that have already been declassified in the predictionary tables in the Activation Group, domain, and dictionary you specify. These declassifications may have been done manually by a user in this tab, manually in the Maintain Repository window, or by the Autoprocess VTAs/VTIs job; for example, if a new dictionary version does not include a dictionary term that had been used for classification.

  • VTA Update. In the VTA Update tab you can see VTs, VTRs, and their dictionary terms (DTs) that have been manually updated in the Maintain Repository window or using Maintain Repository APIs in the Activation Group, domain, and dictionary you specify. A VTA update is a change to the VTA such as a change in the setting for VTA Global? or VTA Approved? or Subtype.

  • Invalid. The Invalid tab displays verbatim term and relations (VTRs) that are currently invalid and cannot be activated.

    The following verbatim terms and relations are invalid:

    • Relations to dictionary terms that no longer exist

    • Relations to unapproved dictionary terms

    • Multiple relations inserted for the same verbatim term

    • Relations whose VT has a different subtype

    • VT with no parent (either the VTR was deleted without deleting the verbatim term, or a verbatim term was added without creating a VTR)

    Use this tab to reclassify or declassify terms whose relations are currently invalid.

Parent topic: Maintaining Predictionary Terms and Relationships

Common Procedure for Using All Tabs

You can use the same general procedures in all tabs of the Maintain Predictionary VTAs/VTIs window. In all tabs, you set the filter and query for one or more terms and relations. You can then, depending on the tab, do one or more of the following:

Parent topic: Maintaining Predictionary Terms and Relationships

Setting the Filter and Querying

When you begin to work in the Maintain Predictionary VTAs/VTIs window, specify the data you want to view in the fields across the top of the window, as follows. These filter settings apply to all tabs in the window. You can change them at any time.

  1. From the Dictionary Upgrade menu, select Maintain Predictionary VTAs/VTIs, then select the tab you want.
  2. Group. From the drop-down list, select the name of the Activation Group that includes the new dictionary version.
  3. Domain. The drop-down list displays the domains associated with the Activation Group you selected. Select the domain you want to work on.
  4. Dictionary. The drop-down list displays the dictionaries associated with the Activation Group you selected. Select the dictionary you want to work on.
  5. Click on the tab you want and enter a query in the upper portion of the window. See Querying in Windows.

    TMS returns all the terms and relations that satisfy your query criteria, with information appropriate for each tab; see Common Fields in the Maintain Predictionary VTAs/VTIs Window.

  6. To make a change, select the term or relation you want to work on by clicking it or tabbing to it.

    To declassify the selected term, see Declassifying Terms. To delete the selected term or relation, see Deleting Terms and Relations.

    To reclassify or classify the selected term, proceed to the next step.

  7. In the Repository Terms section at the bottom of the window, query for dictionary terms and VTAs or VTIs to which you may want to reclassify or classify the verbatim term. Use any of the fields as query criteria. For a description of these fields, seeCommon Fields in the Maintain Predictionary VTAs/VTIs Window.

    In addition, for each term type—dictionary terms (DTs), VTAs, and VTIs—select one of the following to limit the query:

    • No. If selected for DT, TMS will not search for dictionary terms. If selected for VTA or VTI, TMS will not search for VTAs or VTIs.

    • All. If selected for DT, TMS will search for all dictionary terms that match the other query criteria. If selected for VTA or VTI, TMS will search for all VTAs or VTIs that match the other query criteria.

    • Approved. If selected for DT, TMS will search for only approved dictionary terms that match the other query criteria. If selected for VTA or VTI, TMS will search for only approved VTAs or VTIs that match the other query criteria.

    • Not Approved. If selected for DT, TMS will search for only unapproved dictionary terms that match the other query criteria. If selected for VTA or VTI, TMS will search for only unapproved VTAs or VTIs that match the other query criteria.

      Depending on the Non Appr DT setting for the current dictionary/domain combination, you may or may not be able to classify a verbatim term to a nonapproved dictionary term. See Assigning a Dictionary to a Domain for more information. You can never create a Global VTA with a nonapproved dictionary term.

  8. To reclassify the term, see Reclassifying Terms.

    To classify the term, see Classifying Terms.

    Note:

    It is not necessary to Save except for deletions. For classifying, reclassifying, and declassifying, TMS saves your work when you click the Classify, Reclassify, or Declassify button.

Parent topic: Common Procedure for Using All Tabs

Declassifying Terms

When you declassify in this window, TMS deletes the verbatim term (VT) and the verbatim term relation (VTR) from the predictionary tables. You can declassify terms in the Reclassification, VTA Update, and Invalid tabs.

To declassify a term, select it and click

  1. Select the term in the upper tab.
  2. Click Declassify. TMS deletes the values from the New Dictionary Term and New DT ID fields, as well as all the New DT fields in the lower portion of the Reclassification tab.

After you declassify a term and leave the tab, you can find the same term only in the Declassification tab.

Parent topic: Common Procedure for Using All Tabs

Reclassifying Terms

When you reclassify, TMS deletes the current verbatim term relation (VTR) in the predictionary tables and creates the new one in the predictionary tables. You can reclassify terms in any tab except Classifications.

To reclassify a term, do the following:

  1. Select the term in the upper tab.
  2. In the Repository Terms tab, query for the repository term to which you want to reclassify the verbatim term.
  3. Select the term to which you want to reclassify.
  4. You can set values for enterable fields. See Common Fields in the Maintain Predictionary VTAs/VTIs Window.
  5. Click Reclassify. TMS populates the New Dictionary Term fields in the upper tab with values that pertain to the new classification.

Parent topic: Common Procedure for Using All Tabs

Classifying Terms

You can classify terms only in the Classification tab, and you can classify only verbatim terms that you enter manually. You cannot query for unclassified verbatim terms.

To classify a term:

  1. Enter a verbatim term in the upper tab.
  2. In the Repository Terms tab, query for the repository term to which you want to reclassify the verbatim term.
  3. Select the term to which you want to reclassify.
  4. You can set values for enterable fields. See Common Fields in the Maintain Predictionary VTAs/VTIs Window.
  5. Click Classify. TMS populates the fields in the upper tab with values that pertain to the new classification.

Parent topic: Common Procedure for Using All Tabs

Deleting Terms and Relations

In every tab, you can delete VTs and VTRs from the predictionary tables. The VT and VTR are completely removed from the predictionary tables and therefore are never activated and have no impact on production data.

To delete a term or relation:

  1. In the upper tab, select the term or relation you want to delete.
  2. From the Record menu at the top of the screen, select Delete.
  3. TMS deletes the row.
  4. Save.

Parent topic: Common Procedure for Using All Tabs

Common Fields in the Maintain Predictionary VTAs/VTIs Window

Note:

When a value is displayed in blue, you can click it to see additional information.

This section includes descriptions of common fields in multiple tabs of the Maintain Predictionary VTAs/VTIs window:

Parent topic: Maintaining Predictionary Terms and Relationships

Common Fields in the Upper Tabs

The following fields appear in one or more of the upper tabs: Classification, Reclassification, Declassification, VTA Update, and Invalid.

  • Old Dictionary Term: This field displays the dictionary term to which the verbatim term is currently in the production tables.

  • New Dictionary Term: This field displays the dictionary term to which the verbatim term is currently in the predictionary tables.

  • Type: In the Classification tab, select the type of classification to be created. VTIs are valid only in dictionaries with nonunique terms allowed in the classification level. See Nonunique Coding Level Dictionaries. VTIs cannot be global or nonapproved.

  • VTA Global?: In the Classification tab, select Yes to create the VTA as Global when it is activated or No to create the VTA as a Domain VTA in the current domain when it is activated. In the Reclassification and Declassification tabs, this is a read-only field that indicates the nature of the selected VTA.

  • VTA/VTI Subtype: This is a read-only field that indicates the subtype of the selected VTA: either Accepted or Misspelled.

  • VTA Approved?: In the Classification tab, select Yes to create the VTA as Approved when it is activated or No to create the VTA as Unapproved when it is activated. In the Reclassification and Declassification tabs, this is a read-only field that indicates the status of the selected VTA.

  • VTA/VTI ID: This field displays the unique system-generated ID of the selected verbatim term.

  • DT ID: This field displays the ID of the dictionary term to which the verbatim term is currently in the production tables.

  • New DT ID: This field displays the ID of the dictionary term to which the verbatim term is currently in the predictionary tables.

  • VT Created By: This field displays the user name of the individual who first added the verbatim term.

  • VTR Created By: This field displays the user name of the individual who first defined the VTR.

  • DML: This field displays the DML statuses of the repository term. Values—Insert, Update, or Delete—denote the action TMS will take on the term during Activation. If the DML field does not contain a value, the term is currently in the production tables.

  • Error: If the verbatim term's activation generates an error, it is displayed in the Error field.

  • DT Content Code: This field displays the unique system-generated ID of the verbatim term.

  • Old DT Code: This field displays the unique system-generated ID of the term to which the verbatim term is currently in the production tables.

  • New DT Code: This field displays the unique system-generated ID of the term to which the verbatim term is currently in the predictionary tables.

  • Predict?: If set to Yes, the currently dictionary term is in the predictionary tables. If set to No in is in the production tables.

  • Created By: These fields display the user names of the individuals who first added the old and new dictionary terms.

  • Level: This field displays the dictionary level of the verbatim or dictionary term.

  • Subtype: These fields display the subtypes of the old and new dictionary terms.

  • Approved?: These fields indicate whether the old and new dictionary terms have a status of Approved.

  • Global?: This field indicates whether the new dictionary term is Global.

Parent topic: Common Fields in the Maintain Predictionary VTAs/VTIs Window

Common Fields in the Repository Tab

The Repository tab contains the same fields for Classification, Reclassification, Declassification, VTA Update, and Invalid. These fields include:

  • Data Source: Select a data source from which to select repository terms. If you select Dictionary, TMS displays only data from the production tables. If you select Predictionary, TMS displays only data from the predictionary tables. If you select All Data, TMS displays both production and predictionary data.

  • Comment: You may enter comments about your action in this field.

  • Dictionary Term: This field displays the related dictionary term for the term selected in the lower block. It is determined by the user-defined function for the dictionary, if present, or the immediately related dictionary term if the selected term is a verbatim term, or is null otherwise.

  • Term: Depending on the options you select in the Dictionary and Data Source lists, repository terms are displayed in these fields.

  • DML: This field displays the DML statuses of the repository term. Values—Insert, Update, or Delete—denote the action TMS will take on the term during Activation. If the DML field does not contain a value, the term is currently in the production tables.

  • Level: This field displays the dictionary level of the repository term in the Term field in the same row.

  • Code: This field is designed to contain the repository term's ID in this dictionary, but its use depends on your company's policy. This field contains a value only if the term is already in the production tables or if a value was entered in the Maintain Repository Data window.

  • Alt Code: This field is designed to contain a unique ID for the repository term across TMS, but its use depends on your companys policies. This field contains a value only if the term is already in the production tables or if a value was entered in the Maintain Repository Data window.

  • Type: This field displays the repository term's Type. This value is either Dictionary Term or Verbatim Term.

  • SubType: This field displays the subtype for the repository term. This is either Company, Domain, or External for dictionary terms and Accepted or Misspelled for verbatim terms.

  • Glb?: This box indicates whether or not the repository term is global.

  • Appr?: This box indicates whether or not the repository term is approved.

  • Status: This field indicates the status of the repository term.

  • Category: This field indicates the category of the repository term.

  • Id: This field indicates the unique identifier of the repository term.

  • Comment Text: This field contains comment text for the repository term.

  • Error Msg: This field displays an error message for activation of the repository term if the term is not activated; otherwise it is null.

  • Created By: This field displays the user name of the individual who created the repository term.

  • Valid From: This field displays the timestamp of the creation of the repository term.

  • Valid To: This field displays the timestamp of the deletion of the repository term.

  • Trans.id: This field displays the transaction identifier for the repository term.

  • Value 1: This field displays a detail value defined by your company for the first detail for the repository term, if present.

  • Value 2: This field displays a detail value defined by your company for the second detail for the repository term, if present.

  • Value 3: This field displays a detail value defined by your company for the third detail for the repository term, if present.

  • Value 4: This field displays a detail value defined by your company for the fourth detail for the repository term, if present.

Parent topic: Common Fields in the Maintain Predictionary VTAs/VTIs Window