Manage Direct and Derived Fields

Owned by Pamela Totas (Deactivated)
Last updated: Sept 21, 2023
7 min read

In Direct and Derived Fields workspace, you can create, modify and delete direct and derived field attributes.

Field attributes are a major component of the Metadata layer. Direct Field Attribute points to a specific column in the database. It allows you to customize the fields in the database which is needed for associated process, for example, reporting. You must create a field attribute for each column in the database which is to be included in a report. The Derived Field Attributes are fields that are based on Direct Field Attributes. For instance, you can create a Derived Field Attribute that is the sum of two other Direct Field Attributes. 

Create Direct Field and Derived Fields

In the Direct and Derived Fields, you can create a Direct Field.

Create Direct Field

To create direct field:

  1. In the Setup workspace, in the left navigation pane, select  Metadata> Direct and Derived fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

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

  3. Type a name for the Direct Field in the Name box.
    For example, provide a name, which best describes the name of the column for which you are creating the Direct Field attribute. 

  4. Type a description about the field in the Description box, if required.

  5. In Format section, click the list to select the type of database format of the Direct Field. Options include:
    - Decimal
    - Character
    - Date
    - Character Numeric
    - Wide Character
    Note: Character Numeric converts a float (real number) to a description (character) or vice-versa. 

  6. Based on the selected format, the corresponding required option is enabled.

    • If you select Decimal format, type or select the decimal precision required for the field in the Precision box. By default, 2 is set.

    • If you select Character or Character Numeric or Wide Character, then click the Specify Translation Code list to select the translation code which allows you to associate the Direct Field with a cross-referenced list of codes and code values. If you do not associate this field attribute with a Translation code, then the data for this field is displayed as is in the associated process.

  7. Under Select Data Field section, select the corresponding database, table and field that is linked with the field.

    • Click the Database list to select a database corresponding to the Direct Field attribute.

    • Click the Table list to select a table corresponding to the Direct Field attribute.

    • Click the Field list to select the field corresponding to the Direct Field attribute

  8. You see the Field Properties, Permissions, and Options tabs with the Field Properties tab open by default.
    Use these tabs to define additional field attributes. Note: Depending upon the field type, the tabs appear.

  9. In the Fields Properties tab, provide the required details.

    • Click the Currency Process list to select the currency conversion method for the field. Options include:
      –  Begin Value
      –  End Value
      –  Begin Value Fixed
      –  End Value Fixed
      – Return Value
      This is used for on-the-fly currency conversions in case of reports. It determines the dates for the foreign exchange rate lookup. 

    • Click the Currency Type list to select the type of currency the field has. Options include: Base Currency or System Currency.
      This is used for on-the-fly currency conversions and determines what currency the source data is in.

    • Select Include Advanced Field Properties checkbox to display the additional field properties.

    • Click the Process list to select a calculation process for the field.
      You see the available list of process.

    • Click the Indicator list to identify the type of field.
      You see all the available list of indicators. This indicator is used to determine, how data is fetched from the physical database.

  10. In the Permissions tab, provide permission for the field attribute.

    • In Make available to other report types section, select either Defaults or Manual option to provide permission for the field attribute to use it in other report type.
      Defaults: If you select this option, then the Field Attribute is available to all the Report Types that you have access to.
      Manual: Click the Manual list to select one or more Report Types. Otherwise click All to select all the Report Types.
      For example, if Position Report Type is selected, then the Field Attribute is available to all of the Position Reports, which is you have access to – Single Period, Multi Period, Comparison and Range Reports.

    • Select Do not allow others to edit this field checkbox, if you do not want others to edit this Field Attribute.

  11. In the Options tab, provide additional options for the field attribute.

    • Click Specific Category list to select the appropriate category the Field Attribute belongs to.
      These user-defined categories are used for ease of retrieval when adding the Field Attribute to a report.

    • In Define Inventory Parameters section, enter a unique XML tag for the Field Attribute in the XML tag box. 
      This XML tag is used to retrieve data when a report is submitted and retrieved through the API as well as in Uploaders.

    • Enter a unique tag for the field in Eagle Star tag box.
      These tags link Eagle's Accounting metadata to Eagle's Data Management metadata. These STAR tags are used to run Uploaders dynamically.

    • In User Attributes Interface section, select Show this field check box to display the field in all the editing screens.

    • Select Disallow edit check box to make it as read only field, that is, it is not an editable field.

    • Select Required check box 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.

    • Select Update User check box to update the Update User field in the table, whenever the Field Attribute value is changed.

    • Select Update Date check box to update the Update Date field in the table, whenever the Field Attribute value is changed. 

    • In Define Field Identifier box, type an identifier for the Field Attribute. 

    • Click Source Override list to indicate the Field Attribute is specific to the selected source.
      This source is always used for the Field Attribute regardless of how the source is defined in the Source Rule.

  12. Complete the required settings and then click Save.
    The system creates the Direct Field and lists it in the Direct and Derived Fields workspace.

Create Entity Build Field

In the Direct and Derived Fields workspace, you can create Entity Build Field attributes which are required to run the Entity Build Process.

To create entity build fields:

  1. From the left navigation, click Setup > Metadata > Direct and Derived Fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

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

  3. Type a name for the Entity Build field in the Name box.
    For example, provide a name, which best describes the name of the column for which you are creating the Entity Build field attribute. 

  4. Type a description about the field in the Description box, if required.

  5. Select the type of field format for the Entity Build.

  6. Assign the appropriate Database, Table and Column for the Entity Build field attribute.

  7. In the Field Properties tab, select the required Currency Process and Currency Type for on-the-fly currency conversion.

  8. Click Calculation Type list to select a calculation type for the Entity Build field attribute. Options include:
    - Maximum
    - Mean
    - Minimum
    - Sum
    - Weighted Average

  9. Based on the selected Calculate Type, you need to define fields in Numerator and Denominator list.

  10. Provide appropriate information in the Permissions and Options tab. 

  11. Click Save to create the Entity Build Field.
    The system creates the Entity Build Field and lists it in the Direct and Derived Fields workspace.

Create Mutual Fund Field

In the Direct and Derived Fields workspace, you can create Mutual Fund field attributes which are 'background' fields to support Dynamic Mutual Fund Returns fields. Mutual Fund Field attributes is built using columns in the NAV table on the Holding database.

To create mutual fund fields:

  1. From the left navigation, click Setup > Metadata > Direct and Derived Fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

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

  3. Type a name for the Mutual Fund field in the Name box.
    For example, provide a name, which best describes the name of the column for which you are creating the Mutual Fund field attribute. 

  4. Type a description about the field in the Description box, if required.

  5. Select the type of field format for the Mutual Fund.

  6. Assign the appropriate Database, Table and Column for the Mutual Fund field attribute.

  7. In the Field Properties tab, select the required Currency Process and Currency Type for on-the-fly currency conversion.

  8. Click the Fund Process list to select the type of mutual fund processing. Options include:
    - Distribution 
    - Expense 
    - Retained Gain
    - Return of Capital
    - Waiver/Subsidy 

  9. Based on the selected Process Type, you need to set Reinvestment Date, Default Tax Rate, MFL Logging and Secondary Tax Rate.
    Note: The Secondary Tax Rate option is displayed only for Retained Gain fund process type. This is required to derive the excess tax payment equal to: (Retained gain * (1- long term tax)) - (Retained
    gain * (1- corporate tax)).

  10. Provide appropriate information in the Permissions and Options tab. 

  11. Click Save to create the Mutual Fund Field.
    The system creates the Mutual Fund Field and lists it in the Direct and Derived Fields workspace.

Edit Direct and Derived Fields

You can view and edit direct and derived fields.

To edit direct and derived fields:

  1. From the left navigation, click Setup > Metadata > Direct and Derived Fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

  2. Select the field you want to edit and then click Edit in Home tab.

  3. Review the information, make the appropriate changes, and click OK.
    You see the refreshed list of direct and derived fields.

Duplicate Direct and Derived Fields

You can duplicate direct and derived fields.

To duplicate direct and derived fields:

  1. From the left navigation, click Setup > Metadata > Direct and Derived Fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

  2. Select the field you want to duplicate and then click Duplicate in Home tab.
    You see the Duplicate dialog box.

  3. Type a new name for the field in Duplicate as box, and click OK.
    You see the refreshed list of direct and derived fields with the Duplicated field.

Delete Direct and Derived Fields

You can delete direct and derived fields.

To delete direct and derived fields:

  1. From the left navigation, click Setup > Metadata > Direct and Derived Fields.
    You see the Direct and Derived Fields workspace with the list of available direct and derived fields.

  2. Select the field you want to delete and then click Delete.
    You see a confirmation box asking you to verify your selection.

  3. Click OK.
    You see the refreshed list of direct and derived fields.
     If the field you want to delete is already used in a report or other associated process, then an alert message is thrown to the user before deletion.