File parameters

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

You can create File Parameters for registered datasets to update the file definition at the time of calling a semantic model process using REST/JAVA APIs. This gives the flexibility to use parameters in registered datasets in places like filter values and dynamic parts in SQL queries used in SQL-based files so that correct data is processed. 

When the file parameters are created, you can quickly pass appropriate values to be used in place of parameters while calling the semantic model process using REST/JAVA APIs.

Areas allowed to be parameterized in the registered dataset:

1. Filter values

2. Database name

3. Schema name

4. Table name

5. The file path for file-based registered dataset

6. A part of SQL query in SQL-based registered dataset

While processing a semantic model or data profiling, parameters along with their intended values are sent in the REST/JAVA APIs, which will be replaced at respective places in the registered datasets before job execution. You can pass the parameters for files in APIs for both semantic model processes (Test, Full, Incremental) and data profiling jobs (semantic model and registered datasets).

Points to remember: 

• If any parameter is present in the registered dataset but is not sent through REST/JAVA APIs, the default value is used from the file definition.

• In case a semantic model is designed over multiple registered files with each file having the same parameter name, then parameters will get replaced in each registered dataset.

• For the date type columns, provide the parameters in the mm/dd/yyyy format.

• You can see the parameter values with which the process job is executed in the Job Summary.

To create file parameters, perform the following steps.

1. On the Dataset page, click the three-dots menu, and select the Parameters option. Multiple parameters in the same file cannot have the same name.

2. On the Parameters dialog box, provide information as;

   1. Name: Unique parameter name that will be used while creating the registered datasets. 

   2. Description: Description of the parameter.

   3. Value: Default value of the parameter which will be used if the value for the given parameter is not provided in the semantic model process REST API. This value will be used in other file operations like preview, validation, save, and so on.

3. Once done, click Apply.