Feature description

Widget URLs can be modified to populate designated fields with content, extending the usefulness of a single widget that might require unique values in varying situations.

For example, if you have multiple kiosks spread through an area, and want to automatically populate the widget with a store and employee number, you can easily do so by tacking a couple parameters to the end of the widget URL. 

This requires only that the fields to be populated are properly identified, and the values to be inserted are correctly added to the URL.

Adobe Sign uses URL hash fragments to enable this functionality. This ensures that Adobe Sign servers never see the values that are being passed in via URL, protecting any personal data that might be part of the inserted parameters.


How it's used

To insert values into a widget field, there are two things you need to know:

  • How to mark a field as available for URL parameters
  • How to construct the URL parameters to be inserted

 

How to mark a field as available for URL parameters

To make a field available for URL parameters:

  • Create or edit a widget to gain access to the fields
  • Add the text field you want to populate through the URL
    •  Only Text fields can accept values
  • Open the properties of the field by double clicking it
  • Edit the field name to something meaningful. The field name is the first part of the parameter you will use, so shorter is usually better
  • Check the box that says Default value may come from URL
    • Optionally check the Read Only box if you don't want the value to be editable
  • Click OK to save the parameters
  • Repeat for all fields that will need to accept a parameter from the URL
  • Click Save to save the widget
field_settings_toallowvaluestopassinviaurl

In this example we are creating two fields to be filled by the URL:

  • Branch_Office - A field that accepts the branch office string (shown above)
  • Emp_ID - A field that accepts the employee ID

 

How to construct the URL parameters to be inserted

An easy way to construct the URL is to:

  • Copy the URL from the widget. The easiest way to do this is to:
    • Edit the Widget from the Manage page
    • Click the Copy Widget URL link
  • Paste the Widget URL into a text editor (like Notepad)
copy_widget_url

Widget URLs are very long, so an abbreviated one is used here for an example (yours will look different):

Example URL:

https://secure.na1.echosign.com/public/esignWidget?wid=CBF2s*

 

  • Add your parameters  

The start of the parameters are identified by adding a hash (pound, #) symbol at the end of the widget URL.

Then add the parameters in the format of  {field_name}={value} 

Example URL with one parameter

https://secure.na1.echosign.com/public/esignWidget?wid=CBF2s*#Branch_Office=San Jose #621

 

Multiple values are added by inserting an ampersand (&) between field values.

Example URL with two parameters

https://secure.na1.echosign.com/public/esignWidget?wid=CBF2s*#Branch_Office=San Jose #621&Emp_ID=429939

 

Once all of the field=value pairs are added to the URL, copy the full string and paste it into your browser.

The widget will render with the fields populated:

populated_widget

Properties and Limitations

  • You only use the hash mark once to define the beginning of the paramater(s)
    • Using a subsequent hash mark in a value does not negatively impact the result
  • Using spaces in values is acceptable
  • Using spaces in the field name is only acceptable if you explicitly insert %20 as the space character in the URL
    • This will work: https://secure.na1.echosign.com/public/esignWidget?wid=CBF2s*#Branch%20Office=San Jose #621
    • This will not work: https://secure.na1.echosign.com/public/esignWidget?wid=CBF2s*#Branch Office=San Jose #621
    • It is generally recommend that an underscore be used in field names instead of spaces. It will ultimately save you time
  • There is no space allowed between the Field Name, the equals mark, and the beginning of the value (Fieldname=Value)
  • No space to either side of the ampersand if you have multiple values
  • There is no limit (other than perhaps URL length limits) to the number of fields that can get their value from URL parameters
  • Calculated text fields can not be overridden and do not have the checkbox displayed in their field properties.
  • URL parameters do not work with authenticated widgets. Due to the use of URL Hash Fragments, if a widget is protected via a password or other authentication, the URL parameters are not passed back to the client after authentication is complete (the server never sees that part of the URL). 

 

Error handling

  • Any URL parameter that does not match a form field name exactly is ignored
  • Any URL parameter that tries to assign a value to a non-text field or a text field that does not have Default value may come from URL enabled is ignored


Configuration options

There are no options regarding this feature.


How to enable or disable

The ability to populate fields via URL is an inherent property of the Widget, and can not be disabled.

Šis darbs ir licencēts saskaņā ar Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported licenci  Uz portālā Twitter™ un Facebook izvietotajiem ziņojumiem neattiecas Creative Commons sistēmas noteikumi.

Juridisks paziņojums   |   Tiešsaistes konfidencialitātes politika