Like what you see? Have a play with our trial version.

Overview

Custom Parameters is a Yellowfin functionality used for URL substitution, where you can store a URL or part of a URL as a parameter and use it in a report instead of the URL. If the URL ever changes, you can make modifications to the custom parameter, rather than manually changing the URL everywhere in the report. This is also suitable if your report references a number of different websites or client organizations.

You must first create a custom parameter through the Administration module, and then use it in your reports with the Link to URL formatter.


Creating a custom parameter

Here is how you can create a custom parameter.

  1. Navigate to Administration > Configuration > System tab, and expand the Custom Parameters section. 



  2. To create a parameter, enter a key in the first textbox, and the value in the second. The key can be any keyword that you wish to reference the value by, and the value can be the URL or part of a URL. For example:



  3. Click on the add (+) button to save the parameter.
  4. Note: if you use an existing parameter key when creating a new custom parameter, the system will update the value of the existing parameter with the new URL.
  5. Tip: You may delete a parameter by clicking on the delete (X) icon next to its key. 



  6. Once you’re done, click on the Save button.



Using a custom parameter

Once the parameter has been created, you can use it in your reports.

  1. Create a report, and add fields on the Data page.
  2. Click on the menu option of a field that you wish to link to the URL. In our Ski Team example, we’re selecting Campaign as this field.
  3. In the menu, select Format and then Edit.



  4. Select ‘Link To URL’ as the Format type for this field. This will bring up some additional configurations.

  5. In the URL field, add the parameter key using the following syntax: ${PARAMETERKEY}. You can also add https:// to the beginning of this syntax, if you haven’t done so in the parameter value.

    Important

    The parameter key must be specified in capital letters for this to work, and must be enclosed in $, {, and } characters as shown in the example.




  6. You can also dynamically pass a column value by adding ‘##’ through the URL field, as this can only be accomplished at the report level. For example: https://${PARAMETERKEY}/##.



  7. Specify whether the URL is for an external link by choosing Remote as the URL Type, or a local one by choosing Local as the type.
  8. If the URL is local, you have the option to include http://localhost to the beginning of the URL by enabling the Use External Instance Base URL toggle.



  9. Once done, close the formatting popup. All the values in your selected field will become hyperlinks. You can click on a value to navigate to the specified URL. 
  10. If you hover your cursor over a value, the URL will appear at the bottom-left of the page.



  11. Save and exit your report.





  • No labels