Submit a request

Pass parameters to an ADF pipeline

Avatar
Kepion Support
  • Updated
An Azure Data Factory (ADF) pipeline that loads or recalculates plan data usually needs to know who started it and which part of the plan to work on. Without that information, it has to process every member, every time. When a dashboard button runs a pipeline, you can map the pipeline's parameters on that button.
 
Each run then sends the pipeline:
  • who clicked the button
  • the run's activity
  • the filter selection of a form on the page
  • any other values you choose, such as a single dimension's selected members

Before you start

  • An ADF integration and a dashboard button that runs it; Trigger an ADF pipeline shows how.
  • Access to the pipeline in ADF Studio, to declare its parameters.
  • A form on the button's page, or on the header page, whose filters the pipeline needs.

Map the parameters

  1. In ADF Studio, open the pipeline and select the Parameters tab. Declare each parameter the pipeline needs, with its type, then publish the pipeline.

    The Parameters tab of an ADF pipeline declaring userId as Int, instanceFilters as Object, entityIds as Array and scenarioid as Int, outlined

  2. In Kepion Modeler, under Dashboards, open the dashboard, select Edit, and select the page with the button.
  3. Select the button's settings icon and open the Behavior tab. Type is Integration Action, and Integration is your ADF integration.
  4. In Context form, pick the form whose filters the pipeline needs, such as P&L Module Overview.
  5. Select Refresh from pipeline. The Parameters grid lists userId, activityId and instanceFilters as Kepion default, then every parameter the pipeline declares.

  6. For each declared parameter, open Source and pick where its value comes from. Here, entityIds takes Entity (Entity Hierarchy) (MemberId) and scenarioid takes Scenario (MemberId). Source offers only the options the parameter's type can take.

    The Behavior tab of the button with Integration Action, the ADF integration and the P&L Module Overview context form, and the Source list for a parameter open with Default, Custom and each filter dimension by MemberId or Name, outlined

  7. Select OK, then Save. In the app, pick the filters on the page, select ADF Pipeline, and select Run.

The run window lists Prepare pipeline parameters before Create pipeline run, and ends with Completed successfully.

The ADF Pipeline run window with every step successful and Prepare pipeline parameters outlined

With United States and Budget selected, the pipeline receives:

{
  "userId": 179,
  "activityId": 9021,
  "instanceFilters": {
    "Time": [{ "Hierarchy": "FiscalYear", "MemberId": 0, "Name": "All" }],
    "Entity": [{ "Hierarchy": "Entity Hierarchy", "MemberId": 2, "Name": "United States" }],
    "Scenario": [{ "Hierarchy": "Scenario", "MemberId": 3, "Name": "Budget" }],
    "Currency Type": [{ "Hierarchy": "Currency Type", "MemberId": 1, "Name": "Local Currency" }]
  },
  "entityIds": [2],
  "scenarioid": 3
}

In the pipeline, read a value with @pipeline().parameters.scenarioid, or one dimension of the selection with @pipeline().parameters.instanceFilters.Entity.

Tip: To see exactly what a run sent, open Monitor > Pipeline runs in ADF Studio and select the run's Parameters icon.

Kepion default parameters

Kepion sends three parameters on every run, with no setup in Kepion. The only requirement is that the pipeline declares them, with exactly these names. A pipeline that doesn't declare one simply doesn't receive it.
Parameter Type Value
userId Int
The Kepion user ID of the user who ran the pipeline.
activityId
 Int
The activity Kepion registered for the run.
instanceFilters
 Object
The filter selection of the button's context form: one key per dimension, each with the selected members.
  • No mapping needed.  The Parameters grid shows them as Kepion default, and they can't be changed or overridden.
  • Names must match exactly. Names are case sensitive, so userid or UserId in the pipeline doesn't receive the value.
  • Other types work too. userId and activityId can also be declared as Float, String or SecureString.   instanceFilters can also be declared as Array (one row per selected member), or as String or SecureString (the same content as JSON text).
  • instanceFilters needs a context form. It's filled from the form picked in Context form. With None, it's sent empty.

More options

  • Send text or a Kepion value. Pick Custom and type a value.
  • Leave a parameter to the pipeline. Default sends nothing, so the pipeline uses its own default value.
  • Run without filters. Set Context form to None; instanceFilters is then sent empty.

Names are case sensitive: Kepion sends each name exactly as the pipeline declares it, so scenarioid and scenarioId are different parameters. For a new pipeline, name parameters in camelCase, such as scenarioId.

Next steps

Related articles