Oracle Cloud Infrastructure Documentation

Customize Oracle Analytics for Applications

You can customize the semantic model and job roles.

About Semantic Model Customization

Customizing the semantic model enables you to make the data that you moved into the data warehouse more useful for reporting.

You customize your semantic model by creating a customization branch and adding customization steps to that branch. A customization branch is a sandbox for applying your changes. You can apply the model from customization branch to a local test service instance. Once you are happy with the changes, you may merge that branch with the main branch. You can merge multiple such customization branches with the main branch over time. Once you have a set of changes ready for promotion, you can version the main branch, and then use that for promotion to the production environment.

You can customize the model by extending ready-to-use dimensions with additional attributes from another data source.

Create a Customization Branch

To begin customizing your semantic model, create a customization branch of the main semantic model.

You can add customizations to a Test instance only. After you have added and tested your customizations, you can promote them to the production environment. See Promote Your Customizations to the Production Environment.
  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, select the main development branch, click Actions menu, and then click Create New Branch to create a new customization branch as an empty container.
  4. In Create a New Branch, enter a name for your customization branch, for example, Add Cost Center.
  5. Optionally, add a description and click OK.
    You see the new customization branch in the Semantic Model Extensions page. You can add steps to the new customization branch container using the Add Step button or the customization branch menu. See Add a Step to a Customization Branch

Edit a Customization Branch

Before you apply the customization branch to the main branch of your semantic model, you can edit the customization branch.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, under Customization Branch, hover over a customization branch to view the Actions menu.
  4. From the Actions menu, click Edit Branch, and then click Add Step.

Add a Step to a Customization Branch

You can add customization types such as "Extend a Dimension" as a step to an existing un-applied customization branch or a new customization branch that you create.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. In Semantic Model Customizations, hover on a customization branch to view the action menu.
  4. On the Semantic Model Extensions page, under Customization Branch, hover over a customization branch to view the Actions menu.
  5. From the Actions menu, click Edit Branch, and then click Add Step.
  6. In Add step, select a customization type. For example, Extend a Dimension.
    You see the wizard sequence to add details for the selected customization type.

Extend a Dimension

Extend ready-to-use dimensions with additional attributes from another data source.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. In Semantic Model Customizations, hover on a customization branch to view the action menu.
  4. On the Semantic Model Extensions page, under Customization Branch, hover over a customization branch to view the Actions menu.
  5. From the Actions menu, click Edit Branch, and then click Add Step.
  6. In Add step, select Extend a Dimension.
    You see the wizard sequence to extend a dimension.
  7. Enter a name for your customization, for example, Add Cost Center Type.
  8. Select a subject area, for example, Financials GL Profitability.
  9. In Folder, select a dimension that you want to extend, for example, Cost Center.
  10. Select a logical table, for example, Dim – GL Journal Details.
  11. Click Next.
  12. Select a schema and table from the database.
    You see the available attributes in the table.
  13. Select the columns that you want to expose or use as key for creating the join.
  14. Click in the Display Name table field to enter a new name for the column or to edit an existing one and then click Enter to accept or click Esc to cancel.
  15. Click Add Column to create a new column in the selected dimension table.
  16. In Create a new column, enter a display name, for example, Cost Type.
  17. Enter an expression, for example, Case when substring(cc_name,1,10) in ('FIXED','SEMI-FIXED') then 'Fixed' else 'Variable' End.
  18. Click Save.
  19. Click in the Source Column table field to edit the column definition.
  20. Click Save.
    You see the new column in the Data preview section in a highlighted color.
  21. Click Next.
  22. Select a join key to pair with the source column.
  23. Click Next.
  24. Select the subject areas that should use this customization.
    Note

    The Subject Area that you initially selected is selected by default and is read-only. By default all additional subject areas are selected. Deselect the additional subject areas that shouldn’t use this customization.
  25. Click Done.
    You see the new customization step in the customization branch. You can now apply the customization branch to the main branch or edit it to add more steps.

Edit or Delete a Customization Branch Step

Edit a step to modify the details or delete it if it's no longer required.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, under Customization Branch, click a branch to display the steps.
  4. Hover over a step to view the Actions menu.
  5. Click Edit Step and update the details.
  6. Click Delete Step to remove it from the customization branch.

Merge a Customization Branch with the Main Branch

Merge the customization branch with the main branch to use the customization steps as the sequence of steps.

The main branch lives in the test environment. When you edit a customization branch, the system automatically locks it to prevent another user from simultaneously editing the same branch. As you complete each step or reorder the steps, the system unlocks the customization branch, saves it, and notes the change in the change log tab.
  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, under Customization Branch, hover over a customization branch to view the Actions menu.
  4. From the Actions menu, click Merge to Main Branch, and then click Ok.

    The system updates the time stamp on the main branch and you see an indicator on the main branch that changes have been applied since the last version was saved.

    While applying a customization branch to the main branch, if the system detects that a new version has since been saved, then your check-in is out of sync. You see a message explaining that the system has detected a sync conflict. For example:
    1. You create a customization branch based on main branch version 1.0.
    2. You add steps to your branch.
    3. Meanwhile, a new version of main branch saved as 1.1.
    4. You attempt to check in your customization branch.
    5. The system detects a sync conflict and notifies you.

Reorder Customization Branch Steps

You can reorder the steps in a customization branch that has been applied or is yet to be applied to the main branch.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, under Customization Branch, click a customization branch to display the steps.
  4. Click Reorder Steps to enable Drag mode to reorder the steps.
    You see the drag handles appear on each row. The branch menu and Add Step button aren’t available during the reorder process.
  5. Drag and drop the steps in the new order that you want.
  6. Click Done Reordering.
    You see a validation message and after the validation is complete, the branch menu, Add Step, and Reorder Steps buttons are available.
  7. Click Merge to Main Branch to re-apply this customization branch and update the main branch with the changes.

Create a Version of the Main Branch

Once you have a set of customizations ready for promotion and merged them with the main branch, you must version the main branch and promote the version to the production environment.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. On the Semantic Model Extensions page, under Main Development Branch, hover over the Main branch to view the Actions menu.
  4. From the Actions menu, click Create a New Version.
  5. In the Create a New Version dialog, enter a name of the main branch version.
  6. Select a merged branch that you want to include in this version.
  7. Click OK.

Download the Semantic Model File

You can download the semantic model file of the main development branch and the customization branches.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. To download the data model file of the main development branch, select the Main branch, click Actions menu, and then click Download Model.
  4. To download the data model file of a customization branch, select the customization branch, click Actions menu, and then click Download Model.

Test a Branch

You can test the main development branch and the customization branches to ensure that there are no errors.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Semantic Model Extensions.
    You see the Semantic Model Extensions page listing the main branch of your semantic model file and any existing customization branches.
  3. To test the main development branch, select the Main branch, click Actions menu, and then click Test Branch.
  4. To test a customization branch, select the customization branch, click Actions menu, and then click Test Branch.

Load Customization Data to the Autonomous Data Warehouse

You can load your customization data to the autonomous data warehouse provisioned with your Oracle Analytics for Applications instance.

  1. Connect to the autonomous data warehouse corresponding to your Oracle Analytics for Applications instance.
    You need the autonomous data warehouse wallet and credentials. Credentials to connect as the Administrator is same as what you mentioned for the autonomous data warehouse resource while creating the Oracle Analytics for Applications instance. See Create an Oracle Analytics for Applications Instance
  2. Create custom schema to house the customization data.

    Syntax : create user <custom_schema-name> identified by <custom_schema-password>

    Example: create user example_schema identified by abcDEF123654;

  3. Create one or more tables in the custom schema that you created.

    Syntax : CREATE TABLE <custom_schema-name>.<custom_extent_table_name> (<parameters>));

    Example: CREATE TABLE example_schema.ABC_EXTN ("DATE" DATE, "CATEGORY" VARCHAR2(1024 BYTE) , "MANAGER" VARCHAR2(1024 BYTE) );

  4. Populate the required data and grant select permissions to OAX$OAC.

    Syntax : grant select on <custom_schema-name> to OAX$OAC;

    Example: grant select on example_schema.ABC_EXTN to OAX$OAC;

  5. Commit the changes to the autonomous data warehouse and disconnect.

Promote Your Customizations to the Production Environment

Once you have a set of changes to the semantic model and job roles ready for promotion, you can version the main branch, and then use that for promotion to the production environment.

  1. Sign in to your service.
  2. In Oracle Analytics for Applications, open the Application Navigation menu, click Console, and then click Promote Objects.
    You see the Promote Objects page.
  3. On the Promote Objects page, select the options to publish the saved version of the main branch of your Oracle Analytics for Applications instance to another environment, and then click Promote.
  4. Click Check Status to view the progress.