Setting Integration Type Parameters

Integration Type parameters enable the application to pass information to the end point to control how the end point should perform its action. For example, when you run a consolidation, your program can pass which application to run the consolidation against, and the dimension selections for the consolidation. You set the parameter values defined in the Integration Type in the task or Task Type using the integration. The Consolidation Integration Type can be used for many applications and dimension selections in your application, depending on how you set the Consolidate task parameter values.

Each parameter definition requires a name, description, unique code, type, and whether a value is required. The parameter code is the token that replaces in the execution URL for user tasks, or the parameter name that is passed to the execution web service for system-automated integration types. Required values must have a value for all tasks in a schedule before the schedule can be set to Open.

The parameter type controls the parameter value and how the user enters the value in the task field. Supported parameter types:

To set Integration Type parameters:

  1. In the New Integration Type dialog box, click Parameters.
  2. Click New.
  3. Enter a name for the parameter.
  4. Enter a parameter code.
  5. Enter a parameter tooltip.
  6. From the Parameter Type list, select a type, and enter additional information for the parameter:
    • Check box—Boolean value

    • Date—Date value

    • Integer—Numeric value in whole numbers

    • Number—Numeric value in whole numbers or fractions

    • Options Group—Check box for a predefined set of values

    • Static List—Predefined set of text values

    • Task Information—Task information, for example, Assignee, duration, start and end dates

    • Text—Free-form text value.

  7. If the parameter requires a value, select Required.
  8. Click OK to save the parameter.
  9. Click Save and Close to save the Integration Type.