Enable the Ability to Pass Custom Parameters to the ADF Application

Some ADF applications have custom properties defined on the ApplicationModule such as EFFECTIVE_DATE or TREE_VERSION.

You can include these custom properties in your application queries, and the Oracle BI Server passes them to the Oracle ADF application.

You can't use this feature to pass any custom property to your Oracle ADF application. Only certain custom properties, like EFFECTIVE_DATE and TREE_VERSION, are supported.

  1. Open your repository in the Model Administration Tool.
  2. Select Manage, and then select Variables.
  3. Select Action, select New, select Repository, and then select Variable.
  4. For Name, enter ADF_PARAM_LIST. Don't enter the name of the custom property as the name of the variable.
  5. Ensure that the Type is Static.
  6. For Default Initializer, enter the name or names of the custom properties as a character string. If you've multiple custom properties, include them as a comma delimited list. For example:

    'PARAM_EFFECTIVE_DATE'

    'PARAM_EFFECTIVE_DATE, ApplicationIdBind, KeyFlexfieldCodeBind'

  7. Click OK.
  8. Save and close the repository.

After you register the custom properties as a repository variable, you can include these variables in queries. For example:

set variable PARAM_EFFECTIVE_DATE=2001-01-01 : SELECT c1 FROM t1;

or

set variable ApplicationIdBind = '0', KeyFlexfieldCodeBind = 'KFF1' :
select_physical ApplicationID, KeyFlexfieldCode, DataSecurityObjectName,
SegmentLabelCode from adfdb..."AppModule.KFFHierFilterVO1";

When you're including a custom property of type PARAM_EFFECTIVE_DATE, the date format for the property value must use the format, yyyy-mm-dd.