Creating service request URLs with pre-filled questionnaire fields

As a catalog administrator, create a URL with prefilled answers to questionnaires that can help users submit requests faster without manually entering information. With this capability, manual input for the user is minimized when they submit requests. Additionally, consistency is maintained during data entry, making it simple to embed request links to portals or share them through email and other communication channels.

You can use the following methods to share the URL with users:

• Embed the URL in a portal or on Studio pages
• Share the URL through email or over your official messaging application, such as Teams

After receiving the prefilled forms, users can change any values on the form. Prefilled answers serve as default answers that users can change.

Supported browsers

• Google Chrome (latest versions)
• Mozilla Firefox
• Microsoft Edge
• Safari (for macOS)

Constructing the URL

As an administrator, you must understand the items required to construct a URL and the template to construct the URL.

Items required to construct a URL

The following items are required to construct a URL:

• The service version ID
• Unique question aliases for each question in the questionnaire

Obtaining a service version ID

You can obtain the service version ID in one of the following ways:

• From the temporary URL that is generated by clicking a Digital Workplace service.
  
• By using BMC Helix Innovation Suite. Perform the following steps:
  1. In BMC Helix Innovation Suite, go to the Data editor (ServiceSearchCache) page.
  2. Filter the records by using the ServiceNameVersion and RevisionState = Published filters.
  3. Obtain the service version from the ServiceVersionID column.
     

URL template

As a catalog administrator, you can use the following template to construct a URL:

dwp/api/service/create?versionId=<ServiceVersionID>&<questionAlias1>=<answer1>&<questionAlias2>=<answer2>

where:

• versionId identifies the catalogue service version
• <questionAlias> corresponds to the unique alias for each questionnaire field
• <answer> is the value to be prefilled

You can configure the URLs for multiple-choice questions by repeating the alias with different values, for example:

...?alias=option1&alias=option2

If multiple questions share the same alias, the questions receive the same answer.

You can specify aliases when you design questions as shown in the following image:

For more information about creating an alias, see Designing workflows for a repeatable group of questions.

Example

Refer to the following example to understand how to construct the URL.

Supported question types

The following question types are supported:

• Check box
• Counter
• Date and time
• Dropdown  - Single and multi select
• Lookup
• Table - Single and multi select
• Radio button
• Text area
• Text field
• Time
• Toggle

The following types are not supported

• Description
• document
• File attachment
• Password
• Section
• Repeatable group questions

Related topics

Defining navigation through links in pages