Table of Contents

Search

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

Mappings

Mappings

Uploading a Visio template and configuring parameter properties

Uploading a Visio template and configuring parameter properties

Upload a Visio template for use in your organization. When you upload a Visio template, you can define template parameter properties, such as template parameter descriptions and display properties. You can also select a template image to visually represent the template data flow.
Display properties determine where and how a template parameter displays in the
mapping
task wizard.
After you upload a Visio template, you can edit the template. If you select a different template XML file, you can choose between the following options:
  • Reuse the existing mapplet and template parameter customizations.
    Data Integration
    uses the existing customization for mapplets and template parameters with names that match those from the previous file.
  • Discard the existing mapplet and template parameter customizations.
    Data Integration
    clears the existing customizations.
With both options, mapplets and template parameters that are not used in the new file are deleted. New mapplets and template parameters display in the task wizard.
  1. To upload a new Visio template, click
    New
    Components
    Visio Templates
    and then click
    Create
    .
    To edit a Visio template, on the
    Explore
    page, navigate to the Visio template. In the row that contains the Visio template, click
    Actions
    and select
    Edit
    .
  2. Complete the following template details:
    Template details property
    Description
    Template Name
    Name of the template.
    Location
    Project folder in which the Visio template resides.
    If the
    Explore
    page is currently active and a project or folder is selected, the default location for the asset is the selected project or folder. Otherwise, the default location is the location of the most recently saved asset.
    Description
    Optional. Description of the Visio template.
    Template XML File
    Visio template XML file to upload. Perform the following steps to upload a Visio template XML file:
    1. Click
      Select
      .
    2. Browse to locate and select the file you want to use, and then click
      OK
      .
    Template Image File
    Image file associated with the Visio template.
    Optionally, upload an image file. Use a JPG or PNG file that is less than 1 MB in size and 1024 x 768 pixels or smaller.
    Perform the following steps to upload an image file:
    1. Click
      Select
      .
    2. Browse to locate and select the file you want to use, and then click
      OK
      .
    To remove the selected template image file, click
    Clear
    .
  3. If the Visio template includes a mapplet template parameter, click
    Select
    to select a mapplet.
  4. Optionally, edit the template parameter label that appears in the
    mapping
    task wizard and provide a description of the template parameter. The description will appear as a tooltip.
  5. To edit the display properties for a template parameter, click the
    Edit
    icon and configure the following template parameter display properties:
    Template parameter display property
    Required/optional
    Description
    Default Value
    Optional
    Default value for the template parameter.
    Visible
    Required
    Determines if the template parameter displays in the
    mapping
    task wizard.
    Use to hide a template parameter that does not need to be displayed.
    Editable
    Required
    Determines if the template parameter is editable in the
    mapping
    task wizard.
    Required
    Required
    Determines if a template parameter must be defined in the
    mapping
    task wizard.
    Valid Connection Types
    Required for connection template parameters
    Defines the connection type allowed for a connection template parameter.
    Select a connection type or select
    All Connection Types
    .
    Logical Connection
    Optional
    Logical connection name. Use when you want the task developer to use the same connection for logical connections with the same name.
    Enter any string value. Use the same string for logical connections that should use the same connection.
    Connection template parameters only.
    Input Control
    Required for string template parameters
    Defines how the task developer can enter information to configure template parameters in the
    mapping
    task wizard.
    String template parameters only.
    Field Filtering
    Optional for condition, expression, and field input controls
    A regular expression to limit the fields from the input control.
    Use a colon with the include and exclude statements.
    You can use a combination of include and exclude statements. Include statements take precedence.
    Use semicolons or line breaks to separate field names.
    Use any valid regular expression syntax.
    For example:
    Include: *ID$; First_Name Last_Name Annual_Revenue Exclude: DriverID$
    Left Title
    Required for field mapping input controls
    Name for the left table of the field mapping display. The left table can display source, mapplet, and lookup fields.
    Left Field Filtering
    Optional for field mapping input controls
    Regular expression to limit the fields that display in the left table of the field mapping display.
    Use a colon with the include and exclude statements.
    You can use a combination of include and exclude statements. Include statements take precedence.
    Use semicolons or line breaks to separate field names.
    Use any valid regular expression syntax.
    For example:
    Include: *ID$; First_Name Last_Name Annual_Revenue Exclude: DriverID$
    Right Title
    Required for field mapping input controls
    Name for the right table of the field mapping display. The right table can display target, mapplet, and lookup fields.
    Right Data Provider
    Required for field mapping input controls
    Set of fields to display in the right table of the field mapping display:
    • All objects. Shows all fields from all possible right table objects.
    • <object name>. Individual object names. You can select a single object for the right table fields to display.
    • Static. A specified set of fields. Allows you to define the fields to display.
    Fields Declaration
    Required for field mapping input controls
    List of fields to display on the right table of the field mapping display.
    List field names and associated datatypes separated by a line break or semicolon (;) as follows:
    <datatype>(<precision>,<scale>)
    <field name1>; <field name2>;...
    or
    <datatype>(<precision>,<scale>)
    <field name1> <field name2>
    <datatype>(<precision>,<scale>)
    <field name3>
    If you omit the datatype,
    Data Integration
    assumes a datatype of String(255).
    Available when Static is selected for the Right Data Provider.
    Right Field Filtering
    Optional for field mapping input controls
    Regular expression to limit the fields that display in the right table of the field mapping display.
    Use a colon with the include and exclude statements.
    You can use a combination of include and exclude statements. Include statements take precedence.
    Use semicolons or line breaks to separate field names.
    Use any valid regular expression syntax.
    For example:
    Include: *ID$; First_Name Last_Name Annual_Revenue Exclude: DriverID$
    Aggregate Functions
    Required for expression and field mapping input controls
    Enables the display and use of aggregate functions in the
    Field Expression
    dialog box in the
    mapping
    task wizard.
    Label
    Required for custom dropdown input controls
    Label for an option to display in a custom dropdown.
    Click
    Add
    to add additional options. Click
    Remove
    to remove any configured options.
    Value
    Required for custom dropdown input controls
    Value for an option to display in a custom dropdown.
    Click
    Add
    to add additional options. Click
    Remove
    to remove any configured options.
  6. To add another step to the
    mapping
    task wizard, click
    New Step
    .
    You can name the step and rename the Parameters step.
  7. To order template parameters, use the
    Move Up
    and
    Move Down
    icons.
    You can use the icons to move connection template parameters to the Sources or Targets steps.
    You can use the icons to move template parameters from the Parameters step to any new steps.
  8. If you want to add advanced session properties, click
    Add
    , select the property that you want to use, and configure the session property value.
  9. Click
    OK
    .