Setting up the mapping file

  1. Create a file using this specific format:
    Index Subject area name Fully qualified object name (attribute, measure, or expression) Mapped name Tenant ID Locale
    1 Default subject area Attributes.Categories.CategoryID Kategorie ID 101 de_DE
    2 Default subject area Measures.Quantity Anzahl 101 de_DE
    3 Custom subject area 1 Products.ProductName Prod2 102 en_IN
    4 Custom subject area 1 Products.Description Desc2 102 en_IN

    File format rules guidelines:

    • The fully qualified object name and mapped name columns are required.
    • The subject area column is optional if you have only one subject area.
      • The fully qualified object name syntax is as follows for the default subject area:
        • Measures.MeasureName
        • Attributes.DimensionName.AttributeName
        • Measures.MeasureName.AnalyzeByDate
        • SavedExpression('SavedExpressionName') (these are Visualizer variables that have been marked Make Global).
      • The fully qualified object name syntax for custom subject areas uses the folder structure, for example:
        • FolderName.MeasureName
        • FolderName.FolderName.MeasureName
        • FolderName.FolderName.AttributeName
        • FolderName.FolderName.AttributeName
        • SavedExpression('SavedExpressionName') (these are Visualizer variables that have been marked Make Global).
        • FolderName.FolderName.MeasureName.AnalyzeByDate
    • The subject area column is optional if you have only one subject area.
    • It is helpful to add an index column in case you need a primary key.
    • If you define a query session variable geared towards individual users, set up a Locale column with the values of the Birst language setting. Do one of the following to get the Locale values:
      • Go to Admin > Manage Space > Command Window and run the listlanguages command to get the internal code used for a language. Then substitute the hyphen with an underscore. For example, change en-US to en_US.
      • Go to Admin > Define Sources > Query Admin and run this query SELECT 'V{UserLocale$}' FROM [ALL]. This displays the current possible values of UserLocales$ in the current space.

      Later in the query variable, use the UserLocale$ built-in session variable, which returns the value of the user's Language setting, in a WHERE clause.

    • If you are in an OEM multi-tenant environment, you can use a TenantID or equivalent column in a WHERE clause.
  2. Specify the terminology and mappings into the file.
  3. Upload the file. You can use Birst Connect, web services, or Admin > Define Sources > Upload File.
  4. In Admin > Define Sources > Data Flow, right-click on the source and check it as a discovery source.