Introduction

ManagementStudio uses Surveys as a method of enabling administrators to collect further information from users.  Surveys could be used to validate the information held about a user, issue new policy documentation, or request further information about a specific application.  Users interact with ManagementStudio directly via a web browser.  

This document discusses the Form Setup panel of a Portal form (Survey). Although the examples within this document reference the Applications module, Surveys are supported in Users, Devices, Applications, Mailboxes, Deployment Units, Bespoke, and Defects.

For further information about how to configure other Survey panels, please visit:

• Display Fields: https://support.managementstudio.com/a/solutions/articles/14000109918
• Emails: https://support.managementstudio.com/a/solutions/articles/14000109919
• PS / CSS / JS: https://support.managementstudio.com/a/solutions/articles/14000109920

TABLE OF CONTENTS

• TABLE OF CONTENTS
  • Introduction
  • Accessing the Survey Configuration Page
  • Toolbar
  • Create a New Portal Form (Survey)
  • Form Setup
    • Internal
    • On Screen Messages
    • Save Buttons
    • Misc. Options
  • Further Support

Accessing the Survey Configuration Page

The Survey configuration page is accessed through the Administration section:

• Switch to Administration -> Portal Settings (1), expand Portal Forms and select the appropriate module (2).  The example below uses Applications.
• The Form Setup tab will be displayed by default.

Toolbar

1. Save Changes: Save changes after creating or editing a survey.
2. Cancel Changes: Dismiss any changes to the survey since the last save.
3. New Portal Form: Create a new survey.
4. Export Portal Form: Choose a survey to review/edit/delete.
5. Delete Portal Form: Delete the selected survey.

Create a New Portal Form (Survey)

• Click the New Portal Form button (1) from the toolbar:

• Select the Module to target (2)
• Click Select (3)

Form Setup

The Form Setup page, displayed by default, contains the internal controls and configuration options that are required to manage a portal form (Survey).  When a new portal form is created, many of the fields are populated with default values to simplify the customisation process for a ManagementStudio administrator.  The sections are:

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

Information about the object can be retrieved from ManagementStudio and added to the form by referencing Keywords in the text areas.  For example, Hello [TestSignOff-FirstName] will be substituted with Hello Matt in the test form. Rich text formatting is provided by HTML and Markdown.

When changes are made, the Save Changes button at the top of the Survey must be used to commit the update.

Internal

• Portal Form (Survey) Name: The human-readable name for the portal form. Enter a name that describes the portal form (this will be used throughout ManagementStudio as a reference).
• Is Enabled: This controls whether the portal form is accessible to the end-user.  If Is Enabled is unticked, the end-user will receive a message advising them that the portal form (Survey) is no long available.
• Id: The internal ID for the Survey.
• Is New Item: This survey can be used to create new items. E.g. an Application request survey.
• Add User as Contact: Add the logged on User as a contact of this surveys target item (e.g. App, Device etc). **Portal wrapper must be using 'Grid User with AD/Azure login' Auth for this option to work correctly.**
• Browser Window Title: Text displayed in the Tab title in the browser.
• Portal Wrapper: The portal wrapper that this survey will be presented inside.
• Internal Name: The internal name of the portal form for automation.

On Screen Messages

On Screen Messages are displayed when a user submits a Survey. 

• Complete Message: On successful submission of the Survey, the text contained within this field will be displayed.
• Error Message: If an error is encountered, the text within this field will be displayed to the user.

Save Buttons

The following settings enable the text that appears at the bottom of the portal form (Survey) to be customised:

• Show Pass / Fail Buttons: By default, the Pass and Fail buttons are displayed in the Survey. Deselect the option to hide these buttons.
• Pass Button Label: Provide alternative text for the Pass button.  For example, Submit. 
• Fail Button Label: Provide alternative text for the Fail button.  For example, I have a question.
• Show Save Button: Enabling this option will allow the user to save their progress. This is not enabled by default to encourage users to submit their responses in a timely fashion.
• Save Button Label: Provide an alternative test for the Save button.
• Redirects:
  • On Pass Redirect To
  • On Fail Redirect To
  • On Save Redirect To
  • After the User has submitted their survey you can redirect them to another page.
  • Url keywords can be used in the redirect
    • [Applications-Url-Survey-41] will redirect to an application survey with ID 41 
    • [UserMigrations-Url-SelfSchedule] will redirect to the user's Self-Scheduling page. This is very useful if the survey was used to let the user choose which Deployment Unit they should be added to, as they can they choose a migration slot within that DU.

• On Submit Run ESM: ESM plan id to run when a form is submitted (Pass and Fail).
• On Submit Run ESM: Internal name of the ESM plan to run when this form is submitted (Pass and Fail). Note: Multiple plans can be run by using a comma-delimited list of plan names.

Misc. Options

• Lock On Complete: Lock the survey so that a user can not update it after they have submitted a result. Deselect this option if users will be required to modify the data after submission. Please note: The ManagementStudio console provides the ability to unlock portal forms on an ad hoc basis.
• Save Survey As PDF: With this option enabled, a screenshot of the Survey page is attached to the parent object when submitted. This is available as a download.
• Wait for OnSubmit PS: Waits for OnSubmit PowerShell script to complete before returning to User. This can be used to redirect the User to a custom page based on some custom logic.
• PDF Attachment Type: When PDFs are attached to a record, they are assigned to categories to help locate files more easily.  By default, the following options are available:
  • App Test Sign-Off PDF
  • App Test User Attachment
  • Change Request
  • Discovery Docs
  • License Info
  • PRF
• Survey Attachments Type: This option specifies the tag that is used on attachments when uploading to the record. The options are the same as the previous setting.

Further Support

If you require further support, please visit ManagementStudio's Service Desk to search the knowledge base or create a new support ticket.