Derived Entity

Entity refers to a table in which data is stored. Derived Entity within the Infrastructure system facilitates you to define entities which are populated through a series of data transformation processes resulting from an existing Data Set or a Data Source. A Derived Entity can be used to define other Business Metadata such as measures, hierarchies, dimensions, data sets, and cubes.

The Derived Entity Summary window displays the list of pre-defined Derived Entities with their Code, Short Description, Long Description, Creation Date, Source Type, and Materialize View status. You can add, view, edit, copy, and delete a Derived Entity. You can search for a specific Derived Entity based on Code, Short Description, Source Type, and Authorization status. By clicking the Column header names, you can sort the column names in ascending or descending order. Click if you want to retain your user preferences so that when you login next time, the column names will be sorted in the same way. To reset the user preferences click  .

Based on the role that you are mapped to, you can access, read, modify or authorize Derived Entity. For all the roles and descriptions, refer to Appendix A. The roles mapped to Derived Entity are Derived Entity Access, Derived Entity Advanced, Derived Entity Authorize, Derived Entity Phantom, Derived Entity Read Only, and Derived Entity Write.

Creating Derived Entity

This feature allows you to create a Derived Entity based on a Data Set, an Entity or a union of Derived Entities. For Union and Union All options, the metadata used in the participating derived entities determines the columns of the physicalized materialized view. For Union based Derived Entity, even if the participating derived entities have metadata in common, the resultant materialized view in database will ensure unique columns. The same is explained in a tabular format:

Union Based DE

Participating DEs

Metadata present in participating DEs

Final physicalized materialized view for union based DE

UN001

DE001

MSR001

MSR002

MSR003

MSR001

MSR002

MSR003

MSR004

MSR005

DE002

MSR001

MSR004

MSR005

In case of Union All based definition, the resultant materialized view in database may have repetition of data based on data present in the participating derived entities.  

Note: To define a Derived Entity based on an Entity in a Data Source, you should have defined permissions for the particular Data Source in the Atomic schema.

You can approve a Derived Entity created by other users if you have the authorizer rights. You need to be mapped to the role Derived Entity Write to add or create a derived entity.

To create a Derived Entity:

  1. Click Add from the Derived Entity toolbar. The Derived Entity Details window is displayed.

  2. Enter the details as tabulated.

Field

Description

Code

Enter a distinct code to identify the Entity. Ensure that the code is alphanumeric with a maximum of 8 characters in length and there are no special characters except underscore "_".

Note the following:

  • The code can be indicative of the type of Derived Entity being created.

  • A pre-defined Code and Short Description cannot be changed.

  • Same Code or Short Description cannot be used for Essbase installation: "$$$UNIVERSE$$$", "#MISSING", "#MI", "CALC", "DIM", "ALL", "FIX", "ENDFIX", "HISTORY", "YEAR", "SEASON", "PERIOD", "QUARTER", "MONTH", "WEEK", "DAY".

Short Description

Enter a Short Description based on the defined code. Ensure that the description is of a maximum of 80 characters in length and does not contain any special characters except underscore "_, (, ), -, $".

Long Description

Enter the Long Description if you are creating subject-oriented Derived Entity to help users for whom the Derived Entity is being created or other details about the type/subject. Ensure that the description is of a maximum of 100 characters in length.

Source Type

Select the source type from the drop-down list. The options are Dataset, Entity, Union and Union All. The Union and Union All options are used to create a Derived Entity by combining 2 or more existing Derived Entities.

Aggregate

This field is enabled only if Source Type is selected as Dataset.

Turn ON the Aggregate toggle button to collate the information for the Derived Entity.

Materialize View

Turn ON the Materialize View toggle button if you are using Oracle database to create a Materialized View with the Derived Entity Name and short description.

Note: You cannot enable the Materialize View option if you are using IBM DB2 database.

Data Set Name

This field is enabled only if the Source Type is selected as Dataset.

Select the Dataset Name from the drop-down list. The Short Description for the Data Sets is available in the drop-down list to select.

Source Name

This field is enabled only if the Source Type is selected as Entity.

Select the Source Name from the drop-down list.

Refresh Interval

This field is enabled only if the Materialize View checkbox is selected.

Select the appropriate refresh interval from the drop-down list, The options are:

  • None- Only materialized view will be created. If you select None for Refresh Interval, it is mandatory to select None for Refresh Method.

  •  Demand- The refresh of the Materialized View is initiated by a manual request or a scheduled task.

  • Commit- The refresh is triggered by a committed data change in one of the dependent tables.

Refresh Method

This field is enabled only if the Materialize View checkbox is selected.

Select the appropriate refresh method from the drop-down list, The options are:

  • None- Only materialized view will be created. If you have selected None for Refresh Interval, it is mandatory to select None for Refresh Method.

  • Complete- This recreates the materialized view replacing the existing data. This can be a very time-consuming process, especially if there are huge amounts of data to be read and processed.

  • Fast- Applies the incremental changes to refresh the materialized view. If materialized view logs are not present against the source tables in advance, the creation fails.

  • Force- A fast refresh is attempted. If it is not possible, it applies Complete refresh.

Note: Refresh Methods Fast and Commit do not work if the query has some ANSI Join conditions.

Enable Query Rewrite

This toggle button is enabled only if the Materialize View toggle button is turned ON.

Turn ON the toggle button if you want to create materialized view with the query rewrite option.

Hint

Specify Hints (if any), for optimized execution of query. The specified hints are appended to the underlying query of the derived entity.

Oracle hints follow (/*+ HINT */) format.

For example, /*+ PARALLEL */.

On selecting the Data Set Name or Source Application Name, the respective fields are displayed in the Metadata for Source Type list.

  1. Double-click Metadata for Source Type. The list of Metadata defined on the selected Data Set or Application and Source is displayed.

  1. Click to expand the folders. Select the required metadata and click button. Click to select all metadata. You can select a metadata and click  to remove that metadata or click  to remove all selected metadata.

  2. Click Save. A confirmation dialog is displayed.

The details are displayed in the Derived Entity Summary screen.

Back to Top

Copying Derived Entity

You can copy the pre-defined Derived Entity details to create another entity. You should have the Derived Entity Write role mapped to your user group to copy a derived entity.

To copy a Derived Entity:

  1. From the Derived Entity Summary window, select the derived entity you want to copy and click Copy. The Derived Entity Details window is displayed

  2. Enter the required details. For more information, see Creating Derived Entity.

  3. Click Save.

Back to Top

Viewing Derived Entity Properties

You can view the metadata of the selected Derived Entity.

To view the existing Derived Entity definition details:

  1. From the Derived Entity Summary window, select the derived entity you want to view and click View. The Derived Entity Details window is displayed.

The View Derived Entity Details window displays the details of the selected Derived Entity definition. The User Info grid at the bottom of the window displays the metadata information about the Derived Entity definition created along with the option to add comments.

  1. Click Close.

Back to Top

Modifying Derived Entity

You can modify a Derived Entity definition as required. A Derived Entity definition in the un-authorized state (modified by other users) cannot be modified. You can modify Derived Entity if you have Derived Entity Write role mapped to your user group.

  1. From the Derived Entity Summary window, select the derived entity you want to modify and click Edit. The Derived Entity Details window is displayed.

  2. Modify the required details such as Short Description, Long Description and the metadata to be associated with the Derived Entity. For more information, see Creating Derived Entity.

  3. Click Save and update the details.

When you modify a Derived Entity which is mapped to other metadata definition, the Affected Metadata Dialog is displayed with the list of mapped Data Sets, Measures, and Hierarchies which gets auto updated. Click OK to confirm, else click Cancel.

Back to Top

Deleting Derived Entity

You can delete a Derived Entity that you have created or if you are authorized to do so. A Derived Entity in Unauthorized state (modified by other users) cannot be deleted. You can delete Derived Entity if you have the Derived Entity Write role mapped to your user group.

Delete function permanently removes the Derived Entity from the database. Ensure that you have verified the details as indicated below:

To delete a Derived Entity in the Derived Entity window:

  1. From the Derived Entity Summary window, select the derived entity you want to delete and click Delete.

  2. Click OK in the confirmation dialog.

Back to Top