Quick viewing(Text Mode)

Modern Requirements4devops Installation Guide Modern Requirements4devops Installation Guide

Modern Requirements4devops Installation Guide Modern Requirements4devops Installation Guide

Modern Requirements4DevOps Installation Guide Modern Requirements4DevOps Installation Guide

TABLE OF CONTENTS

Introduction ...... 4

System Requirements ...... 4

General Software Requirements ...... 4

Team Foundation Server Requirements ...... 5

Embedded Build Versions ...... 5

Standalone Build versions...... 5

Hardware Requirements ...... 5

Installation Process ...... 6

Installation Guidelines ...... 6

Installing Modern Requirements4DevOps ...... 6

Deploying TFS Extension using the VSIX file ...... 17

In case user can’t find VSIX file ...... 24

Activation (Embedded) ...... 32

Activation (Standalone) ...... 34

User Based Activation ...... 35

Floating Activation ...... 37

Offline Activation ...... 38

Activation Unsuccessful Error ...... 39

Admin Panel (Embedded) ...... 40

General Section ...... 41

How to configure the Repository name for projects ...... 41

Work Item fields to display ...... 45

Sections to display in compare popup ...... 48

Work Item fields to display in the compare popup ...... 49

Configuring email ...... 52

© 2019 Modern Requirements Page 1 of 151 Modern Requirements4DevOps Installation Guide Review Section ...... 54

Configuring the Review Metadata in the desired field ...... 54

Configuring the actions for a review response ...... 56

Configuring the Rules section ...... 58

Configuring review event emails ...... 60

Configuring reminder email timing ...... 61

Configuring the recipients emails in case of failed Post-State in the Review Module ...... 62

Baseline Section ...... 65

Treating link update as a CHANGE during baseline comparison ...... 65

Configuring Work Item fields to be copied while copying baseline ...... 66

Configuring Link type for Copy Baseline ...... 70

MR AGent/Services ...... 73

MR Services User Authentication ...... 73

Manual identification of new project in the Azure DevOps Organization ...... 77

Custom ID Configuraion ...... 80

Configuring the Custom ID XML file ...... 82

Applying Custom ID on Existing Work Items ...... 84

Dirty Flag Configuration ...... 87

Configuring the Dirty Flag XML file ...... 90

Email Monitor ...... 91

Timing configurations in AppSetting file ...... 93

Email Monitor Configuraion ...... 94

Deploying Email Monitor ...... 100

Deploying Email Monitor ...... 100

Appendix: User Configurations ...... 105

Minimum Hardware requirements for Redis ...... 105

Manually Enabling Windows Features ...... 105

© 2019 Modern Requirements Page 2 of 151 Modern Requirements4DevOps Installation Guide Adding IIS Binding Information in Configuration files ...... 108

Email Configuration for the Feedback option ...... 111

Fix for activation lost after the VM Machine restart (stanadalone) ...... 118

How to update the windows credentials for Modern Requirements4DevOps ...... 121

How to use team context in TFS 2019 ...... 126

How to configure load balancing for Modern Requirements4DevOps ...... 131

Change the User Interface Configuration File ...... 131

Change the Service Configuration File ...... 132

How to change the color (RGB) value for a work item ...... 133

How to update the work item type for simulation, Diagram and usecase ...... 134

How to change the location of the baseline file ...... 136

How to delete obsolete NFR templates from FAQ module ...... 137

the Deployment instruction page appearing instead of the License Status Page (Embedded) ...... 138

“Unexpected Error” Message (standalone) ...... 140

“IIS version is Lower..” Error ...... 142

“400 Bad Request” Error (Embedded) ...... 142

Enabling https ...... 146

© 2019 Modern Requirements Page 3 of 151 Modern Requirements4DevOps Installation Guide

INTRODUCTION

This Installation Guide describes the installation/upgradation* of Modern Requirements4DevOps 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 Requirements4DevOps. 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 Requirements4DevOps.

* The Installation and upgradation process is virtually the same, hence the guide can also be used if users intended to upgrade an existing installation of the application.

SYSTEM REQUIREMENTS

GENERAL SOFTWARE REQUIREMENTS

1. : Windows Server 2008 R2 or higher / Windows 7 or higher 2. 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. .Net Framework 4.7.2 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 Requirements4DevOps should include administrator rights on the machine. In other words, users installing Modern Requirements4DevOps 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 Requirements4DevOps 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 Requirements4DevOps is deployed must have authenticated rights on the TFS Collection (or added in Application Domain in IIS).

© 2019 Modern Requirements Page 4 of 151 Modern Requirements4DevOps Installation Guide

TEAM FOUNDATION SERVER REQUIREMENTS

EMBEDDED BUILD VERSIONS

Standard

TFS 2015 update 2+ and higher

Single Sign-On

TFS 2017 update 3, TFS 2018 update 1 and higher

STANDALONE BUILD VERSIONS

TFS 2013 and higher

HARDWARE REQUIREMENTS

1. RAM: At least 12 GB, but higher storage capacity is required if executing TFS work item queries greater than 100,000. 2. Hard drive space: 500 MB

© 2019 Modern Requirements Page 5 of 151 Modern Requirements4DevOps Installation Guide

INSTALLATION PROCESS

INSTALLATION GUIDELINES

 Users are provided with a single installation file i.e. Modern Requirements4DevOps 2019.exe  Since Modern Requirements4DevOps 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 REQUIREMENTS4DEVOPS

1. Double click the Modern Requirements4DevOps 2019.exe file to start the installation process.

© 2019 Modern Requirements Page 6 of 151 Modern Requirements4DevOps Installation Guide The initial installation screen appears, asking the user to accept the terms and conditions for using the application.

© 2019 Modern Requirements Page 7 of 151 Modern Requirements4DevOps Installation Guide 2. Select the terms and conditions agreement check box and click Next.

© 2019 Modern Requirements Page 8 of 151 Modern Requirements4DevOps Installation Guide

3. Select the desired build type (standalone or embedded).

© 2019 Modern Requirements Page 9 of 151 Modern Requirements4DevOps Installation Guide 4. Select the desired installation type (Single sign-on* or Standard)

*If Single sign-on option is selected, it saves the users from entering login credentials every time they intend to use the application.

© 2019 Modern Requirements Page 10 of 151 Modern Requirements4DevOps Installation Guide 5. Click Next.

The prerequisites for Embedded build and Single sign-on appear on the screen in Yellow text, once these options are selected. Users are advised to make sure their systems fulfill these prerequisites before installing the application with these options.

© 2019 Modern Requirements Page 11 of 151 Modern Requirements4DevOps Installation Guide 6. 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.

© 2019 Modern Requirements Page 12 of 151 Modern Requirements4DevOps Installation Guide 7. Configure the MongoDb installation options and click Install.

 The Auto Install MongoDB option is the recommended option if MongoDB isn’t already installed on the target machine.  If MongoDB is already installed, you must provide the name (or IP address) of the machine where MongoDB is installed.  Similarly, if Modern Requirements4DevOps is being installed on a load balancing server, the relevant details should be provided here.  The default port for MongoDB is 27017, but you can give another port number if you’re installing MongoDB independently of Modern Requirements4DevOps. At the time of the Modern Requirements4DevOps installation, you should give the same Port number used during the MongoDB installation.  Refer to your network department to get the value of the MongoDB User/password (if there is one).  The Replica Set information is used for data replication/mirroring.

© 2019 Modern Requirements Page 13 of 151 Modern Requirements4DevOps Installation Guide 8. 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 Requirements4DevOps 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 Requirements4DevOps. At the time of the Modern Requirements4DevOps 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.

© 2019 Modern Requirements Page 14 of 151 Modern Requirements4DevOps Installation Guide 9. Click Yes in the warning message box.

The relevant files are installed.

© 2019 Modern Requirements Page 15 of 151 Modern Requirements4DevOps Installation Guide 10. Complete the installation of Modern Requirements4DevOps 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.

© 2019 Modern Requirements Page 16 of 151 Modern Requirements4DevOps Installation Guide

DEPLOYING 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.

© 2019 Modern Requirements Page 17 of 151 Modern Requirements4DevOps Installation Guide 5. Click Upload new extension.

OR

In case Modern Requirements4DevOps extension already exists and needs to be updated then:

5. Right click on the Modern Requirements4DevOps extension  select Update… option.

This would update the Modern Requirements4DevOps extension in all DevOps collections simultaneously, without the need to update each one individually by the user.

For new installations continue with step # 6.

© 2019 Modern Requirements Page 18 of 151 Modern Requirements4DevOps Installation Guide 6. Click the Browse… button.

© 2019 Modern Requirements Page 19 of 151 Modern Requirements4DevOps Installation Guide 7. Navigate and select the relevant VSIX file (created at the end of the installation in the last section). 8. Click Upload.

© 2019 Modern Requirements Page 20 of 151 Modern Requirements4DevOps Installation Guide 9. Select the desired collection and click Continue.

© 2019 Modern Requirements Page 21 of 151 Modern Requirements4DevOps Installation Guide 10. Click Confirm.

© 2019 Modern Requirements Page 22 of 151 Modern Requirements4DevOps Installation Guide The Modern Requirements4DevOps Embed options become accessible through the Work tab.

© 2019 Modern Requirements Page 23 of 151 Modern Requirements4DevOps Installation Guide

IN CASE USER CAN’T FIND VSIX FILE

In case a user does not find the VSIX, User can generate and deploy the extension in two ways: 1. Using Windows GUI Environment 2. Using Windows Command Prompt

USING GUI ENVIRONMENT

In case of GUI following deployment Instructions are to be followed, to create and deploy TFS Extension 1. Go to the installation folder of Modern Requirements4DevOps e.g. C:\Program Files (x86)\Modern Requirements\Modern Requirements4DevOps 2018 Update 3.1

2. Further navigate inside TFS Extension Maker folder.

© 2019 Modern Requirements Page 24 of 151 Modern Requirements4DevOps Installation Guide Depending upon the selected type of installation; there would a folder named:  Standard (for standard installation) OR  Single Sign On (for Single Sign On installation)

© 2019 Modern Requirements Page 25 of 151 Modern Requirements4DevOps Installation Guide 3. Navigate inside the folder (whichever is present in the TFS Extension Maker folder) and double-click the file “TFSExtensionMaker.exe”

4. Provide required information: (i.e. URI and Output folder) and click the Generate button.

VSIX file will be generated at the desired location.

© 2019 Modern Requirements Page 26 of 151 Modern Requirements4DevOps Installation Guide 5. Click OK button to close the confirmation message box.

VSIX overwrite warning appears.

6. Click No button to close the warning box.

Refer to point # 2 (in Deploying TFS Extension using VSIX file on Desktop section) onwards to deploy TFS Extension

USING COMMAND PROMPT

The command used at the command prompt has the following structure:

TFSExtensionMaker.exe --baseuri --out [[--override] ] [[--publisher] ] [[--version] ] [[--scope] ] [[-- exttype] ]

© 2019 Modern Requirements Page 27 of 151 Modern Requirements4DevOps Installation Guide Following deployment Instructions are to be followed, to create and deploy TFS Extension using Command Prompt: 1. Open command prompt using Run as administrator option.

2. Navigate to the TFS Extension Maker folder within the installation folder (i.e. :\Program Files\Modern Requirements\Modern Requirements4TFS 2018 Update 3\TFS Extension Maker\Standard)

© 2019 Modern Requirements Page 28 of 151 Modern Requirements4DevOps Installation Guide 3. Enter the following command: TFSExtensionMaker.exe --baseuri "http://:8028" --out "" --override true --publisher "edevtech-mr" --version --scope "full" --exttype "project"

4. Check the provided location in command.

© 2019 Modern Requirements Page 29 of 151 Modern Requirements4DevOps Installation Guide 5. Type this address with the server name, in a web browser: http://:8028/VSOInteGreat4TFS/EmbedOMInstructions

6. Follow the instructions and install the extension. 7. To enable features go to the desired project and select Manage Features / Preview Features option.

© 2019 Modern Requirements Page 30 of 151 Modern Requirements4DevOps Installation Guide 8. Select and enable the desired modules/features.

The enabled features will become accessible under the Work option.

© 2019 Modern Requirements Page 31 of 151 Modern Requirements4DevOps Installation Guide

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 Requirements4DevOps option under the Settings tab.

If the product has not been activated the following message will be displayed:

© 2019 Modern Requirements Page 32 of 151 Modern Requirements4DevOps Installation Guide 2. Click Activate.

You are taken to the License Activation Page.

Proceed to the User Based Activation section (explained below) to complete the activation process.

© 2019 Modern Requirements Page 33 of 151 Modern Requirements4DevOps Installation Guide

ACTIVATION (STANDALONE)

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.

© 2019 Modern Requirements Page 34 of 151 Modern Requirements4DevOps Installation Guide If Modern Requirements4DevOps 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 (if not already selected).

© 2019 Modern Requirements Page 35 of 151 Modern Requirements4DevOps Installation Guide 4. Enter the relevant license key and click Activate.

On successful activation, you’ll be taken to the Browse Page, where you can open the team project of your choice.

© 2019 Modern Requirements Page 36 of 151 Modern Requirements4DevOps Installation Guide

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.

© 2019 Modern Requirements Page 37 of 151 Modern Requirements4DevOps Installation Guide

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.

© 2019 Modern Requirements Page 38 of 151 Modern Requirements4DevOps Installation Guide

ACTIVATION UNSUCCESSFUL ERROR

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

© 2019 Modern Requirements Page 39 of 151 Modern Requirements4DevOps Installation Guide

ADMIN PANEL (EMBEDDED)

The Admin Panel is a feature in the embedded version of Modern Requirements4DevOps. 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 Requirements4DevOps option under the Settings tab.

The Admin panel is displayed.

© 2019 Modern Requirements Page 40 of 151 Modern Requirements4DevOps Installation Guide

 The Admin panel has five 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 Services section is used to configure options related to Services (formerly MR Agent)  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

Note: This option is not available for Embedded Single Sign-On version of ModernRequirements4DevOps. The repository is named after the project’s name by default in any project.

© 2019 Modern Requirements Page 41 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 42 of 151 Modern Requirements4DevOps Installation Guide 3. Select the desired GIT project from the list.

4. Enter a suitable repository name and click OK.

© 2019 Modern Requirements Page 43 of 151 Modern Requirements4DevOps Installation Guide 5. Click Save Changes.

The new repository name becomes visible in the list.

© 2019 Modern Requirements Page 44 of 151 Modern Requirements4DevOps Installation Guide

WORK ITEM FIELDS TO DISPLAY

Wherever Work Item details are shown, not every field is displayed. Those which are displayed are configured using General section in Admin Panel.

Users can configure the desired Work Item fields (that will be displayed), using the following steps:

1. Access the Admin Panel and click General.

© 2019 Modern Requirements Page 45 of 151 Modern Requirements4DevOps Installation Guide 2. Click the + Add option (under the Work Items display fields section).

3. Move the desired fields from the Available list to the Selected list using the arrow button.

© 2019 Modern Requirements Page 46 of 151 Modern Requirements4DevOps Installation Guide 4. Click OK after selecting all the desired fields.

5. Scroll down and click Save Changes at the bottom.

© 2019 Modern Requirements Page 47 of 151 Modern Requirements4DevOps Installation Guide

SECTIONS TO DISPLAY IN COMPARE POPUP

When a review is opened, users 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).

Users can configure which sections will be displayed during the comparison, using the following steps:

1. Access the Admin Panel and click General. 2. Select the desired checkboxes in the Sections Configuration heading.

© 2019 Modern Requirements Page 48 of 151 Modern Requirements4DevOps Installation Guide 3. Scroll down and click Save Changes at the bottom.

WORK ITEM FIELDS TO DISPLAY IN THE COMPARE POPUP

Wherever Work Items are compared, certain fields of the selected work item are shown in the Compare popup. The fields shown in the compare popup are configured using Admin Panel.

Users can configure the desired Work Item fields (that will be displayed), using the following steps:

© 2019 Modern Requirements Page 49 of 151 Modern Requirements4DevOps Installation Guide 1. Access the Admin Panel and click General.

2. Click the + Add option (under the Work Items display fields section).

© 2019 Modern Requirements Page 50 of 151 Modern Requirements4DevOps Installation Guide 3. Move the desired fields from the Available list to the Selected list using the arrow button.

4. Click OK after selecting all the desired fields.

© 2019 Modern Requirements Page 51 of 151 Modern Requirements4DevOps Installation Guide 5. Click Save Changes at the bottom.

CONFIGURING EMAIL

For many tasks, Modern Requirements4DevOps needs to send out emails. The settings for the email account are done using General section.

1. Provide details for the email account.

© 2019 Modern Requirements Page 52 of 151 Modern Requirements4DevOps Installation Guide 2. Scroll down and click Save Changes.

© 2019 Modern Requirements Page 53 of 151 Modern Requirements4DevOps Installation Guide

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.

© 2019 Modern Requirements Page 54 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 55 of 151 Modern Requirements4DevOps Installation Guide

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. The Review Response Actions section determines which actions are available for review response.

© 2019 Modern Requirements Page 56 of 151 Modern Requirements4DevOps Installation Guide

2. Select the +Add option located in the Review Response Actions section.

3. Enter a suitable action name and click OK.

© 2019 Modern Requirements Page 57 of 151 Modern Requirements4DevOps Installation Guide 4. Scroll down and click Save Changes at the bottom.

CONFIGURING THE RULES SECTION

While creating a Review Request, the Rules section is shown at the bottom of the dialogue box.

© 2019 Modern Requirements Page 58 of 151 Modern Requirements4DevOps Installation Guide User can configure if this section is shown or not, and if shown which of the controls are shown in the section. This is done by: 1. Accessing the Admin panel and clicking the Review option. 2. Scroll Down till the Rules Configuration section is visible. 3. Configure which of the option appear in the Rules Section of Review Request dialogue box (Disable the top control if the Rules section is not to be shown).

4. Scroll down and click Save Changes.

© 2019 Modern Requirements Page 59 of 151 Modern Requirements4DevOps Installation Guide

CONFIGURING REVIEW EVENT EMAILS

Modern Requirements4DevOps can automatically send out emails to stakeholders when certain events occur while responding to a review request. Users can configure which events, when occurred would send out emails automatically, by enabling/disabling relevant check boxes.

Like other options, Save Changes button should be clicked after updating this section.

© 2019 Modern Requirements Page 60 of 151 Modern Requirements4DevOps Installation Guide

CONFIGURING REMINDER EMAIL TIMING Modern Requirements4DevOps can automatically send out reminder emails to reviewers/approvers to make sure they respond to the review request within due time. This is done using the corresponding part under the Review section of Admin Panel.

Follow these steps to configure the reminder email timing: 1. Access the Admin panel and click Review. 2. Scroll down to view the bottom portion of the page. 3. Select the desired time in days (before the deadline) from the list.

© 2019 Modern Requirements Page 61 of 151 Modern Requirements4DevOps Installation Guide 4. Click Save Changes Button.

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 Requirements4DevOps to change the state field (to the selected state) when the approval process is completed.

© 2019 Modern Requirements Page 62 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 63 of 151 Modern Requirements4DevOps Installation Guide 4. Provide the desired email address and click OK.

5. Click Save Changes.

© 2019 Modern Requirements Page 64 of 151 Modern Requirements4DevOps Installation Guide

BASELINE SECTION

TREATING LINK UPDATE AS A CHANGE DURING BASELINE COMPARISON While two baselines are being compared, field values are actually being compared at the basic level. Users can now configure whether they want link type updates to be considered as a CHANGE or not. This is done by enabling or disabling the relevant checkbox under the Baseline section in Admin Panel.

1. Enable / Disable the checkbox if the links update is to be considered a change or not (during baseline comparison).

© 2019 Modern Requirements Page 65 of 151 Modern Requirements4DevOps Installation Guide 2. Click the Save Changes Button.

CONFIGURING WORK ITEM FIELDS TO BE COPIED WHILE COPYING BASELINE

1. Access the Admin panel and select the Baseline option.

© 2019 Modern Requirements Page 66 of 151 Modern Requirements4DevOps Installation Guide 2. Click + Add option (located in the Work Item display fields section).

3. Select the relevant Work Item type.

© 2019 Modern Requirements Page 67 of 151 Modern Requirements4DevOps Installation Guide 4. Select the desired Work Item field.

5. Select the default value of the field.

© 2019 Modern Requirements Page 68 of 151 Modern Requirements4DevOps Installation Guide The work item field is added to the list.

6. Click the Save Changes Button.

© 2019 Modern Requirements Page 69 of 151 Modern Requirements4DevOps Installation Guide

CONFIGURING 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 the Baseline option.

© 2019 Modern Requirements Page 70 of 151 Modern Requirements4DevOps Installation Guide 2. At the bottom of the page click the Link type drop-down control.

3. Select the desired relation type from the list.

© 2019 Modern Requirements Page 71 of 151 Modern Requirements4DevOps Installation Guide 4. Click Save Changes.

© 2019 Modern Requirements Page 72 of 151 Modern Requirements4DevOps Installation Guide

MR AGENT/SERVICES

MR Services (formerly called MR Agent) is one of the components of Modern Requirements4DevOps that is automatically installed with the main application. It’s a framework that provides extensibility to Azure DevOps using triggers. Please note that MR Services are only accessible with AZURE DEVOPS Services using LIVE/PUBLIC IP to communicate with VSTS(Azure DevOps services). If any machine has no public access than VSTS Azure DevOps services could not be used (as they require public access to communicate with machine). Users are advised to contact their Network Administrators to change the value to the live IP address of their machines including the relevant port. Currently, MR Services (MR Agent) has the following three sub components: 1. Custom ID 2. Dirty Flag 3. Email Monitor

Proper user authentication is required before any of these components are configured. The config files of any of the components won’t work unless the relevant organization (in Azure DevOps) or collection (in TFS) is registered using authentication.

MR SERVICES USER AUTHENTICATION

1. Launch the embedded version of the application and select the Modern Requirements4DevOps option under the Settings tab.

© 2019 Modern Requirements Page 73 of 151 Modern Requirements4DevOps Installation Guide The Admin panel is displayed.

2. Click the Services Tab.

© 2019 Modern Requirements Page 74 of 151 Modern Requirements4DevOps Installation Guide The options for Services Tab are displayed.

The Settings sub-tab deals with two options:

 Setting time interval to Scan the Azure DevOps organization (or TFS Collection) for new projects  Registration of the current organization (Admin user credentials are required for this option)

Note: Enter values for both of these settings in one go. Users can't choose to configure one setting while leave the other pending.

3. Enter time interval for Auto Scan (should be between 1 and 60). This value determines the interval in minutes after which the registered Azure DevOps organization would be scaned for new projects.

© 2019 Modern Requirements Page 75 of 151 Modern Requirements4DevOps Installation Guide 4. Provide authorized login credentials. (with TFS admin rights)

On successful authentication, current organization is registed and a confirmatory message is displayed.

© 2019 Modern Requirements Page 76 of 151 Modern Requirements4DevOps Installation Guide

MANUAL IDENTIFICATION OF NEW PROJECT IN THE AZURE DEVOPS ORGANIZATION

The above section elaborated the process to customize the automatic scanning time for the Azure DevOps Organization. The value shown in the above image means that the organization would be scanned every 30 minutes for the new project. However if the user has just created a new project and wants to work on it right away then he has to manually identify it (the project) in the Azure DevOps Organization. The following steps are required to do so: 1. Enter the following command on CMD: cd :\Program Files\Modern Requirements\MR-Agent\bin

2. Once in the bin directory, enter the following command: MRAgent

The menu of options is displayed.

© 2019 Modern Requirements Page 77 of 151 Modern Requirements4DevOps Installation Guide

3. Type 4 and click Enter.

© 2019 Modern Requirements Page 78 of 151 Modern Requirements4DevOps Installation Guide 4. Enter the Azure DevOps organization value to scan for new projects.

If no error message is displayed, the process has been successfully carried out for scanning new projects created after registering an Azure DevOps organization/or applying its config.

© 2019 Modern Requirements Page 79 of 151 Modern Requirements4DevOps Installation Guide

CUSTOM ID CONFIGURAION

Custom ID is a component of MR Services (MR Agent) that is used to provide Customized IDs to work items in addition to their default work item IDs. The Custom IDs do not replace the original IDs, instead they complement them. The customized IDs can be used to keep track of the work item origins (i.e. which team created a particular work item).

In order to make the Custom ID work properly, users must manually create the following two items:

1. A folder that is named after the Azure DevOps (TFS) server name (on which the Custom ID is required to apply). 2. Another folder that is named after Azure DevOps organization or TFS Collection (on which the Custom ID is required) under the Azure DevOps (TFS) folder name.

The relevant organization folder should also include the config. 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 CustomId folder.

© 2019 Modern Requirements Page 80 of 151 Modern Requirements4DevOps Installation Guide 1. Create a folder named after the Azure DevOps Server name (on which component is required to apply) at this location.

2. Enter the newly created folder and again create another folder here with the name of Azure DevOps organization name (on which component is required to apply).

© 2019 Modern Requirements Page 81 of 151 Modern Requirements4DevOps Installation Guide 3. Copy the Config.xml file (discussed earlier) into the newly created folder i.e. Folder with Azure DevOps organization name.

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.  Team ->apply counter scope to the Team level.

© 2019 Modern Requirements Page 82 of 151 Modern Requirements4DevOps Installation Guide 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. 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 Work Item on which the Custom ID is required to apply. Also, if required, multiple Work Items 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: [PN] Req ##### [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.

© 2019 Modern Requirements Page 83 of 151 Modern Requirements4DevOps Installation Guide

APPLYING CUSTOM ID ON EXISTING WORK ITEMS

1. Enter the following command on CMD: cd :\Program Files\Modern Requirements\MR-Agent\bin 2. Once in the bin directory, enter the following command: MRAgent

The menu of options is displayed.

© 2019 Modern Requirements Page 84 of 151 Modern Requirements4DevOps Installation Guide 3. Type 1 and click Enter.

4. Enter the Azure DevOps organization (or TFS Collection) URL value.

© 2019 Modern Requirements Page 85 of 151 Modern Requirements4DevOps Installation Guide If no error message is displayed the Custom ID has been applied on existing work items of collection successfully.

© 2019 Modern Requirements Page 86 of 151 Modern Requirements4DevOps Installation Guide

DIRTY FLAG CONFIGURATION

Dirty Flag is a component of MR Services (MR Agent) that is used to mark particular work items as dirty (due to changed requirements) so that relevant stakeholders may review these work items once instead of proceeding with the outdated requirements.

In order to make the Dirty Flag work properly, users must manually create the following two items:

1. A folder that is named after the Azure DevOps (TFS) server name (on which the Dirty Flag is required to apply). 2. Another folder that is named after Azure DevOps organization or TFS Collection (on which the Dirty Flag is required) under the Azure DevOps (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 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.

© 2019 Modern Requirements Page 87 of 151 Modern Requirements4DevOps Installation Guide 1. Create a folder named after the Azure DevOps (TFS) Server name (on which component is required to apply) at this location.

2. Enter the newly created folder and again create another folder here with the name of Azure DevOps organization (or TFS collection) name (on which component is required to apply).

© 2019 Modern Requirements Page 88 of 151 Modern Requirements4DevOps Installation Guide 3. Copy the Config.xml file (discussed earlier) into the newly created folder i.e. Folder with Azure DevOps organization (or TFS collection) name.

This file contains the blueprint for the desired configuration.

© 2019 Modern Requirements Page 89 of 151 Modern Requirements4DevOps Installation Guide

CONFIGURING THE DIRTY FLAG XML FILE

1. Open config.xml file in Notepad or any text editor.

1. Open the config.xml file in Notepad or any text editor. 2. 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 Services (MR Agent) what to look for to trigger the Dirty Flag; the Target part tells MR Services (MR Agent) which type of work items will be tagged as dirty in case of a trigger. 3. 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. 4. The “FieldReferenceName” tag denotes which field(s) of the work item (the list is provided in the WIType tag) will be checked. 5. 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. 6. 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. 7. Save and close the configuration file following its successful completion.

© 2019 Modern Requirements Page 90 of 151 Modern Requirements4DevOps Installation Guide

EMAIL MONITOR

Email Monitor is a component of MR Services (MR Agent) that is used to automatically create work items from emails. A particular email address is configured for this purpose and on successful completion of the configuration process, all emails sent to this email address result in creating/updating work items. The process involves the following steps*:

1. Configuring the Email Monitor Config file (placed at a particular location) 2. Entering and verifying email settings

Each of these steps is elaborated further below.

*For local Azure DevOps (TFS) servers, MR Services (MR Agent) automatically adds the relevant location in the application settings file (AppSettings.config). However if Azure DevOps Services are involved then the user’s machine should have a live IP address that the Azure DevOps Services can use to access/communicate. This IP address should be added in the AppSettings config file. The process to do it is elaborated in the following steps:

3. Go to the installation folder of MR Services (MR Agent) (highlighted in the image) and open the AppSettings config file in a text editor.

© 2019 Modern Requirements Page 91 of 151 Modern Requirements4DevOps Installation Guide The ApplicationURL is automatically set toward the local machine.

4. Change the value (for Azure DevOps Services only) to the live IP address of your machine including the relevant port.*

*Contact your Network Administrator to get the live IP address and port information

5. Save and close the config file.

© 2019 Modern Requirements Page 92 of 151 Modern Requirements4DevOps Installation Guide

TIMING CONFIGURATIONS IN APPSETTING FILE

At the bottom of the AppSettings config file, there are three timing configurations available for users.

SUBSCRIBESCHEDULE

1. Works for all components of MR Services 2. Used to check new projects/collections 3. Default value “30”* represents the number of minutes, after which MR Services (MR Agent) scans for new projects. Users can configure the value (in minutes) as per their requirements.

*This value can also be configured using Admin Panel.

APPPLYALLSCHEDULE

1. Works only for Custom ID 2. Used to apply Custom ID on newly created work items 3. Default value “30” represents the number of minutes, after which MR Services (MR Agent) scans for new work items and apply Custom IDs on them. Users can configure the value (in minutes) as per their requirements.

EMAILCHECKSCHEDULE

1. Works only for Email Monitor 2. Used to check if a new email has arrived from which work items could be created/updated 3. Default value “15” represents the number of minutes, after which MR Services (MR Agent) scans for email. Users can configure the value (in minutes) as per their requirements.

© 2019 Modern Requirements Page 93 of 151 Modern Requirements4DevOps Installation Guide

EMAIL MONITOR CONFIGURAION

In order to make the Email Monitor work properly, users must manually create the following items:

1. A folder that is named after the Azure DevOps (TFS) server name (on which the Email Monitor is required to apply).

The relevant server 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:

* Note: for the current versions of Email Monitor, the hierarchy stops at the server folder, and placing the file in that server folder. However for the future versions, the hierarchy would go up to the organization folder (like other components of MR Services (MR Agent)). Please consult with your administrator or contact Modern Requirements if any uncertainty persists in this matter.

As described in the image above, a sample Config.xml file is placed in the EmailMonitor folder.

© 2019 Modern Requirements Page 94 of 151 Modern Requirements4DevOps Installation Guide 1. Create a folder named after the Azure DevOps (TFS) Server name (on which component is required to apply) at this location.

2. Enter the newly created folder and copy the Config.xml file (discussed earlier) into that folder i.e. Folder with Azure DevOps (TFS) Server name.

This file contains the blueprint for the desired configuration.

© 2019 Modern Requirements Page 95 of 151 Modern Requirements4DevOps Installation Guide

CONFIGURING THE EMAIL MONITOR XML FILE

1. Open the config.xml file in Notepad or any text editor.

2. Define the value of the ServerURL tag as per requirement, for example:

3. Similarly define the value for Collection Url (including the DefaultProject)

 The values for both the ServerURL and Collection Url should correspond to the folder structure described before.  Make sure that the URL does not end with a forward slash “/”  User can define multiple Collection URLs in the config file.

© 2019 Modern Requirements Page 96 of 151 Modern Requirements4DevOps Installation Guide 4. Provide the value for AdminEmail. This email address is used as a mitigation, in case the desired functionality can’t be achieved using the address defined in Email tag (explained in the next step).

Note: Only a single Admin email can exist in the config file. 5. “Email” tag is the main tag in this file that defines where the email would be sent. The emails sent to this address would be used to create desired types of work items. Configure the Email tag as required e. Email: Provide the target email address where the email should be delivered for work items creation/update. In case some criteria does not match with the desired values, the warning email would be sent at the Admin Email defined above.

Note: Multiple email addresses can be defined in the config file. f. Work Item Type: Set the desired type of work item to be created. In the following example CategoryReference represents the internal category type of work items. Multiple values in this tag means that the relevant type of work item would be created depending upon the template of team project. e.g. If the team project is using CMMI template then the email would create a Requirement work item. Similarly, for Agile based project a User Story would be created and for a Scrum based project a Project Backlog Item would be created.

© 2019 Modern Requirements Page 97 of 151 Modern Requirements4DevOps Installation Guide

c. FieldReference=”System.Title”: Tells what would be the title of the work Item to be created. The following example shows that the subject of the email would become the title of the work item. i. OnCreate= ”true” means that the title would be set from the email’s subject only for new Work Items. ii. OnUpdate=”false” means that for existing Work Items, the Title field would not be updated.

d. FieldReference=”System.Description”: Tell where to put the information from the incoming emails (i.e. in which property/field of the work item). The following example uses the Description field for this purpose. i. OnCreate= ”true” means that for new Work Items, the content of the email (described next) would be used to populate the Description field of the work item. ii. OnUpdate=”false” means that for existing Work Items, the Description field would not be overwritten. Instead the update would go to the comments/history section of the work item. The later part of this field tells the composition of the description field. The following information would compose the Description field: i. Sender Name shown inside <> e.g. ii. Sender Email also shown inside <> e.g. iii. Email body added in a new line

© 2019 Modern Requirements Page 98 of 151 Modern Requirements4DevOps Installation Guide

g. The final FieldReference=”System.History” is used for discussion emails that come after a work item has been created. Instead of overwriting the Description field, the subsequent email information is stored in the Comments field (internally called History). The composition of the History field is more or less the same as of Description field discussed above. Users are advised to keep the original settings for this tag.

9. Following the successful completion of the configuration file, save and close the file.

© 2019 Modern Requirements Page 99 of 151 Modern Requirements4DevOps Installation Guide

DEPLOYING EMAIL MONITOR

DEPLOYING EMAIL MONITOR

Email Monitor can be deployed by configuring relevant settings under the Admin Panel. These settings can be accessed using the Services Tab.

The Services section of the Admin panel currently has two Tabs: Settings & Email Monitor

© 2019 Modern Requirements Page 100 of 151 Modern Requirements4DevOps Installation Guide

Settings Tab deals with 1) User Authentication/Organization Registration 2) Scanning for new projects.

Email Monitor deals with all the email related options discussed earlier in the command line section.

ACCESSING ADMIN PANEL (AND THE SERVICES TAB)

 Refer to MR Services User Authentication for accessing Admin Panel and Settings sub-tab options.

CONFIGURING EMAIL MONITOR OPTIONS

 Email Monitor tab under the Services section is used to configure email settings.  The options can be accessed by clicking the Email Monitor tab as shown in the following image.

 If the user hasn’t registered their organization (by providing required details in the Settings sub-tab), then upon clicking the Email Monitor sub-tab, the user is sent back to the Settings sub-tab, unless the desired information is entered.

© 2019 Modern Requirements Page 101 of 151 Modern Requirements4DevOps Installation Guide

 The Email Monitor settings are divided into sections, where each section is used to configure a particular setting.

 All necessary settings are configured once. Users can not configure certain settings and leave other pending.  The first section is used to configure the default project and the admin email address.

© 2019 Modern Requirements Page 102 of 151 Modern Requirements4DevOps Installation Guide  The second section is used to configure the email address that would be used for Email Monitoring.

Clicking on Register Email Address would open a popup window where the network settings for the email (e.g. SSL, POP3, IMAP etc) can be configured.

© 2019 Modern Requirements Page 103 of 151 Modern Requirements4DevOps Installation Guide  The third section is used for settings (that will be used to) to extract Work Item content from the emails sent to the Registered Email Address.

Clicking on Save Changes button after configuring all the settings would deploy the Email Monitor.

© 2019 Modern Requirements Page 104 of 151 Modern Requirements4DevOps Installation Guide

APPENDIX: USER CONFIGURATIONS

MINIMUM HARDWARE REQUIREMENTS FOR REDIS

According to Modern Requirements4DevOps, 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.

A user should make sure his machine has sufficient hardware requirements for Redis.

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).

© 2019 Modern Requirements Page 105 of 151 Modern Requirements4DevOps Installation Guide 2. Select the Programs option.

3. Select the “Turn Windows features on or off” option under the Programs and Features category.

The Windows Feature screen will be displayed.

© 2019 Modern Requirements Page 106 of 151 Modern Requirements4DevOps Installation Guide 4. Select the highlighted features required for Modern Requirements4DevOps.

5. If Win8 or a more recent version is installed on the machine please enable the features highlighted in the following image as well:

© 2019 Modern Requirements Page 107 of 151 Modern Requirements4DevOps Installation Guide

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.

© 2019 Modern Requirements Page 108 of 151 Modern Requirements4DevOps Installation Guide 3. Select the Application Pools option.

4. Right-click ModernRequirements4DevOps 2019 and select Edit Binding. The Site Bindings window will be displayed. The “IP Address” field will display which IP has been bound, if any.

© 2019 Modern Requirements Page 109 of 151 Modern Requirements4DevOps Installation Guide 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. :\Program Files\Modern Requirements\ModernRequirements4DevOps 2019\User Interface

6. Select the Web.config file among the list displayed in the folder (refer to the highlighted line in the image above). 7. Open the file in Notepad.

© 2019 Modern Requirements Page 110 of 151 Modern Requirements4DevOps Installation Guide 8. Search for the tag (selected in the following image) and update its value, http://: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.

10. Switch back to the IIS Manger window and restart both inteGREAT services under the Sites folder.

EMAIL CONFIGURATION FOR THE FEEDBACK OPTION

All the configurations regarding emails are now done using Admin Panel (for the Embedded version). Please refer to that section for details. This section is for users currently using the Standalone version of the application.

The email configuration is essential if you want to use the Feedback option in the Simulation Module. This is because Modern Requirements4DevOps 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 (elaborated from next page onwards) to configure the email settings for Modern Requirements4DevOps:

© 2019 Modern Requirements Page 111 of 151 Modern Requirements4DevOps Installation Guide 1. Navigate to the following location on your computer: “C:\Program Files\Modern Requirements\ModernRequirements4DevOps 2019\Service”

2. Copy the “Web.config” file to another location (e.g. desktop) for editing.

© 2019 Modern Requirements Page 112 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 113 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 114 of 151 Modern Requirements4DevOps Installation Guide 7. Note down the information highlighted in the window.

8. Click the More Settings… button.

© 2019 Modern Requirements Page 115 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 116 of 151 Modern Requirements4DevOps Installation Guide 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\ModernRequirements4DevOps2018 Update X\Service”)

This completes the email configuration process for the Feedback Option.

© 2019 Modern Requirements Page 117 of 151 Modern Requirements4DevOps Installation Guide

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 Requirements4DevOps has been deployed. 3. Go to the Run window (by clicking the Keyboard shortcut: [ + ‘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.

© 2019 Modern Requirements Page 118 of 151 Modern Requirements4DevOps Installation Guide

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.

© 2019 Modern Requirements Page 119 of 151 Modern Requirements4DevOps Installation Guide

If VDI (Virtual Desktop Infrastructure) has been implemented, follow these steps:

1. Using Remote Desktop option, connect with the VM Machine where Modern Requirements4DevOps 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 (:\inetpub\wwwroot\walog) at: [email protected] 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.

© 2019 Modern Requirements Page 120 of 151 Modern Requirements4DevOps Installation Guide

HOW TO UPDATE THE WINDOWS CREDENTIALS FOR MODERN REQUIREMENTS4DEVOPS

During the installation of Modern Requirements4DevOps, user login credentials are provided. These Windows credentials are saved in the Modern Requirements4DevOps 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 Requirements4DevOps, the saved settings of the Windows credentials should be consistent with the current Windows credentials. If you change your password after installing Modern Requirements4DevOps, take the following steps to update the saved settings:

1. Invoke inetmgr through Windows’s Run command/Start Menu.

© 2019 Modern Requirements Page 121 of 151 Modern Requirements4DevOps Installation Guide 2. Expand the node in the panel of the IIS Manager on the left-hand side.

3. Select the Application Pools option.

© 2019 Modern Requirements Page 122 of 151 Modern Requirements4DevOps Installation Guide 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.

© 2019 Modern Requirements Page 123 of 151 Modern Requirements4DevOps Installation Guide 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 as displayed in the image above. The settings will be saved by clicking OK.

© 2019 Modern Requirements Page 124 of 151 Modern Requirements4DevOps Installation Guide 8. Start inteGREAT4TFSsrv by clicking Start under the Application Pool Tasks on the right-hand side of the panel.

Close all windows to complete the process.

© 2019 Modern Requirements Page 125 of 151 Modern Requirements4DevOps Installation Guide

HOW TO USE TEAM CONTEXT IN TFS 2019

Normally users access an Azure DevOps Project as a whole, however if different teams are to be given access to relevant portions of the project then users have to configure this setting as elaborated in 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.

© 2019 Modern Requirements Page 126 of 151 Modern Requirements4DevOps Installation Guide 3. Expand the Sites node.

4. Select Modern Requirements4DevOps 2019 Update 1 node.

© 2019 Modern Requirements Page 127 of 151 Modern Requirements4DevOps Installation Guide 5. Select the Application Settings option in the middle panel.

6. Double-click on the Embed.Tfs2019 option in the list.

© 2019 Modern Requirements Page 128 of 151 Modern Requirements4DevOps Installation Guide 7. Set value to “true” and click the OK button.

8. Close IIS Manager.

© 2019 Modern Requirements Page 129 of 151 Modern Requirements4DevOps Installation Guide Users can now select the relevant team of their desired project and it becomes visible in the User Interface.

Note: By enabling the “Team” drop down, MR application will not work in ‘Internet Explorer’ and ‘Edge’ browsers.

© 2019 Modern Requirements Page 130 of 151 Modern Requirements4DevOps Installation Guide

HOW TO CONFIGURE LOAD BALANCING FOR MODERN REQUIREMENTS4DEVOPS

This section describes the configuration process of load balancing for Modern Requirements4DevOps using detailed steps. It acts only as a framework to show how to configure load balancing for Modern Requirements4DevOps. 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 Requirements4DevOps 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 Requirements4DevOps 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 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:

© 2019 Modern Requirements Page 131 of 151 Modern Requirements4DevOps Installation Guide * 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: 4. Uncomment the following section:

5. In the above section, set customProvider value to “RedisCacheAzure01”. 6. Make the following comment in the section above:

CHANGE THE SERVICE CONFIGURATION FILE

The location of this file in Program Files 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) 3. Set the EnableLoadBalancer key value to “true”: 4. Set the Redis storage value host, port and *password

© 2019 Modern Requirements Page 132 of 151 Modern Requirements4DevOps Installation Guide *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).

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 :\Program Files\Modern Requirements\Modern Requirements4DevOps 2019\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.

© 2019 Modern Requirements Page 133 of 151 Modern Requirements4DevOps Installation Guide

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: \Program Files\Modern Requirements\Modern Requirements4DevOps 2019\Service\App_Data 2. Look for the XML file ‘WIToFileTypeMapping’ in the folder and open it. 3. Look for the field ‘’ in the respective module section and update the "" 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.

© 2019 Modern Requirements Page 134 of 151 Modern Requirements4DevOps Installation Guide The IIS Manager window will open.

9. In the IIS Manager window, select the Modern Requirements4DevOps 2019 Service option on the left-hand side.

© 2019 Modern Requirements Page 135 of 151 Modern Requirements4DevOps Installation Guide 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 Requirements4DevOps creates a local working folder on the machine where Modern Requirements4DevOps is installed. The path can be changed but this one is recommended when you’re installing and using Modern Requirements4DevOps for the first time.

By manually changing the location of Modern Requirements4DevOps 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 : :\Program Files\Modern Requirements\Modern Requirements4DevOps 2019\Service 2. Open “web.config” file, find the following tag : 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.

© 2019 Modern Requirements Page 136 of 151 Modern Requirements4DevOps Installation Guide

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 Requirements4DevOps (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

© 2019 Modern Requirements Page 137 of 151 Modern Requirements4DevOps Installation Guide 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 Requirements4DevOps by entering the following URL: :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.

© 2019 Modern Requirements Page 138 of 151 Modern Requirements4DevOps Installation Guide

This situation occurs when you’re using Visual Studio Team Services, but haven’t used any of the Modern Requirements4DevOps modules in the current session yet. In other words, you have been using the container environment but haven’t actually used Modern Requirements4DevOps so far. Therefore the status check for the license won’t work in this scenario. But after you click any of the Modern Requirements4DevOps modules this problem won’t persist.

© 2019 Modern Requirements Page 139 of 151 Modern Requirements4DevOps Installation Guide

“UNEXPECTED ERROR” MESSAGE (STANDALONE)

Occasionally you may come across the “unexpected error” message as displayed in the following image.

The solution to this error starts at the same Sign-in page. 1. Open the Click here link, as shown below.

© 2019 Modern Requirements Page 140 of 151 Modern Requirements4DevOps Installation Guide 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.

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.

© 2019 Modern Requirements Page 141 of 151 Modern Requirements4DevOps Installation Guide

“IIS VERSION IS LOWER..” ERROR

If you encounter the following error message “ModernRequirements4DevOps 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 Requirements4DevOps). 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 Requirements4DevOps. 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 Requirements4DevOps 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 Requirements4DevOps 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.

© 2019 Modern Requirements Page 142 of 151 Modern Requirements4DevOps Installation Guide 3. Open the HTTP Response Headers option by double-clicking it.

4. Click the Add… option in the Actions panel.

© 2019 Modern Requirements Page 143 of 151 Modern Requirements4DevOps Installation Guide 5. Enter the following values and click OK.  Name = p3p  Value = CAO PSA OUR

6. Again click the server name in Root.

© 2019 Modern Requirements Page 144 of 151 Modern Requirements4DevOps Installation Guide 7. Restart IIS.

© 2019 Modern Requirements Page 145 of 151 Modern Requirements4DevOps Installation Guide

ENABLING HTTPS

By default the Modern Requirements4DevOps service runs on port 8028, hence to access the service :8028 is written in the browser. Users have the option to use a port of their choice using the following steps:

1. Invoke the Internet Information Services (IIS) Manager using “inetmgr” in Window’s Run command.

2. Expand the root node.

© 2019 Modern Requirements Page 146 of 151 Modern Requirements4DevOps Installation Guide 3. Expand the Sites node.

4. Right click on the Modern Requirements4DevOps 2019 option.

© 2019 Modern Requirements Page 147 of 151 Modern Requirements4DevOps Installation Guide 5. Select the Edit Bindings… option from the drop down menu.

© 2019 Modern Requirements Page 148 of 151 Modern Requirements4DevOps Installation Guide 6. Click the Add button from the Site Bindings dialogue box.

7. Change type from http to https.

© 2019 Modern Requirements Page 149 of 151 Modern Requirements4DevOps Installation Guide 8. Provide any suitable port number.

9. Select the desired SSL certificate.

© 2019 Modern Requirements Page 150 of 151 Modern Requirements4DevOps Installation Guide 10. Click OK button.

From now on Modern Requirements4DevOps would run using the new url in the format https://:

© 2019 Modern Requirements Page 151 of 151