Tailor your application's portal for different kinds of reporters by creating form portal URLs. For example, if your organization manages multiple campuses, you can create a portal link for each campus, which will automatically fill in the correct campus in the intake form and load the corresponding color theme for the reporter. This will streamline and simplify submitting a case for reporters, ensuring your organization receives detailed and actionable reports. You can create form portal URLs to:

• Pre-populate fields in the Report Online form.
• Select the color theme used for the portal.
• Select the language of the portal interface.

After creating a form portal URL, your organization can provide it to the intended reporters. This article covers how to add parameters to your portal's URL using a sample application to demonstrate each step. Use these examples as a guide to create a unique link for your application's portal.

1. Find Field Names to Set

To create your portal URL, you will need the system names for the fields you want to pre-populate in the Report Online form. You can only populate fields on the case form set to "Show on Portal" with form portal URLs. See a list of the field types, like text boxes and radio buttons, you can populate in the Supported Field Types section.

In our sample portal, we want to fill in fields called "Campus", "Faculty", and "Department" with our form portal URL, so we will look for these system names in this example.

To find the system name for case fields:

1. Navigate to the Forms tab in Settings.
2. Click the "Case" row in the Forms grid. This will load the case form in the Form Builder.
3. Click a field that you want to be pre-populated by the form portal URL.
   1. If you want to add a new field to the case form, see the "Fields" tab in Edit a Standard Record Type for instructions.
4. Check the field's description in the sidebar. The bolded text is the system name for the field. In our sample application, the system names for the "Campus", "Faculty", and "Department" fields are simply "campus", "faculty", and "department".
   1. Make sure these fields are set to "Show on Portal".
5. Take note of the system names for these fields. We will use them in step 3 of this process.

2. Determine the Values to Populate in Fields

Next, determine what you want to fill in the fields, or the "values". Each type of field in Case IQ can only accept certain kinds of data. For example, textboxes, text areas, text editors, and picklists can contain text strings, like names or descriptions. Check the Supported Field Types chart for details on the values you can enter in other field types.

In our example, "Campus" and "Faculty" are picklist fields, while "Department" is a textbox field. We want to set these fields to the following values with our form portal URL:

• Campus: University of XY
• Faculty: Arts and Science
• Department: History

3. Add Field Parameters to the Portal URL

You can now create your portal URL by adding field parameters. Open your application’s portal and click your browser’s address bar. At the end of the URL, type the system names for the fields you want to set and the values you want to populate in the fields in the following format:

?fields={"field1":"valueA","field2":"valueB","field3":"valueC"}

Where:

• field1, field2, and field3 are the system names for the fields you want to populate on your Report Online form. 
• valueA, valueB, and valueC are the values you want to be populated in those fields.

In our example, the system names are "campus", "faculty", and "department" and the values are "University of XY","Arts and Science", and "History". This means the form portal URL for our sample application will look like:

https://organization.caseiq.app/portal/reportonline?fields={"campus":"University of XY","faculty":"Arts and Science","department":"History"}

4. Hide Field Parameters on the Portal Form

You can choose to hide the fields set by your form portal URL on the Report Online form. This is ideal if you do not want reporters to see or change the fields populated by your URL. Skip this step if you do not need to hide these fields.

To hide the populated fields on the Report Online form, enter the following at the end of your URL: &hideParamFields=true. For our sample application, this is what our example form portal URL will look like if we hide these fields:

https://organization.caseiq.app/portal/reportonline?fields={"campus":"University of XY","faculty":"Arts and Science","department":"History"}&hideParamFields=true

5. Set Language for the Portal

If your application has multiple languages, you can preselect the language in your portal's interface. This makes your portal easier to use for reporters using other languages. In our example, the main language used at University of XY is French, so we will preselect French in the portal with our URL.

To preselect a language for the portal, click the Language () button in the portal top bar and select a language. You will now see &lang= followed by a language code in your URL. Our sample portal's URL now looks like:

https://organization.caseiq.app/portal/reportonline?fields={"campus":"University of XY","faculty":"Arts and Science","department":"History"}&hideParamFields=true&lang=fr

6. Set Theme for the Portal

You can also automatically select the color theme for your portal with a URL, allowing you to control the entire portal experience for reporters. Our sample application has a theme for each campus, so we will preselect the theme for University of XY with our form portal URL.

To preselect the theme, click the Theme () button in the portal top bar and choose one of the theme options available. You will now see &theme= followed by the name of your theme in your URL. Our sample portal's URL now looks like:

https://organization.caseiq.app/portal/reportonline?fields={"campus":"University of XY","faculty":"Arts and Science","department":"History"}&hideParamFields=true&lang=fr&theme=University%20of%20XY

7. Encode the URL

The values in your URL parameters must be encoded so your browser can load the page properly. If you are using Microsoft Edge or Google Chrome, your browser will automatically encode your URL for you. In your browser's address bar, hit Enter or Return on your keyboard to load the URL with your parameters. Microsoft Edge or Google Chrome will load the portal per your parameters and automatically encode your URL, which will now include numbers and percent symbols. Any browser should now be able to use this encoded URL.

If you are not using Microsoft Edge or Google Chrome, you can use a URL encoder tool instead. You can find free URL encoders online to encode your form portal URL so all browsers can load your parameters.

8. Test the URL

You can now test your form portal URL to make sure it fills in the fields correctly and selects the correct theme and language. To make sure your form portal URL works:

1. Select the entire URL in your browser's address bar. 
2. Copy the URL. 
3. Open a new browser window.
4. Paste the URL in the new browser's address bar. 
5. Hit Enter or Return on your keyboard.
6. Your browser should load your application's portal with all your parameters. If you landed on the portal homepage, click the Report Online button and see if the fields are populated or hidden per your parameters.
7. If your form portal URL is working, you can now provide this link to reporters. 

Supported Field Types

You can include any of the following field types in form portal URLs.