Portal Forms (Surveys) - Form Setup

Modified on Wed, 21 Jan at 5:25 PM

TABLE OF CONTENTS

Overview

Surveys in ManagementStudio allow administrators to collect additional information from users. Common use cases include validating user data, distributing policy documentation, or requesting details about specific applications. Users complete surveys through a web browser interface.

This guide describes the Form Setup panel for Portal Forms (Surveys). While the examples reference the Applications module, Surveys are supported across the Users, Devices, Applications, Mailboxes, Deployment Units, Bespoke, and Defects modules.

For details on configuring other Survey panels, refer to:


Accessing the Survey Configuration Page

  • Navigate to Administration → Portal Settings. (1)
  • Expand Portal Forms. (2)
  • Select the desired module (e.g., Applications). (3)
  • The Form Setup tab will open by default. (4)


Toolbar

The Survey configuration toolbar includes the following options:

Icon/ActionDescription
Save ChangesSave current changes to the survey.
Cancel ChangesDiscard any unsaved changes.
New Portal FormCreate a new survey form.
Export Portal FormExport the selected survey for review, editing, or deletion.
Delete Portal FormRemove the selected survey from the system.

Creating a New Portal Form (Survey)

To create a new survey form:

  • Click the New Portal Form button in the toolbar. (1)

  • Select the module you wish to target. (2)
  • Click Select to proceed. (3)

Form Setup

The Form Setup page is divided into four main sections:

  • Internal
  • On Screen Messages
  • Save Buttons
  • Misc Options

You can insert ManagementStudio keywords into text fields to dynamically include object data. For example, using Hello [TestSignOff-FirstName] in the survey will render as Hello Matt if the user's first name is Matt. Rich text formatting is supported via HTML and Markdown.

After making changes, select Save Changes to commit updates.

Internal

Configure the core properties and behaviour of the portal form:

  • Portal Form (Survey) Name: Enter a descriptive, human-readable name for the portal form. This will appear throughout ManagementStudio.
  • Is Enabled: Controls user access to the portal form. If disabled, users will be notified the form is unavailable.
  • Id: Displays the internal Survey ID.
  • Is New Item: Allows the survey to create new records (e.g., an Application request survey).
  • Add User as Contact: Adds the logged-in user as a contact of the targeted item (such as App or Device).
    Note: Requires the portal wrapper to use 'Grid User with AD/Azure login' authentication.
  • Browser Window Title: Sets the tab title for the browser window.
  • Portal Wrapper: Specifies the portal wrapper in which this survey will display.
  • Internal Name: Sets the internal name for automation and integration purposes.

On Screen Messages

Configure messages displayed to users after survey submission:

  • Complete Message: Message shown on successful survey submission.
  • Error Message: Message shown if an error occurs during submission.

Save Buttons

Customise the action buttons at the bottom of the portal form:

  • Show Pass / Fail Buttons: Toggles display of Pass and Fail buttons. Deselect to hide these.
  • Pass Button Label: Override default text for the Pass button (e.g., "Submit").
  • Fail Button Label: Override default text for the Fail button (e.g., "I have a question").
  • Show Save Button: Enable to allow users to save progress without submitting. Disabled by default.
  • Save Button Label: Set alternate text for the Save button.
  • Redirects:
    • On Pass Redirect To
    • On Fail Redirect To
    • On Save Redirect To
    • After submission, redirect users to a specified page. You may use URL keywords:
      • <span style="color:red">Error: Invalid Portal Form keyword [Applications-Url-Survey-41]</span>: Redirects to an application survey with ID 41.
      • https://admin.managementstudio.cloud/7/p/schedule/5/11152117/?skey=E923250AEB83249A7419991B81AB1ACE: Redirects to the Self-Scheduling page, useful for workflows involving Deployment Unit selection and migration slot booking.
  • On Submit Run ESM: Specify the ESM plan ID or name(s) to run when the form is submitted (Pass or Fail). Multiple plans can be run using a comma-separated list.

Misc Options

Additional configuration for survey behaviour and document management:

  • Lock On Complete: Prevents users from editing the survey after submission. Deselect to allow post-submission modifications. Administrators can unlock submissions via the console as needed.
  • Save Survey As PDF: When enabled, attaches a screenshot of the completed Survey as a PDF to the parent record.
  • Wait for OnSubmit PS: Delays user redirection until the associated OnSubmit PowerShell script completes, enabling advanced logic-driven redirects.
  • PDF Attachment Type: Sets the category for PDFs attached to a record. Available options include:
    • App Test Sign-Off PDF
    • App Test User Attachment
    • Change Request
    • Discovery Docs
    • License Info
    • PRF
  • Survey Attachments Type: Defines the tag for attachments uploaded from the survey. Options are the same as PDF Attachment Type.

Further Support

For additional assistance, visit the ManagementStudio Service Desk to search the knowledge base or submit a support ticket.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article