Using URL Parameters in BRYTER enables you to transfer data from outside of your BRYTER Module (e.g., from a different Module or a website where the Module is embedded) into your Module or loop through the same Module over and over again.
Watch this video to learn more about URL Parameters and how to use them in BRYTER.
What are URL Parameters?
A URL (Uniform Resource Locators) Parameter is a unique address for a specific webpage on the Internet.
In the BRYTER universe, a URL Parameter is a way of transferring data from outside of your BRYTER Module (e.g., from a different Module or a website where the Module is embedded) into your Module or looping through the same Module over and over again.
💡 Note that this is an advanced feature and it is helpful to already be familiar with how URLs on the Internet are structured.
A webpage's URL is made up of the domain name, the path, and the query parameter.
BRYTER can screen the URL for a Query Parameter (via a URL Parameter Action Node) and retrieve the data for that parameter from another source.
How to use URL Parameters
Follow the links below to be directed to the respective section or review them in order by scrolling down to the next heading.
- How to loop through the same Module
- How to redirect to another Module
- How to pass information between Modules
- How to add Actions in Data Views using URL Parameters
- How to work URL Parameters into Action buttons
Loop through the same Module
In BRYTER, you can use URL parameters in conjunction with Redirect Result Nodes to loop through a Module without needing to re-enter the same info repeatedly.
Let us use a transaction approval process as an example:
In this process, you ask the end-user to provide specific information, including their name and email (e.g., in a Multi-input Node), country, the transaction value, and whether they have the approval of the legal department. In the end, depending on the end-user input the transaction will be either prohibited or allowed. At this stage in your Module, you could integrate the functionality to loop through, i.e., repeat, the process without having to re-enter, e.g., the name and email address.
Step-by-step to looping through the same Module
You have built your graph and would like to include the possibility of assessing another transaction (loop) at the very end? Follow the steps below to loop through the same Module:
First, publish your Module to test and copy the link. Then, add a Result Node to the tail of your graph. Now, change your Result Node into a Redirect Node, and paste the link of your published Module as Custom URL into the field URL.
At the end of that link add a question mark ? and your query parameter (e.g., name, if you do not want to repeatedly input your name), followed by an equals sign =, and finally, @-reference the Node where the user inputs their name.
If you want to carry over more than one piece of information (e.g., the email address), add the ampersand sign & followed by the parameter email, an equals sign =, and, again, @-reference the Node where the user is asked to enter their email address.
This link will carry over the name and email address when you loop through the Module.
Do not forget to adjust the condition in the transition leading to the Redirect node.
Now, you have to place a URL Parameter Action Node for each parameter you have defined in the last step. The URL Parameter Action Node instructs the Module to screen the URL for parameters. Therefore, you would want to place them high up in your graph.
In our example, place one URL Parameter Action Node with name as the Query Parameter Name and the Type set to Text. Place another one with email as the Query Parameter Name and the Type set to Text as well.
Then, select the Input Node (or Nodes) that ask for the information (i.e., name and email) and set the default value by @-referencing the two URL Parameter Action Nodes name and email respectively.
Finally, publish your Module to test and open the link to test if the looping works as expected.
The very first time when we run through the Module, we will run through it with the URL containing no additional parameters. The URL Parameter Action Nodes at the beginning will do nothing in the first run, as the URL contains no parameters to read through. You simply enter your data.
However, in the second run (e.g., when the user decides to assess another transaction is led to the Redirect Node) the user will be redirected to the URL with the additional built-in parameters (name and email). The URL Parameter Action Node will screen the URL for parameters and retrieve the relevant input for name and email. These will be already set as the default values in the input fields at the relevant section of your Module.
Redirect to another Module
BRYTER enables you to combine Redirect Result Nodes and URL Parameters to connect Modules and transfer information from one Module to the next.
There are times when you have two Modules and want one of them to redirect the user to the other. For instance, when you have built a questionnaire that addresses different groups of people or would otherwise be too large if not broken down into smaller Modules.
Step-by-step to redirecting from one Module to another
Follow the steps below to create a link between two or more Modules:
First, add the path to the quiz to your graph by adding a Result Node. Then, adjust the Condition in the Transition so that this path is only taken if the user chooses to go to the questionnaire. Convert the Result Node into a Redirect Result Node and select the published Module that you want to redirect to. Finally, publish to test and open the link to check if the connection works as expected.
Now that you have learned how to link Modules, you can learn how to pass information between linked Modules.
Pass information between Modules
Combining Redirect Result Nodes and URL Parameters enables you to transfer information from one Module to another.
Step-by-step passing information between Modules
Follow the steps below to pass information from one Module to another Module:
- Go to your main Module. Select the Redirect Node that redirects to the questionnaire.
- Select Add Parameter. Type in a URL Parameter Key. This key will be used as the Query Parameter Name of the URL Parameter Action Node in the receiving (questionnaire) Module and serves as the data link between your Modules. This Parameter will also be appended to your destination Module’s URL.
- Type or @-reference a URL Parameter Value, e.g., the user’s name. This value will be passed with the URL Parameter and is picked up with a URL Parameter Action Node in the questionnaire.
- Finally, add the URL Parameter Node to the beginning of your questionnaire and type the URL Parameter Key from earlier as your Query Parameter Name. This establishes the link between the Modules and allows the questionnaire Module to retrieve data (or in this case the value Your name) from the main Module. The value can now also be used in a Transition or referenced in the "child" Module.
💡 Note: If you prefer to redirect your Module to an external source, e.g., an intranet page or another URL, simply select Custom URL in the Redirect Node and enter the destination URL.
Actions in Data Views and URL Parameters
Finally, BRYTER enables you to add action fields in Data Views through the use of URL Parameters. This is an advanced feature that combines different elements of knowledge around URL Parameters.
Let us use a vacation request management Application as an example use case. Such an Application could include a Data View for a manager that displays vacation requests from employees. If you wanted the manager to be able to further process these requests, i.e., accept, decline, or otherwise review them, you could utilize actions. You can add action buttons to each Data View line.
In the below vacation request example, all pending vacation requests are displayed to managers in a Data View. Managers can select Review to open a Module that allows them to approve or reject the request and update the status from "Pending" to "Rejected" or "Approved".
Step-by-step to adding actions in Data Views using URL Parameters
Follow the steps below to add action buttons to each Data View line to allow managers to process requests within an Application:
- In the Data View editor, scroll to Action (optional).
- Type in the text that you would like to be displayed in an additional Action column into the field Link label.💡 Tip: Consider adding an emoji to highlight the Action in the Data View.
- Select the Destination Module from the drop-down menu under Link destination. Once the destination Module has been selected, the action column at the end of every record in your Data View will display a clickable link. The user selecting the link will be redirected to the destination Module in a new window.
In most cases, you will want to continue adding or updating information for the specific record or case in your table.
💡 If you want to ensure the Module you are linking to is actually reading information saved for this specific record in the underlying database, you need to add a URL Parameter.
How to work URL Parameters into Action buttons
- Select Add parameter.
- Type in the Key (similar to Redirect Result Nodes, your Key should be the equivalent to the Query Parameter Name in the URL Parameter Node in the destination Module) and select the correct Value from your Case Database. This value will be passed to the destination Module, which is the link between the Data View and the Module.
- In your Module, ensure you include an Action Node for URL Parameter that can receive this value. The Query Parameter Name needs to be an exact match of the Key in your Data View Action. This way the Module and Data View are connected.
- In this example, the value ID can now be used to read the record from the database. For this, add an Action Node to your graph, choose Case Databases and Read. This will allow you to @-reference the data from the underlying database in this Module.
💡 Please note that linking to non-Module URLs is not supported in Data View Actions. We recommend the following workaround: publish a Module that only contains an Action Node and a Redirect Result Node with a configured custom URL.