6.2.4 Onboarding Models

The models onboarding process depends on the data ingestion and mapping activities performed in the workspace. Models available for onboarding are driven by the source pipelines and processes configured during workspace preparation.

To onboard models:

Note:

You cannot onboard the models in Draft state.
  1. Login to STSA.
  2. In the Workspace Summary, Sandbox tab, select the required workspace.
  3. Click Building Blocks and under the Models tile, click View.
    The Models Summary page is displayed.
  4. To onboard a model, click Actions and then click Onboard against the model.

    Note:

    If mappings already exist in the Data Catalog (DC), they are automatically shown when you onboard for the first time.
  5. In the Source Data Selection page that opens, select the input data tables or files the model requires to execute its calculations and click Continue.
  6. In the Date Management page, do either of the following:
    • To create a new logical reference, do either of the following:
      • Click Add New and do the following:
        1. In the page that opens, select the logical references to add.
        2. Click Select.
      • Click Create New and in the Create Date Logical Reference page that opens, do the following:
        1. In the Name field, enter a name.
        2. In the Display Name field, enter a display name.
        3. In the Description field, enter a description.

        Note:

        • The Reporting Date is always present by default in the summary, as it is mandatory.
        • If the source tables contain a FIC_MIS_DATE column, the mapping for Reporting Date is pre-suggested automatically.
        • For any other date-related logical references, you must manually select the table and column.
        • To delete the logical reference, you must click Unmap Logical Reference > Yes.
        • After you create a logical reference, the newly created logical reference is automatically selected in the Add Logical Reference screen.
    • To map the assests:
      1. In the Actions column, select Map Assests.
      2. In the Coulmn Name field, select the desired value from the drop-down list.
      3. In the Date Format field, select the desired date format from the drop-down list.
      4. Click Continue.

        Note:

        After completing the mapping, ensure that the logical reference is mapped to the corresponding table and column in OpenMetadata (OM).
  7. If you click Continue, the Input Variable Mapping page opens..
    • To create a new Input Variable Mapping:
      1. Click Add New
      2. In the Add Logical Reference For Input page that opens, do either of the following:
        • Select logical references to add and click Select.
        • Click Create New and do the following:
          1. In the Create Input Logical Reference page that opens, add a name display name, and description in the respective fields.
          2. Click Save.

            Note:

            After you create a logical reference, the newly created logical reference is automatically selected in the Add Logical Reference screen.
      3. Click Continue.
    • To map the assests:
      1. In the Actions column, select Map Assests.
      2. In the Assest field, select the desired table name from the drop-down list.
      3. In the Coulmn Name field, select the desired column name from the drop-down list.
      4. Click Add to add the entry.
      5. Click Save.

      Note:

      After completing the mapping, ensure that the logical reference is mapped to the corresponding table and column in OpenMetadata (OM).

    Note:

    To unmap the logical reference, you must click Unmap Logical Reference > Yes.
  8. In the Output Table Selection page, select the target output table and click Continue., select the target output table for the pipeline results and click Continue.
  9. In the Output Metric Mapping page that opens, do the following.
    • To create a new Output Metric Mapping:
      1. Click Add New
      2. In the Add Logical Reference page that opens, do either of the following:
        • Select logical references to add and click Select.
        • Click Create New and do the following:
          1. In the Add Glossary page that opens, add a name, display name, and description in the respective fields.
          2. Click Save.

            Note:

            After you create a logical reference, the newly created logical reference is automatically selected in the Add Logical Reference screen.
      3. Click Continue.
    • To map the assests:
      1. In the Actions column, select Map Assests.
      2. In the Assest Name field, select the desired table name from the drop-down list.
      3. In the Coulmn Name field, select the desired column name from the drop-down list.
      4. Click Add to add the entry.
      5. Click Save.

      Note:

      After completing the mapping, ensure that the logical reference is mapped to the corresponding table and column in OpenMetadata (OM).

    Note:

    To unmap the logical reference, you must click Unmap Logical Reference > Yes.
  10. In the Portfolio Mapping page that opens, do the following.
    • To create a new Portfolio:
      1. Click Create New
      2. In the Are you sure to create a new Portfolio? Changes will be saved as Draft and you will be redirected to portfolio definition page dailog box that appears, select Yes.
      3. Provide a portfolio name and description in the Basic Details section and click Next.
      4. Select the required hierarchies from the dimensions in the Select Dimensions section and click Next.
      5. Select the heirearchy nodes for the dimensions that you selected in the previous step and click Next.
      6. Review the entries and click Save.

        Note:

        The portfolios created during Pipeline Onboarding are automatically saved and displayed in the Portfolio Summary screen.
    • To use an existing Portfolio:
      1. Select the required portfolio.
      2. Click Continue.
  11. In the Review & Submit page that opens, verify all defined configurations and finalize the model onboarding process. Do the following:
    1. Review the Alert section to identify any configuration issues.
    2. If Critical alerts are displayed, click the corresponding Actions icon.
    3. Complete the required mappings on the relevant configuration pages.
    4. Return to the Review & Submit page and verify that all alerts are resolved.
  12. Do either of the following:
    • Click Save or Save and Close to save and continue later.
    • Click Submit to complete the onboarding process.