This article will walk you through how to create a pre-filled launch form.
Launch URLs can be used to direct users to the correct Ironclad workflow and to pre-fill information in the corresponding launch form. This can save time for your users and reduce human error by ensuring they have accurate input from your specified source.
For example, a user might start a purchase order by opening a ticket in JIRA, after which point you would want to direct them to Ironclad to submit their contract for review. A launch URL could then be constructed and posted in a comment on the JIRA ticket. Users who click this link will see a pre-filled Launch Form and have much less information to fill out when submitting their contract.
Configure a Launch URL
To create a launch URL, you must add parameters for the launch form properties that you want to pre-fill to the URL of the form.
-
Copy the URL of the launch form that your users see when launching the target workflow and paste it into the text editor of your choice. It should look a little something like this: https://demo.ironcladapp.com/c/123456789/workflows/launch/1234adfbf5678e1.
-
In the text editor, add a “#” to the end of the URL:
https://demo.ironcladapp.com/c/123456789/workflows/launch/1234adfbf5678e1#
-
In Ironclad, navigate to Workflow Designer, then open the corresponding workflow. In the Properties & Conditions panel located on the left, find the workflow property in the form that you want to pre-fill, then copy the property code. Paste this code at the end of the URL, then add an “=” and the desired value of the property.
Example:
https://demo.ironcladapp.com/c/123456789/workflows/launch/1234adfbf5678e1#counterpartyName=FirstnameLastname
-
Continue adding property codes and property values to the end of your URL as needed. Each subsequent set of code and value should be separated with an ampersand “&”:
https://demo.ironcladapp.com/c/123456789/workflows/launch/1234adfbf5678e1#counterpartyName=FirstnameLastname&governingLaw=California&termLength=1 year&launchUrlTestDate=July 24, 2024
-
Once you have finished building your launch URL, you may add it wherever you would like users to access the pre-filled form.
Considerations
Ironclad currently supports pre-filling the following types of properties in a launch form:
Property Type | Examples |
Text |
counterpartyName=Firstname Lastname governingLaw=California Text properties set as dropdowns or multiple choice can be populated as long as the value sent in the URL exactly matches the desired option. |
Boolean |
testBoolean=true |
role3b7ac16b09144236a577e314923ecdcf=example@example.com |
|
Address |
counterpartyAddress%5Blines%5D%5B0%5D=325 5th Street&counterpartyAddress%5Blines%5D%5B1%5D=Suite |
Number |
launchUrlTestNumber=35 |
Monetary Amount |
launchUrlTestDollar%5Bcurrency%5D=USD&launchUrlTestDollar%5Bamount%5D=25.37 |
Date |
launchUrlTestDate=July 24, 2024 |
Duration |
launchUrlTestDuration%5Byears%5D=1&launchUrlTestDuration%5Bmonths%5D=2& |
Individual fields of the Address, Monetary Amount, and Duration properties will each have their own property name and value pair, separated by an ‘&’ ampersand.
Files and Related Record Properties cannot be set via launch URL.
Spaces can be included in the launch URL values, or they can be URL encoded.
You can also use APIs to directly launch an Ironclad workflow, which may be preferable, depending on the desired user experience (you may not want to force users to switch applications) and security requirements (using query parameters to transfer sensitive information should be avoided). You can find more information on our APIs in the Ironclad Developer Hub.
In some cases, using the launch URL is preferable to the API, as it will allow for additional information to be collected from the user. Depending on your use case, it is also possible to dynamically construct the launch URL via code if you would like to tailor the launch URL to different scenarios.