Welcome to Rosetta Tutorial

This page will guide you through Rosetta: its navigation, its components, features and tools. The guide is organised as a series of practical tasks. In particular, the tutorial will guide you through a small refactor procedure that changes the location of TradeDate and remaps the FpML synonyms.

In this section, you will go through the following tasks:

  • Task 1: Signing into Rosetta
  • Task 2: Creating a new Workspace
  • Task 3: Ingesting FpML data document and viewing as CDM
  • Task 4: In Rosetta Design, navigating to type Trade
  • Task 5: Create dateOfTrade attribute on Trade
  • Task 6: Removing synonym on Trade -> tradeDate and rerunning Ingestion
  • Task 7: Adding synonym to Trade -> dateOfTrade and rerunning Ingestion
  • Task 8: Searching for usages of Trade -> tradeDate
  • Task 9: Signing out

Task 1: Signing into Rosetta

To sign into Rosetta, you can simply press the Rosetta button on the CDM Portal.

../_images/2019-08-09-16-10-44.png

Note

You will only see the Rosetta link if you are part of the beta.

Alternatively, sign in directly using https://ui.rosetta-technology.io with the same credentials as you use for the CDM Portal.

Task 2: Creating a new Workspace

When you sign in for the first time, you will be directed first to the Workspace Manager. This will direct you to choose which of the standard read-only models you wish to use.

Create a workspace called “Tutorial”, then select the latest ISDA Common Domain Model (“CDM”) version and give a description of “ISDA CDM Tutorial”.

../_images/create-workspace1.png

Once the workspace is created you are presented with the main screen.

../_images/workspace.png

Task 3: Ingesting FpML data document and viewing as CDM

To ingest an FpML XML document, click on the Translate icon at the bottom banner. This will bring up a panel to the bottom of the screen.

../_images/translate_ingestion_explorer_overview.png

Download this sample FpML file and upload it using the Upload file button.

../_images/translate_ingestion_file_upload_sample.png

Click the play button to run the Ingestion.

../_images/translate_ingestion_file_upload_sample_run.png

Diagnostic Summary: This summary shows a pie chart with the percentage success calculated against an expected value for each of the following:

  • Mapping: These are the number of paths in the source file that have mapped successfully to paths in the target CDM
  • Validation: This result shows what percentage of validation rules passed for the qualified type

Clicking on the row once ingestion has completed, will take you to the details page.

../_images/translate_ingestion_viewer_upload_overview.png

There are three panels:

  • Diagnostics
    • Diagnostics of the ingestion
  • Input
    • The FpML document displayed in a tree view. You can view the XML by hitting the view as code button
  • CDM
    • The CDM document displayed in a tree view. You can view the JSON by hitting the view as code button
note:Notice that there is a green indicator at top right corner, that shows that we ran successfully and the Ingestion is up to date with the model.

On the second panel (Input), navigate to dataDocument > trade > tradeHeader > tradeDate

To see where the tradeDate maps to in the CDM, click on the date (2018-01-29). You will see the CDM panel open with the correct attribute selected.

../_images/translate_ingestion_field_mapping.png

For more details see Translate documentation.

Task 4: In Rosetta Design, navigating to type Trade

To navigate to Trade, click on the Go to symbol button on the Design Toolbar and then type in “Trade”.

As you type, you will see matching model elements.

../_images/symbol-search.png

Task 5 : Create dateOfTrade attribute on Trade

Scroll down to tradeDate and create a new attribute called dateOfTrade as follows

dateOfTrade date (1..1)
../_images/editor_add_attribute.png

Task 6: Removing synonym on Trade -> tradeDate and rerunning Ingestion

We want to remove the synonym from the tradeDate attribute. To do this, navigate to the synonym file synonym-cdm-fpml and delete the selected mappings below:

../_images/editor_delete_existing_synonyms_mapping.png

Navigate back to Rosetta Translate. Under uploads section the row will have a rerun option available to indicate that Translate results are no longer valid, click rerun to update.

../_images/translate_ingestion_rerun.png

After it is finished, navigate to the results page. You will notice that the tradeDate is no longer mapped.

../_images/translate_ingestion_mapping_failure.png

The red items show that tradeDate is no longer mapped to the CDM as we removed the synonyms.

Task 7: Adding synonym to Trade -> dateOfTrade and rerunning Ingestion

Now we want to add a synonym to the new dateOfTrade attribute we added.

Click on the back button in the Design Toolbar a few times to take you back to Trade mapping file.

Add in the new synonym:

[value "tradeDate" meta "id"]
[value "tradeDate" path "tradeHeader" meta "id"]
../_images/editor_add_synonyms_mapping.png

Navigate back to Rosetta Translate again, and rerun the Ingestion as we did before and check to see where the date is mapped to.

../_images/translate_ingestion_field_mapping_new.png

We have successfully moved the trade date in the CDM.

Task 8: Searching for usages of Trade -> tradeDate

To find all places in the model where the old tradeDate is used, right click on the attribute and select Peek and then Peek References.

../_images/peek_reference_menu.png

This will show you all the places in the CDM where it is used.

../_images/peek_references.png

Pressing the links on the right hand side will show you the places it is used in the model.

Task 9: Signing out

To finish the session, sign out using the menu on the top right of the screen.

../_images/logout1.png