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, then it will be displayed on the report at runtime. In User mode, these parameters appear in the Additional Parameters block.

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, click the Parameters tab.
Click Add to add a new row. Enter the following information.
- Editable: If this check box is selected, the field will be editable in User mode. If not, the field is read-only.
- Hidden: If selected, the field will be hidden in User mode. The report may still use the parameter at runtime, depending on the design.
- Name: Double-click in the field to make it editable. The Name entered here must match the parameter name used in the BI Publisher/Oracle Analytics Publisher report. The behavior and default values for the parameters specified here can be applied automatically to the report at run time.
- Label: Defines the label of the parameter field in User mode.
- Default: You can enter a default value that will be used in User mode.
To delete a row, select it and click Remove.
Click Apply to save changes. You can click OK to save and exit or click another tab to continue to define the configuration.

Predefined BI Publisher/Oracle Analytics Publisher Parameter Examples

The name for a Parameter is mapped to a BI Publisher/Oracle Analytics Publisher parameter based on the format: :uuu_p_{Parameter Name}

Note: Ensure the length of {Parameter Name} is less than 24 characters.

Any parameters created on 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 BI Publisher/Oracle Analytics Publisher 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>

The following is an example for how to use the predefined BI Publisher/Oracle Analytics Publisher 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 and select Size (and its AltText), then enter the following content:

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

Note: 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 HelpText of the form field enter:

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

Last Published Tuesday, December 12, 2023