Manage Inventory of Tables and Fields

The Inventory of Tables and Fields is a section of the metadata layer in the Eagle Data Management suite. It connects to the physical database and contains information about each table and column in the Eagle data model. It is considered as the Eagle Data Management’s definition of all tables and columns in the database.

The Inventory of Tables and Fields is used:

  • To define tables and fields in the database.

  • To provide the definition of the columns in the database so that field attributes can be created.

  • To support the Import/Export Wizard as part of Data Migration.

Inventory of Table and Fields workspace allows you to add, view, edit, duplicate and delete the tables and fields represented in the Eagle data model. You must keep the inventory of fields consist with the Define Data Language (DDL) statements defining the physical database. 

Create Tables and Fields

In the Inventory of Tables and Fields workspace, you can create reference to tables and fields.

Pre-requisite: Before you add a table, the Database Administrator should add the table to the physical database and provide necessary access permission for the tables. After this is done, you should use the Inventory of Tables and Fields to set up a reference to that table.

To create a table in the Inventory of Tables and Fields:

  1. In the Setup workspace, in the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. On the Home tab, click Create New and then select Table.
    You see the Create New Table dialog box.

  3. Click the Database Name list to select a database in which the physical table resides.
    You can select the database name by typing in the field or selecting from the list.

  4. In the Table Name box, enter the name of the table for which you want to set reference to.
    The Table name should match with the one to which it is referenced to.

  5. Click the Indicator list to identify the type of table.
    You see all the available list of indicators. Each table in the database has an indicator. This indicator is also applied to each field attribute that is created against the table. Thus, if the SECURITY table has an indicator of s, then the ISSUE_NAME field attribute also has an indicator of s. This indicator is used to fetch data from the physical database.
    Click Save.
    The system creates the table and lists it in the Inventory of Fields workspace.

You can also add views, if it exists in the database. While adding Views to the Inventory of Tables and Fields, type the name of the View in the Table Name box and select the Indicator as V (virtual).

Pre-requisite: Before you add a field, the Database Administrator should add the field to the physical database and provide necessary access permission for the tables. After this is done, you should use the Inventory of Tables and Fields to set up a reference to that field.

To create a column/field in the Inventory of Tables and Fields:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the  Inventory of Tables and Fields workspace with the list of available fields.

  2. On the Home tab, click Create New and then select Field.
    You see the Create New Field dialog box.

  3. Click the Database Name list to select the database in which the physical column/field resides.
    You can select the database name by typing in the field or selecting from the list.

  4. Click the Table Name list to select the corresponding table in which the physical column/field resides.
    You can select the table name by typing in the field or selecting from the list. 
    Note: If the Table Indicator field is V (virtual), the Database and Table Name fields are disabled for editing.

  5. Enter the name of the column/field for which you want to set reference to in the Column/Field Name box.

  6. Enter a description about the column/field in the Description box.

  7. In the Use this as section, select either Update User Field or Updated Date Field checkbox. Note: This option is used to update user and date information in Eagle's Portfolio Data Center.
    - Update User Field: Select this option to update the Update User field in the table, whenever the column/field value is changed. 
    - Update Date Field: Select this option to update the Update Date field in the table, whenever the column/field value is changed. Note: This option is used to update user and date information in Eagle's Portfolio Data Center.

  8. Click the Storage Type list to select the storage type of the column/field.
    When you select storage type as String or Wide, the Size box is enabled. Note. If the storage type or size, does not match the attributes of the field within the physical table then the user is notified of such invalid entries.

  9. Select Show in editing screens check box to display the field in all the editing screens. Options include:
    - Make required: Select this option to make the field as a mandatory one, that is, you are not allowed to save the window without actually populating the field with a value.
    - Show as read only: Select this option to make it as read only field, that is, it is not an editable field.

  10. Enter a unique XML tag for the column/field in the XML tag box. The name should begin with Capital letters.

    This XML tag is used to identify the specific xsd for the field in Eagle portal.

  11. Select a field to set as reference in the Reference Field list, if required.
    This is a field attribute of Inventory of Fields, which has a reference code attached to it in the place of the Reference Field parameter. 
    Enter a unique tag for the field in Eagle Star tag box.
    Tags are numeric identifiers that corresponds to field's in Eagle Data Model.
    Select a Lookup Type from the drop-down list. Options include:
    –  None
    –  Underlying Security
    –  Issuer
    –  Entity
    –  Business Calendar
    –  Source
    This is used to add a field in the Reference Data Center and Portfolio Data Center screens to place a lookup other than a code value, for example, like a list of business calendars or sources, or an underlying Security linked to the security being looked at.

  12. Click Add to add the column/field name.
    You see the added field gets listed in the below grid with field name, description, database and table name.

  13. Repeat the steps to add another column/field. 

  14. Click Save All to save the created column/field.
    The system creates the column/field and lists it in the Inventory of Tables and Fields workspace.

Edit Tables and Fields

You can view and edit the current list of tables and fields within the Inventory of Table and Fields workspace.

To edit tables in the Inventory of Tables and Fields:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. To view tables only, under View section, click Tables.
    You see the list of available database tables.

  3. To edit a table, select the table you want to edit, and then click Edit on the Home tab.
    You see the Edit table dialog box.

  4. Make the appropriate changes, as required.

  5. Click Save.
    You see the revised table listed in the Inventory of Tables and Fields workspace.

 

To edit fields in the Inventory of Tables and Fields:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. To view fields only, under View section, click Fields.
    You see the list of available fields.

  3. To edit a field, select the field you want to edit, and then click Edit on the Home tab.
    You see the Edit field dialog box.

  4. Edit the Column/Name field, if required.

  5. You can click on the Description box and update the field description.

  6. Click the Storage Type list to change the storage type, if required.

  7. You can click on the XML Tag box and update the XML tag.

  8. Select a Reference field from the drop-down list.

  9. You can click on the Eagle Star Tag box and enter an Eagle Star tag.

  10. Select a Lookup Type from the drop-down list. Options include:
    –  None
    –  Underlying Security
    –  Issuer
    –  Entity
    –  Business Calendar
    –  Source

  11. Click Save All to save the changes.
    You see the revised field listed in the Inventory of Tables and Fields workspace.

Validate Tables and Fields

In Inventory of Tables and Fields workspace, you can validate the table or field against the physical Eagle Data Management database to see if the table or field actually exist.

To validate table or field:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. Select the table or field you want to validate.

  3. On the Home tab, in the Actions group, click Validate and select Table or Field.
    You see a message stating that the table/field is valid, if the table/field exist in the physical database.
    Otherwise, you see a message stating that the table/field does not exist, if the table/field does not exist in the physical database.

Get Fields

In Inventory of Tables and Fields workspace, you can retrieve fields from the physical table.

To get fields of the table:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. Select the table, for which you want to retrieve the fields.

  3. On the Home tab, in the Actions group, click Get Fields.
    You see a warning message to confirm the action.

  4. Click OK to get fields from the database.
    You see a confirmation message stating all fields for the table is retrieved.

  5. The system retrieves all the fields from the physical database and adds it to the selected table in the Inventory of Tables and Fields workspace.

Synchronize with Metadata

In Inventory of Tables and Fields workspace, you can synch your inventory of fields with their field attributes. Both the field attribute and the corresponding reference code are synchronized by using the Synch option.

To synchronize with metadata:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. Select the table for which you want to synch your inventory of fields with their field attributes.

  3. On the Home tab, in the Actions group, click Metadata Synch.
    On successful synchronization, you see a confirmation message for the synch.

  4. Otherwise, you see the Metadata Synch Results dialog box listing the fields which have multiple field attributes mapped to them.

Duplicate Tables or Fields

To duplicate tables/fields in the Inventory of Tables and Fields:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. Select the table or field that you want to duplicate.

  3. On the Home tab, click Duplicate.
    You see the Create New Table/Create New Field dialog box

  4. Update the fields following the steps outlined in Create New Tables and Fields.

  5. Click Save.
    You see the duplicated table/or field listed in the Inventory of Tables and Fields workspace.

Delete Tables and Fields

To delete tables/fields in the Inventory of Tables and Fields:

  1. From the left navigation, click Setup > Metadata > Inventory of Tables and Fields.
    You see the Inventory of Tables and Fields workspace with the list of available database tables.

  2. Select the table or field that you want to delete.

  3. On the Home tab, click Delete.
    You see a message stating successful deletion of Table or field. The table/field is deleted from the system.