Custom Report Window (Parameters tab)

If the report designer has defined a formula using parameters with the same name that was used in the Parameters tab, it will display on the report at runtime. These parameters appear in the Additional Parameters block in the User mode.

Additional Parameters

Additional parameters allow the report runner to specify parameters that can be used at report runtime to alter how the data is displayed.

Unlike search parameters,

Additional parameters only support entering text. You cannot select or multi-select values from Unifier.
Additional parameters allow us to specify a default value so that the user only needs to change the value if needed.

A good example of where to use additional parameters is for calculations, for example, when you enter a target future exchange rate. You can also use additional parameters for conditional highlighting so that only rows over/under a certain value are highlighted.

Note: In the Conditional Formatting section, you must hard-code a value (for example, 10,000).

To add additional parameters to the custom report:

On the Custom Reports window, select the Parameters tab.
Click Add to add a new row. Enter the following information to specify the behavior of the parameter in User mode:
- Editable: Select this checkbox to indicate if the parameter will be editable in User mode; otherwise the parameter is read-only.
- Hidden: Select this checkbox to hide the parameter in User mode. Depending on the design, the report may still use the parameter at runtime.
- Name: Double-click to edit the name. The name must match the parameter name used in the Oracle Analytics Server report. The behavior and default values for the parameters specified here can be applied automatically to the report at runtime.
- Label: Specify the label of the parameter in User mode.
- Default: The default value of the parameter in User mode.
Perform any of the following actions:
- Click Remove to delete a selected row.
- Click Apply to save changes.
- Click OK to save and exit or
- Select another tab to continue defining the configuration.

Predefined Oracle Analytics Server Parameter Examples

The name for a parameter is mapped to an Oracle Analytics Server parameter in the format: :uuu_p_{Parameter Name}

Note: Ensure the length of {Parameter Name} does not exceed 24 characters.

Any parameters created in the Parameters tab also need to be appropriately added into the Parameters tag in the .XDM file.

Predefined Unifier Parameters

Predefined parameters are reserved for Unifier to pass the runtime values to Oracle Analytics Server runtime context.

Here is example from a XDM file.

<parameters xmlns="http://xmlns.oracle.com/oxp/xmlp">

…

<parameter name="uuu_p_context_project_id" dataType="xsd:string" rowPlacement="7">

<input label="context project id" size="10"/>

</parameter>

<parameter name="uuu_p_context_program_id" dataType="xsd:string" rowPlacement="8">

<input label="context program id" size="10"/>

</parameter>

<parameter name="uuu_p_reportByF" dataType="xsd:string" rowPlacement="9">

<input label="uuu_p_reportByF" size="20"/>

</parameter>

<parameter name="uuu_p_timeZoneF" dataType="xsd:string" rowPlacement="10">

<input label="uuu_p_timeZoneF" size="20"/>

</parameter>

<parameter name="uuu_p_diffMinutesF" defaultValue="0" dataType="xsd:string" rowPlacement="11">

<input label="uuu_p_diffMinutesF" size="20"/>

</parameter>

<parameter name="uuu_p_sysyTimeZoneID" dataType="xsd:string" rowPlacement="12">

<input label="uuu_p_sysyTimeZoneID" size="20"/>

</parameter>

<parameter name="uuu_p_searchConditionF" dataType="xsd:string" rowPlacement="13">

<input label="uuu_p_searchConditionF" size="50"/>

</parameter>

<parameter name="uuu_p_urlF" dataType="xsd:string" rowPlacement="14">

<input label="uuu_p_urlF" size="40"/>

</parameter>

<parameter name="uuu_p_sessionIdF" dataType="xsd:string" rowPlacement="15">

<input label="uuu_p_sessionIdF" size="50"/>

</parameter>

<parameter name="uuu_p_companyRegistryF" dataType="xsd:string" rowPlacement="16">

<input label="uuu_p_companyRegistryF" size="50"/>

</parameter>

<parameter name="uuu_p_userId" dataType="xsd:string" rowPlacement="17">

<input label="uuu_p_userId" size="50"/>

</parameter>

<parameter name="uuu_p_userCompanyId" dataType="xsd:string" rowPlacement="18">

<input label="uuu_p_userCompanyId" size="50"/>

</parameter>

Note: uuu_p_userId is the user ID of the user running the report; uuu_p_userCompanyId is the company ID of the user running the report.

The following is an example for how to use the predefined Oracle Analytics Server Parameters to display an image in the Report layout:

Create Form fields in the .rtf.
In the HelpText of the form field, define variable matching the parameter names used in the image URL.
Right-click the dummy image, select Size, and provide the following value in the Description field of the AltText information for the image:

url:{concat($uuu_p_urlF,'companyRegistry=',$uuu_p_companyRegistryF,'&sessionId=',$uuu_p_sessionIdF,'&id=',<PROJECTIMAGE>)}

Notes:

The uuu_p_* are the predefined parameters in the data model. They are also the variable names defined in the RTF form fields. The <PROJECTIMAGE> is the element for image file ID from Unifier.
In the Description, you can access the image by entering the complete path to the image or by using .// to look for the image in the Data Model.

In the HelpText of the form field enter:

<?variable@begin:uuu_p_urlF;(.//uuu_p_urlF)[1]?>

Last Published Friday, April 11, 2025