Table of Contents

Search

  1. Preface
  2. Mappings
  3. Parameters
  4. CLAIRE recommendations
  5. Data catalog discovery
  6. Visio templates

Mappings

Mappings

Parameter files and user-defined parameters

Parameter files and user-defined parameters

A parameter file is a list of user-defined parameters and their associated values. You can use user-defined parameters in Visio templates and
mapping
tasks.
Use a parameter file to define values that you want to update without having to edit the Visio template or the
mapping
task. For example, you might use a user-defined parameter for a sales quota that changes quarterly. Or, you might configure a task to update user-defined parameter values in the parameter file at the end of the job, so the next time the job runs, it uses the new values.
You can include user-defined parameters for multiple Visio templates or
mapping
tasks in a single parameter file. You can also use multiple parameter files for different Visio templates or tasks. The
mapping
task reads the parameter file before a task runs to determine the start values for the user-defined parameters used in the task.
User-defined parameter values are treated as String values. When you use a user-defined parameter in an expression, use the appropriate function to convert the value to the necessary datatype. For example, you might use the following expression to define a quarterly bonus for employees:
IIF((EMP_SALES < TO_INTEGER($$SalesQuota), 200, 0)
To use a parameter file, perform the following steps:
  1. Use a user-defined parameter in a Visio template or
    mapping
    task.
    • Use two dollar signs to name the parameter, as follows: $$<user-defined_parameter>.
    • When you use the user-defined parameter in an expression, convert the String parameter value to the appropriate datatype as necessary.
    • If you use a user-defined parameter in a filter, start the filter with the user-defined parameter.
  2. Use the following format for the parameter file:
    [Global] $$<user-defined_parameter>=value $$<user-defined_parameter2>=value2
    For example:
    [Global] $$SalesQuota=1000 $$Region=NW
    The value of a user-defined parameter includes any characters after the equals sign (=), including leading or trailing spaces. User-defined parameter names are case-sensitive.
    You can save the file as several different formats, such as *.txt, *.doc, or *.param.
  3. Save the parameter file to a directory local to the Secure Agent to run the task.
    Use the following directory:
    <Secure Agent installation directory>/apps/Data_Integration_Server/data/userparameters
  4. Enter the parameter file name on the
    Schedule
    page of the
    mapping
    task wizard.