Enabling 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 ADF application.

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

To enable this feature, use the Administration Tool to register the custom properties as a static repository variable.

To register custom properties:

1. Open your repository in the Administration Tool.
2. Select Manage, then select Variables.
3. Select Action > New > Repository > Variable.
4. For Name, enter ADF_PARAM_LIST. Do not 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 have 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";

Note that when you are including a custom property of type PARAM_EFFECTIVE_DATE, the date format for the property value must be in the format yyyy-mm-dd.