8 Setting Up the Classification System

This chapter contains the following topics:

• About Classification
  Oracle Life Sciences Data Hub classification system allows you to define a set of labels and use them to label, or classify, every defined object, output, and visualization in Oracle LSH.
• Creating and Maintaining Hierarchies
  This section contains the following topics:
• Assigning Levels to Object Subtypes
  You must assign a classification hierarchy level to an object subtype in order to make it possible for a Definer to classify an object of that subtype at that hierarchy level.

About Classification

Oracle Life Sciences Data Hub classification system allows you to define a set of labels and use them to label, or classify, every defined object, output, and visualization in Oracle LSH.

Users can search and browse for an object or output by its classifications.

The classification system consists of a set of hierarchies. A hierarchy can contain multiple logically related levels (such as Project/Study/Site) where the values, or terms, defined for each level are logically related to a single term in the next higher level (for example, the site Mercy Hospital is related to its study, Study01, which is related to its project, Project Wonderdrug.) an Oracle LSH"hierarchy" can also consist of a single level, in which case its terms function as a list of values.

Classification brings order to the potentially huge number of defined objects and outputs contained in the Life Sciences Data Hub. The Outputs and Visualizations subtabs under the Reports tab display reports, submission forms, and visualizations according to the classification hierarchies you define and the classification terms that Definers assign to outputs, similar to the file system on a PC.

For example, in the Reports tab a user can click on the Project/Study/Site hierarchy. Oracle LSH then displays all the project names defined as terms in the Project hierarchy level. If the user clicks on Project Wonderdrug, for example, Oracle LSH displays folders for all the studies that are part of the Wonderdrug project (including Study01) and also all the reports that are classified to Project Wonderdrug as a whole. If the user clicks on Study01, Oracle LSH displays folders for all the sites that are part of Study01 (including Mercy Hospital) as well as all reports that are classified to Study01 as a whole. If the user clicks on Mercy Hospital, Oracle LSH displays all reports classified to Mercy Hospital.

Further information is available in the Oracle Life Sciences Data Hub Implementation Guide.

You must create the following:

• Hierarchies. A hierarchy consists of one or more named levels in a strict linear hierarchical order. Each level can have only one child level. You can define any number of levels.
• Hierarchy Levels. Each hierarchy must include at least one level. If a hierarchy has multiple levels, they must be logically related. For each object subtype, you must specify at least one hierarchy level to which objects of that subtype can be classified.
• Terms. A term is a specific value belonging to a hierarchy level. In each hierarchy level you must add meaningful terms to assign to objects. In a multilevel hierarchy, each term must be logically and definitionally related to a term in the level above. When a Definer assigns a term to an object, the object is classified to that term and users can search for the object by its classification.

You can add classification hierarchies and values at any time. For more information, see Required Role.

This section contains the following topic:

• Required Role
  You must have the Classification Administrator application role to access any of the screens under the Classification tab in the user interface and to perform any of the tasks covered in this section.

Required Role

You must have the Classification Administrator application role to access any of the screens under the Classification tab in the user interface and to perform any of the tasks covered in this section.

See Setting Up Specialized Administrators for information on assigning that role.

Figure 8-1 Flowchart for Setting Up Classification System

Description of "Figure 8-1 Flowchart for Setting Up Classification System"

Creating and Maintaining Hierarchies

This section contains the following topics:

• Creating Hierarchies
  To create a classification hierarchy, go to the Hierarchy subtab of the Classifications tab and do the following.
• Adding Levels to Hierarchies
  You must define at least one level for every hierarchy.
• Activating the Hierarchy and Making it Usable or Unusable
  When you have finished defining the hierarchy and its levels, make a hierarchy active and usable.
• Adding Terms to Levels
  All terms in levels below the top level must be related to a term in the next higher level.
• Modifying Hierarchies and Terms
  To modify a Classification Hierarchy, click Update in the Maintain Hierarchy Screen.

Creating Hierarchies

To create a classification hierarchy, go to the Hierarchy subtab of the Classifications tab and do the following.

For information about designing a system of classification hierarchies, see Defining Classification Hierarchies in the Oracle Life Sciences Data Hub Implementation Guide.

1. Click Add Hierarchy. The Create Hierarchy screen appears.
2. Enter values in the following fields:
   • Name
   • Description
   • Keyword Hierarchy. Set a value for the Keyword Hierarchy.

     Select Yes to make the hierarchy a keyword hierarchy. Keyword hierarchies can have only one level and are not used to display outputs in the Reports screen. Keyword hierarchies can be used in advanced searches.

3. Click Save and Continue. The Maintain Hierarchy screen appears with blank rows for defining levels. See Adding Levels to Hierarchies.

Adding Levels to Hierarchies

You must define at least one level for every hierarchy.

You must define the topmost level first, then the next lower level, and so on.

To add a level, do the following:

1. Enter values in the following fields:
   • Name
   • Description
   • Entry Length. The number of characters allowed for a term in this classification level. The maximum is 300.
   • Term Uniqueness. Select one of the following values to determine the way Oracle LSH enforces the uniqueness requirement for terms in the level:
     • Unique Within Level. Each term contained in this level must be unique relative to other terms in the same level.
     • Unique Within Parent. Each term contained in this level must be unique relative to the other terms in the level that are related to the same parent term.
   • Allow Classification
     • If selected, and if the hierarchy as a whole is set to Active, you can assign this level to object subtypes. Definers can then classify objects of those subtypes to values you define for the level.
     • If cleared, you cannot assign the level to object subtypes and definers cannot classify objects to the level. Oracle LSH uses terms in this level solely as folders in the Reports screen to organize folders in the next lower level.
2. Repeat this procedure to add another level. Click Add Hierarchy Level to add additional rows.
3. Click Apply. The system saves the changes and the Maintain Hierarchy screen appears.

To add a level after you have clicked Apply, click Update.

After creating a hierarchy, you must activate it before you can use it. See Activating the Hierarchy and Making it Usable or Unusable. You can remove and reorder a hierarchy level only if its owning hierarchy is not set to Active.

This section contains the following topics:

• Reorder Hierarchy Levels
  To change the order of the levels in a hierarchy, do the following:
• Remove Hierarchy Levels
  To remove a level, select it and click Remove.

Reorder Hierarchy Levels

To change the order of the levels in a hierarchy, do the following:

1. Click Reorder. The Reorder shuttle appears.
2. Select the level you want to move and click the Up and Down arrows to move it in relation to the other levels.
3. Click Apply. The system returns to the Maintain Hierarchy screen with the levels in the new order.

   Or click Cancel to discard your changes and return to the Maintain Hierarchy screen.

Remove Hierarchy Levels

To remove a level, select it and click Remove.

If you remove a level, the system adjusts the order number of any remaining levels so that the order numbers start at one (1) and are consecutive.

Activating the Hierarchy and Making it Usable or Unusable

When you have finished defining the hierarchy and its levels, make a hierarchy active and usable.

When a hierarchy's Active flag is set to Yes:

• You can add terms to the levels in the hierarchy.
• However, you cannot add levels to an active hierarchy.
• You can never change the setting back to No.

When a hierarchy's Usable flag is set to Yes:

• You can assign the hierarchy to object subtypes.
• You can set it back to No as long as it is not assigned to any subtypes.

This section contains the following topics:

• Activate and Make Usable
  To activate a hierarchy, do the following:
• Make Unusable
  If you prefer not to make the hierarchy usable at this time, do the following:

Activate and Make Usable

To activate a hierarchy, do the following:

1. In the hierarchy's main screen, click Update. The fields become enterable.
2. Set Active to Yes.
3. Click Apply. The system also sets Usable to Yes.

Make Unusable

If you prefer not to make the hierarchy usable at this time, do the following:

1. Click Update. The fields become enterable.
2. Set Usable to No.
3. Click Apply.

You can change the Usable setting to Yes at any time.

Adding Terms to Levels

All terms in levels below the top level must be related to a term in the next higher level.

You must begin by defining at least one term in the highest level. You can then add terms related to that term (child terms) in the second level, and then define child terms for those terms in the third level, and so on.

Note:

You can add terms only to active hierarchies. See Activating the Hierarchy and Making it Usable or Unusable.

To add terms to classification hierarchy levels, go to the Terms subtab of the Classifications tab and do the following:

1. Navigate to the hierarchy for which you want to define values.
   • If the hierarchy already has terms, you can expand its node (+) to see them. Add a term by clicking the pencil icon in the Maintain Terms column for the parent term (the term in the next higher level that is related to the term you are adding).If you are adding a term in the highest level, click the Maintain Terms icon for the hierarchy itself.
   • If the hierarchy does not contain any terms, you must begin by creating a term in the highest level by clicking the pencil icon in the Maintain Terms column for the hierarchy.
2. If there are no blank rows, click Add 5 Hierarchy Terms. Five empty rows appear.
3. Enter values in the following fields for each new term:
   • Name. Enter the term itself as you want it to appear in the user interface for classifying objects. The name must conform to the length and uniqueness rules defined for its hierarchy level.

   • Approved. Select Approved to activate the Term. Only approved terms can be used as default classifications for object subtypes and for object classifications.

     You can select the Approved flag at any time. You can clear (disapprove) a term only if the term has not been used and does not have any approved child terms.

     For example, if Project Wonderdrug is related to Study01, and Study01's Approval flag is selected, you cannot clear the Approval flag for Project Wonderdrug.

4. Click Apply to save your work. The Hierarchy Terms screen appears.

Modifying Hierarchies and Terms

To modify a Classification Hierarchy, click Update in the Maintain Hierarchy Screen.

Click Apply after making changes.

You can modify attributes as follows:

• Name. You can modify the name of the hierarchy. The system automatically updates the hierarchy name everywhere it appears in the user interface, including the classification screen for all objects classified to the hierarchy
• Description. You can modify the description.
• Keyword Hierarchy. You cannot modify the Keyword Hierarchy attribute.
• Active. You can change a hierarchy's Active setting from No to Yes at any time. However, once set to Yes, you can never set it back to No.
• Usable. When you set Active to Yes, the system automatically changes the hierarchy's Usable setting to Yes. You can change it back to No only if the hierarchy has not been assigned to any object subtype. A hierarchy is available for use only when its Usable autoboot is set to Yes.

This section contains the following topics:

• Modifying Hierarchy Levels
  You can modify level attributes as follows:
• Modifying Terms
  To modify a term:

Modifying Hierarchy Levels

You can modify level attributes as follows:

• Name. You can modify the level name. The system automatically updates the level name everywhere it appears in the user interface, including the classification screen for all objects classified to the level or a level below it in the same hierarchy.

• Description. You can modify the description.
• Entry Length. You can modify the Entry length.
• Term Uniqueness. You cannot modify the Term Uniqueness attribute.
• Allow Classification. You cannot modify the Allow Classification attribute.

Modifying Terms

To modify a term:

1. Go to the Terms subtab in the Classifications tab.
2. Navigate to the hierarchy that contains the term you want to modify.
3. Click the pencil icon in the Maintain Terms column of the parent of the term you want to update.
4. You can modify term attributes as follows:
   1. You can change a term's Approved setting from No to Yes at any time.
   1. You can change the Approved setting from Yes to No only if the term has not been used either as a default classification for an object subtype or to classify an object and no approved child terms are associated with the approved term.

You can remove a term only if it has not been used in any way and does not have any child values.

Assigning Levels to Object Subtypes

You must assign a classification hierarchy level to an object subtype in order to make it possible for a Definer to classify an object of that subtype at that hierarchy level.

You can choose to make object classifications mandatory to a particular level or not, and you can set a default classification or not.

You can create subtypes for any object type in the Subtypes subtab of the Security tab if you have the required privileges.

To add classification levels to subtypes, go to the Subtype subtab of the Classification tab and do the following:

1. From the Object drop-down list, select an object type and click Go. The system displays the object type in the lower portion of the screen.
2. Expand the object's node by clicking the plus (+) sign. The system displays all the subtypes currently defined for the object type.
3. Click the plus (+) sign in the Add Level column on the Subtype's row. The Subtype Hierarchy Level Assignment screen appears. The system displays the Classification: Subtype Hierarchy Level Assignment screen for the object subtype.
4. Select values from the following fields:
   • Hierarchy. From the drop-down list, select the classification hierarchy you want to assign to the Subtype. The system populates the Hierarchy Level drop-down list with the levels defined for the hierarchy you select.

   • Hierarchy Level. From the drop-down list, select the level of the hierarchy.

     You can repeat this process to choose more than one level.

   • Reference Allowed. Select Yes or No.
     • Yes. If set to Yes, Definers can choose to set the classification for objects of this Subtype to Reference. With a classification of Reference, an object takes its classification value from its immediate container: either a Work Area, in the case of object instances, or an Application Area or Domain Library in the case of object definitions. If you select Yes, you can set the Default Type to either Explicit or Inherited.
     • No. If set to No, Definers cannot choose a classification of Reference. They must specify a particular term. If you select No, the system sets the Default Type to Explicit and you cannot change that setting.
   • Default Type. Select Explicit or Inherited.
     • Explicit. If set to Explicit, to classify an object of this subtype at this hierarchy level, the Definer must manually specify a value.
     • Inherited. If set to Inherited, objects of this subtype inherit their classifications for this level from their parent object. Definers can override the inheritance by explicitly specifying a classification.
   • Mandatory. Select Yes or No.
     • Yes. Definers are required to set a value for this classification level.
     • No. Definers are not required to set a value for the classification level.
5. Click Apply. The Classification screen appears.
6. You can select a particular term in this hierarchy level as the default classification for all objects created as this object subtype. Definers can override the default value. Click the plus icon (+) in the Add Default Value, and then query for the term you want to define as the default classification. Click Apply.