Skip to main content

What's in Connection Schema

This section provides complete information on the definition of each field/parameter in the Connection schema file, specifying what and how to update each field value. The Connection file schema consists of six sheets, each with its own set of fields and purpose. Based on each section, connections, instances, parameters, and data tables are created.

General

This section captures general information that will be used for creating a new file connection. The file connection is created based on the details below.

Information required:

  • Name: File connection name to be created.

  • Description: Connection description for details.

  • Type: Type of file to be uploaded by users for this connection.

  • Prefix: To be used for creating the remote tables.

  • Load Workbook: Indicator to load the entire workbook (Y) or by worksheet (N).

Field

Type

Allowed Values

Validations

Name

Text

Free Text

Maximum 60 characters.

 

 

 

Start with alphabet.

 

 

 

Only special chars "-", "_" & Space allowed.

Description

Text

Free Text

Maximum 100 characters.

Type

Text

Excel Workbook

Default: Excel Workbook

 

 

CSV

 

 

 

TXT

 

Prefix

Text

3 digit characters

 

Load Workbook

Text

Y

Workbook is Imported.

 

 

N

Specific worksheets only.

Instance

The instance table is created based on the details below.

Instance Header

This section captures the Excel workbook instances to be created to import data.

  • Instance ID: Unique name that will be used to create the instance for remote tables for Excel sheets/workbook to be uploaded.

  • Apply to Sheets: Instance created to be applicable for different sheets referred here.

  • Instance Model: Existing model in the workspace, to be used as a reference for fields.

Field Type Allowed Values Validation

Instance ID

Text

Free Text

Maximum 60 characters.

Apply to Sheets

Worksheet name

Worksheet name

Applicable to only worksheet.

 

 

Worksheet prefix *

Applicable to all Worksheets with the prefix mentioned.

 

 

*

Applicable to all Worksheets.

Instance Model

Text

Model Name

Valid Model ID from the workspace.

Instance Fields

This section comprises instance details like fields and their reference:

  • Instance ID: Specify the instance ID created from the Instance Header sheet above.

  • Instance Field: Fields that would be identified for instance creation, which are variable for loading multiple sets of data.

  • Reference type: Fields defined above will need reference, either from the Excel file or user selection.

  • Reference: If the reference type is Excel file, you need to specify the reference cell.

Field

Type

Allowed Values

Validation

Instance ID

Text

Should be Instance ID defined in Instance Header sheet

 

Instance Field

Text

Only Field Names from the Instance Model

At least one field should be defined.

Reference type

Text

Enable Selection

Field value will be user selection during the data import execution step.

 

 

Workbook Cell

Field value will be retrieved from excel workbook specific cell.

 

 

Name Range

Field value will be retrieved from excel workbook name range 1st cell.

Reference

Text

Specific excel cell

Valid only for Reference type is Workbook cell.

 

 

Specific Name range

Valid only for Reference type is Name range.

Parameters

Refers to parameters that are required for the connection and their references to read data. The parameters table is created based on the details below.

Information required :

  • Instance ID: As created in the Instance Header sheet.

  • Parameters: List of parameters/variables for each instance values to be imported.

  • Parameter type: Type of parameter values to be recorded in the parameter table.

  • Linked Reference field: To link and map the parameter value to a specific field value.

  • Linked Reference Model: To link the model in the workspace to identify the fields.

  • Reference type: Identify where to retrieve the parameter value from for each parameter.

  • Reference: Specify the details of the reference type.

  • Ignore Blanks: Identifier to record the parameters even with blanks (Y) or not (N).

Field

Type

Allowed Values

Validation

Instance ID

Text

Should be Instance ID defined in Instance Header sheet.

 

Parameters

Text

Free Text

 

Parameter type

Text

Text

Default

 

 

Number

 

 

 

Field

Fields will refer to fields in a model selected as part of instance.

 

 

List

List will refer to fields (without linking to model).

Linked Reference field

Text

Specific Field within the Reference model

Mandatory for Parameter type "Field" / "List".

Linked Reference Model

Text

Specific Model within the Workspace

 

Reference type

Text

Workbook Cell

Reads from specific workbook cell.

   

Name Range Cell

Reads from specific Name Range.

   

VLOOKUP

Identifies from VLOOKUP value.

   

HLOOKUP

Identifies from HLOOKUP value.

Reference

Text

Specific excel cell

Valid only for Reference type is Workbook cell.

   

Specific Name range

Valid for Reference type is Name range.

   

Specific Name range

Valid for VLOOKUP/HLOOKUP

Note: Assumption of only 2 columns(VLOOKUP) or 2 rows (HLOOKUP)

Ignore Blanks

Y/N

Y

Parameter saved with blank value.

   

N

Parameter ignored if value is blank.

Tables

Data tables are created based on the details below.

Tables Header

  • Instance ID: As created in the Instance Header sheet.

  • Table Name: Unique ID for the data tables to be created, for each of the data range in Excel.

  • Table Description: Specify the description to identify the purpose of table data.

  • Reference type: Specify the reference of data to be retrieved from the Excel.

  • Reference: Reference type details.

  • Start Row for Column range: Start row to import data from (valid only for column range reference).

  • Has Column Header: Identifier to tag if table header exists.

  • No. of Header rows: Number of rows to ignore for header.

  • Skip first few data rows: Number of rows to be skipped before data starts from the start of the range.

  • Enable Rows to Field Mapping: Option to enable field mapping during data transformation.

Field

Type

Allowed Values

Validation

Instance ID

Text

Should be Instance ID defined in Instance Header sheet

 

Table Name

Text

Unique ID

Maximum 30 Chars and No Special Characters.

Table Description

Text

Free Text Description

Maximum 60 Chars.

Reference type

Text

Fixed Range

Specific cell range for rows & columns that will be retrieved for creating data table.

 

 

Name Range

Specific name range defined in the excel that will be retrieved for creating data table.

 

 

 

Column Range

Specific column range defined in the excel that will be retrieved for creating data table.

Note: Column range will be like uploading csv, where we select from which row, data is available and which row has header

Reference

Text

Specific Fixed Range

(Example: Sheet'!$A$67:$X$68)

 

 

Specific Name Range

(Example: _NCF or _PL or _DIV)

 

 

Specific Column Range

Example: C:I or Sheet!$B:$G)

Start Row for Column range

Number

Specify the start row

Valid only for Reference type = Column Range

Has Column Header

Y/N

Y

Column Header will be ignored

 

 

N

 

No. of Header rows

Number

0 & above

Header rows will be ignored

Skip first few data rows

Number

0 & above

Data range starts after skip rows

Enable Rows to Field Mapping

Y/N

Y

Column Header = Y, is prerequisite for this option

 

 

N

 

Tables Details

Data tables details are captured using the information below:

  • Table Name: As created in the Table header section, unique Table ID.

  • Field Name: Define the field names for each of the tables, each row/column in the table definition can be identified with field name.

  • Field Description: Specify the description for details of the field.

  • Field Type: Type of values that will be populated for the field.

  • Linked Reference Field: Link and map the field values from the specified field values.

  • Linked Reference Model: Link and map the fields from the specified model.

  • Axis: From the data range defined in Table header for each Table name, we would map row/column from the data range to remote fields for importing. Axis will help in specifying the row/column/measure to be populated for the field.

  • Reference: Data values details.

  • Column Range: For Axis = rows, meaning field values to be mapped from rows, specify the column range to transpose as field values.

  • Ignore Blanks: Identify to consider blanks as field values or not.

  • Ignore Zeros: Identify to consider zeros as field values or not.

Field Type Allowed Values Validation
Table Name

Text

as Created in the Table Header section

 

Field Name

Text

Unique field id

Maximum 30 chars, & No Special Characters.

Field Description

Text

Free text for details

 

Field Type

Text

Text

 

 

 

Number

 

 

 

Field

Fields will refer to fields in a model selected as part of instance.

 

 

List

List will refer to fields (without linking to model).

Linked Reference Field

Text

specify valid field ID

Fields within the instance model.

Linked Reference Model

Text

specify valid model ID within the workspace

Mandatory for Field type "Field" / "List".

Axis

Text

Columns

Field values are mapped from columns of data range specified.

 

 

Rows

Field values are mapped from rows of data range specified.

 

 

Measure

Data rows will be mapped to fields.

Reference

Text

Specify the number of column in the excel file data range to map using the below format:

Column_1,

Column_2,

Column_3...

For Axis = Columns

 

 

Row_1, Row_2, Row_3...

For Axis = Rows

 

 

Data

For Axis = Measure

Column Range

Text

Specify the column range to map the field values.

Example:

Column_2:Column_24

Applicable only for

Axis = Rows

Ignore Blanks

Y/N

Y

Field values will be mapped for blanks.

 

 

N

Blank field values will be ignored.

Ignore Zeros

Y/N

Y

Field values will be mapped for zeroes.

 

 

N

Zero field values will be ignored.

Was this article helpful?

We're sorry to hear that.