Create and Edit a Find & Reserve Model

A test data model consists of one or more data entities organised in a hierarchy. This starts with one root entity, which has associations to other entities. Each data entity is identified by its physical name (for example, table name in the case of the relational model) and the data source in which it is available. As a Test Data Engineer (TDE), you can identify and add data elements to the entity - these elements are identified by their physical names (for example, column names in a table in the case of the relational model) and by logical names. An entity can contain other child entities through associations. An association defines the relationship between those entities.
tdm46
A test data model consists of one or more data entities organised in a hierarchy. This starts with one root entity, which has associations to other entities. Each data entity is identified by its physical name (for example, table name in the case of the relational model) and the data source in which it is available. As a Test Data Engineer (TDE), you can identify and add data elements to the entity - these elements are identified by their physical names (for example, column names in a table in the case of the relational model) and by logical names. An entity can contain other child entities through associations. An association defines the relationship between those entities.
This page contains the following sections:
 
 
You can follow a worked example of the Test Data Model creation process in the context of a test scenario here: Example: Order Management System.
When a test data model becomes accessible to testers, they can use it to define their data requirements.
Types of Find & Reserve Models
Standard Find & Reserve Models
From version 4.6, CA TDM can create Find & Reserve models from the data model that you create in the Data Model section of the CA TDM Portal. This new process removes your requirement to register tables directly from their original environments.
Before you create a Find & Reserve Model, ensure that there is no sensitive data in the Data Model that you use to create the Find & Reserve Model. You can do this with the PII Scan feature within the CA TDM Portal. For more information, see Scan Data Model for PII.
Legacy Find & Reserve Models
You can still create Legacy Find & Reserve data models as in previous versions. These require you to register tables directly from their original environments.
Create a Find & Reserve Model
To allow testers to find data and reserve it for their use, you can create a Find & Reserve Model. There are 2 kinds of model that you can create, as follows:
    1. This model uses the data model that you create in the Data Model section of the CA TDM Portal. You no longer need to register tables in the Objects section of the Portal.
    2. Support for DB2/zOS data sources. See a comprehensive list of data types and database types that CA TDM supports at Data Types Supported by Find & Reserve.
    3. Support for fixed-length CHAR data types.
    4. Requires Data Prefetch (this is no longer an optional feature).
    • You should use this model if you require support for compound relationships. New F&R Models do not currently support compound relationships.
    • Legacy models do not support DB2/zOS data sources. 
Create a standard Find & Reserve Model
This is the process to create a standard Find & Reserve Model.
 
Follow these steps:
 
  1. Access the CA TDM Portal.
  2. Select the required project and version from the 
    Project
     drop-down list. 
  3. Expand 
    Modeling
     in the left pane.
  4. Click 
    Find & Reserve
    .
    The 
    Models for Find & Reserve 
    page opens. 
     All test data models that you create for the selected project and version are listed in this page.
  5. Click 
    Create Model
    .
    The 
    Test Data Model
     page opens.
  6. Enter the following information:
    •  
      Name
      Specifies an appropriate name for the test data model.
    •  
      (Optional) Description
      Specifies an appropriate description for the test data model.
  7. Click 
    Next
    .
    The 
    Find & Reserve Model
     page opens.
    On this page, the left pane displays a tree structure of the data model that you created in the 
    Data Model
     section. If you do not have a Data Model defined, the left pane displays 'You currently have no Data Sources. Please run Data Discovery'.
    The right pane displays the contents of the Find & Reserve Data Model that you will create. At the start of the process, the right pane is empty.
  8.  
    Expand tables
    Click the chevron on the left of the Data Model, Database, Schema and Table names, to expand that element.
    If you type a text string into the 
    Search
     field above the left-hand pane, only tables whose names match that string, within the expanded schema, are displayed.
    When you expand a Table element, columns from that table display underneath it.
     The Find & Reserve feature does not support all data types on all databases. The names of columns whose data types are not supported appear in grey. See Data Types Supported by Find & Reserve for a full list of confirmed supported and unsupported data types.
  9.  
    Add Columns to the Find & Reserve model
    Click a column name and click the right arrow to put them in your Find & Reserve Data Model. Review the following considerations:
    • If a column's name is grey, this can mean one of the following:
      1. The column's data source is not supported
      2. The column's table has no primary key relationships to other tables. In this case, the names of all the columns in this table are grey.
      If you try to add a column name in grey, the operation fails with an appropriate error message.
    • When you add a column from a table that has one or more relationships to other tables in your Find & Reserve model, the 
      Relationships
       dialog opens. Here you can choose which foreign key relationship to use to connect this table to other tables in your Find & Reserve model.
      • Click 
        Edit Relationships
         to add relationships to columns in other tables in your Find & Reserve model.
         Only columns of the same data type as the target column are shown in the dropdown list of columns.
      • When you click 
        Save Relationships
        , the new relationship appears in the list of relationships from which you can choose this table's foreign key relationship to the Find & Reserve model.
      • Click 
        Done
         to close the 
        Relationships
         dialog.
    • When you add a column from a table that has no relationships to other tables in your Find & Reserve model, an error dialog opens with the text 'No Relationships found to connect Table <table_name> with Find & Reserve model'. Click 
      Define Relationships
       to open the 
      Relationships
       dialog and add relationship(s) for that table, from which you can choose when you click 
      Save Relationships
      .
      Click 
      Done
       to close the 
      Relationships
       dialog.
  10.  
    Choose Model Key(s).
    You must have at least one Model Key column in your Find & Reserve model.
    Click the checkbox in the 
    Model Key
     column to make a column a Model Key. All Model Keys must come from the same table. If you try to add a Model Key from a column other than the column that currently contains Model Key(s), the 
    Change Model Key(s)
     dialog opens. Click 
    Remove Current Key(s)
     to change to the new Model Key.
     You cannot make changes to the Model Keys after you create the Find & Reserve Model.
  11. (Optional) 
    Edit table relationships in your Find & Reserve model.
    You can click the pencil icon for any table in the Find & Reserve model that does not contain Model Key(s). The 
    Relationships
     dialog opens. Here you can choose which foreign key relationship to use to connect this table to other tables in your Find & Reserve model.
    • Click 
      Edit Relationships
       to add relationships to columns in other tables in your Find & Reserve model.
    • When you click 
      Save Relationships
      , the new relationship appears in the list of relationships from which you can choose this table's foreign key relationship to the Find & Reserve model.
    • Click 
      Done
       to close the 
      Relationships
       dialog.
  12. (Optional) 
    Edit columns in your Find & Reserve model.
    If you click the pencil icon for any column in the Find & Reserve model, the 
    Edit F&R Model Column
     dialog opens. Here you can:
    • Change the column alias (the column's name in the Data Model does not change).
    • Make the column 
      Available as Search Criteria
      . This option is checked by default.
    • Select whether values in this column 
      Display as Dropdown Menu
      . This option is checked by default.
  13. After you add all the columns you want in your Find & Reserve Model, click 
    Finish
    .
    A progress wheel appears. When the process is complete, the 
    Models for Find & Reserve
     page opens. Your new Find & Reserve Model is visible on this list, with the Data Prefetch option 
    On Demand
    .
    The message "Success! Test Data Model '<model_name>' created successfully" appears at the top of the page.
Create a Legacy Find & Reserve Model
This is the process to create a standard Find & Reserve Model.
 
Follow these steps:
 
  1. Access the CA TDM Portal.
  2. Select the required project and version from the 
    Project
     drop-down list. 
  3. Expand 
    Modeling
     in the left pane.
  4. Click 
    Find & Reserve
    .
    The 
    Models for 
     
    Find & Reserve 
    page opens. 
     
    Note:
     All test data models that you create for the selected project and version are listed in this page.
  5. Click 
    Create Legacy Model
    .
  6. Enter the following information:
    •  
      Name
      Specifies an appropriate name for the test data model.
    •  
      (Optional) 
      Description
      Specifies an appropriate description for the test data model.
    • Include Reserved Data
      If checked, testers can decide to include data that is already reserved, in their search results.
      Testers should be aware, that data previously reserved by other testers must not be used for testing.
  7. Click 
    Next
    .
    The 
    Environment
     page opens. This page lists the existing environments that are created for the selected project version.  If no environment is defined, use the 
    New Environment
     button to open the environment creation dialog and specify the appropriate information. You can also edit or delete an existing environment from the list.
    For more information about how to create an environment, see Create an Environment.
  8. Select the applicable environment.
  9. You can activate the
     Data Prefetch
     toggle. Query time can be reduced by prefetching the data to a TDM database. When Data Prefetch is active, data from all your data sources across all your environments will be cached in a TDM database. Once this data is cached, the query will run on the cached data. When Data Prefetch is disabled, all cached data is deleted.
     For smaller data sets with many entities and relationships between them, we recommend the use of Data Prefetch.
    For more information, see Data Prefetch.
  10. Click 
    Next
    .
    The 
    Build Test Data Model: Select Model Key
     page opens. You use this page to define a model key for the test data model you are creating. A model key acts like a primary key for a test data model. The left panel in this page shows all the entities (for example, tables) and data elements (for example, columns) that are already registered with the selected project and version.
    While creating a test data model if you click Cancel after defining the model key, the Portal displays a message that prompts you to specify whether you want to save the test data model or delete it. Select the appropriate action.
  11. Locate and expand the appropriate entity. Use 
    Search
     to search for a specific entity; you cannot search for a data element of an entity. You can also navigate through the paginated list to find the appropriate entity or data element under the entity.
  12. Select the data element that you want to use as a model key for this test data model.
  13. Click the forward arrow (>).
    The 
    Add <
    EntityName
    >
     dialog appears.
    The Portal prompts you to first add the parent entity of the data element (model key). After you add the parent entity details, the Portal allows you to add the data element (model key) information. The added entity acts as a root entity for the test data model; similarly, the added data element acts as a model key for the test data model.
  14. Enter the entity information as follows:
    •  
      Name
      Lets you enter an appropriate logical name for the entity that contains the data element (model key).
    •  
      Data Source
      Displays the data source that contains the entity. The Portal automatically searches all the data sources (connection profiles) for the selected environment and populates the field with the appropriate data source that includes the entity. If the search does not find any data source that includes the entity in the given environment, the Portal displays an error stating that no related data source is available. If the entity is found in multiple data sources, the Portal automatically displays the first data source in the list; however, you must review and then select the data source for which the entity has to be associated.
       We recommend that you verify your environment, add the appropriate data sources, and map them to the related connection profiles.
  15. Click 
    Next
    .
    The 
    Add <
    EntityName.DataElementName
    >
     dialog appears.
  16. Enter the data element (model key) information as follows:
    •  
      Name
      Lets you enter an appropriate logical name for the data element that you are using as a model key.
    •  
      Display in Tester Self Service
      Lets you specify whether you want to display this data element to testers in the Self-Service Catalog. Select this option to display the data element. The logical name that you specify in 
      Name
       is displayed to the tester.
    •  
      Use drop-down filter
      Lets you choose whether or not testers can select values for this element from a drop-down list of all available values. The field auto-suggests values based on the tester's input.
       Drop-down filter functionality is only available for character string values (not Date, Time or Numeric).
  17. Click 
    Save
    .
    The model key (data element) and its related parent entity are added to the right pane.
    After you add the model key, you can proceed to add other data elements to the test data model. If the parent entity of the data element that you are adding is not already present in the test data model (right pane), the Portal prompts you to first add the parent entity details. The Portal also expects you to define the required associations (relationships) while adding the entity to the test data model. Each entity that you add to the test data model must have a direct or indirect (through intermediate entities) association with the root entity already added to the test data model. If the parent entity is already added to the test data model, the Portal skips the entity details dialog and directly displays the data element details dialog.
  18. Click 
    Next
    .
    The 
    Build Test Data Model: Select Data Elements
     page opens.
  19. Select the required data element in the left pane and click the forward arrow.
    The 
    Add 
    <EntityName>
     
     dialog appears if the parent entity is not already added to the test data model. Otherwise, the 
    Add <
    EntityName.DataElementName
    >
     dialog appears.
  20. Enter a logical name for the entity in 
    Name
    , select the related data source from the 
    Data Source
     drop-down list, and specify the association information as follows:
    •  
      Association From
      Lets you select the appropriate entity (source) with which you want to establish the association. This source entity could be a root entity or any other entity that is related to the root entity and is already added to the test data model (right pane). This drop-down list displays the same logical names that you specify while entering the entity information in the previous steps.
    •  
      Association Type
      Lets you select the association type based on your requirement. Applicable types are ONE_ONE, ONE_MANY, and MANY_ONE.
      Specifying appropriate association type helps improve the performance of the find operation on the test data model. The search of the data is optimized based on the association types among the entities. Therefore, ensure that you take appropriate care while specifying the association type.
    •  
      Join Fields
      Lets you select a data element from the entity (source) already added to the test data model and join it with a data element from the entity (target) that you are adding to the test data model. These data elements help establish the association between the two entities. The data type of both the data elements must be the same. If the two entities are from the same data source and an association exists between the two entities, the Portal automatically displays the related data elements in the 
      Join Fields 
      area. If the entities are from different data sources, you need to manually select the appropriate data elements to establish the association.
      For composite keys, click the plus icon (+) to add all the required data elements to establish the complete association.
  21. Click 
    Next
    .
    The 
    Add <
    EntityName.DataElementName
    >
     dialog appears.
     If the source entity is part of multiple associations, you must select the association that you want to use for the data element.
  22. Enter the data element information as explained in Step 15 and click 
    Save
    .
    The intended data element and its related entity (if not already added) are added to the test data model.
  23. Repeat Steps 17 through Step 20 to add other entities to the test data model.
    All the items are added to the right pane. You can browse through the paginated list to review the entities and data elements added to the test data model.
  24. Click 
    Finish
    .
    The test data model is created and is added to the 
    Models for Find & Reserve
     page.
     To delete a test data model, identify the row that contains the test data model, click the Delete icon (cross), and confirm the deletion.
You have successfully created a test data model for testers.
You can find an example of this process here: Example: Order Management System.
Edit a Find & Reserve Model
If you want to update your test data model after you create it, the Portal allows you to do so. The procedure differs slightly for:
You can update the following information about a test data model:
  • Name and description of the test data model.
    We recommend that you always base your automation scripts (if any) on the test data model ID instead of the test data model name. The test data model ID remains unique across all the projects, and it cannot be changed once it is created. This helps ensure that your scripts remain in the working condition even when the name of the test data model is changed.
  • Add a data element and entity to the test data model.
     You cannot add a new root entity or model key. You cannot add a new root entity or model key.
  • Remove a data element and entity from the test data model.
     You cannot remove an already added root entity or model key.
The process to edit a Find & Reserve Model is different for standard models and Legacy models.
Edit a standard Find & Reserve Model
This describes the process to edit a Find & Reserve Model.
 
Follow these steps:
  
  1. Access the CA TDM Portal.
  2. Select the required project and version from the 
    Project
     drop-down list. 
  3. Expand 
    Modeling
     in the left pane.
  4. Click 
    Find & Reserve
    .
    The 
    Models for Find & Reserve 
    page opens. All test data models that you create for the selected project and version are listed in this page. On this page you have the following options:
    •  
      Display to Testers
       
    •  
      Show Reserved Rows
       
    •  
      Data Prefetch
       dropdown
      From this menu you can choose the Data Prefetch behaviour for this Find & Reserve Model. The options are:
      •  
        Periodic
        CA TDM prefetches data in accordance with Synchronization Triggers.
      •  
        On Demand
        CA TDM only prefetches data when you click 
        Fetch Data
         from the 
        Actions
         menu
         If a Find & Reserve Model of type 'New', has the Data Prefetch option 
        Off
        , it always indicates an error in execution of the Data Prefetch. You cannot disable Data Prefetch for New models.
    •  
      Actions
      •  
        Remove model
         
      •  
        Fetch data
        Only available if Data Prefetch option is not 
        Off.
         
  5. Click the test data model that you want to update.
    The 
    Test Data Model
     page opens.
  6. Update the following test data model information, if required:
    • Name of the test data model.
    • Description of the test data model.
  7. Click 
    Next
    .
    The 
    Find & Reserve Model
     page opens. On this page, you can add more columns to your 
    Find & Reserve Test Data Model
     (right pane) from your 
    Data Model
     (left pane), and remove columns from your Data Model.
     After you create a model, you cannot change which column(s) is/are the model keys, and you cannot remove the model key column.
    If you type a text string into the 
    Search
     field above the left-hand pane, only tables whose names match that string are displayed.
  8.  
    Add Columns to the Find & Reserve model
    Click a column name and click the right arrow to put them in your Find & Reserve Data Model.
    • If a column's name is grey, this can mean one of the following:
      1. The column's data source is not supported
      2. The column's table has no primary key relationships to other tables. In this case, the names of all the columns in this table are grey.
      If you try to add a column name in grey, the operation fails with an appropriate error message.
    • When you add a column from a table that has one or more relationships to other tables in your Find & Reserve model, the 
      Relationships
       dialog opens. Here you can choose which foreign key relationship to use to connect this table to other tables in your Find & Reserve model.
      • Click 
        Edit Relationships
         to add relationships to columns in other tables in your Find & Reserve model.
         Only columns of the same data type as the target column are shown in the dropdown list of columns.
      • When you click 
        Save Relationships
        , the new relationship appears in the list of relationships from which you can choose this table's foreign key relationship to the Find & Reserve model.
      • Click 
        Done
         to close the 
        Relationships
         dialog.
    • When you add a column from a table that has no relationships to other tables in your Find & Reserve model, an error dialog opens with the text 'No Relationships found to connect Table <table_name> with Find & Reserve model'. Click 
      Define Relationships
       to open the 
      Relationships
       dialog and add relationship(s) for that table, from which you can choose when you click 
      Save Relationships
      .
      Click 
      Done
       to close the 
      Relationships
       dialog.
  9. Optional) 
    Edit table relationships in your Find & Reserve model.
    You can click the pencil icon for any table in the Find & Reserve model that does not contain Model Key(s). The 
    Relationships
     dialog opens. Here you can choose which foreign key relationship to use to connect this table to other tables in your Find & Reserve model.
    • Click 
      Edit Relationships
       to add relationships to columns in other tables in your Find & Reserve model.
    • When you click 
      Save Relationships
      , the new relationship appears in the list of relationships from which you can choose this table's foreign key relationship to the Find & Reserve model.
    • Click 
      Done
       to close the 
      Relationships
       dialog.
  10. (Optional) 
    Edit columns in your Find & Reserve model.
    If you click the pencil icon for any column in the Find & Reserve model, the 
    Edit F&R Model Column
     dialog opens. Here you can:
    • Change the column alias (the column's name in the Data Model does not change).
    • Make the column 
      Available as Search Criteria
      . This option is checked by default.
    • Select whether values in this column 
      Display as Dropdown Menu
      . This option is checked by default.
  11. Click 
    Finish
     to save your changes and return to the list of Find & Reserve Models.
  12. Click 
    Cancel
     to discard your changes and return to the list of Find & Reserve Models. You need to confirm this decision.
  13. The 
    Models for Find & Reserve
     page opens. This page now includes the updated Find & Reserve Model.
You have successfully updated a Find & Reserve Model.
Edit a Legacy Find & Reserve Model
This describes the process to edit a Legacy Find & Reserve Model.
 
Follow these steps:
  
  1. Access the CA TDM Portal.
  2. Select the required project and version from the 
    Project
     drop-down list. 
  3. Expand 
    Modeling
     in the left pane.
  4. Click 
    Find & Reserve
    .
    The 
    Models for Find & Reserve 
    page opens. All test data models that you create for the selected project and version are listed in this page. On this page you have the following options:
    •  
      Display to Testers
       
    •  
      Show Reserved Rows
       
    •  
      Data Prefetch
       dropdown
      From this menu you can choose the Data Prefetch behaviour for this Find & Reserve Model. The options are:
      •  
        Off
        CA TDM does not Prefetch data for the model.
      •  
        Periodic
        CA TDM prefetches data in accordance with Synchronization Triggers.
      •  
        On Demand
        CA TDM only prefetches data when you click 
        Fetch Data
         from the 
        Actions
         menu.
    •  
      Actions
      •  
        Remove model
         
      •  
        Fetch data
        Only available if Data Prefetch option is not 
        Off
        .
  5. Click the test data model that you want to update.
    The 
    Test Data Model
     page opens.
  6. You can update the following test data model information:
    • Name of the test data model.
    • Description of the test data model.
  7. Click 
    Next
    .
  8. Select a different environment, if applicable. Ensure that you have considered all the relevant factors while selecting a different environment.
  9. Click 
    Next
    .
    The 
    Build Test Data Model: Select Model Key
     dialog opens. You cannot change the model key of a test data model.
  10. Click 
    Next
    .
    The 
    Build Test Data Model: Select
     
    Data Elements
     dialog opens.
  11. Add or remove appropriate data elements and entities from the test data model based on your requirements.
  12. (Optional) Edit data elements by clicking the Pencil icon, in the Actions column.
    This lets you change the 
    Name
    Display in Tester Self-Service
     status, and 
    Use Drop-down filter
     status. Click 
    Save
     if you make any changes.
  13. Review the changes.
  14. Click 
    Finish
    .
    The 
    Models for Find & Reserve 
    page opens. This page now includes the updated Find & Reserve Model.
You have successfully updated a Legacy Find & Reserve Model.