Onboarding Models

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.

Model onboarding supports two modes:

Automated Onboarding – Upload Excel specification files at the start of onboarding. The system uses these files to pre-select and auto-recommend asset-to-column mappings across the relevant onboarding steps, reducing manual effort.
Manual Onboarding – Configure each step individually by selecting tables and columns without uploading specification files.

Note:

You cannot onboard models in Draft state.
If mappings already exist in the Data Catalog (DC), they are automatically shown when you onboard for the first time.

Onboarding a Process Pipeline Using Automated Onboarding

Automated onboarding uses uploaded Excel specification files to generate recommendations across the onboarding steps. The guided process includes an additional first step, Model Specifications Set Up, where you upload the files before proceeding.

The Model Specifications Set Up screen contains two upload sections:

Input Specifications – Upload an Excel file (.xlsx or .xls) that automates the configuration of Step 2 (Source Data Selection), Step 3 (Date Management), and Step 4 (Input Variable Mapping). The status indicator changes to “Uploaded” once the file is successfully uploaded, and a confirmation message is displayed below the upload area. •
Output Specifications – Upload an Excel file (.xlsx or .xls) that automates the configuration of Step 5 (Output Table Selection) and Step 6 (Output Metric Mapping). The status indicator changes to “Uploaded” once the file is successfully uploaded.

Note:

Uploading specification files is optional. If you do not upload files, you can still proceed and complete onboarding manually.

After uploading specification files, a Show Recommendations toggle appears at the top right of the Source Data Selection, Date Management, Input Variable Mapping, and Output Table Selection pages. The toggle controls whether automated recommendations are displayed.

First visit (first-time onboarding): The toggle is ON by default. Recommended items are displayed with a “Recommended” chip and are auto-selected.
Subsequent visits (returning to a step in the same session): The toggle remains ON, and recommendations continue to display.
Returning after closing the guided process: The toggle is OFF by default. You can turn it on manually to view recommendations, but previously saved selections are retained. Recommendations are shown but not auto-selected.

To onboard a model using automated onboarding:

Login to STSA.
In the Workspace Summary, Sandbox tab, select the required workspace.
Click Building Blocks and under the Model tile, click View.
The Model Summay page is displayed.
To onboard a model, click Actions and then click Onboard against the model.
The Model Specifications Set Up page opens.

Note:
If mappings already exist in the Data Catalog (DC), they are automatically shown when you onboard for the first time.
In the Input Specifications section, drag and drop or click to browse and upload the Excel file (.xlsx or .xls) that defines your model’s input specifications.
When the upload is complete, the status changes to Uploaded and a confirmation message is displayed.

In the Output Specifications section, drag and drop or click to browse and upload the Excel file (.xlsx or .xls) that defines your model’s output specifications.

When the upload is complete, the status changes to Uploaded and a confirmation message is displayed.

Note:

For Input Specifications and Output Specifications, the automated onboarding works only when the uploaded Excel file follows one of the supported template formats. Uploading a generic Excel file or an Excel file with unsupported column headers may prevent the system from generating recommendations as expected.

The following Excel template structures are currently supported for pipeline onboarding automation:

Table 6-1 Excel template supported for pipeline onboarding automation

Template	Supported Column Headers
Template 1	Logical Table Name, Physical Table Name, Description
Template 2	Subject Area, Physical Table Names, Description
Template 3	Column, Table
Template 4	Entity Name, Column Name
Template 5	Entity Name, Column Name1, Column Name2, Column Name3
Template 6	Entity Name, Table Name, Table Description, Attribute Name, Column Name, Column Description, Column Domain, Column Is PK, Column Is FK, Null Allowed, Column Datatype, LLFP

Use only these supported Excel templates for Input Specifications and Output Specifications uploads. The column names in the file must match the accepted template structure so that onboarding automation can read the file and generate table, column, and mapping recommendations.

Click Continue.
The Source Data Selection page opens.
In the Source Data Selection page, the Show Recommendations toggle is ON by default when an input Excel file is present. Recommended tables are auto-selected with a "Recommended" chip. Do the following:
1. Review the pre-selected tables. Deselect any tables you do not want to include, or select additional tables as required.
2. Click Continue.
  An Information dialog is displayed with the message: "The assets selected in this step will be considered for generating auto-suggestions for asset-to-column level mappings in the subsequent steps: Date Management and Input Variable Mapping."
3. Click OK to proceed.
In the Date Management page, the Show Recommendations toggle is ON by default. The Assets Mapped Status column displays the mapping status and the number of new suggestions for each logical reference. Do the following:
1. To map assets, click the Actions menu for a logical reference and select Map Assets.
  
  Note:
  The preseeded Logical Reference Mappingcalled Reporting Date will be available by default for FIC MIS Date column.
  
  The Logical Reference Mapping panel opens, displaying recommended source table and column combinations with a “Recommended” chip. The recommended entries are pre-selected.
2. Review the pre-selected recommendations. Deselect any entries you do not want, or add additional entries manually using the Source Table and Column Name drop-down lists.
3. Click Save.
4. Repeat for each logical reference as required.
5. Click Continue.
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.
In the Input Variable Mapping page, the Show Recommendations toggle is ON by default. The Assets Mapped column displays the mapping status and the number of new suggestions for each logical reference. Do the following:
1. To map assets, click the Actions menu for a logical reference and select Map Assets.
  The Logical Reference Mapping panel opens, displaying recommended source table and column combinations with a “Recommended” chip. The recommended entries are pre-selected.
2. Review the pre-selected recommendations. Deselect any entries you do not want, or add additional entries manually using the Source Table and Column Name drop-down lists.
3. Click Save.
4. Repeat for each logical reference as required.
5. Click Continue.
In the Output Table Selection page, the Show Recommendations toggle is ON by default and recommended output tables are displayed with a “Recommended” chip. Do the following:
1. Review the recommended output tables. Select or deselect as required.
2. Click Continue.
  An Information dialog is displayed with the message: "The assets selected in this step will be considered for generating auto-suggestions for asset-to-column level mappings in the Output Metric Mapping step."
3. Click OK to proceed.
In the Output Metric Mapping page, do the following:
1. To map assets, click the Actions menu for a logical reference and select Map Assets.
  The Logical Reference Mapping panel opens, displaying recommended source table and column combinations with a “Recommended” chip. The recommended entries are pre-selected.
2. Review the recommended entries and select or deselect as required.
3. Click Save.
4. Repeat for each logical reference as required.
5. Click Continue.
In the Portfolio Mapping page that opens, do the following.
- To create a new Portfolio:
  1. Click Create New
  2. In the confirmation dialog 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.
- To use an existing Portfolio:
  1. Select the required portfolio.
  2. Click Continue.
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.
Do either of the following:
- Click Save or Save and Close to save and continue later.
- Click Submit to complete the onboarding process..
Note:
- When you click Onboard on the Process Summary screen, the process is published to Data Catalog (DC).
- For models, publishing happens separately from the Model Definition screen when you click Publish Model.

Onboarding a Model Using Manual Onboarding

Manual onboarding allows you to configure each step individually by selecting tables and columns without uploading specification files. You can skip the Model Specifications Set Up step or upload files for only one of the two specification types.

To onboard a model using manual onboarding:

Login to STSA.
In the Workspace Summary, Sandbox tab, select the required workspace.
Click Building Blocks and under the Models tile, click View.
The Models Summary page is displayed.
To onboard a model, click Actions and then click Onboard against the model.

The Model Specifications Set Up page opens.

Note:
If mappings already exist in the Data Catalog (DC), they are automatically shown when you onboard for the first time.
Click Continue without uploading any files to skip the automated specification setup and proceed with manual configuration.
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.
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.
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:
      
      In the Create Input Logical Reference page that opens, add a name display name, and description in the respective fields.
      
      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 assets:
  1. In the Actions column, select Map Assets.
  2. In the Asset field, select the desired table name from the drop-down list
  3. In the Column Name field, select the desired column name from the drop-down list.
  4. Click Add to add the entry.
  5. Click Save.
Note:
To unmap the logical reference, you must click Unmap Logical Reference > Yes.
In the Output Table Selection page, select the target output table for the pipeline results and click Continue.
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:
      
      In the Add Glossary page that opens, add a name, display name, and description in the respective fields.
      
      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 assets:
  1. In the Actions column, select Map Assets.
  2. In the Asset Name field, select the desired table name from the drop-down list.
  3. In the Column Name field, select the desired column name from the drop-down list.
  4. Click Add to add the entry.
  5. Click Save.
Note:
To unmap the logical reference, you must click Unmap Logical Reference > Yes.
In the Portfolio Mapping page that opens, do the following.
- To create a new Portfolio:
  1. Click Create New
  2. In the confirmation dialog 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.
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.
Do either of the following:
- Click Save or Save and Close to save and continue later.
- Click Submit to complete the onboarding process.