Managing Objects in Mainframe

This chapter describes CA Repository Webstation Option objects, concepts, and tasks that are performed by the system administrator on the mainframe to manage the repository objects.

Metadata Models

CA Repository Webstation Option uses two metadata models: the Control model and the Category Builder model.

• The Control model consists of object types for defining CA Repository Webstation Option search objects.
• The Category Builder model consists of meta-entities used to define the topics, categories, and subcategories that will appear to CA Repository Webstation Option end users.

For complete information about repository object types and metadata models, see the Metadata Models Reference Guide.

Control Model

The CA Repository Webstation Option Control model is shown in the following illustration. The Control model enables CA Repository Webstation Option to be fully extensible.

You can observe the following in this illustration:

• The entity TAB CNTL is linked to itself through a relationship TABFLOW.
• The entity TAB CNTL is linked to SRCHATTR entity through a relationship TAB ATTR .
• The entity SRCHATTR is linked to SRCH VAL entity through a relationship SRCHATVL

For instructions on how to create search objects, see Search Object Maintenance.

Category Builder Model

Topics and Categories are two distinct repository object types that are used by CA Repository Webstation Option. The Category Builder model (shown in the following illustration) lets you perform the following tasks:

• Create topics and categories
• Determine which categories are found within each topic
• Determine which categories are subcategories of other categories

You can observe the following in this illustration:

• The entity TOPIC is linked to the entity CATEGORY through the association TOP CAT 25129.
• The entity CATEGORY is linked to itself through the association CAT CAT 25129.
• The entity CATEGORY is a workstation entity type, which is made up of several metadata components constituting Enterprise Model.

For instructions on how to create topics and categories and how to define the hierarchy within categories and subcategories, see Topic and Category Maintenance.

Metadata Retrieval

CA Repository Webstation Option executes SQL queries against the repository to retrieve the search objects, its attributes, and its set of allowable values. However, there are some differences depending on whether the query was initiated with the Finder search or with the Topics and Categories search.

• A Finder search allows you to search for a particular search object. You can also build complex queries by setting filter criteria using WHERE clauses for specific search objects. This interface provides a list of search objects from which the user can select to perform a search for a particular object.
• A Topics and Categories search provides a hierarchical folder view that defines the top-level topics and subordinate tree "folders" that represent subtopics. You can drill-down to a particular category or subcategory.

With Finder

Using Finder search you can perform a simple search or, specify filter criteria to fetch specific details about a search object. When you execute a query from Finder, CA Repository Webstation Option retrieves search objects, their attributes, and the set of allowable values. The search object appear as a list. The query also retrieves the repository text that contains the impact analysis query that can be executed by the user.

• When you search without setting filter criteria, on the Finder Search Objects panel, search objects are retrieved from the DBX_SHP_TABCNTL table where the Search Object Type (Mainline) is equal to F.
• However, when you specify filter criteria on the Finder Search Criteria panel, you can see the following items:
  • Attributes are retrieved from the DBX_SHP_SRCHATTR and DBX_SHP_TABATTR tables
  • Operators are part of the Finder and are based on the data type of the search attribute selected by the user
  • Attribute values are retrieved from the DBX_SHP_SRCHVAL and DBX_SHP_ATTRVAL tables.
  • When you executes a query, the augmented WHERE clause is passed back to the server where it is inserted into the pre-defined query and executed to retrieve a result set.

The actual query that is executed is retrieved from the DBX_TEXT_1 table where the row is associated with the ID of the search object.

The text contains a question mark (?) to indicate where the user-specified WHERE clause is inserted to create the query that will be executed. There can be multiple question marks in the search object. Each one is substituted with the same partial WHERE clause.

For more information about queries, see Repository Queries and their Usage.

With Topics and Categories

For a Topics and Categories search, CA Repository Webstation Option executes SQL against the repository to get the Topics and Categories objects, its attributes and its set of allowable values. It also retrieves the repository text that contains the impact analysis query. When you select a category object, the pre-defined query is executed, and a result set is retrieved.

The Topics and Categories panel lets you work with the following:

• Topics are retrieved from the DBX_SHP_TOPICS table
• Categories are retrieved from the DBX_WORKSTATION_D and DBX_XREF table where the ENT_TYPE is equal to 25122
• Search objects are retrieved from the DBX_SHP_TABCNTL table where the Search Object Type (Mainline) is equal to C

For more information, see Topic and Category Maintenance.

RZOS--Search Objects

CA Repository Webstation Option retrieves data from the repository by using search objects. A search object consists of a pre-defined SQL query that can be executed against data within the repository. When the pre-defined SQL query executes it accesses a set of repository tables and displays a result set.

CA Repository Webstation Option supplies a set of search objects when it is installed; however you can also create your own search objects. Search objects are typically defined by your CA Repository administrator. There is no limit to the number of search objects that can be created. Here are some examples:

• Business Rules–Displays the business rules for the selected folder (category)
• Non-DBMS Structures–Displays all records and segments for the selected category

For samples of search object queries, see Query Examples.

Search objects can contain one column that can be used to launch other tools. For information about how to configure this feature, see Launch Tools.

By assigning search objects to group profiles, you can control which search objects are available to CA Repository Webstation Option users, effectively limiting access to the data grouped under those search objects. For more information about group profiles, see the section Group Profile Maintenance.

The SQL queries for the pre-defined search objects are stored in the pre-defined CA Repository Webstation Option Control Tables. For samples of search object queries, see the section Query Examples.

Search objects are part of a Finder search and Topics and Categories searches used by CA Repository Webstation Option end users when they search repository data:

• A Finder search allows an end user to build complex WHERE clauses for specific search objects. This interface provides a list of search objects from which the user can select to perform a search for a particular object. After selecting a search object from the list, the user selects attributes on which to search, adds operations with values, and uses search criteria including AND, OR and NOT logical operators. The SQL is stored in the pre-defined CA Repository Webstation Option Control Tables.
• A Topics and Categories search enables an end user to drill-down through CA Repository Webstation Option topics and categories to narrow a search to specific data in the repository. This interface provides a hierarchical folder view that defines the top-level topics and subordinate tree "folders" that users see in a drill-down search. These folders present an organized view of the search objects that use only the pre-defined queries. Once users locate the data category they are looking for, they can view the associated search objects.

Using Search Objects

Search objects are used in both Finder searches and Topics and Categories searches. Each search object represents a pre-defined query that accesses a set of repository tables and displays a result set to the user.

In addition to a set of pre-defined search objects supplied with CA Repository Webstation Option, you can also create your own search objects. Search objects are typically defined by your CA Repository administrator. There is no limit to the number of search objects that can be created. Here are some examples:

• Business Rules–Displays the business rules for the selected folder (category)
• Non-DBMS Structures–Displays all records and segments for the selected category

For samples of search object queries, see the section Query Examples.

Search objects can contain one column that can be used to launch other tools. For information about how to configure this feature, see Launching Tools later in this chapter.

By assigning search objects to group profiles, you can control which search objects are available to CA Repository Webstation Option users, effectively limiting access to the data grouped under those search objects. For more information about group profiles, see Group Profile Maintenance.

Search Object Creation

Search objects are defined in the mainframe repository. The CA Repository Webstation Option administrator defines search objects by inserting an instance into the TAB CNTL entity. After creating a search object, you need to secure it within the external security manager (ESM) product in use at your site. For information about security considerations on search objects, see External Security and External Security Implementation within an ESM in chapter "Implementing Security."

Search objects that query tables which do not reside in the repository associated with CA Repository Webstation Option, or are not in any repository at all, are allowed. However, the ability of users to edit text on those other tables must be suppressed. This is accomplished by updating the search object. For more information about suppressing text update for a search object, see Edit Objects on the Query Results Panel.

Note: These instructions assume that you are familiar with commands and dialogs in CA Repository Webstation Option, and know how to create control data.

To create a search object

1. Execute the command VD SHOPCNTL;VT TAB CNTL,

   to Select CA Repository CLIST, ARZOS, dialog SHOPCNTL, entity type TAB CNTRL.

   The SHOPCNTL dialog opens.

2. Complete the fields on the SHOPCNTL dialog to define the new search object, and then insert the instance.

   A new search object is defined.

   For a description of the fields, see the TAB CNTL entity description in Model Entity and Relationship Control.

   For information about search objects that query text, see Extended Text as Search Objects.

3. Create search attributes that are unique to the search object. These attributes appear in the Finder Search Criteria panel:
   1. Within the SHOPCNTL dialog, select entity type SRCHATTR.
   2. Create any search attributes that do not already exist. Then insert the instances.

   Search attributes are defined for the new search object.

4. Create a TAB ATTR relationship, one for each search attribute in the search object.

   Relationship is defined for the new search object.

5. Specify search attribute values and create a relationship for each search value:
   1. Create the values in SRCH VAL if they do not already exist.
   2. Create a SRCHATVL relationship for each search value.

   The attribute values and relationship for each search value is defined.

   The new search object is created.

6. Start CA Repository Webstation Option, go to Finder and check the new search object and see how it appears.

   Important! After creating a search object, you need to secure it within the external security manager (ESM) product in use at your site. For more information about security considerations on search objects, see Implement External Security within an ESM in the chapter "Implementing Security."

Search Object Controls

The following information describes each of the entities shown in the Control Model. You use the SHOPCNTL dialog in CA Repository to maintain search objects.

Model Entity and Relationship Control

The objects used by the CA Repository Webstation Option administrator to extend its capabilities are described in the following table.

Extended Text as Search Objects

Text queries are defined in the repository as search objects with a Search Object Type (Mainline) of T. These search objects are used in the text report. A list of text objects both global and local will be displayed in the Select Report Criteria pane. A user can select one or more of the text types for inclusion in the text report.

Make Text Search Objects Global

To make a text search object global, the text search object must have a search object type of T (as specified in the Search Object Type in TAB CNTL) and cannot be related to any other search object through the TABFLOW relationship.

Make Text Search Objects Local

Text search objects are local when they are associated with specific search objects through the TABFLOW relationship.

List Report

You can select multiple rows from the query result page and generate List report that allows you to see detailed information about the selected rows or elements.

RZOS--Table Report

The table report displays context-sensitive information about repository tables and where they are used in the repository. It is used by repository administrators to generate detailed reports on repository tables.

The table report displays detailed information on underlying tables, for example, table schema, database, index information, and foreign key information. Therefore, you must have access rights for DB2 tables to generate this report.

Remove CA-Supplied Search Objects

To remove a search object from CA Repository for z/OS Webstation Option while keeping it in the repository, change the Search Object Type in TAB CNTL to any character except C, F, N, T or R. We recommend Z as CA may add new object types at a later time that may conflict with the value you set. The character Z will not be used in the future for search objects.

Topic and Category Maintenance

The Topic/Category search consists of two object types, Topics and Categories, which are unique to CA Repository Webstation Option. The objects in the Category Builder model control what information is displayed to the CA Repository on Option end user for a Topic/Category search.

TOPIC and CATEGORY entities define the top-level topics and subordinate tree folders that users see in a drill-down search using CA Repository Webstation Option. The Repository administrator typically defines these entities, and therefore the contents of your folders.

• Topics are the top-level folders that appear on the Topic Category panel. They do not contain any actual data. A plus (+) icon to the left of the Topic indicates that there are subordinate folders. These subordinate folders are Categories. Categories can be nested within other categories.
• Categories, also known as a type of repository workstation, function like containers for holding collections of the different entity and relationship definitions that make up the CA Repository Webstation Option model. The idea of a workstation container does not mean that the CA Repository Webstation Option model definitions are physically stored more than once in the repository-it simply means that workstations can reference a collection of data definitions spanning multiple, different entity types.

  For more information about using workstations, see the User Guide.

Topics are defined in the mainframe repository. The Repository administrator defines topics by inserting an instance into the TOPIC entity. After creating topics, the administrator creates categories and subcategories, and then creates associations between the topics and categories and the categories and any subcategories.

Note: These instructions assume the reader is familiar with commands and dialogs in CA Repository, and knows how to create control data.

Topic Creation

Topics allow you to organize repository data effectively and are easily accessible to the end user. You can create new topics to contain category and subcategories. The end user can then search for specific category and subcategories within each topic.

Note: These instructions assume that you are familiar with the commands and dialogs in CA Repository, and know how to create control data.

To create a topic

1. Select CA Repository CLIST, ARZOS, SHOPCNTL dialog, entity type TOPIC by executing the following command:

   View.Dialog SHOPCNTL;View.Type TOPIC

   View.Type TOPIC panel appears.

2. Complete the fields on the screen using the following information and then insert the instance.

The topic is created.

1. Start CA Repository Webstation Option, Select Categories and check the new topic and see how it appears.
2. Repeat Steps 1 to 3 to create additional topics.

You can now create categories and subcategories, and associate them to the topics you have created.

Create a Category

Categories and subcategories are defined in the mainframe repository. As Repository administrator, you need to define a category by inserting an instance into the CATEGORY entity. To define a subcategory, you need to create relationships between a higher-level category and lower-level categories.

In some cases, you may not need to create categories. For example, you can create a topic to display workstations. The end users will then be able to view the topic but not select any data within the topic.

Note: These instructions assume the reader is familiar with commands and dialogs in CA Repository, and knows how to create control data.

To create a category

1. From CA Repository, select SHOPCNTL dialog, entity type CATEGORY.

   For example, issue the command View.Dialog SHOPCNTL;View.Type CATEGORY.

2. Complete the fields on the screen using the following information; then insert the instance.

The category is created.

1. Repeat Steps 1 and 2 to create additional categories.

Create a Subcategory

A subcategory is a category, which is associated with a higher-level category. In case your data structure requires it, you can create subcategories or use existing categories as subcategories.

To create a subcategory

1. Create the category that you want to use as subcategory.

   Or

   Identify the existing category that you want to use as subcategory.

2. Select the dialog SHOPCNTL, entity type CAT CAT.
3. Complete the values on the screen to associate the lower-level category with the higher-level category to which it belongs.

   The subcatgory is created.

4. Repeat Steps 1 to 3 to create additional subcategories.
5. Start CA Repository Webstation Option, select Categories and check the new topic, category, and subcategory to see how it appears.

Associate Category with Topic

You need to create an association between the category and the topic that contains the category. Unless it is associated with the topic the end users will not be able to search for it.

To associate category with topic

1. Select dialog SHOPCNTL, entity type TOP CAT.
2. Complete the values on the screen to associate the category with the topic to which it belongs
3. Start CA Repository Webstation Option, select Categories and check the new topic and category to see how it appears.