Modern Requirements4TFS Installation Guide

Similar documents
Modern Requirements4TFS Installation Guide

integreat4tfs Installation Guide

integreat4tfs Installation Guide

integreat4tfs Installation Guide

Modern Requirements4TFS 2018 Update 1 Release Notes

Modern Requirements4TFS 2018 Update 3 Release Notes

Modern Requirements4TFS 2018 Release Notes

edev Technologies integreat4tfs 2016 Update 2 Release Notes

InCycle InRelease User Guide

Covene Cohesion Server Installation Guide A Modular Platform for Pexip Infinity Management October 25, 2016 Version 3.3 Revision 1.

Workspace ONE UEM Certificate Authentication for EAS with ADCS. VMware Workspace ONE UEM 1902

Automation Anywhere Enterprise 10 LTS

Workspace Administrator Help File

Microsoft Windows Servers 2012 & 2016 Families

DocAve for Salesforce 2.1

DocAve 6 SharePoint Migrator

TeamViewer User Guide for Microsoft Dynamics CRM. Document Information Version: 0.5 Version Release Date : 20 th Feb 2018

Kernel Migrator. for SharePoint. Configuration Guide

Sophos Mobile as a Service

DOCUMENTUM D2. User Guide

High Availability Enabling SSL Database Migration Auto Backup and Auto Update Mail Server and Proxy Settings Support...

10ZiG Manager Cloud Setup Guide

Workstation Configuration

KYOCERA Net Admin User Guide

Installation and Upgrade Guide. Front Office v9.0

Installation on Windows Server 2008

Web Push Notification

Privileged Access Agent on a Remote Desktop Services Gateway

Installation Guide. Mobile Print for Business version 1.0. July 2014 Issue 1.0

VII. Corente Services SSL Client

Workstation Configuration Guide

Cisco NAC Appliance Agents

Contents. Limitations. Prerequisites. Configuration

Installing and Configuring hopto Work. System Requirements Be sure you have these system requirements to install and use hopto Work.

Install and upgrade Qlik Sense. Qlik Sense 3.0 Copyright QlikTech International AB. All rights reserved.

Workstation Configuration

Workstation Configuration

VMWARE HORIZON CLOUD WITH VMWARE IDENTITY MANAGER QUICK START GUIDE WHITE PAPER MARCH 2018

Installation Guide Blueprint 8.1 Storyteller 2.2

Mobile Inventory Tracking & Sales Management Software. Installation Procedure

DocAve 6 Lotus Notes Migrator

Using vrealize Operations Tenant App as a Service Provider

Amazon AppStream 2.0: SOLIDWORKS Deployment Guide

IBM Atlas Policy Distribution Administrators Guide: IER Connector. for IBM Atlas Suite v6

Bomgar Vault Server Installation Guide

Sophos Mobile SaaS startup guide. Product version: 7.1

Early Data Analyzer Web User Guide

Roxen Content Provider

LabTech Ignite Installation

Installation Guide - Windows

Configuring SharePoint 2007

Accops HyWorks v3.0. Installation Guide

Installation Guide for Pulse on Windows Server 2012

ApplicationServer XG Version 11. Last updated:

SOA Software Intermediary for Microsoft : Install Guide

VMware AirWatch Content Gateway for Windows. VMware Workspace ONE UEM 1811 Unified Access Gateway

USER GUIDE Summer 2015

User Manual. ARK for SharePoint-2007

About XenClient Synchronizer

DSS User Guide. End User Guide. - i -

Enterprise Vault.cloud CloudLink Google Account Synchronization Guide. CloudLink to 4.0.3

INTEGRATION TO MICROSOFT EXCHANGE Installation Guide

IMPLEMENTING SINGLE SIGN-ON (SSO) TO KERBEROS CONSTRAINED DELEGATION AND HEADER-BASED APPS. VMware Identity Manager.

Overview. Top. Welcome to SysTools MailXaminer

ROCK-POND REPORTING 2.1

Table of Contents HOL-1757-MBL-6

Configuring GNS3 for CCNA Security Exam (for Windows) Software Requirements to Run GNS3

owncloud Android App Manual

NBC-IG Installation Guide. Version 7.2

271 Waverley Oaks Rd. Telephone: Suite 206 Waltham, MA USA

SUREedge DR Installation Guide for Windows Hyper-V

Novi Survey Installation & Upgrade Guide

TECHNICAL WHITE PAPER AUGUST 2017 REVIEWER S GUIDE FOR VIEW IN VMWARE HORIZON 7: INSTALLATION AND CONFIGURATION. VMware Horizon 7 version 7.

Abstract. XV Sync Installation Guide & User Manual. Abstract Abstract

PAN 802.1x Connector Application Installation Guide

Installation Guide Worksoft Analyze

Dell EMC Ready Architectures for VDI

Version 1.9. Inbound Integration (POP3, IMAP and EWS) Installation, Configuration and User Guide. Last updated February 2015

Dell Wyse Management Suite. Version 1.1 Migration Guide

CLIQ Web Manager. User Manual. The global leader in door opening solutions V 6.1

Getting started with System Center Essentials 2007

Auslogics BOOSTSPEED USER MANUAL. auslogics.

Two factor authentication for Microsoft Remote Desktop Web Access

Runecast Analyzer User Guide

IT Essentials v6.0 Windows 10 Software Labs

Dell Repository Manager Business Client Version 2.0 User s Guide

Configuration Guide. Version 1.5.9

SharePoint General Instructions

Network Scanner Tool V3.3. User s Guide Version

Colligo Engage Outlook App 7.1. Offline Mode - User Guide

Dell EMC License Manager Version 1.5 User's Guide

Version Installation Guide. 1 Bocada Installation Guide

Nintex Forms 2010 Help

SkyPoint Installation & Licensing Guide

Content Publisher User Guide

Administering Cloud Pod Architecture in Horizon 7. Modified on 4 JAN 2018 VMware Horizon 7 7.4

VMware AirWatch Certificate Authentication for EAS with NDES-MSCEP. For VMware AirWatch

ForeScout Extended Module for VMware AirWatch MDM

DocAve 6 Exchange Public Folder Migrator

FastStats Integration

Transcription:

TABLE OF CONTENTS Introduction... 4 System requirements... 4 Software requirements... 4 Hardware requirements... 5 Hardware requirements for Redis... 5 Installation process... 5 Installation guidelines... 5 Installing Modern Requirements4TFS... 5 Deploying the TFS Extension using the VSIX file... 16 Activation (embedded)... 22 Activation (standalone)... 24 User based activation... 25 Floating activation... 27 Offline activation... 28 Activation unsuccessful error... 29 Admin panel (embedded)... 30 General section... 31 How to configure the repository name for GIT projects... 31 Review section... 35 Configuring the Review Metadata in the desired field... 35 Configuration for the Compare popup... 37 Configuring the work item fields for the display in the Compare popup... 38 Configuring the actions for a review response... 43 Configuring the recipients emails in case of failed post-state in the review module... 45 Baseline section... 48 2018 Modern Requirements Page 1 of 138

Configuring the sections for the display in the Compare baseline popup... 48 Configuring the work item fields for the display on opening a baseline... 49 Configuring the work item fields for the display while comparing baselines... 51 Configuring the link type for copy baseline... 53 MR Agent... 55 MR Agent user authentication... 55 Custom ID configuraion... 58 Configuring the custom ID XML file... 61 Applying ustom ID on existing work items... 63 Dirty Flag Configuration... 65 Configuring the Dirty Flag XML file... 68 Scanning the TFS Collection for identification of new project... 69 Appendix: User configurations... 72 Manually enabling Windows features... 72 Adding IIS binding information in config files... 74 Email configuration for the feedback option... 78 Fix for the activation lost after the VM Machine restart (stanadalone)... 84 How to update the Windows credentials for Modern Requirements4TFS... 87 How to configure load balancing for Modern Requirements4TFS... 92 Change the user interface configuration file... 92 Change the service configuration file... 93 How to change the color (RGB) value for a work item... 94 How to configure the repository name for GIT projects... 95 How to update the work item type for simulation, diagram and use case... 103 How to change the location of the baseline file... 105 How to pre-fill a specific field while copying the baseline using Modern Requirements4TFS... 106 2018 Modern Requirements Page 2 of 138

How to define the link type relation with the source work item while copying the baseline using Modern Requirements4TFS... 109 Configuring the fields for the display in the Work Item Details Panel on opening a baseline... 112 Configuring the fields for the display in the Work Item Details Panel while comparing baselines... 115 Configuring the fields for the display in the Work Item Details Panel on opening a review... 117 How to configure the Rules section of review management in Modern Requirements4TFS... 120 How to configure the actions for a review response in Modern Requirements4TFS... 124 Configuring the review metadata in the desired field... 126 Configuring the recipients emails in case of failed Post-State in the Review Module... 128 How to delete obsolete NFR templates from FAQ module... 130 The Deployment instruction page appearing instead of the License Status Page (embedded)... 131 Unexpected error message (standalone)... 132 IIS version is lower.. error... 134 400 Bad Request error (embedded)... 135 2018 Modern Requirements Page 3 of 138

INTRODUCTION This Installation Guide describes the installation of Modern Requirements4TFS using detailed steps. The guide is divided into the following three sections: 1. System requirements 2. Installation process 3. Activation The first section describes the prerequisites for installing the application. The second section deals with the installation procedure while the third section describes the process of activation after successful installation. The guide describes the embedded and standalone versions of Modern Requirements4TFS. Normally, a section is applicable to both installation types. However, if a section is valid only for a particular type, that type is mentioned at the end of the section heading. The last section before the appendices deals with the Custom ID configuration The document also has an appendix that contains additional, necessary information for installation and proper operation of Modern Requirements4TFS. SYSTEM REQUIREMENTS SOFTWARE REQUIREMENTS 1. Operating System: Windows Server 2012, 2008 R2 or Windows 7, 8, 8.1,10 2. Internet Explorer 10 or higher, Chrome, Mozilla Firefox 47.0.1 or higher 3. Screen resolution: 1280 x 960 or higher 4. IIS 7 or higher 5. Microsoft.Net Framework 4.5 or higher 6. ASP.NET 4.5 7. Multilingual support Language pack for IE & Save as Word *Note: Both the 32-bit and 64-bit versions of the operating systems are supported. The credentials required for installing Modern Requirements4TFS should include administrator rights on the machine. In other words, users installing Modern Requirements4TFS on their machine should use admin credentials (or credentials which have admin rights) for proper installation. For regular team projects, the user of a machine on which Modern Requirements4TFS is deployed must have admin rights on the TFS Collection (or added in the application domain in IIS). *Note: To access GIT-enabled team projects, logged-in domain user of a machine on which Modern Requirements4TFS is deployed must have authenticated rights on the TFS Collection (or added in Application Domain in IIS). 2018 Modern Requirements Page 4 of 138

HARDWARE REQUIREMENTS Modern Requirements4TFS Installation Guide 1. RAM: At least 4 GB, but higher storage capacity is required if executing TFS work item queries greater than 100,000. 2. Hard drive space: 350 MB HARDWARE REQUIREMENTS FOR REDIS According to Modern Requirements4TFS, approx. memory usage per user is 477.8495 KB (0.4666 MB). The maximum hard drive space required is 1.5 * (memory size). For instance, in case of 8 GB of RAM, the maximum hard drive space occupied by Redis would be 12 GB. INSTALLATION PROCESS INSTALLATION GUIDELINES Users are provided with a single installation file i.e. Modern Requirements4TFS 2018.exe Since Modern Requirements4TFS is a web-based application, it s preferable to install the file on a server. However, any machine with IIS 7 installed would suffice, as would any other more recent IIS web server. Installation is required only once. After the installation all the users with proper access rights can use the application, even if they haven t installed any of the installation files on their local machine. INSTALLING MODERN REQUIREMENTS4TFS 1. Double click the Modern Requirements4TFS 2018.exe file to start the installation process. 2018 Modern Requirements Page 5 of 138

The initial installation screen appears, asking the user to accept the terms and conditions for using the application. 2018 Modern Requirements Page 6 of 138

2018 Modern Requirements Page 7 of 138

2. Select the terms and conditions agreement check box and click Next. 2018 Modern Requirements Page 8 of 138

3. Select the type of installation (standalone or embedded). 2018 Modern Requirements Page 9 of 138

4. Click Next. 2018 Modern Requirements Page 10 of 138

5. Enter *Windows credentials (for user login on the PC where the services are being installed) and click Next. *The application will be installed, even if incorrect Windows credentials are entered during the installation. However, users will not be able to log in to the application. An error message will pop up on the sign-in page. Refer to the Appendix section to find out how to update the Windows credentials. 2018 Modern Requirements Page 11 of 138

6. Configure the MongoDb installation options and click Install. 2018 Modern Requirements Page 12 of 138

7. Configure the Redis Installation *options and click Install. The Auto Install Redis option is the recommended option if Redis isn t already installed on the target machine. If Redis is already installed, you must provide the name (or IP address) of the machine where Redis is installed. Similarly, if Modern Requirements4TFS is being installed on a load balancing server, the relevant details should be provided here. The default port for Redis is 6379, but you can give another port number if you re installing Redis independently of Modern Requirements4TFS. At the time of the Modern Requirements4TFS installation, you should give the same Port number used during the Redis installation. Refer to your network department to get the value of the Redis password (if there is one). The use SSL option should be enabled where required. Refer to your network department for this as well. The password and Use SSL options aren t mandatory, but their use mainly depends on the procedures followed in your organization. 2018 Modern Requirements Page 13 of 138

8. Click Yes in the warning message box. The relevant files are installed. Modern Requirements4TFS Installation Guide 2018 Modern Requirements Page 14 of 138

9. Complete the installation of Modern Requirements4TFS by clicking Finish or Run. This is the last installation step for the standalone version. Additional steps for the embedded version are described below. For the embedded version, the TFS deployment instruction page is displayed in the default browser window. Follow the steps described in the page to obtain the VSIX file. 2018 Modern Requirements Page 15 of 138

DEPLOYING THE TFS EXTENSION USING THE VSIX FILE 1. Log into your TFS. 2. Click the Marketplace icon and then select the Manage extensions option from the drop-down menu. 3. Click the Browse local extensions link. 4. Click Manage extensions. 2018 Modern Requirements Page 16 of 138

5. Click Upload new extension. Modern Requirements4TFS Installation Guide 6. Click the Browse button. 2018 Modern Requirements Page 17 of 138

7. Navigate and select the relevant VSIX file (created at the end of the installation in the last section). 8. Click Upload. 2018 Modern Requirements Page 18 of 138

9. Select the desired collection and click Continue. Modern Requirements4TFS Installation Guide 2018 Modern Requirements Page 19 of 138

10. Click Confirm. Modern Requirements4TFS Installation Guide 2018 Modern Requirements Page 20 of 138

The Modern Requirements4TFS Embed options become accessible through the Work tab. 2018 Modern Requirements Page 21 of 138

ACTIVATION (EMBEDDED) Most of the activation process for the embedded version is similar to that of the standalone version although some early steps are unique to the embedded version. These are described below: 1. Access your TFS using a browser and select the Modern Requirements4TFS option under the Settings tab. If the product has not been activated the following message will be displayed: 2. Click Activate. 2018 Modern Requirements Page 22 of 138

You are taken to the License Activation Page. Proceed to the User Based Activation section (explained below) to complete the activation process. 2018 Modern Requirements Page 23 of 138

ACTIVATION (STANDALONE) Modern Requirements4TFS Installation Guide 1. Open a browser window and enter the path shown at the end of the installation followed by a colon and 8028/User/SignIn e.g. http://steve:8028/user/signin. 2. Click Sign In on the Sign in page. Refer to the End of Appendix section if an unexpected error message is displayed on the Sign In page. 2018 Modern Requirements Page 24 of 138

If Modern Requirements4TFS has not been activated yet you ll be taken to the License Activation Page. USER BASED ACTIVATION 3. Select the User Based type of license. 2018 Modern Requirements Page 25 of 138

4. Enter the relevant license key and click Activate. Modern Requirements4TFS Installation Guide On successful activation, you ll be taken to the Browse Page, where you can open the team project of your choice. 2018 Modern Requirements Page 26 of 138

FLOATING ACTIVATION 3. Select the Floating type of license. 4. Enter the Floating URL and click Activate. On successful activation, you ll be taken to the Browse Page, where you can open the team project of your choice. 2018 Modern Requirements Page 27 of 138

OFFLINE ACTIVATION 3. Select the Activate Offline check box. 4. Follow the given instructions to activate. On successful activation, you ll be taken to the Browse Page, where you can open the team project of your choice. 2018 Modern Requirements Page 28 of 138

ACTIVATION UNSUCCESSFUL ERROR Modern Requirements4TFS Installation Guide Very rarely, you a message will pop up saying that the activation has been unsuccessful, asseen in the image above. In most cases, this error is due to problems in Internet connectivity. Users have to resolve their connectivity problems themselves in order to successfully activate the application. This message is also displayed when secured environment is blocking proxy from firewall, or due to applied network policy. To resolve the problem in this case users have to provide their network department with the following URL and ask the department to enable it: https://modernrequirements.compliance.flexnetoperations.com:443/deviceservices 2018 Modern Requirements Page 29 of 138

ADMIN PANEL (EMBEDDED) Modern Requirements4TFS Installation Guide The Admin Panel is a feature in the embedded version of Modern Requirements4TFS. It s used for licensing options, plus configuration and tweaking of many options (present in various modules of the application). To access the Admin panel, launch the embedded version of the application and select the Modern Requirements4TFS option under the Settings tab. The Admin panel is displayed. 2018 Modern Requirements Page 30 of 138

The Admin panel has four sections as shown in the image below. Each of these sections has relevant commands to configure or tweak corresponding modules (except the General section whose commands apply to the whole app). The Licensing section is used to check the license status, or activate the product using a valid key (in case the product hasn t been activated yet). The General section is used to configure the repository name for GIT projects. The Review and Baseline sections are used for tweaking options in relevant modules. The licensing section has already been discussed in the Activation part of this document. Options in other sections are explained below. Many of the options discussed below are also discussed under the Appendix section. They illustrate how to carry out the same process for the standalone version of the application. GENERAL SECTION HOW TO CONFIGURE THE REPOSITORY NAME FOR GIT PROJECTS The repository is named after the project s name by default in any project. 2018 Modern Requirements Page 31 of 138

However, for GIT projects only, users can now configure the repository name of their choice by following these steps: 1. Access the Admin panel and select the General option. 2. Click the +Add option. 2018 Modern Requirements Page 32 of 138

3. Select the desired GIT project from the list. Modern Requirements4TFS Installation Guide 4. Enter a suitable repository name and click OK. 2018 Modern Requirements Page 33 of 138

5. Click Save Changes. Modern Requirements4TFS Installation Guide The new repository name becomes visible in the list. 2018 Modern Requirements Page 34 of 138

REVIEW SECTION CONFIGURING THE REVIEW METADATA IN THE DESIRED FIELD When you initiate each review request, a Feedback Request Work Item is created. By default, the metadata of the review is saved in the Launch Instruction field of that work item. However, you can configure it to save the metadata in the field of your *choice using the following steps: *The metadata support at the moment is reserved only for the HTML type fields of Launch Instructions and Description. 1. Access the Admin panel and click Review. 2018 Modern Requirements Page 35 of 138

2. Select the desired field (from the first option in the page) to store the metadata. 3. Scroll down and click Save Changes at the bottom. 2018 Modern Requirements Page 36 of 138

CONFIGURATION FOR THE COMPARE POPUP Modern Requirements4TFS Installation Guide When a review is opened, you can check and compare different revisions of the selected work item using the compare popup. In this popup there are different sections such as Attachments and Links (highlighted below). You can configure which sections will be displayed during the comparison, using the following steps: 1. Access the Admin panel and click Review. 2. Select the desired checkboxes in the Sections Configuration section. 2018 Modern Requirements Page 37 of 138

3. Scroll down and click Save Changes at the bottom. CONFIGURING THE WORK ITEM FIELDS FOR THE DISPLAY IN THE COMPARE POPUP When a review is opened, the fields of the selected work item are shown in the Compare popup. 2018 Modern Requirements Page 38 of 138

You can configure which work item fields you want to display in the popup by following these steps: 1. Access the Admin panel and click Review. The Work item display fields section determines which work item fields will be displayed for the selected work item in a review. ADDING A FIELD 1. Click the +Add option (in the Work item display fields section). 2018 Modern Requirements Page 39 of 138

2018 Modern Requirements Page 40 of 138

2. Move the desired fields from the Available list to the Selected list using the arrow button. 3. Click OK after selecting all the desired fields. 2018 Modern Requirements Page 41 of 138

4. Scroll down and click Save Changes at the bottom. REMOVING A FIELD 1. Select the desired field from the list and click Remove. 2. Scroll down and click Save Changes at the bottom. 2018 Modern Requirements Page 42 of 138

CONFIGURING THE ACTIONS FOR A REVIEW RESPONSE The actions for the review response can be configured so that the desired values can be added. This can be done by: 1. Accessing the Admin panel and clicking the Review option. 2. Scrolling down to view the bottom portion of the page. The Review Response Actions section determines which actions are available for review response. 2018 Modern Requirements Page 43 of 138

3. Select the +Add option located in the Review Response Actions section. 2. Enter a suitable action name and click OK. 2018 Modern Requirements Page 44 of 138

3. Scroll down and click Save Changes at the bottom. CONFIGURING THE RECIPIENTS EMAILS IN CASE OF FAILED POST-STATE IN THE REVIEW MODULE When a review request is being created, a field called Post State (in the Rules section) tells Modern Requirements4TFS to change the state field (to the selected state) when the approval process is completed. 2018 Modern Requirements Page 45 of 138

If the selected post state can t be automatically achieved for any reason, the review initiator will be notified automatically via email. That said, the review initiators may want to send out the automatic notification to additional stakeholders. This section deals with how to configure the emails for these additional stakeholders. 1. Access the Admin panel and click Review. 2. Scroll down to view the bottom portion of the page. The Review Post State Rule section determines which actions are available for review response. 3. Click +Add option located in the Review Post State Rule section. 2018 Modern Requirements Page 46 of 138

4. Provide the desired email address and click OK. Modern Requirements4TFS Installation Guide 5. Click Save Changes. 2018 Modern Requirements Page 47 of 138

BASELINE SECTION CONFIGURING THE SECTIONS FOR THE DISPLAY IN THE COMPARE BASELINE POPUP 1. Access the Admin panel and select the Baseline option. 2. Select the desired checkboxes in the Sections Configuration section. 3. Scroll down and click Save Changes. 2018 Modern Requirements Page 48 of 138

CONFIGURING THE WORK ITEM FIELDS FOR THE DISPLAY ON OPENING A BASELINE 1. Access the Admin panel and select the Baseline option. 2. Click +Add option (located in the Work Item display fields section). 3. Move the desired fields from the Available list to the Selected list using the arrow button. 2018 Modern Requirements Page 49 of 138

4. Click OK after selecting all the desired fields. Modern Requirements4TFS Installation Guide 5. Scroll down and click Save Changes. 2018 Modern Requirements Page 50 of 138

CONFIGURING THE WORK ITEM FIELDS FOR DISPLAY WHILE COMPARING BASELINES 1. Access the Admin panel and select the Baseline option. 2. Click +Add option (located in the Work Item display fields for compare baseline section). 3. Move the desired fields from the Available list to the Selected list using the arrow button. 2018 Modern Requirements Page 51 of 138

4. Click OK after selecting all the desired fields. Modern Requirements4TFS Installation Guide 5. Scroll down and click Save Changes. 2018 Modern Requirements Page 52 of 138

CONFIGURING THE LINK TYPE FOR COPY BASELINE When a baseline is being copied, users can link the original work items with the work items being created at the target location. Users can configure which type of relationship should exist between the source and target work items using the following steps: 1. Access the Admin panel and select Baseline. 2. Scroll down to the bottom of the page and click the Link type drop-down control. 2018 Modern Requirements Page 53 of 138

3. Select the desired relation type from the list. Modern Requirements4TFS Installation Guide 4. Click Save Changes. 2018 Modern Requirements Page 54 of 138

MR AGENT MR Agent is one of the components of Modern Requirements4TFS that is automatically installed with the main application. It s a framework that provides extensibility to TFS using triggers. Currently, MR Agent has the following two sub components: 1. Custom ID 2. Dirty Flag Proper user authentication is required before any of these components are configured. This is explained in the following section. MR AGENT USER AUTHENTICATION MR Agent user authentication requires you to open the CMD and carry out the following steps: 1. Enter the following command on CMD: cd <Installation Drive Letter>:\Program Files (x86)\modern Requirements\MR-Agent\bin 2. Once in the bin directory, enter the following command: MRAgent 2018 Modern Requirements Page 55 of 138

The menu of options is displayed. Modern Requirements4TFS Installation Guide 3. Type 2 and click Enter. 2018 Modern Requirements Page 56 of 138

4. Enter the value for the TFS URL. Modern Requirements4TFS Installation Guide 5. Enter the User ID value. These credentials should grant project administrator privileges. 2018 Modern Requirements Page 57 of 138

6. Enter the password value. Modern Requirements4TFS Installation Guide In case of VSTS, the mandatory password will be Personal Access Token. For further details about the Personal Access Token, please refer to the following link: https://docs.microsoft.com/en-us/vsts/git/_shared/personalaccess-tokens For on-prem TFS, Personal Access Token can also be used. If no error message is displayed the authentication has been completed successfully. CUSTOM ID CONFIGURAION In order to make the Custom ID work properly, users must manually create the following two items: 1. TFS server folder name on which the Custom ID is required to apply. 2. TFS Collection folder name (the Collection on which the Custom ID is required) under the TFS folder name. The relevant collection folder should also include the config.xml file containing all configuration. The file and folder hierarchy should appear as shown below using the text pattern and relevant image: 2018 Modern Requirements Page 58 of 138

As described in the image above, a sample Config.xml file is placed in the CustomId folder. 2018 Modern Requirements Page 59 of 138

1. Create a folder named after the TFS name at this location. 2. Enter the newly created folder and again create another folder here named after the relevant TFS collection name. 2018 Modern Requirements Page 60 of 138

3. Copy the Config.xml file (discussed earlier) into the newly created folder. This file contains the blueprint for the desired configuration. CONFIGURING THE CUSTOM ID XML FILE 1. Open the config.xml file in Notepad or any text editor. 2. Define the value of the IDScope tag as per requirement, for example: Collection -> apply counter scope to Collection level. Project -> apply counter scope to Project level. 2018 Modern Requirements Page 61 of 138

Modern Requirements4TFS Installation Guide Team ->apply counter scope to the Team level. 3. FieldReferenceName tag with Override value "Yes means that the user defined field (between the tags) will be considered for the Custom ID. Override value No means that the default field MR.CID will be considered and applied for the Custom ID. This means that users must define this field in their TFS template with the same reference name, i.e. MR.CID. 4. CollectionUrl tag requires the URL for the TFS collection on which the Custom ID is required to apply. (Note: Please make sure that the URL should not end on \ ) 5. Projects DefaultNoOfChar tag denotes the number of characters to pick up from the project name, if the project name is not defined in the tag<project Name= >. By default its value is 5. Update the value if desired. 6. Provide the TFS Project name (e.g. Project Name="GITNew") and its customized name (e.g. Prefix="GTN") to be used as a part of custom IDs. 7. Sequence Id="1" tag ID value shows the number of different Custom ID groups created in the configuration file and is used to identify and differentiate from the ID. It will always be a numeric only field and should be kept unique. The Sequence tag consists of a combination of WorkItem type, formatting required on the ID field and counter to start from. a. The WIType value requires the type of WorkItem on which the Custom ID is required to apply. Also, if required, multiple WorkItems could be defined for the same configuration to apply as a group. b. The FieldFormat tag is used to define ID formatting required on the Custom ID. Example: <FieldFormat>[PN] Req #####</FieldFormat> [PN] is used as a placeholder for the above defined prefix of the project Name. For numeric format reference please check the following link: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings c. The FieldCounter tag is required to define the number or series from where the Custom ID counter is required to start from. Once the counter value is applied (configuration file is applied), it cannot be modified in any case. 8. Following the successful completion of the configuration file, save and close the file. 2018 Modern Requirements Page 62 of 138

APPLYING CUSTOM ID ON EXISTING WORK ITEMS 1. Enter the following command on CMD: cd <Installation Drive Letter>:\Program Files (x86)\modern Requirements\MR-Agent\bin 2. Once in the bin directory, enter the following command: MRAgent 3. Type 1 and click Enter. 2018 Modern Requirements Page 63 of 138

4. Enter the URL value. Modern Requirements4TFS Installation Guide If no error message is displayed the Custom ID application has been completed successfully. 2018 Modern Requirements Page 64 of 138

DIRTY FLAG CONFIGURATION Modern Requirements4TFS Installation Guide In order to make the Dirty Flag work properly, users must manually create the following two items: 1. The TFS folder name 2. The TFS collection folder name (the collection on which the dirty flags are required) under the TFS server folder name The relevant collection folder should also include the config.xml file containing all configuration. The file and folder hierarchy should appear as displayed below using the text pattern and relevant image: As described in the image above, a sample Config.xml file is placed in the Dirty Flag folder. 2018 Modern Requirements Page 65 of 138

1. Create a folder named after the TFS name at this location. 2. Enter the newly created folder and again create another folder here named after the relevant TFS collection name. 2018 Modern Requirements Page 66 of 138

3. Copy the Config.xml file (discussed earlier) into the newly created folder. This file contains the blueprint for the desired configuration. 2018 Modern Requirements Page 67 of 138

CONFIGURING THE DIRTY FLAG XML FILE Modern Requirements4TFS Installation Guide 1. Open config.xml file in Notepad or any text editor. 2. Open the config.xml file in Notepad or any text editor. 3. Define the Collection URL value using the CollectionURL tag. Each Action tag has a Source part and a Target part. The Source part tells MR Agent what to look for to trigger the Dirty Flag; the Target part tells MR Agent which type of work items will be tagged as dirty in case of a trigger. 4. In the Source section the WIType tag denotes the type of work items with which the Dirty Flag will work. Multiple work items types could be used with comma, as a separator. 5. The FieldReferenceName tag denotes which field(s) of the work item (the list is provided in the WIType tag) will be checked. 6. The FieldValue tag denotes the exact value of the FieldReferenceName that will trigger the Dirty Flag. If multiple fields are checked, the Dirty Flag will be triggered only when all the FieldValues are matched, i.e. using AND logic. 7. The WIType of the target section denotes the type of work items that will be marked as dirty if the condition in the source section is satisfied. 8. Save and close the configuration file following its successful completion. 2018 Modern Requirements Page 68 of 138

SCANNING THE TFS COLLECTION FOR IDENTIFICATION OF NEW PROJECT This operation is also performed automatically and is configurable in the AppSettings.config file at the following location: <Installation Drive Letter>:\Program Files (x86)\modern Requirements\MR-Agent\ 1. Open the AppSettings.config file in any text editor, as shown below. The edev.mr.agent.core.subscribeschedule tag value shows minutes, i.e. 30 of time interval for scanning all configured TFS collections (refer to the highlighted line below). 2. Make sure that this value is between 1 and 60. Update within this range if needed. 3. Enter the following command on CMD: cd <Installation Drive Letter>:\Program Files (x86)\modern Requirements\MR-Agent\bin 2018 Modern Requirements Page 69 of 138

4. Once in the bin directory, enter the following command: MRAgent 5. Type 3 and click Enter. 2018 Modern Requirements Page 70 of 138

6. Enter the TFS collection to scan. Modern Requirements4TFS Installation Guide If no error message is displayed, the Dirty Flag process has been successfully carried out. 2018 Modern Requirements Page 71 of 138

APPENDIX: USER CONFIGURATIONS Modern Requirements4TFS Installation Guide MANUALLY ENABLING WINDOWS FEATURES If an organization has restrictions in its working environment that don t permit you to enable or modify the Windows Feature settings, follow these instructions to enable the window features manually. 1. Open the Control Panel and change the View by field value to Category (if not selected by default). 2. Select the Programs option. 3. Select the Turn Windows features on or off option under the Programs and Features category. 2018 Modern Requirements Page 72 of 138

The Windows Feature screen will be displayed. 4. Select the highlighted features required for Modern Requirements4TFS. 2018 Modern Requirements Page 73 of 138

5. If Win8 or a more recent version is installed on the machine please enable the features highlighted in the following image as well: ADDING IIS BINDING INFORMATION IN CONFIGURATION FILES If you have bound any IP on the system, you must update the web configuration file using the following steps: 1. Invoke inetmgr through Windows s Run command/start Menu. 2. Expand the node on the left-hand side of the panel of the Internet Information Services (IIS) Manager. 2018 Modern Requirements Page 74 of 138

3. Select the Application Pools option. 2018 Modern Requirements Page 75 of 138

4. Right-click ModernRequirements4TFS 2017 Update XX and select Edit Binding. The Site Bindings window will be displayed. The IP Address field will display which IP has been bound, if any. 5. Note the IP Address value, e.g.10.0.0.20 (displayed in the image above), and go to the installation directory, i.e. <Default Installation Drive>:\Program Files (x86)\modern Requirements\ModernRequirements4TFS 2017Update X\User Interface 6. Select the Web.config file among the list displayed in the folder (refer to the highlighted line in the image above). 2018 Modern Requirements Page 76 of 138

7. Open the file in Notepad. Modern Requirements4TFS Installation Guide 8. Search for the tag <add key="serviceaddress" value=".."/> (selected in the following image) and update its value, http://<machine name>:8027/ with the IP address bound and noted above, i.e. value=http://10.0.0.20:8027/ 9. Save the file and close it. If you aren t allowed to save the Notepad file with changes on the same directory, save it on desktop first. Then copy it back to this directory, i.e. location and replace. 2018 Modern Requirements Page 77 of 138

10. Switch back to the IIS Manger window and restart both integreat services under the Sites folder. EMAIL CONFIGURATION FOR THE FEEDBACK OPTION The email configuration is essential if you want to use the Feedback option in the Simulation Module. This is because Modern Requirements4TFS automatically sends out emails to concerned stakeholders to get their feedback. If the email settings are not properly configured, these emails can t be sent out and the feedback option won t function properly. Take the following steps to configure the email settings for Modern Requirements4TFS: 1. Navigate to the following location on your computer: C:\Program Files (x86)\modern Requirements\ModernRequirements4TFS 2017 Update X\Service 2018 Modern Requirements Page 78 of 138

2. Copy the Web.config file to another location (e.g. desktop) for editing. 3. Open the file using a text editor (e.g. Notepad). Note: The highlighted section in the image above displays the section of the file that needs to be configured properly. 2018 Modern Requirements Page 79 of 138

4. Now open your email client/email reader (e.g. Microsoft Outlook). Note: The following steps show the process for Microsoft Outlook. If you re using another email reader, refer to its documentation for relevant steps. 5. Click File Account Settings Account Settings. 6. Double-click the desired email account from the list. 2018 Modern Requirements Page 80 of 138

7. Note down the information highlighted in the window. 8. Click the More Settings button. 2018 Modern Requirements Page 81 of 138

9. Open the Advanced tab. 10. Note down the SMTP port highlighted in the window. 11. After noting down all the required information, close down all the windows in Microsoft Outlook. 12. Switch back to the Web.config file opened in the text editor. 2018 Modern Requirements Page 82 of 138

13. Update the mail settings section using the information gathered from Microsoft Outlook. 14. Save the Web.config file and replace the older version with the updated version at its original location (i.e. C:\Program Files (x86)\modern Requirements\ModernRequirements4TFS2017 Update X\Service ) This completes the email configuration process for the Feedback Option. 2018 Modern Requirements Page 83 of 138

FIX FOR ACTIVATION LOST AFTER THE VM MACHINE RESTART (STANADALONE) For any general Virtual Machine (of any O.S): 1. If you re navigated to the Activation page again after license activation, as displayed below: Or you re navigated there following the error message, An error occurred while processing your request, as displayed below: 2. Using Remote Desktop option, connect with the VM Machine where Modern Requirements4TFS has been deployed. 2018 Modern Requirements Page 84 of 138

3. Go to the Run window (by clicking the Keyboard shortcut: [<windows key> + R ]) and typing gpedit.msc. Refer to the screen shot below: 4. Go to Computer Configuration->Administrative Templates->System->UserProfiles. 5. Select Do not forcefully unload the user registry at user logoff as highlighted below. 6. Change the setting from Not Configured to Enabled, and click Apply. Once done, restart the VM machine and check if the issue has been resolved. 2018 Modern Requirements Page 85 of 138

If VDI (Virtual Desktop Infrastructure) has been implemented, follow these steps: 1. Using Remote Desktop option, connect with the VM Machine where Modern Requirements4TFS has been deployed. 2. Go to the Run window and type %public%. 3. Select the Public Documents folder. 4. Confirm that the following file exists in the folder: username.bin in case offline activation was done by the user username.orf in case online activation was done by the user 5. If Yes, kindly mention this in your email along with the log files (<Default Drive>:\inetpub\wwwroot\walog) at: support@edevtech.com 6. If No, please ask the VDI administrator to share the image of VM after activating the license from all users. That image will be present on all licensing information. 2018 Modern Requirements Page 86 of 138

HOW TO UPDATE THE WINDOWS CREDENTIALS FOR MODERN REQUIREMENTS4TFS During the installation of Modern Requirements4TFS, user login credentials are provided. These Windows credentials are saved in the Modern Requirements4TFS settings and are used while running the application. If you change your Windows password after the installation, these settings become obsolete and you may face problems running the application. For a seamless operation of Modern Requirements4TFS, the saved settings of the Windows credentials should be consistent with the current Windows credentials. If you change your password after installing Modern Requirements4TFS, take the following steps to update the saved settings: 1. Invoke inetmgr through Windows s Run command/start Menu. 2018 Modern Requirements Page 87 of 138

2. Expand the node in the panel of the IIS Manager on the left-hand side. 3. Select the Application Pools option. 2018 Modern Requirements Page 88 of 138

4. Select integreat4tfssrv and click Advanced Settings under Edit Application Pool on the right-hand side. 5. Select the Identity option under the Process Model section and click the button. 2018 Modern Requirements Page 89 of 138

6. Select the Custom account option and click the Set button. 7. Enter the latest *Windows credentials and click OK. *The User name should be given in the format of <Domain\Username> as displayed in the image above. The settings will be saved by clicking OK. 8. Start integreat4tfssrv by clicking Start under the Application Pool Tasks on the right-hand side of the panel. 2018 Modern Requirements Page 90 of 138

Close all windows to complete the process. 2018 Modern Requirements Page 91 of 138

HOW TO CONFIGURE LOAD BALANCING FOR MODERN REQUIREMENTS4TFS This section describes the configuration process of load balancing for Modern Requirements4TFS using detailed steps. It acts only as a framework to show how to configure load balancing for Modern Requirements4TFS. Installation steps are not covered here. For installation steps of individual applications, refer to their respective sections in the guide. The configuration process consists of the following seven steps: 1. Setup/Install the desired load balancing environment. 2. Install Modern Requirements4TFS on all servers. 3. Configure the shared network drive for shared workspace. 4. Install/configure the shared Redis server. 5. Change the User Interface Configuration file (web.config). 6. Change the Service Configuration file (web.config) 7. Repeat steps 5 and 6 for all servers on which Modern Requirements4TFS has been installed for load balancing. While most of the steps are straightforward, steps 5 and 6 are described in further detail below. Also note that both of these steps refer to different files with same name. CHANGE THE USER INTERFACE CONFIGURATION FILE The location of this file in Program Files (x86) is highlighted in the following image: To complete this step carry out the following elementary steps: 1. Open the Web.config file (as mentioned above) in editable mode. 2. Edit the following to set the shared drive *path: <add key="appcontentpath" value="<shared drive path>" /> * The shared drive path is setup in step 3 of the overall configuration process (mentioned in the previous section). 3. Comment the SessionState timout command as the following: <!--<sessionstate timeout="40" />--> 2018 Modern Requirements Page 92 of 138

4. Uncomment the following section: Modern Requirements4TFS Installation Guide 5. In the above section, set customprovider value to RedisCacheAzure01. 6. Make the following comment in the section above: <add name= LocalRedisCacheAzure01 type= Microsoft.Web.Redis.Redis. 7. Set the Redis host, port and access key (password) value in the following line of the above section: <add name= RedisCacheAzure01 type= Microsoft.Web.Redis.Redis. CHANGE THE SERVICE CONFIGURATION FILE The location of this file in Program Files (x86) is highlighted in the following image: To complete this step, carry out the following elementary steps: 1. Open the Web.config file (as mentioned above), in editable mode. 2. Set the shared drive path for the workspace folder key (the same path assigned in step 3) <addkey= WorkspaceFolder value= %public%documents > 3. Set the EnableLoadBalancer key value to true : <addkey= EnableLoadBalancer value= true > 4. Set the Redis storage value host, port and *password *Note: The values for these attributes are determined while installing Redis Server in step 4 of the overall configuration process (mentioned at the beginning of this section). 2018 Modern Requirements Page 93 of 138

HOW TO CHANGE THE COLOR (RGB) VALUE FOR A WORK ITEM You can change the color for a work item by performing the following steps: 1. Go to the location <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\User Interface\App_Data 2. Open the file ColorCodeMapping.xml in Notepad. 3. Change the desired color code for a work item. 4. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 5. Restart IIS. 2018 Modern Requirements Page 94 of 138

HOW TO CONFIGURE THE REPOSITORY NAME FOR GIT PROJECTS The repository is named after the project s name by default in any project. But for GIT projects only, you can now configure the repository name of your choice by following these steps: 1. Open the desired GIT project. 2018 Modern Requirements Page 95 of 138

2. Open the Code option from the toolbar and select the repository name in the drop-down menu. 3. Click the repository name and select the New Repository option. 2018 Modern Requirements Page 96 of 138

4. Enter the desired name for the new repository and click Create. A new repository is created. 5. Go to the location <Modern Requirements4TFS Installation Drive>:\Users\Public\Documents 2018 Modern Requirements Page 97 of 138

6. Open the file IG4TFSUserSetting.json in any text editor. 7. Search for the GeneralSettings section. 8. If found, search for the subsequent sub-sections mentioned below. If none of the sub-sections are present in the file, create one as described in the following steps. 9. If the GeneralSettings section is not found place a comma at the end of the last section. 2018 Modern Requirements Page 98 of 138

10. Create a new GeneralSettings section as shown in the following image. 11. Create a sub-section named WorkItemProperties under the GeneralSettings section. 2018 Modern Requirements Page 99 of 138

12. Similarly, create a ConfigField sub-section under WorkItemProperties. 13. Under the ConfigField sub-section create a property named ProjectBasedGitRepoName as highlighted in the following image. 2018 Modern Requirements Page 100 of 138

14. Enter the value for the desired repository name. Separate the GIT project name and the relevant repository name using a separator. 2018 Modern Requirements Page 101 of 138

15. Repeat the process for other GIT projects and the relevant repository name. Separate the two pairs of the GIT project and repository names using a semicolon. 16. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 17. Sign out from Modern Requirements4TFS and sign in again for the changes to take effect (standalone version). 12. Select any of the Modern Requirements4TFS modules (embedded version). 2018 Modern Requirements Page 102 of 138

HOW TO UPDATE THE WORK ITEM TYPE FOR SIMULATION, DIAGRAM AND USECASE Default mapping is embedded in the application to support the Work Item to File Type functionality. When you create a new file, a page work item is also created in the connected team project in accordance with the work item type stated in this file. Complete the following steps to update the work item type of a page work item: 1. Access the following path: <Windows installation folder>\program Files (x86)\modern Requirements\Modern Requirements4TFS 2017 Update X\Service\App_Data 2. Look for the XML file WIToFileTypeMapping in the folder and open it. 3. Look for the field <WorkItem id="<wi Type>" /> in the respective module section and update the "<WI Type>" value accordingly. 4. Save the file at some other location (e.g. desktop). 5. Copy the file from the saved location and paste it in the same installation folder (as mentioned earlier in step 1) 6. Restart the application service from IIS Manager. Refer to Appendix for process details. 7. Log in to the application. 8. Type inetmgr on the Run command. 2018 Modern Requirements Page 103 of 138

The IIS Manager window will open. Modern Requirements4TFS Installation Guide 9. In the IIS Manager window, select the Modern Requirements4TFS 2017 Service option on the left-hand side. 2018 Modern Requirements Page 104 of 138

10. Look for the section called Manage Web Site on the right-hand side of the panel. Click Stop followed by Start. HOW TO CHANGE THE LOCATION OF THE BASELINE FILE Modern Requirements4TFS creates a local working folder on the machine where Modern Requirements4TFS is installed. The path can be changed but this one is recommended when you re installing and using Modern Requirements4TFS for the first time. By manually changing the location of Modern Requirements4TFS folder (different then that used during the existing installation), all existing created project data and files will become inaccessible. This approach isn t going to work for the existing projects by just copying existing content to new location. Changing any existing file or removing it from the location might corrupt the whole project data. The following steps need to be performed to update the location: 1. Go to the location : <Modern Requirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\Modern Requirements4TFS 2017Update X\Service 2. Open web.config file, find the following tag : <add key="worksapcefolder" value="%public%/documents"/> 3. Update the value of WorkspaceFolder with the required location**. 4. Save the web.config file. 5. Restart the IIS service. **A location can be a shared Data Drive, or a separate drive/folder. P.S: By doing this with the existing installation, all existing created project data and files will be inaccessible. 2018 Modern Requirements Page 105 of 138

HOW TO PRE-FILL A SPECIFIC FIELD WHILE COPYING THE BASELINE USING MODERN REQUIREMENTS4TFS You can pre-fill a specific field or fields of a work item when it s copied from one of the baselines to the same project or a different one. This is achieved by updating the IG4TFSUserSetting file in the Modern Requirements4TFS installation file. Perform the following steps to complete this action. 1. Close the Modern Requirements4TFS application. 2. Go to the location <ModernRequirements4TFS Installation Drive>:\Users\Public\Documents 3. Open the file IG4TFSUserSetting.json in any text editor. 4. Search for the ConfigField section under the CopyBaseline section, located under the BaselineSettings section. 2018 Modern Requirements Page 106 of 138

The basic structure for the configuration will already be there, i.e. Name & Value. 5. Configure the pre-filled field using the following format: a. Enter the name of the field within the quotation marks in the Name field. b. Enter the value to be pushed within the quotation marks in the Value field. There are two approaches that you can follow: I. Enter a static value in the target project field. For example, you should populate the target project s Description field with value login details (static text) as follows: Name: Description Value: Login Details II. Obtain the value from the source project field and set it into the target project field. For example, you should populate the target project s Description field with the value of the Area Path field of the source project as follows: Name: Description Value: @Area Path Please note that to get the value of a specific field, <Field name> must be written with @ character. 2018 Modern Requirements Page 107 of 138

1. Repeat the last step if you want to configure additional fields. Make sure to separate the two fields with a comma as illustrated in the following image: 2. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 108 of 138

HOW TO DEFINE THE LINK TYPE RELATION WITH THE SOURCE WORK ITEM WHILE COPYING THE BASELINE USING MODERN REQUIREMENTS4TFS When you copy the work items from the baseline using ModernRequirements4TFS to the same or another project you can select the Link with the source Work Item option. If you check this box (shown in the image below) the system will create a related relationship in the target project by default. This can be changed to any relationship type defined in your process template by making the following changes: 1. Go to the location <ModernRequirements4TFS Installation Drive>:\Program Files (x86)\ Modern Requirements\ModernRequirements4TFS 2017Update X\Service\App_Data 2018 Modern Requirements Page 109 of 138

2. Open the file IG4TFSUserSetting.json in Notepad. 3. Search for the RelationLinkType section. 2018 Modern Requirements Page 110 of 138

4. Replace the value Related with the desired one. 5. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 6. Restart IIS. 2018 Modern Requirements Page 111 of 138

CONFIGURING THE FIELDS FOR THE DISPLAY IN THE WORK ITEM DETAILS PANEL ON OPENING A BASELINE When a baseline is opened, the fields of the selected work item are displayed in the Work Item Details Panel (if the panel is not collapsed). You can configure which work item fields you want to display in the panel by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor. 2018 Modern Requirements Page 112 of 138

2. Create a new section named GeneralSettings. Modern Requirements4TFS Installation Guide 3. Add the WorkItemProperties section inside the GeneralSettings section. 2018 Modern Requirements Page 113 of 138

4. Similarly add the ConfigField section inside the WorkItemProperties section. 5. Configure the desired properties (that are to be displayed in the Work Item Details panel) using the following format: a. In the first line write the following text = Name : WorkItemDisplayProperties, b. In the second line write the following text = Value : <reference name of the Work Item field> For example if you want to display only the Work Item Type you should write: Name : WorkItemDisplayProperties, Value : System.WorkItemType The additional fields should be separated by a comma as displayed in the following image. 6. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 114 of 138

CONFIGURING THE FIELDS FOR THE DISPLAY IN THE WORK ITEM DETAILS PANEL WHILE COMPARING BASELINES The previous section described the process of configuring the work item fields that would show up in the Work Item Details panel. A similar panel is also shown when two baselines are compared. You can configure its fields as well by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor. 2. Search or create the section called GeneralSettings. This section would already exist if you have have carried out the instructions in the previous section. 2018 Modern Requirements Page 115 of 138

3. Add an unnamed sub-section under the ConfigField section and populate it as described in the previous topic (i.e. Configuring the fields for the display in the Work Item Details Panel on opening a baseline). Make sure to put a comma between the two sub-sections. 4. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 116 of 138

CONFIGURING THE FIELDS FOR THE DISPLAY IN A WORK ITEM DETAILS PANEL ON OPENING A REVIEW When a review is opened, the fields of the selected work item are displayed in the Work Item Details tab. This happens when the tab is selected. The Comments tab is displayed by default. You can configure which work item fields you want to display in the panel by following these steps: 1. Open the file IG4TFSUserSetting.json in any text editor. 2018 Modern Requirements Page 117 of 138

2. Create a new section called GeneralSettings. Modern Requirements4TFS Installation Guide 3. Add the WorkItemProperties section inside the GeneralSettings section. 2018 Modern Requirements Page 118 of 138

4. Similarly add the ConfigField section inside the WorkItemProperties section. 5. Configure the desired properties that will be displayed in the Work Item Details panel using the following format: a. In the first line write the following text = Name : WorkItemDisplayProperties, b. In the second line write the following text = Value : <reference name of the Work Item field> If you want to display only the Work Item Type you should write: Name : WorkItemDisplayProperties, Value : System.WorkItemType Additional fields should be separated by a comma, as displayed in the following image: 6. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 119 of 138

HOW TO CONFIGURE THE RULES SECTION OF REVIEW MANAGEMENT IN MODERN REQUIREMENTS4TFS Setting up the review in the Review module of Modern Requirements4TFS enables you to define the rules of your choice. As displayed in the image, the Rules section consists of checkbox controls and dropdown controls. Users can configure the checkbox controls individually (and independently from one another). However the dropdown boxes are configured as a whole they either appear or not, depending on settings put in place by the users. To configure the rules section follow these steps: 1. Go to the location <ModernRequirements4TFS Installation Drive>:\Program Files (x86)\modern Requirements\ModernRequirements4TFS 2017Update X\User Interface 2. Open the file web.config in Notepad. 2018 Modern Requirements Page 120 of 138

3. Search for the tag keys starting with Review.Rules. Some values are set to True by default, while others are set to False. 2018 Modern Requirements Page 121 of 138

The relationship between the fields displayed in the Review Request window and corresponding tag keys is displayed in the following image: 4. Set the values as required using the following table serving as a guide: Key RulesApproveAsPackage RulesApproveAsPackageChecked RulesReenterPassword RulesReenterPasswordChecked RulesStatesVisible Set value as True: if Approve as package rule is to be displayed in the section False: if Approve as package rule is to be omitted from the section True: if Approve as package checkbox is to appear selected by default False: if Approve as package checkbox is to be unticked by default True: if Password on approval rule is to be displayed in the section False: if Password on approval rule is to be omitted from the section True: if Password on approval checkbox is to appear selected by default False: if Password on approval checkbox is to appear unticked by default True: if the Pre-state, Post-state and Change state rules are to be displaued in the section 2018 Modern Requirements Page 122 of 138

False: if the Pre-state, Post-state and Change state rules are to be omitted from the section 5. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 6. Restart IIS. 2018 Modern Requirements Page 123 of 138

HOW TO CONFIGURE THE ACTIONS FOR A REVIEW RESPONSE IN MODERN REQUIREMENTS4TFS You can configure the actions for the review response so that the desired values can be added. This can be done as follows: 1. Go to the location C:\users\Public\Documents and open the file IG4TFSUserSetting in Notepad. 2018 Modern Requirements Page 124 of 138

2. Search for the contents highlighted in the image below: 3. The values of ReviewResponseCustomState are used to set an action against a review response. By default, it has three actions (as shown in the xml of the Value field). 4. You can only configure the Value field; for example you can add more actions, delete or update any existing actions. 5. You cannot update the label of the Review Action field; you cannot even can set any action value to appear in the drop-down as default. 6. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 7. Restart IIS. 2018 Modern Requirements Page 125 of 138

CONFIGURING THE REVIEW METADATA IN THE DESIRED FIELD Each time you initiate a review request, a feedback request work item is created. By default, the metadata of the review is saved in the Launch Instruction field of that work item. However, you can configure it to save the metadata in the *field of your choice, using the following steps: *The metadata support is reserved for only the HTML type fields. 1. Go to the location C:\users\Public\Documents and open the file IG4TFSUserSetting in Notepad. 2. Search for the ReviewManagementSettings section in the file. 2018 Modern Requirements Page 126 of 138

3. Configure the metadata to the desired field by adding the section highlighted in the following image where Value = the desired field required to hold the metadata. 4. Add the reference name of the desired field in the Value tag from the process template as shown in the image below. 5. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 127 of 138

CONFIGURING THE RECIPIENTS EMAILS IN CASE OF FAILED POST-STATE IN THE REVIEW MODULE When a review request is being created a field called Post State (located in the Rules section) tells Modern Requirements4TFS to change the state field (to the selected state) when the approval process is completed. If the selected Post State can t be automatically achieved for any reason, the review initiator is notified automatically via email. Still, review initiators may want to send out the automatic notification to additional stakeholders. This section deals with how to configure the emails for these additional stakeholders. 1. Open the file IG4TFSUserSetting.json in any text editor. 2. Search for the ReviewManagementSettings section. 2018 Modern Requirements Page 128 of 138

3. Under this section create the ReviewRequest section. 4. Add the ConfigField section under it. 5. Under this section add the EmailAddress property along with its value, as displayed in the following image. Separate the two email addresses with a semicolon. Save the file. If you don t have admin rights save the file on desktop and replace it with the existing file in the same folder. 2018 Modern Requirements Page 129 of 138

HOW TO DELETE OBSOLETE NFR TEMPLATES FROM FAQ MODULE The obsolete NFR templates of the FAQ module appear when you try to create a new topic in the FAQ Module. These templates appear due to a folder created during the installation of older versions of Modern Requirements4TFS (at that time called integreat4tfs). The following folder needs to be manually deleted by the users to get rid of these obsolete templates: C:\Users\Public\Documents\inteGREAT4TFS\QWizard Templates\NFR 2018 Modern Requirements Page 130 of 138

After deleting the folder you should re-sign in or refresh the application to confirm the disposition of the obsolete templates. THE DEPLOYMENT INSTRUCTION PAGE APPEARING INSTEAD OF THE LICENSE STATUS PAGE (EMBEDDED) For the embedded version, you may check the status of the license for Modern Requirements4TFS by entering the following URL: <machine name>:8028/license/status e.g. steve:8028/license/status. This URL usually displays the status page similar to the one shown below. You may come across a situation where, instead of the license status page, the deployment instruction page is displayed as shown below. 2018 Modern Requirements Page 131 of 138

This situation occurs when you re using Visual Studio Team Services, but haven t used any of the Modern Requirements4TFS modules in the current session yet. In other words, you have been using the container environment but haven t actually used Modern Requirements4TFS so far. Therefore the status check for the license won t work in this scenario. But after you click any of the Modern Requirements4TFS modules this problem won t persist. UNEXPECTED ERROR MESSAGE (STANDALONE) Occasionally you may come across the unexpected error message as displayed in the following image. 2018 Modern Requirements Page 132 of 138

The solution to this error starts at the same Sign-in page. 1. Open the Click here link, as shown below. You ll be taken to the Diagnostics page which briefly describes the precise root cause of the error. 2. Open the click here for solution link. 2018 Modern Requirements Page 133 of 138

You ll be redirected to the solutions page, where you can browse through the detailed solution for the relevant root cause of the error. 3. Follow the solution provided in the answer to solve the problem in question. IIS VERSION IS LOWER.. ERROR 2018 Modern Requirements Page 134 of 138

If you encounter the following error message ModernRequirements4TFS cannot be installed on system with IIS Services version lower than 7.0 during installation, there could be multiple reasons for it. 1. IIS isn t installed on the targeted machine (on which you re trying to install Modern Requirements4TFS). 2. IIS hasn t been properly or completely installed on the machine. 3. IIS has been properly installed but the version installed is below Version 7.0. In these scenarios it s recommended to install IIS Manager completely for the successful installation of Modern Requirements4TFS. Additionally, the IIS version installed should be greater than Version 7.0. 400 BAD REQUEST ERROR (EMBEDDED) Internet Explorer by default doesn t allow storing cookies of sites which are inside the IFrame and have a different domain from the parent site. The embedded version of Modern Requirements4TFS has an architecture where the parent site is https://*.visualstudio.com and IFrame site used is https://modernrequirements.info. This issue, however, is limited to Internet Explorer only. Firefox & Chrome don t show any problems in such scenario. To overcome this issue we need to direct IIS to send a custom header with every response it sends. This needs to be done on every IIS where Modern Requirements4TFS will be deployed in the embedded version. The following steps are required to solve this issue: 1. Open IIS Manager. 2. Select the server name in Root. 2018 Modern Requirements Page 135 of 138

3. Open the HTTP Response Headers option by double-clicking it. 4. Click the Add option in the Actions panel. 2018 Modern Requirements Page 136 of 138

5. Enter the following values and click OK. Name = p3p Value = CAO PSA OUR 6. Again click the server name in Root. 2018 Modern Requirements Page 137 of 138

7. Restart IIS. 2018 Modern Requirements Page 138 of 138